rcs > test

Whitelist Number for Test Agent

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

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

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.

post/rcs/test/agents/{agentId}/whitelist

Request

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

Path parameters

agentIdstring required

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

Request body

phoneNumberstring required

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

Response

Returns the whitelist status of the 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.

Changes

No recorded changes to this operation across all 1 revision of this API.