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
#include <CkJsonObject.h>
#include <CkHttp.h>
#include <CkStringBuilder.h>
#include <CkHttpResponse.h>
void ChilkatSample(void)
{
bool success = false;
// Assumes Chilkat is unlocked. See Global Unlock Sample.
// Store real credentials in private configuration, never in distributed client code.
CkJsonObject config;
config.put_Strict(true);
success = config.LoadFile("sinch-engage.json");
if (success != true) {
std::cout << "Could not load private sinch-engage.json." << "\r\n";
return;
}
if ((config.JsonTypeOf("api_key") != 1) || (config.StringOfEquals("api_key","",true) == true) || (config.JsonTypeOf("api_secret") != 1) || (config.StringOfEquals("api_secret","",true) == true)) {
std::cout << "The private configuration must contain api_key and api_secret." << "\r\n";
return;
}
// Choose the host for your Engage account: au, eu, or us. Do not guess from the recipient.
const char *apiHost = "https://au.app.api.sinch.com";
CkHttp http;
http.put_RequireSslCertVerify(true);
http.put_FollowRedirects(false);
http.put_ConnectTimeout(20);
http.put_ReadTimeout(30);
http.put_Login(config.stringOf("api_key"));
http.put_Password(config.stringOf("api_secret"));
http.put_BasicAuth(true);
http.SetRequestHeader("Accept","application/json");
CkStringBuilder url;
CkHttpResponse resp;
CkJsonObject result;
result.put_Strict(true);
const char *number = "+61491570156";
CkJsonObject body;
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.get_StatusCode() == 0)) {
std::cout << "HTTP transport failed. Inspect diagnostics privately; do not blindly retry a write." << "\r\n";
return;
}
if ((resp.get_StatusCode() != 200) && (resp.get_StatusCode() != 201)) {
std::cout << "Unexpected HTTP status: " << resp.get_StatusCode() << "\r\n";
if (resp.get_StatusCode() == 429) {
std::cout << "Retry-After: " << resp.getHeaderField("Retry-After") << "\r\n";
}
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.get_StatusCode() == 0)) {
std::cout << "HTTP transport failed. Inspect diagnostics privately; do not blindly retry a write." << "\r\n";
return;
}
if ((resp.get_StatusCode() != 200)) {
std::cout << "Unexpected HTTP status: " << resp.get_StatusCode() << "\r\n";
if (resp.get_StatusCode() == 429) {
std::cout << "Retry-After: " << resp.getHeaderField("Retry-After") << "\r\n";
}
return;
}
success = result.Load(resp.bodyStr());
if (success != true) {
std::cout << "Expected a JSON response." << "\r\n";
return;
}
if (result.SizeOfArray("numbers") < 0) {
std::cout << "Expected an array in the response." << "\r\n";
return;
}
if ((result.SizeOfArray("numbers") != 1) || (result.JsonTypeOf("numbers[0].authorised") != 5)) {
std::cout << "Expected one number with a boolean authorisation status." << "\r\n";
return;
}
std::cout << "Number: " << result.stringOf("numbers[0].number") << "\r\n";
std::cout << "Authorised by the blocking check: " << result.BoolOf("numbers[0].authorised") << "\r\n";
}