(PowerShell) 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 .NET Downloads Chilkat .NET Assemblies

Add-Type -Path "C:\chilkat\ChilkatDotNet47-9.5.0-x64\ChilkatDotNet47.dll"

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

$http = New-Object Chilkat.Http

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

$json = New-Object Chilkat.JsonObject
$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"
$resp = $http.PostJson3("https://platform.clickatell.com/messages","application/json",$json)
if ($http.LastMethodSuccess -eq $false) {
    $($http.LastErrorText)
    exit
}

$sbResponseBody = New-Object Chilkat.StringBuilder
$resp.GetBodySb($sbResponseBody)
$jResp = New-Object Chilkat.JsonObject
$jResp.LoadSb($sbResponseBody)
$jResp.EmitCompact = $false

$("Response Body:")
$($jResp.Emit())

$respStatusCode = $resp.StatusCode
$("Response Status Code = " + $respStatusCode)
if ($respStatusCode -ge 400) {
    $("Response Header:")
    $($resp.Header)
    $("Failed.")

    exit
}

# 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

$errorCode = $jResp.StringOf("errorCode")
$error = $jResp.StringOf("error")
$errorDescription = $jResp.StringOf("errorDescription")
$i = 0
$count_i = $jResp.SizeOfArray("messages")
while ($i -lt $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
}