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 add test devices to your agent's whitelist before sending test messages. ## Verification Process After whitelisting a number, you'll need to complete verification: 1. Check the test device for an "RBM Tester Management" request 2. Accept the request on the device 3. Enter the 4-digit verification code in the Pinnacle dashboard at: ``` https://app.pinnacle.sh/dashboard/brands/{brandId}?campaignId={campaignId}&campaignType=RCS ``` > **Important Notes** > > - **Testing only:** This is only required for test agents. Production agents can message any RCS-enabled number > - **AT&T limitation:** Whitelisting may currently fail for AT&T numbers > - **Verification required:** The whitelist request isn't complete until you verify the device.

Headers

PINNACLE-API-KEYstringRequired

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