Email Messaging
This page lists the optional parameters, request data and reponse in xml
Retrieve sent messages [HTTP GET]
https://appapi.dlangemobile.com/xml/email/{api_key}/sent?page_size={page_size}&page_number={page_number}
URL Parameters
- api_key (Required) - Your API application key.
Query string Parameters
- 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
Each message includes all contacts and groups set as recipients.
- ID - Used to delete and set status of sent message
- DateReceived - Format is {yyyy}-{mm}-{dd}T{hh}:{mm}:{ss}
Example XML Response
<EmailMessages>
<EmailMessage>
<ID>1</ID>
<DateCreated>2011-05-31T11:20:00</DateCreated>
<SenderEmail>contact1@domain.com</SenderEmail>
<RecipientEmail>contact2@domain.com</RecipientEmail>
<Subject>my email subject</Subject>
<Message>my email body</Message>
</EmailMessage>
<EmailMessage>
<ID>2</ID>
<DateCreated>2011-05-31T11:20:00</DateCreated>
<SenderEmail>contact1@domain.com</SenderEmail>
<RecipientEmail>contact3@domain.com</RecipientEmail>
<Subject>my second email subject</Subject>
<Message>my second email body</Message>
</EmailMessage>
</EmailMessages>
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..
Retrieve sent messages total count [HTTP GET]
https://appapi.dlangemobile.com/xml/email/{api_key}/sent/count
URL Parameters
- api_key (Required) - Your API application key.
Example XML Response
<int>500</int>
Error Codes
- 001 - API key is required.
- 002 - Invalid API key.