/agents

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Body

basics
object

Agent details including visual identity, contact methods, and legal links. At least one complete contact method is required at submission.

campaign
object

Campaign details including call-to-action, example messages, and compliance messages.

testing
object

Some carriers require a hands-on test or a preview video of your RCS experience before granting final approval.

config
object

Agent behavior configuration such as sending read receipts or typing indicator.

string
length between 1 and 40

The name of the agent as it will appear to users in their messaging app. Choose something recognizable. Takes second place to basics.name when both are sent.

string
required
length ≥ 6

The ID of the brand this agent will be associated with.

string
enum
required

The use case for the agent. OTP: One-time password and two-factor authentication. TRANSACTIONAL: Appointment reminders, order delivery notifications, etc. PROMOTIONAL: Campaigns, discounts, abandoned cart, etc. MULTI_USE: One or more of the above.

Allowed:
boolean

Whether to auto-fill agent details using AI.

Responses

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json