Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

 

Retrieve a list of available delivery report names.

Code Block
themeRDark
languagephp
titleExample
linenumberstrue
$result = $tmClient->getDeliveryReports();
echo "User Directory: {$result['userdirectory']} <br/>\n";
foreach($result['reports'] as $key => $report)
	echo "Report number $key: Name {$report['name']}, Last Updated 
{$report['last_updated']}, Extension {$report['extension']} <br/>\n";

Arguments:

None.

Returns:

an array with 2 keys: 'userdirectory' and 'reports':

Array key Value
userdirectory DEPRECATED – this value no longer has any meaning.
reports 

Array of arrays. reports is an array of arrays where each nested array has keys 'name', 'last_updated', 'extension'.

Each nested array in the array 'reports' has 3 keys:

Array key

Value

name String. The name of the report.
last_updated 

String. The last time a message delivery status in this delivery report was updated, in ISO 8601 format. This allows you to determine whether there was a change since you last accessed the report

extension 

DEPRECATED – this value no longer has any meaning.

Specific error codes:

None.

 

 

 

Panel
title
  • Next

 

 

Warning
titleYou must know!

Our example code is an illustration of how you might integrate with our systems and is not certified for production environments. You are responsible for testing and QA.