---
title: "Get Whitelist Status"
method: GET
path: "/rcs/test/agents/{agentId}/numbers"
tags: ["rcs > test"]
---

# Get Whitelist Status

`GET /rcs/test/agents/{agentId}/numbers`

## Request

- Base URL: `https://api.pinnacle.sh`
- URL: `https://api.pinnacle.sh/rcs/test/agents/{agentId}/numbers`
- Auth: API key in header `PINNACLE-API-KEY`

Check the current whitelist status of a phone number for a specific test agent.

Use this endpoint to poll the status of a previously whitelisted number and determine
whether the recipient has accepted or rejected the tester invite.

## Status Values

- **`PENDING`** — The tester invite was sent but the recipient has not yet responded. Ask the recipient to check their messages and accept the invite.
- **`ACCEPTED`** — The recipient accepted the invite. Messages can be exchanged.
- **`REJECTED`** — The recipient rejected the invite or the invite could not be delivered since the carrier does not support test agents. If the user rejected the invite, they can accept it again by tapping "Make me a tester" in the same message from "RBM Tester Management".

<div style="display: flex; gap: 16px;">
  <div style="flex: 1; text-align: center;">
    <strong>Accepting the invite</strong><br/>
    <img src="https://pncl.to/f769cAvCbEx-MmezZjR6dz6KVkr5ZO" alt="Accepting the tester invite" style="max-width: 100%;" />
  </div>
  <div style="flex: 1; text-align: center;">
    <strong>Declining the invite</strong><br/>
    <img src="https://pncl.to/VRere3tEKfx4n0HNaxK-vwl7pbLHTJ" alt="Declining the tester invite" style="max-width: 100%;" />
  </div>
</div>

## Path parameters

- `agentId` string, required

## Query parameters

- `phoneNumber` string, required

## Response `200`

The current whitelist status of the phone number.

- TestAgentWhitelistResponse: Response containing the whitelist status of a phone number.
  - `status` 'PENDING' | 'ACCEPTED' | 'REJECTED', required: Status of a whitelisted phone number for RCS testing. - `PENDING` — The tester invite has been sent but the recipient has not yet accepted or rejected it. - `ACCEPTED` — The recipient accepted the tester invite and can send/receive messages with the test agent. - `REJECTED` — The recipient rejected the tester invite or the invite could not be delivered.

## Other responses

- `400`: Validation failed. The payload has missing required fields and/or invalid types. <br> See https://zod.dev/error-formatting for more information.
- `401`: The request lacks valid authentication credentials or the provided credentials are invalid. <br> Ensure you're including a valid API key in the request headers and that your account has the necessary permissions to access this endpoint.
- `403`: Your subscription does not include access to this feature. <br> This occurs when attempting to use functionality that requires a higher subscription tier. Please upgrade your subscription to access this feature.
- `404`: The phone number has not been whitelisted for this test agent.
- `500`: An unexpected error occurred on Pinnacle's servers while processing your request. <br> If this error persists, please contact support with the request details.

---

[API](https://skmtc.dev/pinnacle/apis/pinnacle-2.md) - [All operations](https://skmtc.dev/pinnacle/apis/pinnacle-2/llms.txt) - [OpenAPI document](https://skmtc.dev/pinnacle/apis/pinnacle-2/revisions/45416dadab79?raw)