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

# Get A2P SMS Batch

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

## Request

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

Returns information on a message batch.

## Path parameters

- `accountId` string, required
- `batchId` string, required

## Response `200`

Message batch information

- MessageBatchResponse: Batch of A2P SMS messages. This object provides a specification to send message(s) to many recipients. It contains top-level attributes which apply to all messages. In addition to that, it is possible to override this attribute for each message. This way a single API call may be used to send individual messages to many recipients
  - `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.

## Other responses

- `400`: Invalid request
- `401`: Unauthorized error
- `404`: The batch is not found
- `500`: Service is 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)