Sinch Engage: Archive and Acknowledge Delivery Reports
See more Sinch Engage Examples
Fetch one batch of up to 100 pending delivery reports, save the entire batch in a private local inbox, then acknowledge only those record IDs. Acknowledged records stop appearing in subsequent polls. Run again to drain further batches; this is a queue, not page-number pagination.
This example treats a checked local archive write as acceptance for later processing. A production inbox should commit durable, atomic storage and deduplicate by account plus delivery_report_id before applying business effects. A failed acknowledgement can cause redelivery. Coordinate consumers: polling covers the account and acknowledgements affect other pollers. Protect the archive because it contains personal data.
Request delivery_report=true when sending. Several reports can describe the same message: deduplicate by delivery_report_id, not message_id, and use event timestamps when applying changes. Reports may carry an additional charge.
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 lnCount
LOCAL loConfirmation
LOCAL i
LOCAL loFac
LOCAL loHash
LOCAL lcDigest
LOCAL loArchive
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
loUrl.Clear()
loUrl.Append(lcApiHost)
loUrl.Append("/v1/delivery_reports")
lnSuccess = loHttp.HttpNoBody("GET",loUrl.GetAsString(),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
CANCEL
ENDIF
IF ((loResp.StatusCode <> 200)) 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
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
CANCEL
ENDIF
IF (loResult.SizeOfArray("delivery_reports") < 0) THEN
? "Expected an array in the response."
RELEASE loConfig
RELEASE loHttp
RELEASE loUrl
RELEASE loResp
RELEASE loResult
CANCEL
ENDIF
lnCount = loResult.SizeOfArray("delivery_reports")
IF (lnCount = 0) THEN
? "No pending records."
RELEASE loConfig
RELEASE loHttp
RELEASE loUrl
RELEASE loResp
RELEASE loResult
CANCEL
ENDIF
IF (lnCount > 100) THEN
? "Unexpected batch size; nothing was acknowledged."
RELEASE loConfig
RELEASE loHttp
RELEASE loUrl
RELEASE loResp
RELEASE loResult
CANCEL
ENDIF
loConfirmation = CreateObject('Chilkat.JsonObject')
i = 0
DO WHILE (i < lnCount)
loResult.I = i
loConfirmation.I = i
IF ((loResult.JsonTypeOf("delivery_reports[i].delivery_report_id") <> 1) OR (loResult.StringOfEquals("delivery_reports[i].delivery_report_id","",1) = 1)) THEN
? "The response did not contain the expected ID."
RELEASE loConfig
RELEASE loHttp
RELEASE loUrl
RELEASE loResp
RELEASE loResult
RELEASE loConfirmation
CANCEL
ENDIF
loConfirmation.UpdateString("delivery_report_ids[i]",loResult.StringOf("delivery_reports[i].delivery_report_id"))
i = i + 1
ENDDO
* Preserve the complete payload, including channel-specific and future fields.
loFac = CreateObject('Chilkat.FileAccess')
lnSuccess = loFac.DirEnsureExists("engage-inbox/delivery_reports")
IF (lnSuccess <> 1) THEN
? "Could not create the private inbox directory; no acknowledgement sent."
RELEASE loConfig
RELEASE loHttp
RELEASE loUrl
RELEASE loResp
RELEASE loResult
RELEASE loConfirmation
RELEASE loFac
CANCEL
ENDIF
loHash = CreateObject('Chilkat.Crypt2')
loHash.HashAlgorithm = "sha256"
loHash.Charset = "utf-8"
loHash.EncodingMode = "hex"
lcDigest = loHash.HashStringENC(loResp.BodyStr)
IF (loHash.LastMethodSuccess <> 1) THEN
? "Could not name the archive; no acknowledgement sent."
RELEASE loConfig
RELEASE loHttp
RELEASE loUrl
RELEASE loResp
RELEASE loResult
RELEASE loConfirmation
RELEASE loFac
RELEASE loHash
CANCEL
ENDIF
loArchive = CreateObject('Chilkat.StringBuilder')
loArchive.Append("engage-inbox/delivery_reports/")
loArchive.Append(lcDigest)
loArchive.Append(".json")
lnSuccess = loResult.WriteFile(loArchive.GetAsString())
IF (lnSuccess <> 1) THEN
? "Could not save the records; no acknowledgement sent."
RELEASE loConfig
RELEASE loHttp
RELEASE loUrl
RELEASE loResp
RELEASE loResult
RELEASE loConfirmation
RELEASE loFac
RELEASE loHash
RELEASE loArchive
CANCEL
ENDIF
* Acknowledge only after the checked archive write succeeds.
loUrl.Clear()
loUrl.Append(lcApiHost)
loUrl.Append("/v1/delivery_reports/confirmed")
lnSuccess = loHttp.HttpJson("POST",loUrl.GetAsString(),loConfirmation,"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 loConfirmation
RELEASE loFac
RELEASE loHash
RELEASE loArchive
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 loConfirmation
RELEASE loFac
RELEASE loHash
RELEASE loArchive
CANCEL
ENDIF
? "Archived and acknowledged records: " + STR(lnCount)
RELEASE loConfig
RELEASE loHttp
RELEASE loUrl
RELEASE loResp
RELEASE loResult
RELEASE loConfirmation
RELEASE loFac
RELEASE loHash
RELEASE loArchive