Send Carousel Message

Overview

This API allows you to create and send advanced RCS templates with carousel configuration. The carousel template enables you to display multiple cards that users can swipe through. Each card can contain different content such as images, text, and interactive buttons. This template is ideal for showcasing multiple products, offers, or steps in a process.

API Endpoint

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

• {{your_domain}}: Replace this with your actual domain (e.g., pingtochat.com).
• {{key}}: Replace this with your API key.

HTTP Method

• POST: Used to send the basic message.

Headers

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

Request Payload

This is the JSON structure used to send the basic RCS message with no advanced components:

Example Request Payload:

{
  "messaging_product": "rcs",
  "recipient_type": "individual",
  "to": "9198xxxxxxxx",
  "type": "advance",
  "template": {
    "name": "basicmessage",
    "components": [
      {
        "cards": [
          {
            "title": "title_one",
            "description": "description_one",
            "media": {
              "height": "MEDIUM",
              "fileUrl": "https://example.com/image.png"
            },
            "buttons": [
              {
                "type": "url",
                "text": "link",
                "url": "https://example.com"
              },
              {
                "type": "call",
                "text": "call now",
                "number": "9198xxxxxxxx"
              }
            ]
          },
          {
            "title": "title_two",
            "description": "description_two",
            "media": {
              "height": "MEDIUM",
              "fileUrl": "https://example.com/image.png"
            },
            "buttons": [
              {
                "type": "url",
                "text": "link",
                "url": "https://example.com"
              },
              {
                "type": "call",
                "text": "call now",
                "number": "9198xxxxxxxx"
              }
            ]
          }
        ]
      }
    ]
  }
}

Field Descriptions:

Field Name	Type	Description	Example
messaging_product	String	Specifies the messaging product. Set to "rcs" for RCS messaging.	"rcs"
recipient_type	String	Defines the recipient type. Set to "individual" for sending messages to an individual user.	"individual"
to	String	The phone number of the recipient. This is where the message will be sent.	"9198xxxxxxxx"
type	String	Defines the type of template. For an advanced carousel template, this should be "advance".	"advance"
template	Object	Contains the template details for the message. Includes the template name and components (e.g., cards).	N/A
template.name	String	The name of the template, used for identification.	"basicmessage"
template.components	Array	An array containing the components of the message. In this case, it contains an array of cards.	N/A
template.components.cards	Array	Contains an array of cards, each representing a different part of the message (e.g., image, text, buttons).	N/A
template.components.cards.title	String	The title for the card, typically a heading or the name of the product/offer.	"title_one"
template.components.cards.description	String	A short description or content for the card (e.g., product details, promo description).	"description_one"
template.components.cards.media	Object	Contains media details like the image URL and height.	N/A
template.components.cards.media.height	String	Specifies the height of the media (e.g., "SMALL", "MEDIUM", or "LARGE").	"MEDIUM"
template.components.cards.media.fileUrl	String	The URL to the image or media content displayed on the card.	"https://example.com/image.png"
template.components.cards.buttons	Array	A list of buttons that are interactive on the card. Buttons can be of types "url" or "call".	N/A
template.components.cards.buttons.type	String	The type of button. This can either be "url" (to open a link) or "call" (to make a call).	"url", "call"
template.components.cards.buttons.text	String	The label text displayed on the button (e.g., "link", "call now")	"link", "call now"
template.components.cards.buttons.url	String	The URL to open when the button type is "url".	"https://example.com"
template.components.cards.buttons.number	String	The phone number to dial when the button type is "call".	"9198xxxxxxxx"

Success Response

If the template is successfully created, you will receive a 200 OK HTTP status, along with the details of the newly created template.

Example Response:

{
    "status": "success",
    "message": "Message send successfully",
    "transaction_id": "abcxxxxxxxx"
}