SMS Messaging

This page lists the optional parameters, request data and reponse in xml

Retrieve inbox messages [HTTP GET]

https://appapi.dlangemobile.com/xml/messages/{api_key}/inbox?deleted={deleted}&unread={unread}&page_size={page_size}&page_number={page_number}

URL Parameters

• api_key (Required) - Your API application key.

Query string Parameters

• deleted (Optional) - Default value if not provided is false
  • true - return all deleted inbox items
  • false - return all active inbox items
• unread (Optional) - Default value if not provided is all
  • all - return both read and unread inbox items
  • true - return unread inbox items
  • false - return read inbox items
• page_size (Optional) - Value should be an integer. Defines the number of items per page. Value is required if page_number is defined. Default value if not provided is to return all items.
• page_number (Optional) - Value should be an integer. Defines the page number to return if page_size is defined. Default value if not provided is to return all items.

Response Notes

• ID - Used to delete and set status of inbox message
• DateReceived - Format is {yyyy}-{mm}-{dd}T{hh}:{mm}:{ss}

Example XML Response

<Inbox>
  <MessageInbox>
    <ID>2147483647</ID>
    <DateReceived>2011-05-31T11:20:00</DateReceived>
    <SenderNumber>+16501234567</SenderNumber>
    <Message>test message 1</Message>
    <IsUnread>true</IsUnread>
    <IsDeleted>false</IsDeleted>
  </MessageInbox>
  <MessageInbox>
    <ID>2</ID>
    <DateReceived>2011-05-31T11:20:00</DateReceived>
    <SenderNumber>+16501234567</SenderNumber>
    <Message>test message 2</Message>
    <IsUnread>true</IsUnread>
    <IsDeleted>false</IsDeleted>
  </MessageInbox>
</Inbox>

Error Codes

• 001 - API key is required.
• 002 - Invalid API key.
• 003 - Define the page size for paged queries..
• 004 - Define the page number for paged queries..
• 301 - Invalid unread value. It should be either 'true', 'false' or 'all'.

Retrieve inbox messages total count [HTTP GET]

https://appapi.dlangemobile.com/xml/messages/{api_key}/inbox/count?deleted={deleted}&unread={unread}

URL Parameters

• api_key (Required) - Your API application key.

Query string Parameters

• deleted (Optional) - Default value if not provided is false
  • true - return all deleted inbox items
  • false - return all active inbox items
• unread (Optional) - Default value if not provided is all
  • all - return both read and unread inbox items
  • true - return unread inbox items
  • false - return read inbox items

Example XML Response

<int>500</int>

Error Codes

• 001 - API key is required.
• 002 - Invalid API key.
• 301 - Invalid unread value. It should be either 'true', 'false' or 'all'.