Sending Large Message Batches
If you need to send a single message to a high volume of destinations, the add-batch endpoint is best suited for this.
Adding a batch of messages
To add a batch, make a request to the add-batch endpoint. This endpoint differs from the add-message endpoint in that rather than specifying multiple different messages, you specify a single message with a list of destinations to send it to.
POST
https://api.mplus.cymba.co.uk/batchjson
{
"from": "mplus-test",
"message": "Bulk test message",
"destinations": ["441111111111", "442222222222", "443333333333"],
}The
add-batchendpoint supports all sending features of theadd-messageendpoint, with the exception of:
- Assigning shared sender IDs for receiving inbound traffic. You may still specify sender IDs owned by your organization.
- Specifying different message parameters in the same request.
View the full list of features in the API reference here:
add-batch
response body
json
{
"identifier": "0d064d2c-fafb-4363-b863-28fe49ebe67f"
}The
identifierfield returned is thebatch-uuid