Developers

Example Usage of
campaign_report_bounce_list

View bounced email addresses for a specific campaign.

Description: View all bounces for a specific campaign. You will be able to see the email address of each bounce, much like on the Campaign Reports page.
Endpoint: /admin/api.php?api_action=campaign_report_bounce_list
HTTP method: GET
Supported output formats: xml, json, serialize
Requires authentication: true
Parameters:
* indicates requirement. Underlined params include in URL, otherwise as part of the post body. POST data must be formatted as
Content-Type: application/x-www-form-urlencoded
. We don't accept any other input formats like JSON.
Variable Description
api_action*campaign_report_bounce_list
api_key*Your API key
api_outputxml, json, or serialize (default is XML)
campaignid*ID of the campaign you wish to see bounces for
messageidOptional message ID
pageOptional Page number to view more records on other pages
Example response:
Variable Description
0Array
idID of the row. Example: 3
emailEmail address that bounced. Example: test@gmail.com
subscriberidID of this contact. Example: 4
listidID of the list this contact bounced from. Example: 1
campaignidID of the campaign this contact bounced from. Example: 7
messageidID of the message this contact bounced from. Example: 1
tstampDate the bounce occurred. Example: 2011-03-07
typeType of bounce. Example: hard
codeBounce code. Example: 5.1.1
countedWhether or not we count this bounce against this contact. Example: 1
descriptA description of the bounce. Example: Bad destination mailbox address
1Array
id1
emailjsdiaj24fe@asu8dy7uah3u.com
subscriberid3
listid1
campaignid7
messageid1
tstamp2011-03-07
typehard
code5.1.2
counted1
descriptBad destination system address
2Array
id2
emailjdifhj83asdkk_si9jnnn@yahoo.com
subscriberid5
listid1
campaignid7
messageid1
tstamp2011-03-07
typehard
code5.2.4
counted1
descriptMailing list expansion problem
result_codeWhether or not the response was successful. Examples: 1 = yes, 0 = no
result_messageA custom message that appears explaining what happened. Example: Something is returned
result_outputThe result output used. Example: serialize

PHP Example

This is an example of using the campaign_report_bounce_list call with PHP. You can replicate the same idea in virtually any other programming language. The example shown is using serialize as the output format. You can change that to XML or JSON if you would like.

<?php

// By default, this sample code is designed to get the result from your ActiveCampaign installation and print out the result
$url = 'http://account.api-us1.com';


$params = array(

	// the API Key can be found on the "Your Settings" page under the "API" tab.
	// replace this with your API Key
	'api_key'      => 'YOUR_API_KEY',

	// this is the action that fetches info based on the parameters you provide
	'api_action'   => 'campaign_report_bounce_list',

	// define the type of output you wish to get back
	// possible values:
	// - 'xml'  :      you have to write your own XML parser
	// - 'json' :      data is returned in JSON format and can be decoded with
	//                 json_decode() function (included in PHP since 5.2.0)
	// - 'serialize' : data is returned in a serialized format and can be decoded with
	//                 a native unserialize() function
	'api_output'   => 'serialize',

	// ID you wish to fetch
	'campaignid'          => '122',

	// optional message ID
	//'messageid'           => '3',

	// optional Page Number
	//'page'		=> '1'
);

// This section takes the input fields and converts them to the proper format
$query = "";
foreach( $params as $key => $value ) $query .= urlencode($key) . '=' . urlencode($value) . '&';
$query = rtrim($query, '& ');

// clean up the url
$url = rtrim($url, '/ ');

// This sample code uses the CURL library for php to establish a connection,
// submit your request, and show (print out) the response.
if ( !function_exists('curl_init') ) die('CURL not supported. (introduced in PHP 4.0.2)');

// If JSON is used, check if json_decode is present (PHP 5.2.0+)
if ( $params['api_output'] == 'json' && !function_exists('json_decode') ) {
	die('JSON not supported. (introduced in PHP 5.2.0)');
}

// define a final API request - GET
$api = $url . '/admin/api.php?' . $query;

$request = curl_init($api); // initiate curl object
curl_setopt($request, CURLOPT_HEADER, 0); // set to 0 to eliminate header info from response
curl_setopt($request, CURLOPT_RETURNTRANSFER, 1); // Returns response data instead of TRUE(1)
//curl_setopt($request, CURLOPT_SSL_VERIFYPEER, FALSE); // uncomment if you get no gateway response and are using HTTPS
curl_setopt($request, CURLOPT_FOLLOWLOCATION, true);

$response = (string)curl_exec($request); // execute curl fetch and store results in $response

// additional options may be required depending upon your server configuration
// you can find documentation on curl options at http://www.php.net/curl_setopt
curl_close($request); // close curl object

if ( !$response ) {
	die('Nothing was returned. Do you have a connection to Email Marketing server?');
}

// This line takes the response and breaks it into an array using:
// JSON decoder
//$result = json_decode($response);
// unserializer
$result = unserialize($response);
// XML parser...
// ...

// Result info that is always returned
echo 'Result: ' . ( $result['result_code'] ? 'SUCCESS' : 'FAILED' ) . '<br />';
echo 'Message: ' . $result['result_message'] . '<br />';

// The entire result printed out
echo 'The entire result printed out:<br />';
echo '<pre>';
print_r($result);
echo '</pre>';

// Raw response printed out
echo 'Raw response printed out:<br />';
echo '<pre>';
print_r($response);
echo '</pre>';

// API URL that returned the result
echo 'API URL that returned the result:<br />';
echo $api;?>

Questions? Discuss this API call in our developer forum