PMessage.Inbox.get

Description

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

Method

GET

Endpoint

Parameters

^Required ^Name ^Type ^Description ^

Example Request

Example Return XML

<ConversationInboxSet xmlns="http://cixonline.com" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> 
  <Conversations> 
    <ConversationInbox> 
      <Body>I got an error..</Body> 
      <Date>2008-10-06T11:19:07.867</Date> 
      <ID>180</ID> 
      <LastMsgBy>xxx</LastMsgBy> 
      <Sender>xxx</Sender> 
      <Subject>testing</Subject> 
      <Unread>false</Unread> 
    </ConversationInbox> 
    <ConversationInbox> 
      <Body>Yep, still nice and fast...</Body> 
      <Date>2008-09-25T17:16:53.783</Date> 
      <ID>174</ID> 
      <LastMsgBy>xxx</LastMsgBy> 
      <Sender>xxx</Sender> 
      <Subject>speed</Subject> 
      <Unread>false</Unread> 
    </ConversationInbox> 
  </Conversations> 
  <Count>11</Count> 
  <Start>0</Start> 
</ConversationInboxSet>

Example Return JSON

{
  "Conversations":[
    {"Body":"I got an error...","Date":"\/Date(1223288347867+0100)\/","ID":180,
      "LastMsgBy":"nigelgo","Sender":"nigelgo","Subject":"testing","Unread":false},
    {"Body":"Yep, still nice and fast...","Date":"\/Date(1222359413783+0100)\/","ID":174,
      "LastMsgBy":"nigelgo","Sender":"nigelgo","Subject":"speed","Unread":false}
  ],
  "Count":11,
  "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.inbox.get.txt · Last modified: 2008/10/20 15:19 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