---
title: "List A2P SMS Messages"
method: GET
path: "/restapi/v1.0/account/{accountId}/a2p-sms/messages"
tags: ["High Volume SMS"]
---

# List A2P SMS Messages

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

## Request

- Base URL: `https://platform.ringcentral.com`
- URL: `https://platform.ringcentral.com/restapi/v1.0/account/{accountId}/a2p-sms/messages`
- Auth: OAuth 2
  - Authorization code: `https://platform.ringcentral.com/restapi/oauth/authorize`
  - Token URL: `https://platform.ringcentral.com/restapi/oauth/token`
- TypeScript: <https://skmtc.dev/ringcentral/apis/ringcentral-api/docs/restapi/v1.0/account/:accountId/a2p-sms/messages/get.ts> (a function with typed inputs; its response is checked against the schema)

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.

## Path parameters

- `accountId` string, required

## Query parameters

- `batchId` string
- `direction` 'Inbound' | 'Outbound': Direction of the SMS message
- `dateFrom` string, date-time
- `dateTo` string, date-time
- `view` 'Simple' | 'Detailed'
- `phoneNumber` string[]
- `pageToken` string
- `perPage` integer

## Response `200`

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

- MessageListResponse: List of messages retrieved for an account and other filter criteria such as `batchId` and `fromPhoneNumber` specified in the request
  - `records` MessageListMessageResponse[]: An array containing individual messages
    - `id` integer: The Id of the message
    - `batchId` string: Internal identifier of a batch the message was submitted in
    - `from` string: Phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format from which the message is sent
    - `to` string[]: Phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format to which a message is sent
    - `creationTime` string, date-time: The time at which the message was created
    - `lastModifiedTime` string, date-time: The time at which the messages was last updated
    - `messageStatus` 'Queued' | 'Delivered' | 'Sent' | 'SendingFailed' | 'DeliveryFailed': Current status of a message
    - `segmentCount` integer: Number of segments of a message
    - `text` string: Text of a message. Returned if the `view` parameter is set to 'Detailed'
    - `cost` number, double: Cost of a message
    - `direction` 'Inbound' | 'Outbound': Direction of the SMS message
    - `errorCode` string: The RC error code of the message sending failure reason
  - `paging` PagingResource: Pagination details
    - `pageToken` string: Page token of the current response list
    - `perPage` integer: Number of records per page
    - `firstPageToken` string: First page token of the current filter criteria
    - `previousPageToken` string: Previous page token of the current filter criteria
    - `nextPageToken` string: Next page token of the current filter criteria

## Other responses

- `400`: Invalid Request
- `401`: Unauthorized
- `404`: No resource found for the account.
- `500`: Internal Server Error

---

[API](https://skmtc.dev/ringcentral/apis/ringcentral-api.md) - [All operations](https://skmtc.dev/ringcentral/apis/ringcentral-api/llms.txt) - [OpenAPI document](https://skmtc.dev/ringcentral/apis/ringcentral-api/revisions/8d602198ec97?raw)