Sinch Engage: Block a Number and Check Its Status
See more Sinch Engage Examples
Add one number to the account blocking list, then check the result. This prevents future sends from this account; it does not cancel a message already delivered. At most ten numbers can be added per request. The API calls this a blacklist. An authorised=true result means the number is not blocked, not that the person has consented. Do not automatically remove blocks to bypass an opt-out.
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 number = "+61491570156";
Chilkat.JsonObject body = new Chilkat.JsonObject();
body.UpdateString("numbers[0]",number);
url.Clear();
url.Append(apiHost);
url.Append("/v1/number_authorisation/mt/blacklist");
success = http.HttpJson("POST",url.GetAsString(),body,"application/json",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) && (resp.StatusCode != 201)) {
Debug.WriteLine("Unexpected HTTP status: " + Convert.ToString(resp.StatusCode));
if (resp.StatusCode == 429) {
Debug.WriteLine("Retry-After: " + resp.GetHeaderField("Retry-After"));
}
return;
}
url.Clear();
url.Append(apiHost);
url.Append("/v1/number_authorisation/is_authorised/");
url.Append(http.UrlEncode(number));
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;
}
if ((result.SizeOfArray("numbers") != 1) || (result.JsonTypeOf("numbers[0].authorised") != 5)) {
Debug.WriteLine("Expected one number with a boolean authorisation status.");
return;
}
Debug.WriteLine("Number: " + result.StringOf("numbers[0].number"));
Debug.WriteLine("Authorised by the blocking check: " + Convert.ToString(result.BoolOf("numbers[0].authorised")));