Get Whitelist Status
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>
Authentication
PINNACLE-API-KEYstring
API Key authentication via header
Path parameters
agentId
The RCS agent ID (must be prefixed with agent_).
Query parameters
phoneNumber
The phone number to check whitelist status for (E.164 format).
Response
The current whitelist status of the phone number.
status
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.
Allowed values:
Errors
400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error
