Intouch REST Resource: Folders

RSS

This page describes the folders portion of the Intouch REST API.

Table of Contents [Hide/Show]

Endpoints
Data contract
   JSON
   XML
   Deliver status
   Direction
See also

Endpoints¶

URI	Method	Returns	Notes
/folders	GET	Array of folders	Retrieve all message folders. The structure is hierarchical; folders can have subfolders.
/folders/{id}/messages	GET	Array of messages	Retrieves all the messages in a particular folder. Note that the data contract used is not the same as for the /messages resource.

Data contract¶

When getting folder data you have the option of using either XML or JSON.

JSON¶

Sample data, returned by requesting resource /folders. In this case there is a single top-level folder called Inbox, which has a subfolder called Support messages:

[{"FolderId":23,
  "FolderType":"Inbox",
  "IsPrivate":false,
  "IsUserDeletable":false,
  "MessagesInFolder":33,
  "Name":"Inbox",
  "ParentFolderId":null,
  "SubFolders":
  [{"FolderId":197,
    "FolderType":"UserFolder",
    "IsPrivate":false,
    "IsUserDeletable":true,
    "MessagesInFolder":2,
    "Name":"Support messages",
    "ParentFolderId":23,
    "SubFolders":[]}]}]

Sample data, returned by requesting resource /folders/197/messages:

[{"DeliverStatus":"Unknown",
  "DeliverTime":null,
  "Direction":"I",
  "From":"Audun40 ",
  "FromNumber":"40555966",
  "MessageId":"I_1294",
  "MessageType":"SMS",
  "ResourceURI":"http:\/\/intouchapi.pswin.com\/1\/messages\/I_1294",
  "SendReceiveTime":"\/Date(1227101047157+0100)\/",
  "Text":"Genoa test",
  "To":"2077"},
 {"DeliverStatus":"Unknown",
  "DeliverTime":null,
  "Direction":"I",
  "From":"Audun40 ",
  "FromNumber":"40555966",
  "MessageId":"I_1234",
  "MessageType":"SMS",
  "ResourceURI":"http:\/\/intouchapi.pswin.com\/1\/messages\/I_1234",
  "SendReceiveTime":"\/Date(1224488767350+0200)\/",
  "Text":"Genoa test",
  "To":"2077"}]

XML¶

Sample data, returned by requesting resource /folders. In this case there is a single top-level folder called Inbox, which has a subfolder called Support messages:

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfFolder xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PSWinCom.Intouch.API.Resources">
  <Folder>
    <FolderId>23</FolderId>
    <FolderType>Inbox</FolderType>
    <IsPrivate>false</IsPrivate>
    <IsUserDeletable>false</IsUserDeletable>
    <MessagesInFolder>33</MessagesInFolder>
    <Name>Inbox</Name>
    <ParentFolderId
      i:nil="true" />
    <SubFolders>
      <Folder>
        <FolderId>197</FolderId>
        <FolderType>UserFolder</FolderType>
        <IsPrivate>false</IsPrivate>
        <IsUserDeletable>true</IsUserDeletable>
        <MessagesInFolder>2</MessagesInFolder>
        <Name>Support messages</Name>
        <ParentFolderId>23</ParentFolderId>
        <SubFolders />
      <Folder>
    </SubFolders>
  </Folder>
<ArrayOfFolder>

Sample data, returned by requesting resource /folders/197/messages:

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfMessageView xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PSWinCom.Intouch.API.Resources">
  <MessageView>
    <DeliverStatus>Unknown</DeliverStatus>
    <DeliverTime
      i:nil="true" />
    <Direction>I</Direction>
    <From>Audun40 </From>
    <FromNumber>40555966</FromNumber>
    <MessageId>I_1294</MessageId>
    <MessageType>SMS</MessageType>
    <ResourceURI>http://intouchapi.pswin.com/1/messages/I_1294</ResourceURI>
    <SendReceiveTime>2008-11-19T14:24:07.157</SendReceiveTime>
    <Text>Genoa test</Text>
    <To>2077</To>
  </MessageView>
  <MessageView>
    <DeliverStatus>Unknown</DeliverStatus>
    <DeliverTime
      i:nil="true" />
    <Direction>I</Direction>
    <From>Audun40 </From>
    <FromNumber>40555966</FromNumber>
    <MessageId>I_1234</MessageId>
    <MessageType>SMS</MessageType>
    <ResourceURI>http://intouchapi.pswin.com/1/messages/I_1234</ResourceURI>
    <SendReceiveTime>2008-10-20T09:46:07.35</SendReceiveTime>
    <Text>Genoa test</Text>
    <To>2077</To>
  </MessageView>
</ArrayOfMessageView>

Deliver status¶

Possible values are:

Unknown
Delivered
Expired
Blocked

Direction¶

The direction property specifies the direction of the message in relation to Intouch. The value can be the letter I for incoming messages and the letter O for outgoing messages.

Search the wiki¶

API Documentation¶

Mobile Payment¶