List A2P SMS Batches
Returns the list of A2P batches sent from the current account. The list can be filtered by message batch ID and/or from phone number.
Path parameters
Internal identifier of the RingCentral account (can be set to "~" to indicate that the account associated with current authorization session should be used)
Query parameters
The end of the time range to filter the results in ISO 8601 format including timezone. Default is the 'dateTo' minus 24 hours
The end of the time range to filter the results in ISO 8601 format including timezone. Default is the current time
Phone number in E.164 format from which the messages are going to be sent
A list of batch statuses to filter the results
The page token of the page to be retrieved
The number of records to be returned per page
Response
The list of batches sent by the account and filtered by the criteria specified in the query parameters
Example response
{
"records": [
{
"id": "12345",
"from": "+15551234567",
"batchSize": 5,
"processedCount": 1,
"status": "Processing",
"rejected": [
{
"index": 1,
"to": [
"29395"
],
"errorCode": "CMN-100",
"description": "The recipient is invalid"
}
],
"cost": 0.007
}
],
"paging": {
"pageToken": "pgt1",
"perPage": 3,
"firstPageToken": "fpgt1",
"previousPageToken": "lpgt1",
"nextPageToken": "npgt1"
}
}