Skip to main content

MessageBatchResponse

Batch of A2P SMS messages. This object provides a specification to send message(s) to many recipients. It contains top-level attributes which apply to all messages. In addition to that, it is possible to override this attribute for each message. This way a single API call may be used to send individual messages to many recipients

Properties

NameTypeRequiredDescription
id_strUnique identifier of the message batch
from_strPhone number in E.164 format from which the messages are going to be sent
batch_sizeintTotal number of messages in the accepted batch
processed_countintTotal number of messages currently processed in the batch
last_modified_timestrThe last time the batch was processed.
statusMessageBatchResponseStatusCurrent status of a message batch
creation_timestrThe time at which the batch was created
rejectedList[RejectedRecipientResponseResource]The list of rejected/invalid recipients
costfloatThe estimated batch cost for completed batch. Calculated after batch processing is completed.

MessageBatchResponseStatus

Current status of a message batch

Properties

NameTypeRequiredDescription
PROCESSINGstr"Processing"
COMPLETEDstr"Completed"

Build Your Own SDKs with  liblab

Build developer friendly SDKs in minutes from your APIs

Start for Free →