Send a campaign.
| Description: | Re-send an existing campaign using optional actions like 'copy', 'preview', 'test'. | ||||||||||||||||||||
| 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.
|
||||||||||||||||||||
| Example response: |
|
PHP Example
This is an example of using the campaign_send 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
$url = 'https://api.t2connect.com/v1/';
//set POST variables
$data = array(
'account' => [YOUR ACCOUNT URL],
'api_key' => [YOUR API KEY],
// this is the action that sends a camapign to a contact on the campaign ID and contact email you provide
'api_action' => 'campaign_send',
// 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',
// email address (of the contact) that will be receiving the email
'email' => 'test@example.com',
// ID of the campaign you wish to send
'campaignid' => 1,
// ID of the campaign's message you wish to send
// (used in Split campaigns if you have more than one message assigned to a campaign)
'messageid' => 0,
// type of the message you wish to send
// (can be used to send TEXT-only email even if campaign is set to use MIME)
'type' => 'mime', // possible values: mime, text, html
// action
// send, spamcheck, preview, test, copy
'action' => 'send', // send: send a campaign to this contact and to append him to the recipients list
// copy: send a copy of a campaign to contact (campaign is not updated)
// test: send a test email to contact (campaign is not updated)
// source: simulate a campaign test to contact (campaign is not updated), return message source
// messagesize: simulate a campaign test to contact (campaign is not updated), return message size
// spamcheck: simulate a campaign test to contact (campaign is not updated), return spam rate
// preview: same as preview
);
//open connection
$ch = curl_init($url);
$json_data = json_encode($data);
curl_setopt($ch, CURLOPT_HEADER, 0); // set to 0 to eliminate header info from response
curl_setopt($ch, CURLOPT_POSTFIELDS, $json_data);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, array('Content-Type:application/json'));
curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE); // uncomment if you get no gateway response and are using HTTPS
$response = (string)curl_exec($ch); // execute curl post and store results in $response
if ( !$response ) {
die('Nothing was returned. Do you have a connection to Email Marketing server?');
}
//close connection
curl_close($ch);
$result = unserialize($response);
// JSON decoder
//$result = json_decode($response, true);
// 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>';
?>