rcs > test

Create Test Agent

Create a new RCS test agent for development and testing.

Overview

Test agents let you build and test full RCS functionality — rich cards, carousels, buttons, quick replies, and media messages — without going through the full carrier review process. Messages from test agents can only be sent to whitelisted phone numbers.

Limits

  • Maximum 5 test agents per account.

Image Requirements

ImageFormatMax Size
LogoJPEG, PNG50 KB
HeroJPEG, PNG200 KB

After Creation

Once your test agent is created, you'll need to:

  1. Whitelist test phone numbers using POST /rcs/test/agents/{agentId}/whitelist.
  2. Accept the tester invite on each whitelisted device.
  3. Send messages using POST /messages/send/rcs with the returned agent ID as the from field.

2-Minute Cooldown

After creating a test agent, there is a mandatory 2-minute cooldown before you can whitelist phone numbers. This is a requirement imposed by Google's RBM platform.

post/rcs/test/agents

Request

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

Request body

displayNamestring required

Display name of the agent shown to users in RCS conversations. Must be between 1 and 40 characters.

descriptionstring required

Short description of what the agent does. Shown to users in the agent's profile. Must be between 1 and 100 characters.

logoUrlstring uri required

URL to the agent's logo image. Displayed as the agent's avatar in conversations.

Requirements:

  • Format: JPEG or PNG
  • Max file size: 50 KB
  • Recommended: Square aspect ratio
heroUrlstring uri required

URL to the agent's hero banner image. Displayed at the top of the agent's profile.

Requirements:

  • Format: JPEG or PNG
  • Max file size: 200 KB
  • Recommended: Landscape aspect ratio
privacyUrlstring uri required

URL to the agent's privacy policy.

termsUrlstring uri required

URL to the agent's terms and conditions.

colorstring required

The agent's brand color as a hex color code. Used for UI accents in the RCS conversation. Must have sufficient contrast with white for accessibility.

isConversationalboolean required

Whether the agent supports two-way conversations. Set to true if the agent will respond to user messages. Set to false for send-only agents (e.g., notifications).

agentUseCase'TRANSACTIONAL' | 'PROMOTIONAL' | 'OTP' | 'MULTI_USE'

The primary use case for the RCS agent. This helps carriers understand the purpose of the agent during review.

  • TRANSACTIONAL — Order confirmations, shipping updates, appointment reminders, and similar transactional notifications.
  • PROMOTIONAL — Marketing messages, offers, discounts, and promotional content.
  • OTP — One-time passwords and verification codes.
  • MULTI_USE — A combination of transactional, promotional, and/or OTP messaging.

Response

The test agent was created successfully.

Use the returned id as the from field when sending RCS messages, and when whitelisting phone numbers.

idstring required

The unique agent ID. Use this ID when sending messages, whitelisting numbers, and performing other agent operations. Always prefixed with agent_.

type'TEST' required

The type of the agent. Test agents always have type TEST.

serviceIdstring required

The RCS service ID assigned to this agent by the carrier network. Used internally for routing messages. You can use this to construct RCS deep links manually.

Changes

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