Send Rich Card Standalone Message

POST Method

The Send Rich Card Standalone Message API request allows you to send a Rich Card Standalone message, which includes structured content such as a title, description, and media (image or video). Rich cards are visually engaging and ideal for showcasing products, services, or announcements in a compact, interactive format.

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.
  • Before sending the RCS, you must configure the RCS channel in the Kaleyra platform. To configure the RCS channel in your account, please contact your local Kaleyra representative.
  • You must have an approved AgentID or a specific number to be used as AgentID.

Base URL

https://rcs-api.<pod>.kaleyra.ai - For North America (NA).

https://rcs-api.<pod>.kaleyra.io - For rest of the world.

API Domain and Value

API request to send a Rich Card Standalone Message

To send a rich card standalone message, use the https://rcs-api.<pod>.kaleyra.ai/v1/<sid>/rcs/messages endpoint with the following request method:

Request Format

The following is the request format to send a rich card standalone message:

curl --location --request POST 'https://<api_domain>/v1/<sid>/rcs/messages'\
--header 'Content-Type:<Content-Type>'\
--header 'api-key: <api-key>'\
--data {
  "from": "<from>",
  "to": ["<to>"], 
  "richCardStandalone": {
    "cardOrientation": "<cardOrientation>",
    "content": {
      "title": "<title>",
      "description": "<description>",
      "media": {
        "height": "<height>",
        "file": {
          "fileUrl": "<fileUrl>",
          "thumbnailUrl": "<thumbnailUrl>",
          "contentDescription": "<contentDescription>"
        }
      },
      "suggestions": [
        {
          "reply": {
            "text": "<text>",
            "postbackData": "<postbackData>",
            "openUrlAction": {
              "url": "<url>"
            }
          }
        },
        {
          "action": {
            "text": "<text>",
            "postbackData": "<postbackData>",
            "openUrlAction": {
              "url": "<url>"
            }
          }
        }
      ]
    }
  }
}  

Sample Request Format

The following is the sample request format to send a rich card standalone message:

curl --location --request POST 'https://rcs-api.na.kaleyra.ai/v1/xxxxx6913850xxxx/rcs/messages'\
--header 'Content-Type: application/json'\ 
--header 'api-key: xxxxx3b8497f58a94e84b671aca43xxxx'\ 
--data {
  "from": "rcs-dev",
  "to": ["91915898XXXXX"],
  "richCardStandalone": {
    "cardOrientation": "VERTICAL",
    "content": {
      "title": "CIS Global Gateway",
      "description": "Testing Rich Business Messaging Capabilities",
      "media": {
        "height": "MEDIUM",
        "file": {
          "fileUrl": "https://live.staticflickr.com/65535/50835500798_32a9ed90e6_b.jpg",
          "thumbnailUrl": "https://live.staticflickr.com/65535/52221582411_c670670cf4.jpg",
          "contentDescription": "C634893 - caption"
        }
      }
    }
  }
}

URL Parameters and Headers

The following is the list of parameters and headers to send the outgoing message request:

Parameter/HeadersData TypeDescriptionExampleMandatory?
sidStringAccount SID (Security Identifier).xxxxx6913850xxxxYes
Content-TypeStringIndicates the format of the content the API will be processing.The only allowed value is application/JSONYes
api-keyStringAPI key generated from kaleyra.io account.xxxxx3b8497f58a94e84b671aca43xxxxYes

The following is the list of attributes to be used in the payload to send the messages:

ParameterData TypeDescriptionExampleMandatory?
fromStringThe service code unique to the RCS agent, specified when the RCS agent is created or onboarded. You can contact the RCS Provisioning Team for more details on unique service code.rcs-testYes
toArray of StringList of recipients’ device addresses (up to 100 allowed), a phone number in E.164 format prefixed with the country code without a plus sign used to contact the user.[9191588XXXXX]Yes
richCardStandaloneJSON ObjectContainer for rich card content.See the specific table for details.Yes

The following table describes the different attributes used for the richCardStandalone JSON object:

ParameterData TypeDescriptionExampleMandatory?
cardOrientationStringLayout orientation of the card (UNSPECIFIED, VERTICAL or HORIZONTAL).VERTICALYes
contentJSON ObjectThe content of the rich card.See the specific table for details.Yes

The following table describes the different attributes used for the content JSON object:

ParameterData TypeDescriptionExampleMandatory?
titleStringTitle of the rich card.CIS Global GatewayYes
descriptionStringDescription text of the rich card (2000 Unicode characters max.).Testing Rich Business Messaging CapabilitiesYes
mediaJSON ObjectMedia to be included in a rich card.See the specific table for details.No
suggestionsJSON ObjectList of chiplist items (quick replies or actions).See the specific table for details.No

The following table describes the different attributes used for the media JSON object:

ParameterData TypeDescriptionExampleMandatory?
heightStringHeight of the media (SHORT, MEDIUM, TALL).MEDIUMYes
fileJSON ObjectFile message content to send to the users’ device, typically an image, audio, or a video file.See the specific table for details.Yes

The following table describes the different attributes used for the file JSON object:

ParameterData TypeDescriptionExampleMandatory?
fileUrlStringPublic accessible URL of the media file (image or video).https://live.staticflickr.com/...jpgYes
thumbnailUrlStringPublic accessible URL of the thumbnail image.https://live.staticflickr.com/...jpgNo
contentDescriptionStringDescription of the media content for accessibility.C634893 - captionNo

The following table describes the different attributes used for the <suggestions> JSON object:

ParameterData TypeDescriptionExampleMandatory?
replyJSON ObjectContains the details of the reply chip.See the specific table for details.No
actionJSON ObjectContains the details of the action chip.See the specific table for details.No

The following table describes the different attributes used for the reply JSON object:

ParameterData TypeDescriptionExampleMandatory?
textStringText displayed on the reply chip.Thank you!Yes (if reply)
postbackDataStringData sent back to your system when the reply chip is clicked.more_infoYes (if reply)
buttonIdStringIdentifier for the reply button.01No

The following table describes the different attributes used for the action JSON object:

ParameterData TypeDescriptionExampleMandatory?
textStringText displayed on the action chip.Visit WebsiteYes (if action)
postbackDataStringData sent back to your system when the action chip is clicked.tata_comm_websiteYes (if action)
openUrlActionJSON ObjectContains the URL to be opened when the action chip is clicked.See the specific table for details.Yes (if action)

The following table describes the different attributes used for the openUrlAction JSON object:

ParameterData TypeDescriptionExampleMandatory?
urlStringA URL, as defined by RFC 2396 (4000 Unicode characters max.)https://www.tatacommunications.com/Yes (if action)

Sample Success Response

The following success message appears:

{
  "recipientDetails": [
    {
      "to": "9191588XXXXX",
      "messageId": "dc4cxxxx-xxxx-xxxx-xxxx-xxxx349a5e3d "
    }
  ]
}

The following examples illustrate typical success responses generated during the lifecycle of a message transmitted using the messaging platform. These responses represent key stages in message delivery, including successful submission to the carrier, delivery to the recipient's device, and confirmation of message read status. Each response includes metadata such as timestamps, message identifiers, and event types, which can be used for tracking and diagnostics.

Sent

The messages that are successfully submitted from Google to the carrier.

{ 
  "type": "SENT", 
  "eventId": "c8c3aa5d-1082-45a9-9f88-026c9XXXXX94", 
  "from": "9176739XXX02", 
  "to": "mmx_traffic", 
  "sentAt": "2025-06-16T13:46:38.929Z", 
  "messageId": "4543932d-c8f0-48c4-90bf-f9aXXXXXX2095f" 
} 

Delivered

The messages that are successfully delivered to the recipient's handset.

{ 
  "type": "DELIVERED", 
  "eventId": "MxfdhMDmfXXXXXQQBlrIGcIg", 
  "from": "91767XXXXXX2", 
  "to": "mmx_traffic", 
  "sentAt": "2025-06-16T13:46:41.295Z", 
  "messageId": "4543932d-c8f0-48c4-90bf-f9aXXXXX005f" 
} 

Read

The messages that have been read on the recipient's handset.

{ 
  "type": "READ", 
  "eventId": "MxZJragNjfT=qY4XXXXXYxcA", 
  "from": "917673XXXXX2", 
  "to": "mmx_traffic", 
  "sentAt": "2025-06-16T13:46:49.193Z", 
  "messageId": "4543932d-c8f0-48c4-90bf-f9aXXXXX005f" 
} 

Error

The messages that have been undelivered.


Sample Failure Response

The following failure message appears:

{
    "status": "ERROR",
    "errorText": "Error Message"
}





© 2025 Kaleyra Inc. All rights reserved.
Trademarks, logos and service marks displayed on this site are registered and unregistered trademarks of Kaleyra Inc.