getDeliveryErrors

Description

Get bounced messages within a specified date.



Params

Name Type Description
apiKey string API key previously generated.
date string Date in the following format: YYYY-MM-DD.
bounceCategory string Optional bounce category. Check Appendix 1 for all bounce message codes.
offset integer Optional parameter to specify offset. If not specified, it's 0.
count integer Optional parameter to specify the number of records. If not specified, it's 100. The maximum allowed value is 10000. Numbers bigger than 10000 are automatically reduced to 10000.

 

Returned data

Type: array

Description: Return data as an array containing the full info for all messages. Check Appendix 2 for more info about the returned data.

 

Json sample code

<?php

$curl = curl_init('https://your_address/ccm/admin/api/version/2/&type=json');

$postData = array(
    'function' => 'getDeliveryErrors',
    'apiKey' => 'apiKey',
    'date' => '2010-02-15',
    'bounceCategory' => 'bad-mailbox',
);

curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_POSTFIELDS, http_build_query($postData));
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);

$json = curl_exec($curl);
if ($json === false) {
    die('Request failed with error: '. curl_error($curl));
}

$result = json_decode($json);
if ($result->status == 0) {
    die('Bad status returned. Error: '. $result->error);
}

var_dump($result->data);

 

Result of API call

Array
(
)
Menu Title