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

# List A2P SMS Batches

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

## Request

- Base URL: `https://platform.ringcentral.com`
- URL: `https://platform.ringcentral.com/restapi/v1.0/account/{accountId}/a2p-sms/batches`
- 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/batches/get.ts> (a function with typed inputs; its response is checked against the schema)

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

- `accountId` string, required

## Query parameters

- `dateFrom` string, date-time
- `dateTo` string, date-time
- `from` string
- `status` string[]
- `pageToken` string
- `perPage` integer

## Response `200`

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

- BatchListResponse: The list of batches retrieved for an account and other filter criteria such as fromPhoneNumber, date specified in the request.
  - `records` MessageBatchResponse[]: An array containing individual batches
    - `id` string: Unique identifier of the message batch
    - `from` string: Phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format from which the messages are going to be sent
    - `batchSize` integer: Total number of messages in the accepted batch
    - `processedCount` integer: Total number of messages currently processed in the batch
    - `lastModifiedTime` string, date-time: The last time the batch was processed.
    - `status` 'Processing' | 'Completed': Current status of a message batch
    - `creationTime` string, date-time: The time at which the batch was created
    - `rejected` RejectedRecipientResponseResource[]: The list of rejected/invalid recipients
      - `index` integer: The index of the messages list in the send batch request where the invalid recipient was found
      - `to` string[]: The invalid recipient number as found in the request
      - `errorCode` string: The error code
      - `description` string: The description of the error
    - `cost` number, double: The estimated batch cost for completed batch. Calculated after batch processing is completed.
  - `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`: Service Unavailable

---

[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)