logo   HOME

SMS Messaging

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

Retrieve outbox message [HTTP GET]

https://appapi.dlangemobile.com/xml/messages/{api_key}/outbox/{outbox_message_id}

URL Parameters

  • api_key (Required) - Your API application key.
  • out_message_id (Required) - ID of a MessageOutbox item.

Response Notes

Message includes all contacts and groups set as recipients.
  • DataCreated - Format is {yyyy}-{mm}-{dd}T{hh}:{mm}:{ss}

Example XML Response

<MessageOutbox>
    <ID>1</ID>
    <DateCreated>2011-05-31T11:20:00</DateCreated>
    <Message>my first message</Message>
    <Status>Message queued for sending</Status>
    <RecipientContacts>
      <Contact>
        <ID>1</ID>
        <PhoneNumber>+18353456334</PhoneNumber>
        <FirstName>firsttest</FirstName>
        <LastName>lasttest</LastName>
      </Contact>
      <Contact>
        <ID>1</ID>
        <PhoneNumber>+18359232834</PhoneNumber>
        <FirstName>ted</FirstName>
        <LastName>ray</LastName>
      </Contact>
    </RecipientContacts>
    <RecipientGroups>
      <Group>
        <ID>2147483647</ID>
        <Name>String content</Name>
        <ColorCode>-16751002</ColorCode>
      </Group>
      <Group>
        <ID>1</ID>
        <Name>first group</Name>
        <ColorCode>-13434625</ColorCode>
      </Group>
    </RecipientGroups>
  </MessageOutbox>

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 Message ID.