Sample code for 30+ languages & platforms
PowerShell Requires Chilkat v11.0.0+

Clickatell One API: Send personalized SMS reminders in a batch

See more Clickatell Examples

Send two appointments in one request with a different text and application ID for each. Use two distinct recipient numbers in international digits. For a US two-way integration, add its provisioned from number to each message.

Read each recipient result even when HTTP 207 reports a mixed outcome. Save the accepted provider ID against the appointment. A missing result calls for checking the message report before retrying. A client message ID helps correlate records and does not guarantee deduplication.

Clickatell API reference

Chilkat PowerShell Downloads

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

#  Assumes Chilkat is unlocked. See Global Unlock Sample.
$http = New-Object Chilkat.Http
$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")

$firstPhone = "FIRST_PHONE_NUMBER"
$secondPhone = "SECOND_PHONE_NUMBER"
$body = New-Object Chilkat.JsonObject
$body.UpdateString("messages[0].channel","sms")
$body.UpdateString("messages[0].to",$firstPhone)
$body.UpdateString("messages[0].content","Your appointment with Lee is at 10:00.")
$body.UpdateString("messages[0].clientMessageId","appt-1042")
$body.UpdateString("messages[1].channel","sms")
$body.UpdateString("messages[1].to",$secondPhone)
$body.UpdateString("messages[1].content","Your appointment with Sam is at 14:30.")
$body.UpdateString("messages[1].clientMessageId","appt-1043")

$resp = New-Object Chilkat.HttpResponse
$sent = $http.HttpJson("POST","https://platform.clickatell.com/v1/message",$body,"application/json",$resp)
if ($resp.StatusCode -eq 0) {
    $("No HTTP response. Check the message report before resending.")
    exit
}

$reply = New-Object Chilkat.JsonObject
$parsed = $reply.Load($resp.BodyStr)
if (($sent -ne $true) -or (($resp.StatusCode -ne 202) -and ($resp.StatusCode -ne 207))) {
    $("Send returned HTTP " + $resp.StatusCode)
    if ($reply.HasMember("error.description") -eq $true) {
        $($reply.StringOf("error.description"))
    }

    exit
}

if ($reply.HasMember("error.code") -eq $true) {
    if ($reply.IsNullOf("error.code") -ne $true) {
        $("Submission error " + $reply.StringOf("error.code") + "  " + $reply.StringOf("error.description"))
        exit
    }

}

#  Look up each submitted appointment in the reply using its unique recipient.
#  This works even if the result order changes or clientMessageId is absent.
$results = New-Object Chilkat.JsonObject
$i = 0
while (($i -lt 2)) {
    $body.I = $i
    $appointment = $body.StringOf("messages[i].clientMessageId")
    $phone = $body.StringOf("messages[i].to")
    $result = New-Object Chilkat.JsonObject
    $found = $reply.FindRecord2("messages","to",$phone,$true,$result)
    $results.I = $i
    $results.UpdateString("appointments[i].clientMessageId",$appointment)
    if (($found -ne $true) -or ($result.JsonTypeOf("accepted") -ne 5)) {
        $results.UpdateString("appointments[i].outcome","unknown")
        $($appointment + " has no confirmed result.")
    }
    else {
        if ($result.BoolOf("accepted") -eq $true) {
            $results.UpdateString("appointments[i].outcome","accepted")
            if ($result.JsonTypeOf("apiMessageId") -eq 1) {
                $results.UpdateString("appointments[i].apiMessageId",$result.StringOf("apiMessageId"))
            }

            $($appointment + " accepted.")
        }
        else {
            $results.UpdateString("appointments[i].outcome","rejected")
            $results.UpdateString("appointments[i].reason",$result.StringOf("error.description"))
            $($appointment + " rejected: " + $result.StringOf("error.description"))
        }

    }

    $i = $i + 1
}

#  This demo writes a snapshot. In an application, update the two appointment records.
$saved = $results.WriteFile("appointment-send-results.json")
if ($saved -ne $true) {
    $("Could not save the results. Reconcile the submitted messages before retrying.")
    exit
}

$("Saved appointment-send-results.json")