JavaScript Requires Chilkat v11.0.0+
JavaScript
Constant Contact V3: Read every page of list members
See more Constant Contact Examples
Filter the contacts collection with lists and a list ID. To query multiple lists together, supply their comma-separated IDs. Follow the returned cursor links and report the total after the last page. The default contacts query excludes deleted records. A list member can still have unsubscribed email permission. Authorize the app first and use the same credential store.
Constant Contact developer guide
Note
This example is intended for running within a Chilkat.Js embedded JavaScript engine. All Chilkat JavaScript examples require Chilkat
v11.4.0 or greater.
var success = false;
// Assumes Chilkat is unlocked. See Global Unlock Sample.
var vault = new CkSecrets();
vault.Location = "local_manager";
vault.AutoSplit = true;
var entry = new CkJsonObject();
entry.UpdateString("appName","ConstantContactV3");
entry.UpdateString("service","OAuth2");
entry.UpdateString("username","my-account");
var tokens = new CkJsonObject();
var loaded = vault.GetSecretJson(entry,tokens);
if (loaded !== true) {
console.log("Run the desktop authorization example using this account and store.");
return;
}
if (tokens.JsonTypeOf("access_token") !== 1) {
console.log("The saved authorization has no access token.");
return;
}
var http = new CkHttp();
http.RequireSslCertVerify = true;
http.AuthToken = tokens.StringOf("access_token");
var resp = new CkHttpResponse();
http.SetUrlVar("list","LIST_ID");
var url = new CkStringBuilder();
url.Append("https://api.cc.email/v3/contacts?lists={$list}&limit=50");
var page = new CkJsonObject();
var total = 0;
while ((url.Length > 0)) {
success = http.HttpNoBody("GET",url.GetAsString(),resp);
if ((success !== true) || (resp.StatusCode !== 200)) {
console.log("Expected HTTP 200. Received " + resp.StatusCode);
if (resp.StatusCode == 401) {
console.log("Refresh the saved access token or authorize again.");
}
return;
}
success = page.Load(resp.BodyStr);
var count = page.SizeOfArray("contacts");
if ((success !== true) || (count < 0)) {
console.log("Expected a page of contacts.");
return;
}
var i = 0;
while ((i < count)) {
page.I = i;
console.log(page.StringOf("contacts[i].contact_id") + " " + page.StringOf("contacts[i].email_address.address"));
i = i+1;
}
total = total+count;
url.Clear();
if (page.JsonTypeOf("_links.next.href") == 1) {
url.Append(page.StringOf("_links.next.href"));
// The documented cursor link is relative to api.cc.email.
if (url.StartsWith("/v3/contacts?",true) !== true) {
console.log("Unexpected pagination link. Stopped before following it.");
return;
}
url.Prepend("https://api.cc.email");
}
}
console.log("List members read: " + total);