Sinch Engage: Read a Message Detail Report (Preview API)
See more Sinch Engage Examples
Query a fixed UTC window covering the previous 24 hours and read every page up to a demonstration limit. This uses the explicitly versioned v2-preview reporting API; verify account access and current schema before production use. It uses channels rather than the deprecated message_format filter. Reports are historical queries, distinct from the consumable delivery-report queue. Accounts with sub-accounts can return a wider scope unless accounts is supplied. Large exports should use the asynchronous reporting API.
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 loWindow
LOCAL lnPage
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')
loWindow = CreateObject('Chilkat.CkDateTime')
lnSuccess = loWindow.SetFromCurrentSystemTime()
IF (lnSuccess <> 1) THEN
? "Could not get the report end time."
RELEASE loConfig
RELEASE loHttp
RELEASE loUrl
RELEASE loResp
RELEASE loResult
RELEASE loBody
RELEASE loWindow
CANCEL
ENDIF
loBody.UpdateString("end_date",loWindow.GetAsTimestamp(0))
lnSuccess = loWindow.AddSeconds(-86400)
IF (lnSuccess <> 1) THEN
? "Could not get the report start time."
RELEASE loConfig
RELEASE loHttp
RELEASE loUrl
RELEASE loResp
RELEASE loResult
RELEASE loBody
RELEASE loWindow
CANCEL
ENDIF
loBody.UpdateString("start_date",loWindow.GetAsTimestamp(0))
loBody.UpdateString("direction","all")
loBody.UpdateString("channels[0]","SMS")
loBody.UpdateString("channels[1]","MMS")
loBody.UpdateString("channels[2]","TTS")
loBody.UpdateString("channels[3]","RCS")
loBody.UpdateInt("page_size",100)
lnPage = 0
DO WHILE (lnPage < 100)
loBody.UpdateInt("page",lnPage)
loUrl.Clear()
loUrl.Append(lcApiHost)
loUrl.Append("/v2-preview/reporting/messages/detail")
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 loWindow
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
RELEASE loBody
RELEASE loWindow
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 loWindow
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 loWindow
CANCEL
ENDIF
i = 0
DO WHILE (i < loResult.SizeOfArray("messages"))
loResult.I = i
? "Message ID: " + loResult.StringOf("messages[i].message_id")
? "Status: " + loResult.StringOf("messages[i].status")
i = i + 1
ENDDO
IF (loResult.JsonTypeOf("pagination.has_next") <> 5) THEN
? "Missing pagination.has_next; cannot establish completeness."
RELEASE loConfig
RELEASE loHttp
RELEASE loUrl
RELEASE loResp
RELEASE loResult
RELEASE loBody
RELEASE loWindow
CANCEL
ENDIF
IF (loResult.BoolOf("pagination.has_next") <> 1) THEN
? "Report complete."
RELEASE loConfig
RELEASE loHttp
RELEASE loUrl
RELEASE loResp
RELEASE loResult
RELEASE loBody
RELEASE loWindow
CANCEL
ENDIF
lnPage = lnPage + 1
ENDDO
? "Stopped at the example's 100-page limit. Resume the same time window and page."
RELEASE loConfig
RELEASE loHttp
RELEASE loUrl
RELEASE loResp
RELEASE loResult
RELEASE loBody
RELEASE loWindow