(Lianja) Clickatell Send SMS Text Message

See more Clickatell Examples

Demonstrate how to send a Clickatell SMS text message.

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

Chilkat Lianja Extension Download Chilkat Lianja Extension

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

loHttp = createobject("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"
//   ]
// }

loJson = createobject("CkJsonObject")
loJson.UpdateString("content","Test Message Text")
loJson.UpdateString("to[0]","PHONE_NUMBER")
loJson.UpdateString("from","FROM_PHONE_NUMBER")

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

// If the following URL does not work, then try "https://platform.clickatell.com/v1/message"
loResp = loHttp.PostJson3("https://platform.clickatell.com/messages","application/json",loJson)
if (loHttp.LastMethodSuccess = .F.) then
    ? loHttp.LastErrorText
    release loHttp
    release loJson
    return
endif

loSbResponseBody = createobject("CkStringBuilder")
loResp.GetBodySb(loSbResponseBody)
loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.

? "Response Body:"
? loJResp.Emit()

lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
    ? "Response Header:"
    ? loResp.Header
    ? "Failed."
    release loResp
    release loHttp
    release loJson
    release loSbResponseBody
    release loJResp
    return
endif

release loResp

// 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

lcErrorCode = loJResp.StringOf("errorCode")
lcError = loJResp.StringOf("error")
lcErrorDescription = loJResp.StringOf("errorDescription")
i = 0
lnCount_i = loJResp.SizeOfArray("messages")
do while i < lnCount_i
    loJResp.I = i
    lcApiMessageId = loJResp.StringOf("messages[i].apiMessageId")
    llAccepted = loJResp.BoolOf("messages[i].accepted")
    lcV_to = loJResp.StringOf("messages[i].to")
    lcErrorCode = loJResp.StringOf("messages[i].errorCode")
    lcError = loJResp.StringOf("messages[i].error")
    lcErrorDescription = loJResp.StringOf("messages[i].errorDescription")
    i = i + 1
enddo


release loHttp
release loJson
release loSbResponseBody
release loJResp