Send Single Card Message

Overview

This API allows you to send an RCS message to an individual recipient, using an advance card template. The message can contain a single card with media, buttons, title, and description. It’s ideal for sending rich content, such as promotional offers, product updates, or alerts, to a user’s device.

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 a message using the provided template.

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 RCS message with a single card template:

Example Request Payload:

{
  "messaging_product": "rcs",
  "recipient_type": "individual",
  "to": "9198xxxxxxxx",
  "type": "advance",
  "template": {
    "name": "basicmessgage",
    "components": [
      {
        "cards": [
          {
            "title": "your_title",
            "description": "your_description",
            "media": {
              "height": "MEDIUM",
              "fileUrl": "https://your_image_path"
            },
            "buttons": [
              {
                "type": "url",
                "text": "link",
                "url": "https://example.com"
              },
              {
                "type": "call",
                "text": "call now",
                "number": "9198xxxxxxxx"
              }
            ]
          }
        ]
      }
    ]
  }
}

Field Description

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 the template. For an advanced 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 (e.g., cards, media, buttons).	N/A
template.components.cards	Array	An array of cards that make up the template. Each card can have a title, description, media, and buttons.	N/A
template.components.cards.title	String	The title of the card, typically a headline or product name.	"your_title"
template.components.cards.description	String	A short description of the card content (e.g., product details, promotional text).	"your_description"
template.components.cards.media	Object	Contains media details like image URL and height.	N/A
template.components.cards.media.height	String	Specifies the height of the media. Can be "SMALL", "MEDIUM", or "LARGE".	"MEDIUM"
template.components.cards.media.fileUrl	String	The URL of the image or media file that will be displayed in the card.	"https://your_image_path"
template.components.cards.buttons	Array	An array of buttons to be included in the card. Each button can be either a URL button or a call button.	N/A
template.components.cards.buttons.type	String	The type of button. It can be "url" (to open a link) or "call" (to initiate a call).	"url" or "call"
template.components.cards.buttons.text	String	The text displayed on the button (e.g., “link”, “call now”).	"link" or "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 call when the button type is "call".	"9198xxxxxxxx"

Success Response

If the message is successfully sent, you will receive a 200 OK HTTP status, along with details about the sent message.

Example Response:

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