RIringcentral
High Volume SMS

List A2P SMS Messages

Returns the list of outbound/inbound A2P messages sent from/to A2P phone numbers of the current account. The list can be filtered by message batch ID and/or phone number.

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

Request

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)

Query parameters

batchIdstring

Internal identifier of a message batch to filter the response

direction'Inbound' | 'Outbound'

Direction of the SMS message

Direction of a message to filter the message list result. By default, there is no filter applied - both Inbound and Outbound messages are returned

dateFromstring date-time

The end of the time range to filter the results in ISO 8601 format including timezone. Default is the 'dateTo' minus 24 hours

dateTostring date-time

The end of the time range to filter the results in ISO 8601 format including timezone. Default is the current time

view'Simple' | 'Detailed'

Indicates if the response has to be detailed, includes text in the response if detailed

phoneNumberstring[]

List of phone numbers (specified in 'to' or 'from' fields of a message) to filter the results. Maximum number of phone numbers allowed to be specified as filters is 15

pageTokenstring

The page token of the page to be retrieved.

perPageinteger

The number of messages to be returned per request

Response

The list of messages sent by the account and filtered by the criteria specified in the query parameters

Example response

{
  "records": [
    {
      "id": 1234,
      "batchId": "12345",
      "from": "+15551234567",
      "to": [
        "+15551234567"
      ],
      "messageStatus": "Queued",
      "segmentCount": 1,
      "cost": 0.007,
      "errorCode": "SMS-RC-503"
    }
  ],
  "paging": {
    "pageToken": "pgt1",
    "perPage": 3,
    "firstPageToken": "fpgt1",
    "previousPageToken": "lpgt1",
    "nextPageToken": "npgt1"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.