Sinch Engage: List Blocked Numbers with Pagination
See more Sinch Engage Examples
Read the blocking list in pages of up to 100 numbers. The response pagination.page field carries the next token and next_uri indicates continuation. The example rebuilds requests against the configured host rather than forwarding credentials to a response-provided URL. Blocking lists and contact channel subscription preferences are distinct controls; preserve both.
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 C# Downloads
bool success = false;
// Assumes Chilkat is unlocked. See Global Unlock Sample.
// Store real credentials in private configuration, never in distributed client code.
Chilkat.JsonObject config = new Chilkat.JsonObject();
config.Strict = true;
success = config.LoadFile("sinch-engage.json");
if (success != true) {
Debug.WriteLine("Could not load private sinch-engage.json.");
return;
}
if ((config.JsonTypeOf("api_key") != 1) || (config.StringOfEquals("api_key","",true) == true) || (config.JsonTypeOf("api_secret") != 1) || (config.StringOfEquals("api_secret","",true) == true)) {
Debug.WriteLine("The private configuration must contain api_key and api_secret.");
return;
}
// Choose the host for your Engage account: au, eu, or us. Do not guess from the recipient.
string apiHost = "https://au.app.api.sinch.com";
Chilkat.Http http = new Chilkat.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");
Chilkat.StringBuilder url = new Chilkat.StringBuilder();
Chilkat.HttpResponse resp = new Chilkat.HttpResponse();
Chilkat.JsonObject result = new Chilkat.JsonObject();
result.Strict = true;
string nextToken = "";
Chilkat.StringArray seenTokens = new Chilkat.StringArray();
int pageCount = 0;
while ((pageCount < 100)) {
url.Clear();
url.Append(apiHost);
url.Append("/v1/number_authorisation/mt/blacklist?");
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) && (resp.StatusCode == 0)) {
Debug.WriteLine("HTTP transport failed. Inspect diagnostics privately; do not blindly retry a write.");
return;
}
if ((resp.StatusCode != 200)) {
Debug.WriteLine("Unexpected HTTP status: " + Convert.ToString(resp.StatusCode));
if (resp.StatusCode == 429) {
Debug.WriteLine("Retry-After: " + resp.GetHeaderField("Retry-After"));
}
return;
}
success = result.Load(resp.BodyStr);
if (success != true) {
Debug.WriteLine("Expected a JSON response.");
return;
}
if (result.SizeOfArray("numbers") < 0) {
Debug.WriteLine("Expected an array in the response.");
return;
}
int i = 0;
while ((i < result.SizeOfArray("numbers"))) {
result.I = i;
Debug.WriteLine(result.StringOf("numbers[i]"));
i = i + 1;
}
pageCount = pageCount + 1;
nextToken = "";
if ((result.JsonTypeOf("pagination.next_uri") == 1) && (result.StringOfEquals("pagination.next_uri","",true) != true) && (result.JsonTypeOf("pagination.page") == 1)) {
nextToken = result.StringOf("pagination.page");
}
if (nextToken == "") {
Debug.WriteLine("Completed pages: " + Convert.ToString(pageCount));
return;
}
if (seenTokens.Find(nextToken,0) >= 0) {
Debug.WriteLine("Repeated pagination token; stopping to avoid a loop.");
return;
}
seenTokens.Append(nextToken);
}
Debug.WriteLine("Stopped at the example's 100-page limit. Save the continuation token to resume.");