getDeliveryReport

=20

Retrieve an individual delivery report (or combined reports), which show= s the current known status of messages sent in a given time period, or for = a particular campaign orcampaigns.

Conversely, the function = getDeliveryReports gets a list of available delivery report names, incl= uding delivery reports for campaigns.

=20

Messages sent with the API can be given a 'tag'. The getDeliveryReport f= unction allows you to specify that tag in order to restrict your search.

See also What = is a sent message?

=20

To get the contents of a delivery report for the campaign name 'mycampai= gn-020411':

=20

Example

=20

$result =3D $tmClient->getDeliveryReport('mycampaign-020411');

=20

To get the delivery report details for 'mycampaign-020411' between 01:00= and 02:00 on 1st Jan 2011:

=20

Example

=20

$result =3D $tmClient->getDeliveryReport('mycampaign-020411', '2011=
-01-01T01:00:00+00:00', '2011-01-01T02:00:00+00:00');

=20

Or, between 01:00 on 1st Jan 2011 and now:

=20

Example

=20

$result =3D $tmClient->getDeliveryReport('mycampaign-020411', '2011=
-01-01T01:00:00+00:00', time());

=20

To get delivery report details for all campaigns and API sends between t= he same dates as the previous 2 examples:

=20

Example

=20

$result =3D $tmClient->getDeliveryReport('all', '2011-01-01T01:00:0=
0+00:00', 
'2011-01-01T02:00:00+00:00');
$result =3D $tmClient->getDeliveryReport('all', '2011-01-01T01:00:00+00:=
00', time());

=20

To get a delivery report with the name 'mycampaign-020411', restricted t= o those messages sent with custom tag 'test':

=20

Example

=20

 $result =3D $tmClient->getDeliveryReport('mycampaign-020411',=
 null, null, 'test');

=20

To get the status of messages from all delivery reports for messages sen= t with custom tag 'test':

=20

Example

=20

 $result =3D $tmClient->getDeliveryReport('all', null, null, '=
test');

=20

The same as the previous 2 examples, but between 2 dates:

=20

Example

=20

 $result =3D $tmClient->getDeliveryReport('mycampaign-020411',=
 '2011-01-01T01:00:00+00:00', 
'2011-01-01T02:00:00+00:00', 'test');
$result =3D $tmClient->getDeliveryReport('all', '2011-01-01T01:00:00+00:=
00', time(), 'test');

=20

A complete example, including output:

=20

Example

=20

$result =3D $tmClient->getDeliveryReport('all');
foreach ($result as $key =3D> $report)
{
=09echo "Report number $key: Name {$report['name']}, Last Updated {$re=
port['last_updated']} <br/>\n";
foreach ($report['reportrow'] as $key =3D> $reportrow){
=09echo "Message ID: {$reportrow['message_id']}, number:{$reportrow['m=
obile_number']}, 
Status:{$reportrow['status']}, Updated:{$reportrow['last_updated']}<=
;br/>\n";
=09}
}

=20

Arguments:

=20

string $name:

=20

name of the delivery report to retrieve or 'all' to retrieve all campaig= n/API report data.

=20

string/int $date_start:

=20

(optional) restrict search to be from $date_start (Europe/London time). = String dates should be in ISO 8601 format. Integer dates as Unix timestamp.=

=20

string/int $date_end:

=20

(optional) restrict search to be up to $date_end (Europe/London time). S= tring dates should be in ISO 8601 format. Integer dates as Unix timestamp.<= /p>

=20

string $custom:

=20

(optional) restrict search to those SMS sent with a custom 'tag' (see cu= stom parameter of sendSms function). Up to and including 20, alpha-numeric = characters.

=20

Returns:

an array of arrays. Each nested array represents a delivery report and h= as 4 keys: 'name', 'last_updated', 'extension' and 'reportrow':

=20

Array key	Value
name	String. The name of the delivery report conta= ining the message statuses. For campaigns sent via the web interface, this = is the campaign name that way specified. For messages sent via one of= our APIs, the name is GatewayAPI_DD-MM-YY, where DD is the calendar day, M= M the month, and YY the year.
last_updated	String. The last time a message delivery stat= us in this delivery report was updated, 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	Array. reportrow is an array with keys 'message_= id', 'mobile_number','status' and 'last_updated' (see below).

=20

reportrow is an array with 4 keys:

=20

Array key	Value
message_id	String. The unique ID of the sent message (di= fferent for each number sent to).
mobile_number	String. The mobile number that the message wa= s sent to, in international format, e.g. 447000000000.
status	String. The status of the message delivery. PENDING means the status of the sent message is curre= ntly unknown. REJECTED means that the relevant operat= or rejected the message and did not attempt to deliver it. FAI= LED probably means that the number doesn't exist (or not anymore),= or the recipient didn't turn on their phone to receive the message and it = expired. DELIVERED means the message was received on = the handset.NON-UK means you are on a UK-only account and have tried to sen= d a non-UK number
last_updated	String. The last time this message delivery s= tatus was updated, ISO8601 format. This allows you to determine whether the= re has been a change since you last accessed the report.

=20

Specific error codes:

=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

error code 404 is reported if no delivery reports are found using the sp= ecified search criteria. See General error codes.

=20

Next: getDeliveryReports
Home: Developers Documentation

=20

You must know!

=20 =20

Our example code is an illustra= tion of how you might integrate with our systems and is not certified for p= roduction environments. You are responsible for testing and QA.

=20