Skip to main content

Register an RCS agent

This quickstart takes an RCS agent from brand registration to carrier launch. The process has two stages, allowing the agent to be created and tested before all carrier launch information is available. The first stage registers the brand, creates the agent, submits its basic configuration, and adds test devices. The second stage provides the campaign and testing evidence needed for carrier review.

Prerequisites

Before starting, gather:
  • A Telnyx account with an API key
  • A Messaging Profile ID
  • Business registration details, including the legal name, EIN, address, website, and contact
  • Public HTTPS URLs for the agent logo, hero image, privacy policy, and terms and conditions
Set the API key as an environment variable:
RCS registration is asynchronous. A successful submission means Telnyx accepted the work, not that external review is complete. Use the retrieve endpoints to follow each resource’s status.

Stage 1: Create and test the agent

Create a brand

A brand represents the legal business operating the RCS agent.
Save the returned brand_id. A brand can be updated while its status is CREATED. After submission, its registration fields are locked.

Submit the brand

The endpoint returns 202 Accepted. Poll the brand until its status becomes VERIFIED:
Do not submit an agent until the brand is VERIFIED. REJECTED and FAILED are terminal states that require investigation before creating another registration.

Create the agent basics

Create the agent with only the information needed for the first stage. The Idempotency-Key is required. Reuse the same key and request body when retrying an uncertain response.
Save the returned agent_id. Agent fields can be updated while the status is CREATED.
Using an existing idempotency key with a different request returns a conflict. Do not generate a new key for a retry of the same logical agent creation.

Submit the agent basics

This starts provider provisioning and basic agent review. Follow progress with:
When basics_status is SUBMITTED or APPROVED, the agent can remain in this stage during testing and while carrier launch information is gathered. There is no requirement to begin the second stage immediately.

Add a test device

After the basic submission completes, add an RCS-capable phone number in E.164 format:
List the agent’s test devices:

Stage 2: Submit the agent for launch

Start this stage after gathering the campaign, consent, and testing information needed for carrier review. The testing.test_url must point to a publicly accessible video that demonstrates START, STOP, and HELP behavior and an example interaction with the agent.
The endpoint returns 202 Accepted. Telnyx submits the campaign and testing sections in the order required by the provider, then tracks external review and launch.

Monitor launch status

Retrieve the agent until status becomes LIVE:
The agent response includes section statuses, test devices, carrier approvals, and provider capabilities. Carrier approval may be reported as an aggregate hub status when the provider does not expose individual carrier results. Once the agent is LIVE, continue with Send an RCS message.