JavaScript Requires Chilkat v11.0.0+
JavaScript
Clickatell One API: Send personalized SMS reminders in a batch
See more Clickatell Examples
Send two appointments in one request with a different text and application ID for each. Use two distinct recipient numbers in international digits. For a US two-way integration, add its provisioned from number to each message.
Read each recipient result even when HTTP 207 reports a mixed outcome. Save the accepted provider ID against the appointment. A missing result calls for checking the message report before retrying. A client message ID helps correlate records and does not guarantee deduplication.
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.
// Assumes Chilkat is unlocked. See Global Unlock Sample.
var http = new CkHttp();
http.RequireSslCertVerify = true;
// Load the key for this One API integration from your application configuration.
http.SetRequestHeader("Authorization","ONE_API_KEY");
http.SetRequestHeader("Accept","application/json");
var firstPhone = "FIRST_PHONE_NUMBER";
var secondPhone = "SECOND_PHONE_NUMBER";
var body = new CkJsonObject();
body.UpdateString("messages[0].channel","sms");
body.UpdateString("messages[0].to",firstPhone);
body.UpdateString("messages[0].content","Your appointment with Lee is at 10:00.");
body.UpdateString("messages[0].clientMessageId","appt-1042");
body.UpdateString("messages[1].channel","sms");
body.UpdateString("messages[1].to",secondPhone);
body.UpdateString("messages[1].content","Your appointment with Sam is at 14:30.");
body.UpdateString("messages[1].clientMessageId","appt-1043");
var resp = new CkHttpResponse();
var sent = http.HttpJson("POST","https://platform.clickatell.com/v1/message",body,"application/json",resp);
if (resp.StatusCode == 0) {
console.log("No HTTP response. Check the message report before resending.");
return;
}
var reply = new CkJsonObject();
var parsed = reply.Load(resp.BodyStr);
if ((sent !== true) || ((resp.StatusCode !== 202) && (resp.StatusCode !== 207))) {
console.log("Send returned HTTP " + resp.StatusCode);
if (reply.HasMember("error.description") == true) {
console.log(reply.StringOf("error.description"));
}
return;
}
if (reply.HasMember("error.code") == true) {
if (reply.IsNullOf("error.code") !== true) {
console.log("Submission error " + reply.StringOf("error.code") + " " + reply.StringOf("error.description"));
return;
}
}
// Look up each submitted appointment in the reply using its unique recipient.
// This works even if the result order changes or clientMessageId is absent.
var results = new CkJsonObject();
var i = 0;
while ((i < 2)) {
body.I = i;
var appointment = body.StringOf("messages[i].clientMessageId");
var phone = body.StringOf("messages[i].to");
var result = new CkJsonObject();
var found = reply.FindRecord2("messages","to",phone,true,result);
results.I = i;
results.UpdateString("appointments[i].clientMessageId",appointment);
if ((found !== true) || (result.JsonTypeOf("accepted") !== 5)) {
results.UpdateString("appointments[i].outcome","unknown");
console.log(appointment + " has no confirmed result.");
}
else {
if (result.BoolOf("accepted") == true) {
results.UpdateString("appointments[i].outcome","accepted");
if (result.JsonTypeOf("apiMessageId") == 1) {
results.UpdateString("appointments[i].apiMessageId",result.StringOf("apiMessageId"));
}
console.log(appointment + " accepted.");
}
else {
results.UpdateString("appointments[i].outcome","rejected");
results.UpdateString("appointments[i].reason",result.StringOf("error.description"));
console.log(appointment + " rejected: " + result.StringOf("error.description"));
}
}
i = i+1;
}
// This demo writes a snapshot. In an application, update the two appointment records.
var saved = results.WriteFile("appointment-send-results.json");
if (saved !== true) {
console.log("Could not save the results. Reconcile the submitted messages before retrying.");
return;
}
console.log("Saved appointment-send-results.json");