logo   HOME

SMS Messaging

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

Retrieve inbox message [HTTP GET]

https://appapi.dlangemobile.com/xml/messages/{api_key}/inbox/{inbox_message_id}

URL Parameters

  • api_key (Required) - Your API application key.
  • inbox_message_id (Required) - ID of a MessageInbox item.

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

<MessageInbox>
  <ID>1</ID>
  <DateReceived>2011-05-31T11:20:00</DateReceived>
  <SenderNumber>+18351234454</SenderNumber>
  <Message>String content</Message>
  <IsUnread>true</IsUnread>
  <IsDeleted>false</IsDeleted>
</MessageInbox>

Error Codes

  • 001 - API key is required.
  • 002 - Invalid API key.
  • 302 - Define a valid Message ID.
  • 303 - Invalid Message ID format.
  • 304 - Message not found. Please provide a valid Inbox Message ID.

Set message as read [HTTP PUT]

https://appapi.dlangemobile.com/xml/messages/{api_key}/inbox/{inbox_message_id}/read

URL Parameters

  • api_key (Required) - Your API application key.
  • inbox_message_id (Required) - ID of a MessageInbox item.

Response Notes

Returns HTML status 200 if successful.

Error Codes

  • 001 - API key is required.
  • 002 - Invalid API key.
  • 302 - Define a valid Message ID.
  • 303 - Invalid Message ID format.
  • 304 - Message not found. Please provide a valid Inbox Message ID.

Set message as unread [HTTP PUT]

https://appapi.dlangemobile.com/xml/messages/{api_key}/inbox/{inbox_message_id}/unread

URL Parameters

  • api_key (Required) - Your API application key.
  • inbox_message_id (Required) - ID of a MessageInbox item.

Response Notes

Returns HTML status 200 if successful.

Error Codes

  • 001 - API key is required.
  • 002 - Invalid API key.
  • 302 - Define a valid Message ID.
  • 303 - Invalid Message ID format.
  • 304 - Message not found. Please provide a valid Inbox Message ID.

Restore deleted message [HTTP PUT]

https://appapi.dlangemobile.com/xml/messages/{api_key}/inbox/{inbox_message_id}/restore

URL Parameters

  • api_key (Required) - Your API application key.
  • inbox_message_id (Required) - ID of a MessageInbox item.

Response Notes

Returns HTML status 200 if successful.

Error Codes

  • 001 - API key is required.
  • 002 - Invalid API key.
  • 302 - Define a valid Message ID.
  • 303 - Invalid Message ID format.
  • 304 - Message not found. Please provide a valid Inbox Message ID.

Delete message [HTTP DELETE]

https://appapi.dlangemobile.com/xml/messages/{api_key}/inbox/{inbox_message_id}

URL Parameters

  • api_key (Required) - Your API application key.
  • inbox_message_id (Required) - ID of a MessageInbox item.

Response Notes

Returns HTML status 200 if successful.

Error Codes

  • 001 - API key is required.
  • 002 - Invalid API key.
  • 302 - Define a valid Message ID.
  • 303 - Invalid Message ID format.
  • 304 - Message not found. Please provide a valid Inbox Message ID.