Get Whitelist Status API Reference

Serverhttps://api.pinnacle.sh/

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".

<img src="https://pncl.to/f769cAvCbEx-MmezZjR6dz6KVkr5ZO" alt="Accepting the tester invite" style="max-width: 100%;" />

<img src="https://pncl.to/VRere3tEKfx4n0HNaxK-vwl7pbLHTJ" alt="Declining the tester invite" style="max-width: 100%;" />

Authorization

Pinnacle API key

PINNACLE-API-KEY<token>

In: header

Path Parameters

agentIdstring

The RCS agent ID (must be prefixed with agent_).

Match

^agent_.*

Example

"agent_abc123def456"

Query Parameters

phoneNumberstring

The phone number to check whitelist status for (E.164 format).

Example

"+12345678901"

Response Body

`application/json`

Pinnacle client libraries

import { PinnacleClient } from "rcs-js";

const client = new PinnacleClient({
  apiKey: process.env.PINNACLE_API_KEY!,
});

await client.rcs.test.getWhitelistStatus("agent_abc123def456", {
    phoneNumber: "+12345678901"
});

Responses

{  "status": "PENDING"}

Get Whitelist Status

Status Values

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Query ParametersCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

Example Pending

Example Accepted

Example Rejected

Authorization

Path Parameters

Query Parameters

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`