Create an RCS template

post

https://rcs-api.in.kaleyra.io/v1/{sid}/rcs/template

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

The Create Template API allows you to create a new RCS template that can be used in sending RCS messages.

Prerequisites

After you sign up, your account will be on the trial version. You must complete the KYC to access all the features in kaleyra.io.
Before you get started, Create an API Key. To view the API Key and the SID, see View API Key and SID.
To send any RCS messages, you must configure the RCS channel in the Kaleyra platform. To configure the RCS channel in your account, please contact your local Kaleyra representative.

Body Params

agent_number

string

required

Agent Number of the agent under which the template is created.

template_type

string

enum

required

Template type. 1 is Text, 3 is File, 4 is Rich Card Standalone, and 5 is Rich Card Carousel.

Allowed:

template_name

string

required

length ≤ 20

Unique template name. Maximum 20 characters including alphanumeric characters and underscore. Space is not allowed.

text

string

length ≤ 2000

Text message to send to end users. Maximum 2000 characters. Conditional when template_type is 1.

status

string

enum

required

Template status. DRAFT can be edited. CREATED can be edited until ACTIVE. SUBMITTEDFORAPPROVAL indicates submission to the carrier. ACTIVE templates can be used for messaging and cannot be edited. FAILED and DELETED are documented workflow states.

Allowed:

contentMessage

object

Interactive content of the RCS message.

file

object

rich_card_standalone

object

rich_card_carousel

object

Headers

api-key

string

required

API key generated from the Kaleyra account.

Responses

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Prerequisites

200RCS Template created successfully.

400Bad request.

405Method not allowed.

500Internal Gateway Error.