Single Template Creation

Overview

This API allows you to create RCS templates for rich communication services. These templates can contain multiple cards, each with a title, description, media content, and buttons. The API is helpful for businesses that want to send rich, interactive messages to users via platforms that support RCS.

API Endpoint

POST https://{{your_domain}}/api/v1.0/{{key}}/rcs_templates

URL Parameters:

• {{key}}: The account key in the URL should be replaced with your actual account key. .

HTTP Method

• POST: This method is used to send the data to create a new RCS template.

Headers

• Content-Type: application/json
• Authorization: Bearer <your_access_token> Replace <your_access_token> with your actual Bearer token for authentication.

Request Payload

The request body should be a JSON object containing the RCS template details. Below is an example of the JSON payload for creating a new RCS template:

Example Request Payload:

{
  "name": "template_name",
  "type": "advance",
  "advance_types": "single",
  "orientation": "vertical",
  "components": [
    {
      "cards": [
        {
          "title": "your_title",
          "description": "your_description",
          "media": {
            "height": "MEDIUM",
            "fileUrl": "https://your_file_path"
          },
          "buttons": [
            {
              "type": "url",
              "text": "link",
              "url": "https://example.com"
            },
            {
              "type": "call",
              "text": "call now",
              "number": "9198xxxxxxxx"
            }
          ]
        }
      ]
    }
  ]
}

Field Descriptions:

Field Name	Type	Description
name	string	The name of the template, typically used for identification. Example: "rcs_template_one".
type	string	The type of template. It can be “advance” (for rich templates with media).
advance_types	string	Specifies the type of advance template. For example, “single”.
orientation	string	The orientation of the template. Can be “vertical” or “horizontal”.
components	array	An array containing the template components (e.g., cards).
cards	array	An array of cards in the template, each representing a message or content block.
title	string	The title of the card (e.g., "HI").
description	string	A description or content for the card (e.g., "This is a sample rcs description").
media	object	The media object for the card, containing the height and fileUrl.
height	string	Specifies the height of the media. Example: “MEDIUM”.
fileUrl	string	The URL to the media file to be included in the card. Example: image URL.
buttons	array	An array of buttons for interaction in the card (e.g., link, call).
type	string	The type of button, e.g., “url” (a link button) or “call” (a call button).
text	string	The text displayed on the button (e.g., "link", "call now").
url	string	The URL to be opened when the user clicks the button (for “url” type buttons).
number	string	The phone number to be called when the “call” button is clicked.

Success Response

If the template is created successfully, the server will return a 200 OK status with details of the created template.

Example Response:

{
    "id": "3232",
    "status": "PENDING",
    "type": "ADVANCE"
}