Sign in
latestOpenAPI 3.1.0MIT2026-08-102046250.0 KB

67cb925f1c81

Batches

Dry run

This operation will perform a dry run of a batch which calculates the bodies and number of parts for all messages in the batch without actually sending any messages.

post/xms/v1/{service_plan_id}/batches/dry_run

Query parameters

per_recipientboolean
Example:true

Whether to include per recipient details in the response

number_of_recipientsinteger
Example:500

Max number of recipients to include per recipient details for in the response

Request body

OR
OR

Example request

{
  "to": [
    "+15551231234",
    "+15551256344"
  ],
  "from": "+15551231234",
  "send_at": "2024-08-07T12:34:56.789Z"
}

Response

OK. A successful response , or an Error.

number_of_recipientsinteger required

The number of recipients in the batch

number_of_messagesinteger required

The total number of SMS message parts to be sent in the batch

Example response

{
  "per_recipient": [
    {
      "recipient": "+15551231234"
    }
  ]
}