Skip to navigation
RCSTemplates

Get template detail

Returns the full structure of the template plus an example object: a ready-to-use body for POST /v1/rcs/messages where you only need to substitute AGENT_ID with a real agent of the same type as the template.

The template field is an object for BASIC templates and an array of cards for SINGLE / CONVERSATIONAL templates. Placeholders like {{nombre}} are variables you must provide when sending; the {{UUID_MESSAGE}} placeholder is internal and resolved by the system — never send it.

Authentication

x-api-keystring

Account authentication key. The App-Key must have the RCS channel enabled.

OR
AuthorizationBearer

OAuth 2.0 access token issued by POST /api/oauth/token (client-credentials). Takes precedence over x-api-key when both are sent. See the Authentication section.

Path parameters

templateIdstringRequired
Template identifier.

Response

Template detail with send example.
idstringOptional

Template identifier. Use it as template_id when sending a message.

namestringOptional
accountstringOptional

Owner account (informational).

statusbooleanOptional

Always true; only active templates are listed.

typeenumOptional
RCS content type. The agent's type must match the template's type when sending.
Allowed values:
created_atdatetimeOptional
updated_atdatetimeOptional
templatemap from strings to any or list of maps from strings to anyOptional

Template structure. Object { text, suggestions? } for BASIC; array of cards (richCard with standaloneCard or carouselCard) for SINGLE; array of contents with contentInfo and suggestions for CONVERSATIONAL. Placeholders {{...}} are the variables to provide when sending, except {{UUID_MESSAGE}}, which is internal.

examplemap from strings to anyOptional

Ready-to-use body for POST /v1/rcs/messages; substitute AGENT_ID with a real agent of the same type as the template.

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error