Sinch Engage: Schedule a Message with an Expiry
See more Sinch Engage Examples
Schedule delivery one hour from now, with an expiry one hour after that. UTC timestamps are computed at runtime instead of embedding a date that will become stale. Expiry is the latest permitted delivery time, not a guarantee of delivery. Keep the returned message ID for cancellation.
Live send: Running this submits real, potentially billable messages. Replace the sample destination with a number you control and have permission to message. E.164 numbers and all returned IDs stay as strings. Account/channel/sender provisioning and destination rules still apply. HTTP 202 means accepted for processing, not delivered. Store returned IDs and inspect status or delivery reports. No callback URL is required; account-level webhooks, if configured, can still receive events.
Sinch Engage is the renamed MessageMedia platform. This uses the Engage API, not Sinch Conversation API credentials or endpoints. Create an Engage API key/secret and place {"api_key":"YOUR_KEY","api_secret":"YOUR_SECRET"} in private sinch-engage.json. Select the account's regional HTTPS host: https://au.app.api.sinch.com, https://eu.app.api.sinch.com, or https://us.app.api.sinch.com. Basic authentication here means the API key/secret over verified TLS. Do not ship account credentials in a public mobile, browser, or desktop application.
Transport success and API success are checked separately. On HTTP 429, honor Retry-After before a bounded retry. Check account permissions and regional credentials for 401/403. A timeout or 5xx response after submitting a write can leave its outcome uncertain: reconcile before retrying, especially sends and resource creation. Metadata is correlation data, not an idempotency key. Inspect error bodies privately because they can contain phone numbers and message content.
Chilkat Visual FoxPro Downloads
LOCAL lnSuccess
LOCAL loConfig
LOCAL lcApiHost
LOCAL loHttp
LOCAL loUrl
LOCAL loResp
LOCAL loResult
LOCAL loBody
LOCAL loWhen
LOCAL i
lnSuccess = 0
* Assumes Chilkat is unlocked. See Global Unlock Sample.
* Store real credentials in private configuration, never in distributed client code.
loConfig = CreateObject('Chilkat.JsonObject')
loConfig.Strict = 1
lnSuccess = loConfig.LoadFile("sinch-engage.json")
IF (lnSuccess <> 1) THEN
? "Could not load private sinch-engage.json."
RELEASE loConfig
CANCEL
ENDIF
IF ((loConfig.JsonTypeOf("api_key") <> 1) OR (loConfig.StringOfEquals("api_key","",1) = 1) OR (loConfig.JsonTypeOf("api_secret") <> 1) OR (loConfig.StringOfEquals("api_secret","",1) = 1)) THEN
? "The private configuration must contain api_key and api_secret."
RELEASE loConfig
CANCEL
ENDIF
* Choose the host for your Engage account: au, eu, or us. Do not guess from the recipient.
lcApiHost = "https://au.app.api.sinch.com"
loHttp = CreateObject('Chilkat.Http')
loHttp.RequireSslCertVerify = 1
loHttp.FollowRedirects = 0
loHttp.ConnectTimeout = 20
loHttp.ReadTimeout = 30
loHttp.Login = loConfig.StringOf("api_key")
loHttp.Password = loConfig.StringOf("api_secret")
loHttp.BasicAuth = 1
loHttp.SetRequestHeader("Accept","application/json")
loUrl = CreateObject('Chilkat.StringBuilder')
loResp = CreateObject('Chilkat.HttpResponse')
loResult = CreateObject('Chilkat.JsonObject')
loResult.Strict = 1
loBody = CreateObject('Chilkat.JsonObject')
loBody.UpdateString("messages[0].destination_number","+61491570156")
loBody.UpdateString("messages[0].format","SMS")
loBody.UpdateString("messages[0].content","Sample message.")
loBody.UpdateBool("messages[0].delivery_report",1)
loWhen = CreateObject('Chilkat.CkDateTime')
lnSuccess = loWhen.SetFromCurrentSystemTime()
IF (lnSuccess <> 1) THEN
? "Could not obtain the current time."
RELEASE loConfig
RELEASE loHttp
RELEASE loUrl
RELEASE loResp
RELEASE loResult
RELEASE loBody
RELEASE loWhen
CANCEL
ENDIF
lnSuccess = loWhen.AddSeconds(3600)
IF (lnSuccess <> 1) THEN
? "Could not calculate the schedule."
RELEASE loConfig
RELEASE loHttp
RELEASE loUrl
RELEASE loResp
RELEASE loResult
RELEASE loBody
RELEASE loWhen
CANCEL
ENDIF
loBody.UpdateString("messages[0].scheduled",loWhen.GetAsTimestamp(0))
lnSuccess = loWhen.AddSeconds(3600)
IF (lnSuccess <> 1) THEN
? "Could not calculate the expiry."
RELEASE loConfig
RELEASE loHttp
RELEASE loUrl
RELEASE loResp
RELEASE loResult
RELEASE loBody
RELEASE loWhen
CANCEL
ENDIF
loBody.UpdateString("messages[0].message_expiry_timestamp",loWhen.GetAsTimestamp(0))
loUrl.Clear()
loUrl.Append(lcApiHost)
loUrl.Append("/v1/messages")
lnSuccess = loHttp.HttpJson("POST",loUrl.GetAsString(),loBody,"application/json",loResp)
* HttpJson/HttpNoBody also return false for HTTP 4xx/5xx responses.
IF ((lnSuccess <> 1) AND (loResp.StatusCode = 0)) THEN
? "HTTP transport failed. Inspect diagnostics privately; do not blindly retry a write."
RELEASE loConfig
RELEASE loHttp
RELEASE loUrl
RELEASE loResp
RELEASE loResult
RELEASE loBody
RELEASE loWhen
CANCEL
ENDIF
IF ((loResp.StatusCode <> 202)) THEN
? "Unexpected HTTP status: " + STR(loResp.StatusCode)
IF (loResp.StatusCode = 429) THEN
? "Retry-After: " + loResp.GetHeaderField("Retry-After")
ENDIF
RELEASE loConfig
RELEASE loHttp
RELEASE loUrl
RELEASE loResp
RELEASE loResult
RELEASE loBody
RELEASE loWhen
CANCEL
ENDIF
lnSuccess = loResult.Load(loResp.BodyStr)
IF (lnSuccess <> 1) THEN
? "Expected a JSON response."
RELEASE loConfig
RELEASE loHttp
RELEASE loUrl
RELEASE loResp
RELEASE loResult
RELEASE loBody
RELEASE loWhen
CANCEL
ENDIF
IF (loResult.SizeOfArray("messages") < 0) THEN
? "Expected an array in the response."
RELEASE loConfig
RELEASE loHttp
RELEASE loUrl
RELEASE loResp
RELEASE loResult
RELEASE loBody
RELEASE loWhen
CANCEL
ENDIF
IF (loResult.SizeOfArray("messages") <> loBody.SizeOfArray("messages")) THEN
? "Unexpected number of message results; reconcile before retrying."
RELEASE loConfig
RELEASE loHttp
RELEASE loUrl
RELEASE loResp
RELEASE loResult
RELEASE loBody
RELEASE loWhen
CANCEL
ENDIF
i = 0
DO WHILE (i < loResult.SizeOfArray("messages"))
loResult.I = i
IF ((loResult.JsonTypeOf("messages[i].message_id") <> 1) OR (loResult.StringOfEquals("messages[i].message_id","",1) = 1)) THEN
? "The response did not contain the expected ID."
RELEASE loConfig
RELEASE loHttp
RELEASE loUrl
RELEASE loResp
RELEASE loResult
RELEASE loBody
RELEASE loWhen
CANCEL
ENDIF
? "Message ID: " + loResult.StringOf("messages[i].message_id")
? "Submission status: " + loResult.StringOf("messages[i].status")
i = i + 1
ENDDO
* Persist IDs with the local records before any later status/cancellation operation.
RELEASE loConfig
RELEASE loHttp
RELEASE loUrl
RELEASE loResp
RELEASE loResult
RELEASE loBody
RELEASE loWhen