Sinch Engage: List Approved Sender Addresses
See more Sinch Engage Examples
Enumerate approved sender-address records with pagination. The returned address ID differs from the request ID issued during sender registration. Inspect display_status and destination eligibility before using a sender. This does not register, renew, or delete a sender.
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
nextToken = ""
seenTokens = chilkat2.StringArray()
pageCount = 0
while (pageCount < 100) :
url.Clear()
url.Append(apiHost)
url.Append("/v1/messaging/numbers/sender_address/addresses?page_size=50")
if (nextToken != ""):
url.Append("&token=")
url.Append(http.UrlEncode(nextToken))
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("data") < 0):
print("Expected an array in the response.")
sys.exit()
i = 0
while (i < result.SizeOfArray("data")) :
result.I = i
print("Sender address ID: " + result.StringOf("data[i].id"))
print("Sender: " + result.StringOf("data[i].sender_address"))
print("State: " + result.StringOf("data[i].display_status"))
i = i + 1
pageCount = pageCount + 1
nextToken = ""
if (result.JsonTypeOf("pagination.next_token") == 1):
nextToken = result.StringOf("pagination.next_token")
if (nextToken == ""):
print("Completed pages: " + str(pageCount))
sys.exit()
if (seenTokens.Find(nextToken,0) >= 0):
print("Repeated pagination token; stopping to avoid a loop.")
sys.exit()
seenTokens.Append(nextToken)
print("Stopped at the example's 100-page limit. Save the continuation token to resume.")