Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Get the contents of an individual delivery report names.
Example successful response body XML:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<?xml version="1.0" encoding="ISO-8859-1"?> <!DOCTYPE response PUBLIC "-//textmarketer.co.uk//DTD Web Services REST 1.6//EN" "http://api.textmarketer.co.uk/services/rest/DTD/deliveryreport_get.dtd"> <response processed_date="2011-04-14T16:11:25+01:00"> <report name="mycampaign-020411" last_updated="2011-04-12T09:25:06+01:00" extension="csv"> <reportrow last_updated="2011-04-12T09:21:00+01:00" mobile_number="447777000001" message_id="1006454672" status="DELIVERED"/> <reportrow last_updated="2011-04-12T09:21:00+01:00" mobile_number="447777000002" message_id="1006454673" status="DELIVERED"/> </report> </response> |
Response meanings:
| XML tag/attribute | Meaning |
|---|---|
| report | Details of the delivery report (can be more than one report tag). |
| name | The name of the delivery report. |
| last_updated | The date that an individual delivery report / message status was last updated, in ISO 8601 format. |
| extension | DEPRECATED – this value no longer has any meaning |
| reportrow | The status of an individual message (i.e. to a particular mobile number) within the delivery report. |
| mobile_number | The mobile number that the message was sent to. |
| status | The status of the message delivery, PENDING, DELIVERED, REJECTED, FAILED, NON-UK. |
Specifc specific errors:
| Code | Meaning |
|---|---|
| 0 | The custom value must contain only alpha-numeric characters |
| 1 | The custom value must be between 1 and 20 characters in length |
| 2 | The 'from' and 'to' timestamps must be in ISO 8601 format |
| Note |
|---|
that status code 404 (not found) is returned if the delivery report does not exist. |
DTD for deliveryReport GET:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<?xml version="1.0" encoding="UTF-8"?> <!-- PUBLIC ID : -//textmarketer.co.uk//DTD Web Services REST 1.6//EN SYSTEM ID : http://api.textmarketer.co.uk/services/rest/DTD/deliveryreport_get.dtd --> <!ELEMENT response (report*)> <!ATTLIST response processed_date CDATA #REQUIRED > <!ELEMENT report (reportrow*) > <!ATTLIST report name CDATA #REQUIRED last_updated CDATA #REQUIRED extension CDATA #REQUIRED > <!ELEMENT reportrow (#PCDATA) > <!ATTLIST reportrow last_updated CDATA #REQUIRED mobile_number CDATA #REQUIRED message_id CDATA #REQUIRED status (DELIVERED|FAILED|REJECTED|PENDING|NON-UK) #REQUIRED custom CDATA #IMPLIED > |