Sample code for 30+ languages & platforms
Python Requires Chilkat v11.6.0+

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.

Sinch Engage API reference

Chilkat Python Downloads

Python
import sys
import chilkat2

success = False

# Assumes Chilkat is unlocked. See Global Unlock Sample.

# Store real credentials in private configuration, never in distributed client code.
config = chilkat2.JsonObject()
config.Strict = True
success = config.LoadFile("sinch-engage.json")
if (success != True):
    print("Could not load private sinch-engage.json.")
    sys.exit()

if ((config.JsonTypeOf("api_key") != 1) or (config.StringOfEquals("api_key","",True) == True) or (config.JsonTypeOf("api_secret") != 1) or (config.StringOfEquals("api_secret","",True) == True)):
    print("The private configuration must contain api_key and api_secret.")
    sys.exit()

# Choose the host for your Engage account: au, eu, or us. Do not guess from the recipient.
apiHost = "https://au.app.api.sinch.com"
http = chilkat2.Http()
http.RequireSslCertVerify = True
http.FollowRedirects = False
http.ConnectTimeout = 20
http.ReadTimeout = 30
http.Login = config.StringOf("api_key")
http.Password = config.StringOf("api_secret")
http.BasicAuth = True
http.SetRequestHeader("Accept","application/json")
url = chilkat2.StringBuilder()
resp = chilkat2.HttpResponse()
result = chilkat2.JsonObject()
result.Strict = True
body = chilkat2.JsonObject()
window = chilkat2.CkDateTime()
success = window.SetFromCurrentSystemTime()
if (success != True):
    print("Could not get the report end time.")
    sys.exit()

body.UpdateString("end_date",window.GetAsTimestamp(False))
success = window.AddSeconds(-86400)
if (success != True):
    print("Could not get the report start time.")
    sys.exit()

body.UpdateString("start_date",window.GetAsTimestamp(False))
body.UpdateString("direction","all")
body.UpdateString("channels[0]","SMS")
body.UpdateString("channels[1]","MMS")
body.UpdateString("channels[2]","TTS")
body.UpdateString("channels[3]","RCS")
body.UpdateInt("page_size",100)
page = 0
while (page < 100) :
    body.UpdateInt("page",page)
    url.Clear()
    url.Append(apiHost)
    url.Append("/v2-preview/reporting/messages/detail")
    success = http.HttpJson("POST",url.GetAsString(),body,"application/json",resp)
    # HttpJson/HttpNoBody also return false for HTTP 4xx/5xx responses.
    if ((success != True) and (resp.StatusCode == 0)):
        print("HTTP transport failed. Inspect diagnostics privately; do not blindly retry a write.")
        sys.exit()

    if ((resp.StatusCode != 200)):
        print("Unexpected HTTP status: " + str(resp.StatusCode))
        if (resp.StatusCode == 429):
            print("Retry-After: " + resp.GetHeaderField("Retry-After"))

        sys.exit()

    success = result.Load(resp.BodyStr)
    if (success != True):
        print("Expected a JSON response.")
        sys.exit()

    if (result.SizeOfArray("messages") < 0):
        print("Expected an array in the response.")
        sys.exit()

    i = 0
    while (i < result.SizeOfArray("messages")) :
        result.I = i
        print("Message ID: " + result.StringOf("messages[i].message_id"))
        print("Status: " + result.StringOf("messages[i].status"))
        i = i + 1

    if (result.JsonTypeOf("pagination.has_next") != 5):
        print("Missing pagination.has_next; cannot establish completeness.")
        sys.exit()

    if (result.BoolOf("pagination.has_next") != True):
        print("Report complete.")
        sys.exit()

    page = page + 1

print("Stopped at the example's 100-page limit. Resume the same time window and page.")