Message-ID: <400419299.15763.1614958037992.JavaMail.confluence@wiki> Subject: Exported From Confluence MIME-Version: 1.0 Content-Type: multipart/related; boundary="----=_Part_15762_1569539776.1614958037991" ------=_Part_15762_1569539776.1614958037991 Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Content-Location: file:///C:/exported.html deliveryReport GET method

deliveryReport GET method

=20
=20
=20
=20

 

=20
=20
=20
=20
=20
=20

Get the contents of an individual delivery report names.

=20
=20
=20
=20
=20
=20

Example successful response body XML:

=20
=20
=20
=20
=20
<?xml version=3D"1.0" encoding=3D"ISO-8859-1"?&=
gt;
<!DOCTYPE response PUBLIC
"-//textmarketer.co.uk//DTD Web Services REST 1.6//EN"
"http://api.textmarketer.co.uk/services/rest/DTD/deliveryreport_get.dt=
d">
<response processed_date=3D"2011-04-14T16:11:25+01:00">
=09<report name=3D"mycampaign-020411" last_updated=3D"201=
1-04-12T09:25:06+01:00"=20
extension=3D"csv">
=09=09<reportrow last_updated=3D"2011-04-12T09:21:00+01:00"=20
mobile_number=3D"447777000001" message_id=3D"1006454672"=
; status=3D"DELIVERED"/>
=09<reportrow last_updated=3D"2011-04-12T09:21:00+01:00"=20
mobile_number=3D"447777000002" message_id=3D"1006454673"=
; status=3D"DELIVERED"/>
=09</report>
</response>
=20
=20
=20
=20
=20
=20
=20

Response meanings:

=20
=20
=20
=20
XML tag/attribute  Meaning
report 

Details of the delivery report (can be more t= han 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.
This allows you= to determine whether there was a change since you last accessed the report= .

extension

DEPRECATED =E2=80=93 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.<= /td>
status

The status of the message delivery, PENDING, = DELIVERED, REJECTED, FAILED, NON-UK.

=20
=20
=20
=20
=20
=20

specific errors:

=20
=20
=20
=20
Code  Meaning
0 The custom value must contain only alpha-numeric= characters
1

The custom value must be between 1 and 20 cha= racters in length

2

The 'from' and 'to' timestamps must be in ISO= 8601 format

=20 =20

that status code 404 (not found) is returned if the delivery report does= not exist.

=20
=20
=20
=20
=20
=20
=20
=20

DTD for deliveryReport GET:

=20
=20
=20
=20
=20
<?xml version=3D"1.0" encoding=3D"UTF-8"?>
<!--
 =09PUBLIC ID : -//textmarketer.co.uk//DTD Web Services REST 1.6//EN
 =09SYSTEM ID :=20
http://api.textmarketer.co.uk/services/rest/DTD/deliveryreport_get.dtd
-->
<!ELEMENT response (report*)>
<!ATTLIST response
 =09processed_date CDATA #REQUIRED
>
<!ELEMENT report (reportrow*) >
<!ATTLIST report
 =09name CDATA #REQUIRED
 =09last_updated CDATA #REQUIRED
 =09extension CDATA #REQUIRED
>
<!ELEMENT reportrow (#PCDATA) >
<!ATTLIST reportrow
 =09last_updated CDATA #REQUIRED
 =09mobile_number CDATA #REQUIRED
 =09message_id CDATA #REQUIRED
=09 status (DELIVERED|FAILED|REJECTED|PENDING|NON-UK) #REQUIRED
 =09custom CDATA #IMPLIED
>
=20
=20
=20
=20
------=_Part_15762_1569539776.1614958037991--