Sinch Engage: Create a List and Add an Existing Contact
See more Sinch Engage Examples
Create a list, read its returned ID, and add an existing contact. These are two independent requests, not a transaction. If adding the contact fails, keep the list ID and resume membership rather than creating another list. List membership does not opt a contact in or send a message.
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 Python Downloads
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
contactId = "YOUR_CONTACT_ID"
body = chilkat2.JsonObject()
body.UpdateString("name","Example contacts")
url.Clear()
url.Append(apiHost)
url.Append("/api/v1/contacts/lists")
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 != 201)):
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.JsonTypeOf("id") != 1) or (result.StringOfEquals("id","",True) == True)):
print("The response did not contain the expected ID.")
sys.exit()
listId = result.StringOf("id")
print("Created list ID: " + listId)
# Save the list ID before changing membership. A later failure does not undo creation.
url.Clear()
url.Append(apiHost)
url.Append("/api/v1/contacts/lists/")
url.Append(http.UrlEncode(listId))
url.Append("/contacts/")
url.Append(http.UrlEncode(contactId))
success = http.HttpNoBody("POST",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) and (resp.StatusCode != 201)):
print("Unexpected HTTP status: " + str(resp.StatusCode))
if (resp.StatusCode == 429):
print("Retry-After: " + resp.GetHeaderField("Retry-After"))
sys.exit()
print("Contact added to the list.")