Sinch Engage: Send Multiple Messages in One Request
See more Sinch Engage Examples
Submit separate messages with per-message metadata. The API accepts up to 100 messages per request; split larger inputs into bounded batches. If any message is invalid, the request is rejected without sending the batch. Longer/Unicode content may use multiple billable SMS parts. Match returned IDs and metadata to your local records.
Live send: Running this submits real, potentially billable messages. Replace the sample destination with a number you control and have permission to message. E.164 numbers and all returned IDs stay as strings. Account/channel/sender provisioning and destination rules still apply. HTTP 202 means accepted for processing, not delivered. Store returned IDs and inspect status or delivery reports. No callback URL is required; account-level webhooks, if configured, can still receive events. TLS 1.3 is selected for sends, including the provider's current requirement for Singapore destinations.
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);
http.put_SslProtocol("TLS 1.3");
CkJsonObject body;
body.UpdateString("messages[0].destination_number","+61491570156");
body.UpdateString("messages[0].format","SMS");
body.UpdateString("messages[0].content","First sample message.");
body.UpdateBool("messages[0].delivery_report",true);
body.UpdateString("messages[0].metadata.local_id","record-001");
body.UpdateString("messages[1].destination_number","+61491570157");
body.UpdateString("messages[1].format","SMS");
body.UpdateString("messages[1].content","Second sample message.");
body.UpdateBool("messages[1].delivery_report",true);
body.UpdateString("messages[1].metadata.local_id","record-002");
url.Clear();
url.Append(apiHost);
url.Append("/v1/messages");
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() != 202)) {
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("messages") < 0) {
std::cout << "Expected an array in the response." << "\r\n";
return;
}
if (result.SizeOfArray("messages") != body.SizeOfArray("messages")) {
std::cout << "Unexpected number of message results; reconcile before retrying." << "\r\n";
return;
}
int i = 0;
while ((i < result.SizeOfArray("messages"))) {
result.put_I(i);
if ((result.JsonTypeOf("messages[i].message_id") != 1) || (result.StringOfEquals("messages[i].message_id","",true) == true)) {
std::cout << "The response did not contain the expected ID." << "\r\n";
return;
}
std::cout << "Message ID: " << result.stringOf("messages[i].message_id") << "\r\n";
std::cout << "Submission status: " << result.stringOf("messages[i].status") << "\r\n";
i = i + 1;
}
// Persist IDs with the local records before any later status/cancellation operation.
}