(JavaScript) Clickatell Send SMS Text Message

See more Clickatell Examples

For more information, see https://docs.clickatell.com/channels/sms-channels/sms-api-reference/

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;

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

var http = new CkHttp();

// Implements the following CURL command:

// curl -i \
// -X POST \
// -H "Content-Type: application/json" \
// -H "Accept: application/json" \
// -H "Authorization: API_KEY" \
// -d '{"content": "Test Message Text", "to": ["PHONE_NUMBER"], "from": "FROM_PHONE_NUMBER" }' \
// -s https://platform.clickatell.com/messages

// Use this online tool to generate code from sample JSON:
// Generate Code to Create JSON

// The following JSON is sent in the request body.

// {
//   "content": "Test Message Text",
//   "to": [
//     "PHONE_NUMBER"
//   ]
// }

var json = new CkJsonObject();
json.UpdateString("content","Test Message Text");
json.UpdateString("to[0]","PHONE_NUMBER");
json.UpdateString("from","FROM_PHONE_NUMBER");

http.SetRequestHeader("Authorization","API_KEY");
http.SetRequestHeader("Accept","application/json");
http.SetRequestHeader("Content-Type","application/json");

// If the following URL does not work, then try "https://platform.clickatell.com/v1/message"
var resp = new CkHttpResponse();
success = http.HttpJson("POST","https://platform.clickatell.com/messages",json,"application/json",resp);
if (success == false) {
    console.log(http.LastErrorText);
    return;
}

var sbResponseBody = new CkStringBuilder();
resp.GetBodySb(sbResponseBody);
var jResp = new CkJsonObject();
jResp.LoadSb(sbResponseBody);
jResp.EmitCompact = false;

console.log("Response Body:");
console.log(jResp.Emit());

var respStatusCode = resp.StatusCode;
console.log("Response Status Code = " + respStatusCode);
if (respStatusCode >= 400) {
    console.log("Response Header:");
    console.log(resp.Header);
    console.log("Failed.");
    return;
}

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

// {
//   "messages": [
//     {
//       "apiMessageId": "66c06ac68e5c4afb953ea9328babfde6",
//       "accepted": true,
//       "to": "16302581871",
//       "errorCode": null,
//       "error": null,
//       "errorDescription": null
//     }
//   ],
//   "errorCode": null,
//   "error": null,
//   "errorDescription": null
// }

// Sample code for parsing the JSON response...
// Use the following online tool to generate parsing code from sample JSON:
// Generate Parsing Code from JSON

var errorCode;
var error;
var errorDescription;
var i;
var count_i;
var apiMessageId;
var accepted;
var v_to;

errorCode = jResp.StringOf("errorCode");
error = jResp.StringOf("error");
errorDescription = jResp.StringOf("errorDescription");
i = 0;
count_i = jResp.SizeOfArray("messages");
while (i < count_i) {
    jResp.I = i;
    apiMessageId = jResp.StringOf("messages[i].apiMessageId");
    accepted = jResp.BoolOf("messages[i].accepted");
    v_to = jResp.StringOf("messages[i].to");
    errorCode = jResp.StringOf("messages[i].errorCode");
    error = jResp.StringOf("messages[i].error");
    errorDescription = jResp.StringOf("messages[i].errorDescription");
    i = i+1;
}