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:
- The recipient's device will receive a message from "RBM Tester Management".
- The recipient must tap "Make me a tester" to accept.
- Once accepted, the status transitions from
PENDINGtoACCEPTED.
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
agentIdstringThe RCS agent ID (must be prefixed with agent_).
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.
phoneNumberstringPhone number to whitelist for testing in E.164 format.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json