Sign in

v1

latestOpenAPI 3.0.3RingCentral API License Agreement2026-08-064871,2921.5 MB
High Volume SMS

Send A2P SMS

Allows to send high volume of A2P (Application-to-Person) SMS messages (in message batches). Only phone number with the A2PSmsSender feature can be used as a sender.

post/restapi/v1.0/account/{accountId}/a2p-sms/batches

Path parameters

accountIdstring required

Internal identifier of the RingCentral account (can be set to "~" to indicate that the account associated with current authorization session should be used)

Request body

fromstring required

Sender's phone number in E.164 format.

textstring

Text to send to messages.to phone numbers. Can be overridden on a per-message basis

Example request

{
  "from": "+15551234567",
  "text": "Hello, World!",
  "messages": [
    {
      "to": [
        "15551234477"
      ],
      "text": "Hello, World!"
    }
  ]
}

Response

Message batch created

idstring

Unique identifier of the message batch

fromstring

Phone number in E.164 format from which the messages are going to be sent

batchSizeinteger

Total number of messages in the accepted batch

processedCountinteger

Total number of messages currently processed in the batch

lastModifiedTimestring date-time

The last time the batch was processed.

status'Processing' | 'Completed'

Current status of a message batch

creationTimestring date-time

The time at which the batch was created

costnumber double

The estimated batch cost for completed batch. Calculated after batch processing is completed.

Example response

{
  "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
}