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

Sinch Engage: Archive and Acknowledge Replies

See more Sinch Engage Examples

Fetch one batch of up to 100 pending replies, 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 reply_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.

Do not assume every reply has content: RCS free-text replies can use a body array. Saving the whole JSON preserves both forms. Suggestion taps require webhooks and do not appear here. Replies may be unsolicited and need not match a message_id.

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
url.Clear()
url.Append(apiHost)
url.Append("/v1/replies")
success = http.HttpNoBody("GET",url.GetAsString(),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("replies") < 0):
    print("Expected an array in the response.")
    sys.exit()

count = result.SizeOfArray("replies")
if (count == 0):
    print("No pending records.")
    sys.exit()

if (count > 100):
    print("Unexpected batch size; nothing was acknowledged.")
    sys.exit()

confirmation = chilkat2.JsonObject()
i = 0
while (i < count) :
    result.I = i
    confirmation.I = i
    if ((result.JsonTypeOf("replies[i].reply_id") != 1) or (result.StringOfEquals("replies[i].reply_id","",True) == True)):
        print("The response did not contain the expected ID.")
        sys.exit()

    confirmation.UpdateString("reply_ids[i]",result.StringOf("replies[i].reply_id"))
    i = i + 1

# Preserve the complete payload, including channel-specific and future fields.
fac = chilkat2.FileAccess()
success = fac.DirEnsureExists("engage-inbox/replies")
if (success != True):
    print("Could not create the private inbox directory; no acknowledgement sent.")
    sys.exit()

hash = chilkat2.Crypt2()
hash.HashAlgorithm = "sha256"
hash.Charset = "utf-8"
hash.EncodingMode = "hex"
digest = hash.HashStringENC(resp.BodyStr)
if (hash.LastMethodSuccess != True):
    print("Could not name the archive; no acknowledgement sent.")
    sys.exit()

archive = chilkat2.StringBuilder()
archive.Append("engage-inbox/replies/")
archive.Append(digest)
archive.Append(".json")
success = result.WriteFile(archive.GetAsString())
if (success != True):
    print("Could not save the records; no acknowledgement sent.")
    sys.exit()

# Acknowledge only after the checked archive write succeeds.
url.Clear()
url.Append(apiHost)
url.Append("/v1/replies/confirmed")
success = http.HttpJson("POST",url.GetAsString(),confirmation,"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 != 202)):
    print("Unexpected HTTP status: " + str(resp.StatusCode))
    if (resp.StatusCode == 429):
        print("Retry-After: " + resp.GetHeaderField("Retry-After"))

    sys.exit()

print("Archived and acknowledged records: " + str(count))