Send RCS (Carrossel) Message

POST

/messages/rcs/carousel/send

Este endpoint permite o envio de mensagens RCS (Rich Communication Services) no formato de carrossel, com múltiplos cards interativos. Cada card pode conter uma imagem, título, descrição e botões com links que direcionam o usuário para páginas externas ou ações específicas. É ideal para campanhas promocionais, vitrines de produtos, notificações dinâmicas e experiências mais ricas de engajamento via RCS.

Ao chamar este endpoint, você pode definir o público-alvo por números de telefone diretos e/ou grupos de contatos, personalizar o agendamento da entrega e aplicar uma tag de rastreamento para fins analíticos. As imagens dos cards são automaticamente processadas e preparadas para envio.

Request

Authorization

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Body Params application/json

Examples

Responses

🟢200Success

application/json

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/messages/rcs/carousel/send' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "receivers": [
        5516988887777
    ],
    "contactGroups": [],
    "message": "salve from API",
    "route": 14,
    "tag": "API-sending",
    "custom": "123-abc",
    "cards": [
        {
            "cardImage": "https://img.freepik.com/free-vector/gradient-beautiful-landscape_23-2149122377.jpg",
            "cardTitle": "Salve from API 0",
            "cardMessage": "Imagem envia pelo Postman 0",
            "buttons": [
                {
                    "text": "sem url"
                },
                {
                    "text": "com url",
                    "url": "https://comtele.com.br"
                }
            ]
        },
        {
            "cardImage": "https://img.freepik.com/free-vector/hand-drawn-cartoon-wizard-illustration_52683-147516.jpg",
            "cardTitle": "Salve from API 1",
            "cardMessage": "Imagem envia pelo Postman 1",
            "buttons": [
                {
                    "text": "sem url"
                },
                {
                    "text": "com url",
                    "url": "https://comtele.com.br"
                }
            ]
        }
    ]
}'

Response Example

{
    "hasError": true,
    "message": "string",
    "totalRecords": 0,
    "errors": [
        "string"
    ],
    "object": null
}

Modified at 2025-11-06 13:37:32

Send RCS (File) Message

Send RCS (Card) Message