Skip to navigation
RCSTemplates

Get template variables preview

Returns the variables the template requires — with an example value per variable — plus a body_example ready to use in POST /v1/rcs/messages. Useful to build a send form dynamically without parsing the template structure.

The type of each variable is inferred from where it appears in the template: variables placed in fileUrl, thumbnailUrl, iconUrl, or url are of type URL (they must be valid http/https URLs and the referenced media is validated with a real HEAD request — MIME type and size); any other variable is free TEXT.

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

Variables required by the template and example send body.
template_idstringOptional
typeenumOptional
RCS content type. The agent's type must match the template's type when sending.
Allowed values:
variablesmap from strings to stringsOptional

Map { variable: example_value }. Empty {} if the template has no variables. URL-type variables (those placed in fileUrl/thumbnailUrl/iconUrl/url) show a URL example and must be valid http/https URLs when sending; the rest are free text.

body_examplemap from strings to anyOptional

Ready-to-use body for POST /v1/rcs/messages.

Errors

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