Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Telnyx RCS API

Send RCS messages

Telnyx RCS API is one of 168 APIs that Telnyx publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include RCS. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 8 operations across 7 paths, and defines 38 schemas. It is described by OpenAPI 3.1.0, at version 2.0.0.

Requests are made against a single base URL, https://api.telnyx.com/v2.

8 operations 7 paths 38 schemas 4 GET1 PATCH2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.0.0
Base URL
https://api.telnyx.com/v2
Authentication
HTTP Bearer, HTTP Bearer, OAuth 2.0, HTTP Bearer, HTTP Bearer, HTTP Bearer
Resource Areas
1

Authentication & Security 6

Telnyx RCS API declares 6 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). It accepts HTTP bearer tokens (branded-calling_bearerAuth). It supports OAuth 2.0 (oauthClientAuth) using the authorizationCode and clientCredentials flows, exposing 1 scope. It accepts HTTP bearer tokens (JWT) (outbound-voice-profiles_bearerAuth). It accepts HTTP bearer tokens (pronunciation-dicts_bearerAuth). It accepts HTTP bearer tokens (JWT) (stored-payment-transactions_bearerAuth). By default, every request must be authenticated.

  • branded-calling_bearerAuth — API key passed as a Bearer token in the Authorization header
  • oauthClientAuth — OAuth 2.0 authentication for Telnyx API and MCP integrations
  • pronunciation-dicts_bearerAuth — Telnyx API v2 key. Obtain from https://portal.telnyx.com

Paths & Operations 8

Across 7 paths, the API surfaces 8 operations — 4 GET, 1 PATCH, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

RCS 8

Send RCS messages

POST
/messages/rcs
Send an RCS message
SendRCSMessage body → 2004XX
GET
/messages/rcs/deeplinks/{agent_id}
Generate RCS deeplink
GenerateRCSDeeplink 3 params → 2004XX
GET
/messaging/rcs/agents
List all RCS agents
ListRCSAgents 1 param → 2004XX
GET
/messaging/rcs/agents/{id}
Retrieve an RCS agent
GetRCSAgentById 1 param → 2004XX
PATCH
/messaging/rcs/agents/{id}
Modify an RCS agent
UpdateRCSAgentById 1 param body → 2004XX
POST
/messaging/rcs/bulk_capabilities
Check RCS capabilities (batch)
ListRCSCapabilitiesOfAPhoneNumbersBatch body → 2004XX
GET
/messaging/rcs/capabilities/{agent_id}/{phone_number}
Check RCS capabilities
ListRCSCapabilitiesOfAPhoneNumber 2 params → 2004XX
PUT
/messaging/rcs/test_number_invite/{id}/{phone_number}
Add RCS test number
InviteATestNumberToRCS 2 params → 2004XX

Schemas 38

The contract defines 38 schemas that model the data the API accepts and returns. The most detailed are RCSAgent (9 properties), RCSAction (8 properties), RCSMessage (8 properties), messaging_Error (5 properties). Each schema is shown below with its type and property counts.

RCSResponse
object
1 property
RCSMessage
object
8 properties 4 required
RCSAgentMessage
object
4 properties
RCSCapabilitiesBulk
object
1 property
RCSMedia
object
A media file within a rich card.
2 properties
RCSTo
array
RCSRichCard
object
2 properties
SMSFallback
object
2 properties
RCSCapabilitiesSingle
object
1 property
RCSReply
object
2 properties
RCSShareLocationAction
object
Opens the RCS app's location chooser so the user can pick a location to send back to the agent.
RCSFrom
object
3 properties
RCSTestNumberInviteResponse
object
1 property 1 required
RCSCarouselCard
object
Carousel of cards.
2 properties 2 required
MMSFallback
object
4 properties
RCSAgentResponse
object
1 property
RCSAgentUpdate
object
3 properties
RCSDialAction
object
Opens the user's default dialer app with the agent-specified phone number filled in.
1 property 1 required
RCSContentMessage
object
4 properties
RCSCardContent
object
4 properties
RCSEvent
object
RCS Event to send to the recipient
1 property
RCSContentInfo
object
3 properties 1 required
RCSToItem
object
4 properties
RCSOpenUrlAction
object
Opens the user's default web browser app to the specified URL.
4 properties 3 required
RCSAgentsResponse
object
2 properties
RCSAgent
object
9 properties
RCSCreateCalendarEventAction
object
Opens the user's default calendar app and starts the new calendar event flow with the agent-specified event data pre-filled.
4 properties
RCSLatLng
object
2 properties 2 required
RCSAction
object
When tapped, initiates the corresponding native action on the device.
8 properties
RCSCapabilitiesInternal
object
5 properties
RCSViewLocationAction
object
Opens the user's default map app and selects the agent-specified location.
3 properties
RCSStandaloneCard
object
Standalone card
3 properties 3 required
messaging_Errors
object
1 property
RCSDeeplinkResponse
object
1 property 1 required
RCSSuggestion
object
2 properties
messaging_PaginationMeta
object
4 properties 4 required
messaging_Error
object
5 properties 2 required
RCSCapabilityListRequest
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

telnyx-rcs-api-openapi.yml Raw ↑

Other APIs Telnyx publishes across the network.

Telnyx Access Tokens API
Telnyx Addresses API
Telnyx Advanced Number Orders API
Telnyx Assistants API
Telnyx Audio API
Telnyx Audit Logs API
Telnyx Authentication Providers API
Telnyx AutoRechargePreferences API
Telnyx Billing API
Telnyx Billing Groups API
Telnyx Brands API
Telnyx Bucket SSL Certificate API