Whitelist Phone Number

Whitelist a phone number for testing with your test RCS agent. ## Overview During development and testing, RCS agents can only send messages to whitelisted phone numbers. Use this endpoint to whitelist specific phone numbers to send and receive messages from the test agent. ## Verification Process After whitelisting a number, you'll need to complete verification: 1. Check the test device for message from "RBM Tester Management" 2. Click the "Make me a tester" button 3. Enter the separate 4-digit verification SMS code in the Pinnacle dashboard at: ``` https://app.pinnacle.sh/dashboard/brands/{brandId}?campaignId={campaignId}&campaignType=RCS ``` > **⚠️ Important: Re-whitelisting Numbers** > > If you whitelist a number that's already whitelisted, you'll receive a new message from "RBM Tester Management". **You must click the "Make me a tester" button again to continue sending and receiving messages.** > **Important Notes** > > - **Verification required:** Messages cannot be sent nor received until you have clicked the "Make me a tester" button on the test device. > - **Testing only:** This is only required for test agents. Production agents can message any RCS-enabled number. > - **Network limitations:** Whitelisting may be temporarily unavailable for some carriers but are usually restored shortly.

Authentication

PINNACLE-API-KEYstring
API Key authentication via header

Request

This endpoint expects an object.
agentIdstringRequiredformat: "^agent_.*"

The RCS agent ID (must be prefixed with ‘agent_’)

phoneNumberstringRequiredformat: "^\+[1-9]\d{1,14}$"

Phone number to whitelist for testing (E.164 format)

Response

Phone number successfully whitelisted
successboolean
Whether the whitelisting operation was successful

Errors