Pinnacle
API ReferenceRCS AgentsTest Agents

Whitelist Number for Test Agent

Serverhttps://api.pinnacle.sh/
POST
/rcs/test/agents/{agentId}/whitelist

Request body

Edit JSON, then apply it to your request.

JSON

Whitelist a phone number for testing with a specific test agent.

During development and testing, RCS agents can only send messages to whitelisted phone numbers. Use this endpoint to whitelist specific phone numbers so you can send and receive messages from the test agent.

Verification Process

After whitelisting, the recipient must accept the tester invite:

  1. The recipient's device will receive a message from "RBM Tester Management".
  2. The recipient must tap "Make me a tester" to accept.
  3. Once accepted, the status transitions from PENDING to ACCEPTED.

Verification

<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%;" />

Cooldown

There is a 2-minute cooldown after creating or updating a test agent before you can whitelist numbers. Attempting to whitelist during the cooldown returns a 500 error with the remaining wait time.

Path Parameters

agentIdstring

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

Match
^agent_.*
Example
"agent_abc123def456"

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Request body for whitelisting a phone number on a specific test agent.

phoneNumberstring

Phone number to whitelist for testing in E.164 format.

Match
^\+[1-9]\d{9,14}$
Example
"+12345678901"

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

Pinnacle referenceAsk Pinnacle

Get a sourced answer from the published documentation.

ViewingPinnacle documentation

Conversations are saved for analysis.

Try asking