Get Inbox Message Service
You can link to this page to retrieve messages from your Esendex inbox using the HTML Form Post protocol. The table below shows the fields you can include in your form. The fields marked with an asterisk (*) are mandatory.
| Authentication | ||
| Username* | Your Esendex username, for example [email protected] | |
| Password* | Your Esendex password, for example joe1234 | |
| Account* | Your Esendex account reference, for example EX0000000 | |
| Message details | ||
| MessageID | The ID of the message to retrieve. To retrieve multiple messages, specify a comma-separated list. To retrieve all messages, leave this field blank. This field is ignored if you specify a value for StartDate or EndDate. | |
| StartDate | The date of the first message you want to retrieve. Leave this field blank to retrieve messages beginning with your earliest message. | |
| EndDate | The date of the last message you want to retrieve. Leave this field blank to retrieve messages ending with your latest message. | |
| Day | The day of the month to retrieve messages for. This is ignored if you specify a value for StartDate, EndDate or MessageID. Both Month and Year must be filled if a value is given for this field | |
| Month | The month of the year to retrieve messages for. This is ignored if you specify a value for StartDate, EndDate or MessageID. Both Day and Year must be filled if a value is given for this field | |
| Year | The Year in YYYY format (e.g. 2004) to retrieve messages for. This is ignored if you specify a value for StartDate, EndDate or MessageID. Both Day and Month must be filled if a value is given for this field | |
| Other information | ||
| PlainText |
Specify a value for this field to return plain text results instead of a formatted HTML page. For a successful request, results are in the format: Result=OK ID=value&Originator=value&Recipient=value&Body=value&ReceivedAt=value&Type=value&IndexID=value where ID is the identifier assigned to the message by Esendex. Originator is the mobile number of the message sender. Recipient is the recipient of the message (your virtual mobile number). Body is the message content. Type is the type of content contained in Body. This can be Text, Binary, SmartMessage or Unicode. ReceivedAt is the time Esendex took delivery of the message. IndexId is the ID of the index of the message in the inbox. For an unsuccessful request, results are in the format: Result=Error Message=value where Message value is a URL encoded description of the error. |
|
Note: If any of the field names conflict with those in your existing HTML page, prefix them with Esendex, for example (EsendexUserName).
The following example is an HTML page you can use on your website: