CkPhp Requires Chilkat v11.0.0+
CkPhp
Constant Contact V3: Find a campaign and its primary email activity
See more Constant Contact Examples
Enter the unique campaign name from the account. Follow the campaign collection’s cursor until the name matches, then fetch that campaign’s details. Select the activity whose role is primary_email. A permalink or resend can appear first.
The example writes the two IDs to newsletter-selection.json, the same file produced by the draft example. Run this lookup when selecting an existing newsletter for review or scheduling.
Authorize the application using the same account and credential store.
Constant Contact developer guide
Chilkat CkPhp Downloads
<?php
include("chilkat.php");
$success = false;
// Assumes Chilkat is unlocked. See Global Unlock Sample.
$vault = new CkSecrets();
$vault->put_Location('local_manager');
$vault->put_AutoSplit(true);
$entry = new CkJsonObject();
$entry->UpdateString('appName','ConstantContactV3');
$entry->UpdateString('service','OAuth2');
$entry->UpdateString('username','my-account');
$tokens = new CkJsonObject();
$loaded = $vault->GetSecretJson($entry,$tokens);
if ($loaded != true) {
print 'Run the desktop authorization example using this account and store.' . "\n";
exit;
}
if ($tokens->JsonTypeOf('access_token') != 1) {
print 'The saved authorization has no access token.' . "\n";
exit;
}
$http = new CkHttp();
$http->put_RequireSslCertVerify(true);
$http->put_AuthToken($tokens->stringOf('access_token'));
$resp = new CkHttpResponse();
$campaignName = 'Workshop newsletter';
$campaignId = '';
$url = new CkStringBuilder();
$url->Append('https://api.cc.email/v3/emails?limit=50');
$page = new CkJsonObject();
while ((($url->get_Length() > 0) and ($campaignId == ''))) {
$success = $http->HttpNoBody('GET',$url->getAsString(),$resp);
if (($success != true) and ($resp->get_StatusCode() <= 0)) {
print 'Read campaigns: HTTP request failed.' . "\n";
exit;
}
if (($success != true) or ($resp->get_StatusCode() != 200)) {
print 'Read campaigns: HTTP ' . $resp->get_StatusCode() . ' ' . $resp->bodyStr() . "\n";
exit;
}
$success = $page->Load($resp->bodyStr());
$count = $page->SizeOfArray('campaigns');
if (($success != true) or ($count < 0)) {
print 'Expected a page of campaigns.' . "\n";
exit;
}
$i = 0;
while ((($i < $count) and ($campaignId == ''))) {
$page->put_I($i);
if ($page->StringOfEquals('campaigns[i].name',$campaignName,true) == true) {
$campaignId = $page->stringOf('campaigns[i].campaign_id');
}
$i = $i + 1;
}
$url->Clear();
if (($campaignId == '') and ($page->JsonTypeOf('_links.next.href') == 1)) {
$url->Append($page->stringOf('_links.next.href'));
if ($url->StartsWith('/v3/emails?',true) != true) {
print 'Unexpected campaign pagination link.' . "\n";
exit;
}
$url->Prepend('https://api.cc.email');
}
}
if ($campaignId == '') {
print 'No campaign named ' . $campaignName . "\n";
exit;
}
$http->SetUrlVar('campaign',$campaignId);
$success = $http->HttpNoBody('GET','https://api.cc.email/v3/emails/{$campaign}',$resp);
if (($success != true) and ($resp->get_StatusCode() <= 0)) {
print 'Read campaign: HTTP request failed.' . "\n";
exit;
}
if (($success != true) or ($resp->get_StatusCode() != 200)) {
print 'Read campaign: HTTP ' . $resp->get_StatusCode() . ' ' . $resp->bodyStr() . "\n";
exit;
}
$campaign = new CkJsonObject();
$success = $campaign->Load($resp->bodyStr());
if ($success != true) {
print 'Expected a JSON object in the response.' . "\n";
exit;
}
// The campaign identifies the newsletter. The primary activity identifies the email to test or schedule.
$primary = new CkJsonObject();
$success = $campaign->FindRecord2('campaign_activities','role','primary_email',true,$primary);
if (($success != true) or ($primary->JsonTypeOf('campaign_activity_id') != 1)) {
print 'No primary email activity ID in the response.' . "\n";
exit;
}
$selectedCampaign = $campaign->stringOf('campaign_id');
$selectedActivity = $primary->stringOf('campaign_activity_id');
if (($selectedCampaign == '') or ($selectedActivity == '')) {
print 'Missing campaign or activity ID.' . "\n";
exit;
}
print 'Campaign ID: ' . $selectedCampaign . "\n";
print 'Primary activity ID: ' . $selectedActivity . "\n";
$selection = new CkJsonObject();
$selection->UpdateString('name',$campaign->stringOf('name'));
$selection->UpdateString('campaign_id',$selectedCampaign);
$selection->UpdateString('campaign_activity_id',$selectedActivity);
$success = $selection->WriteFile('newsletter-selection.json');
if ($success != true) {
print 'Could not save newsletter-selection.json. Keep the IDs printed above.' . "\n";
exit;
}
print 'Saved newsletter-selection.json.' . "\n";
?>