(Tcl) 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 Tcl Extension Downloads Chilkat Tcl Extension Downloads

load ./chilkat.dll

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

set 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"
#   ]
# }

set json [new_CkJsonObject]

CkJsonObject_UpdateString $json "content" "Test Message Text"
CkJsonObject_UpdateString $json "to[0]" "PHONE_NUMBER"
CkJsonObject_UpdateString $json "from" "FROM_PHONE_NUMBER"

CkHttp_SetRequestHeader $http "Authorization" "API_KEY"
CkHttp_SetRequestHeader $http "Accept" "application/json"
CkHttp_SetRequestHeader $http "Content-Type" "application/json"

# If the following URL does not work, then try "https://platform.clickatell.com/v1/message"
# resp is a CkHttpResponse
set resp [CkHttp_PostJson3 $http "https://platform.clickatell.com/messages" "application/json" $json]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkJsonObject $json
    exit
}

set sbResponseBody [new_CkStringBuilder]

CkHttpResponse_GetBodySb $resp $sbResponseBody
set jResp [new_CkJsonObject]

CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0

puts "Response Body:"
puts [CkJsonObject_emit $jResp]

set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
    puts "Response Header:"
    puts [CkHttpResponse_header $resp]
    puts "Failed."
    delete_CkHttpResponse $resp

    delete_CkHttp $http
    delete_CkJsonObject $json
    delete_CkStringBuilder $sbResponseBody
    delete_CkJsonObject $jResp
    exit
}

delete_CkHttpResponse $resp

# 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

set errorCode [CkJsonObject_stringOf $jResp "errorCode"]
set error [CkJsonObject_stringOf $jResp "error"]
set errorDescription [CkJsonObject_stringOf $jResp "errorDescription"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "messages"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set apiMessageId [CkJsonObject_stringOf $jResp "messages[i].apiMessageId"]
    set accepted [CkJsonObject_BoolOf $jResp "messages[i].accepted"]
    set v_to [CkJsonObject_stringOf $jResp "messages[i].to"]
    set errorCode [CkJsonObject_stringOf $jResp "messages[i].errorCode"]
    set error [CkJsonObject_stringOf $jResp "messages[i].error"]
    set errorDescription [CkJsonObject_stringOf $jResp "messages[i].errorDescription"]
    set i [expr $i + 1]
}

delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp