PMessage.Outbox.get

Description

Get a list of converstaion threads in the users personal message outbox. Requires OAuth authentification.

Method

GET

Endpoint

Parameters

^Required ^Name ^Type ^Description ^

Example Request

Example Return XML

<ConversationOutboxSet xmlns="http://cixonline.com" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> 
  <Conversations> 
    <ConversationOutbox> 
      <Body>For the docs</Body> 
      <Date>2008-10-20T16:54:12.24</Date> 
      <ID>196</ID> 
      <Recipient>xxx</Recipient> 
      <Subject>Test of API</Subject> 
    </ConversationOutbox> 
    <ConversationOutbox> 
      <Body>For the docs</Body> 
      <Date>2008-10-20T16:53:24.567</Date> 
      <ID>195</ID> 
      <Recipient>xxx</Recipient> 
      <Subject>Test of API</Subject> 
    </ConversationOutbox> 
  </Conversations> 
  <Count>17</Count> 
  <Start>0</Start> 
</ConversationOutboxSet>

Example Return JSON

{
  "Conversations":[
    {"Body":"For the docs","Date":"\/Date(1224518052240+0100)\/","ID":196,
      "Recipient":"xxx","Subject":"Test of API"},
    {"Body":"For the docs","Date":"\/Date(1224518004567+0100)\/","ID":195,
      "Recipient":"xxx","Subject":"Test of API"}
  ],
  "Count":17,
  "Start":0
}

Error Codes

Code Description
401 Authentication failed. Missing required parameter : {parameter name}.
401 Signature expired. Either the timestamp or the nonce have expired or are invalid.
 
cix.api/pmessage.outbox.get.txt · Last modified: 2008/10/20 16:04 by charlie
 
Except where otherwise noted, content on this wiki is licensed under the following license:Public Domain
Recent changes RSS feed Donate Powered by PHP Valid XHTML 1.0 Valid CSS Debian Driven by DokuWiki