v1

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

High Volume SMS

Get A2P SMS

Returns the details of an A2P SMS message by ID.

get/restapi/v1.0/account/{accountId}/a2p-sms/messages/{messageId}

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)

messageIdstring required

Internal identifier of a message to be retrieved

Response

The message is found and returned

idstring

Internal identifier of a message

fromstring

Phone number in E.164 format from which the message was sent

tostring[]

List of phone numbers in E.164 format to which the message was sent

textstring

Text of a message, maximum number of characters is 1000

creationTimestring date-time

The time when this is message was created.

lastModifiedTimestring date-time

The time when this message was last updated.

messageStatus'Queued' | 'Delivered' | 'Sent' | 'SendingFailed' | 'DeliveryFailed'

Current status of a message

segmentCountinteger

Number of segments of a message

costnumber double

Cost of a message

batchIdstring

The batch in which the message was submitted

direction'Inbound' | 'Outbound'

Direction of the SMS message

errorCodestring

The RC error code of the message sending failure reason

Example response

{
  "id": "1234",
  "from": "+15551234567",
  "to": [
    "+15551234567"
  ],
  "text": "Hello, World!",
  "messageStatus": "Queued",
  "segmentCount": 1,
  "cost": 0.007,
  "batchId": "batch12345",
  "errorCode": "SMS-RC-503"
}