PowerShell Requires Chilkat v11.0.0+
PowerShell
Clickatell One API: Schedule a time-limited SMS reminder
See more Clickatell Examples
Schedule a reminder 15 minutes from now in UTC. The scheduledDeliveryTime includes its time zone and validityPeriod is expressed in minutes. Set both from the appointment and the period for which the reminder will still be useful. Use the returned message ID for a later status lookup.
Supply an international number as digits. Set the sender to the provisioned number when the integration requires it.
Chilkat PowerShell Downloads
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")
$schedule = New-Object Chilkat.CkDateTime
$schedule.SetFromCurrentSystemTime()
$schedule.AddSeconds(900)
$sendAt = $schedule.GetAsTimestamp($false)
$body = New-Object Chilkat.JsonObject
$body.UpdateString("messages[0].channel","sms")
$body.UpdateString("messages[0].to","PHONE_NUMBER")
$body.UpdateString("messages[0].content","Appointment reminder: please check in at reception.")
$body.UpdateString("messages[0].scheduledDeliveryTime",$sendAt)
$body.UpdateInt("messages[0].validityPeriod",60)
$sender = ""
if ($sender -ne "") {
$body.UpdateString("messages[0].from",$sender)
}
$("Requested send time (UTC): " + $sendAt)
$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)) {
$("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
}
}
# HTTP acceptance and the recipient result are separate checks.
if (($parsed -ne $true) -or ($reply.JsonTypeOf("messages[0].accepted") -ne 5)) {
$("Missing recipient result. Check the message report.")
exit
}
if ($reply.BoolOf("messages[0].accepted") -ne $true) {
$("Message rejected: " + $reply.StringOf("messages[0].error.code") + " " + $reply.StringOf("messages[0].error.description"))
exit
}
if ($reply.JsonTypeOf("messages[0].apiMessageId") -ne 1) {
$("Accepted without a message ID. Check the message report.")
exit
}
$("Accepted. Message ID: " + $reply.StringOf("messages[0].apiMessageId"))