The deliveryReport resource

=20

Resource URL 1:

=20

http://api.textmarketer.co.uk/ser= vices/rest/deliveryReport/<reportName>

=20

e.g. for a delivery report with the name 'mycampaign-020411', the URL wo= uld be:

=20

http://api.textm= arketer.co.uk/services/rest/deliveryReport/mycampaign-020411

=20

using the name 'all' allows you to retrieve all campaign/API repor= ts, the URL would be:

=20

http://api= .textmarketer.co.uk/services/rest/deliveryReport/all

=20

Resource URL 2:

=20

specific dates and times

=20

http://api= .textmarketer.co.uk/services/rest/deliveryReport/<reportName>/<from-date>/<to-date>

=20

e.g. to get the delivery reports for 'mycampaign-020411' between 01:00 a= nd 02:00 on 1^st Jan 2011:

=20

http://api= .textmarketer.co.uk/services/rest/deliveryReport/mycampaign-020411/2011-01-01T01:00:00+00:00/2011-01-01T02:00:00+00:00

=20

or all reports between the same times:

=20

http://api= .textmarketer.co.uk/services/rest/deliveryReport/all/2011-01-01T01:0= 0:00+00:00/2011-01-01T02:00:00+00:00

=20

Resource URL 3:

=20

specific string tag ('custom')

=20

http://api.textmarketer.co.uk/ser= vices/rest/deliveryReport/<reportName>/custom/<tag>

= =20

=20

The same as Resource URL 1, above, except that you also specify a 'tag',= which will restrict the search to those messages you sent with that tag (s= ee 'custom' parameter of sms POST).

=20

Resource URL 4:

=20

specific string tag combined with specific dates

=20

As with Resource URL 2, you can also combine a date search with the tag = search, as follows:

=20

http://api.textmarketer.co.uk/ser= vices/rest/deliveryReport/<reportName>/custom/<tag>/<from>= ;/<to>

=20

=20 =20

the dates should be in ISO 8601 format, an= d of course URL-encoded.

=20

Actions avai= lable:

=20

GET - retrieve= the complete contents of an individual delivery report, all delivery repor= ts, and also within specific date ranges.

=20

An individual delivery report shows the current known status of all mess= ages sent on a given day, or for a particular campaign. Whereas the resourc= e deliveryReports gets a list of available delivery report= names, including delivery reports for campaigns.
See The deli= veryReports resource above to see how to get a list of available d= elivery reports and naming conventions.

=20

What is a deliv= ery report?

=20

A =E2=80=98success=E2=80=99 response from an API sms POST call (a send) = only confrms that the number andmessage appear to be in the correct format = =E2=80=93 this does not mean that the number actually exists, or that = the message was received by the recipient.

=20

Whereas a delivery report =E2=80=93 which you retrieve through this deli= veryReport resource =E2=80=93 confrms to you what has actually happened to = the sent message. This may change over time, i.e. a delivery report may not= show a delivered status for a given message 10 minutes after the message w= as sent, but may show a delivered status after an hour.

=20

The status of messages can change up to 72 hours after the message was s= ent. Therefore you may prefer to wait for 72 hours after sending an SM= S before trying to retrieve its delivery report.

=20

The possible outcomes for a sent message in a delivery report are: PENDI= NG, DELIVERED, REJECTED, FAILED, NON-UK or no report at all.

=E2=80=9CPENDING=E2=80=9D means the status of the sent= message is currently unknown.
=E2=80=9CREJECTED=E2=80=9D means that the relevant = operator rejected the message and did not attempt to deliver it.
=E2=80=9CFAILED=E2=80=9D probably means that the nu= mber doesn't exist (or not anymore), or the recipient didn't turn on their = phone to receive the message and it expired.
=E2=80=9CDELIVERED=E2=80=9D means the message was rece= ived on the handset.
=E2=80=9CNON-UK=E2=80=9D means you are on a UK-only= account and have tried to send a non-UK number.

Very occasionally there is no delivery report status for a given message= at all. This can be due to a failure at the operator end because of except= ionally high load or other problems.

=20