JavaScript Requires Chilkat v11.0.0+
JavaScript
Clickatell One API: Schedule a time-limited SMS reminder
See more Clickatell Examples
Schedule a reminder 15 minutes from now in UTC. The scheduledDeliveryTime includes its time zone and validityPeriod is expressed in minutes. Set both from the appointment and the period for which the reminder will still be useful. Use the returned message ID for a later status lookup.
Supply an international number as digits. Set the sender to the provisioned number when the integration requires it.
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 schedule = new CkDateTime();
schedule.SetFromCurrentSystemTime();
schedule.AddSeconds(900);
var sendAt = schedule.GetAsTimestamp(false);
var body = new CkJsonObject();
body.UpdateString("messages[0].channel","sms");
body.UpdateString("messages[0].to","PHONE_NUMBER");
body.UpdateString("messages[0].content","Appointment reminder: please check in at reception.");
body.UpdateString("messages[0].scheduledDeliveryTime",sendAt);
body.UpdateInt("messages[0].validityPeriod",60);
var sender = "";
if (sender !== "") {
body.UpdateString("messages[0].from",sender);
}
console.log("Requested send time (UTC): " + sendAt);
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)) {
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;
}
}
// HTTP acceptance and the recipient result are separate checks.
if ((parsed !== true) || (reply.JsonTypeOf("messages[0].accepted") !== 5)) {
console.log("Missing recipient result. Check the message report.");
return;
}
if (reply.BoolOf("messages[0].accepted") !== true) {
console.log("Message rejected: " + reply.StringOf("messages[0].error.code") + " " + reply.StringOf("messages[0].error.description"));
return;
}
if (reply.JsonTypeOf("messages[0].apiMessageId") !== 1) {
console.log("Accepted without a message ID. Check the message report.");
return;
}
console.log("Accepted. Message ID: " + reply.StringOf("messages[0].apiMessageId"));