Gateway-API
  1. RCS
Gateway-API
  • Gateway - API
    • Contacts
      • List
    • Routes
      • Routes
    • Reports
      • Received Messages Report
      • Sent Messages Report
    • RCS
      • Send RCS (File) Message
        POST
      • Send RCS (Carrossel) Message
        POST
      • Send RCS (Card) Message
        POST
      • Send RCS (Basic) Message
        POST
    • SMS
      • Send SMS Message
    • Schemas
      • Core
        • CoreResult
      • Contacts
        • Contact
      • Routes
        • Routes
      • Reports
        • Received
        • Sent
      • RCS
        • Send RCS File
        • Send RCS Basic
        • Send RCS carousel
        • Send RCS card
      • SMS
        • Send Sms
  • Default module
    • Raiz
  1. RCS

Send RCS (Card) Message

POST
/messages/rcs/card/send
Este endpoint permite o envio de uma mensagem RCS com um card interativo, composto por imagem, título, mensagem e botões clicáveis. Ele é ideal para campanhas promocionais, avisos importantes, lançamentos de produtos ou qualquer comunicação que deseje combinar visual impactante com ações diretas.
Com esse recurso, é possível construir experiências de mensagem mais ricas e responsivas, melhorando a taxa de cliques e engajamento com o público. A imagem do card é automaticamente processada pela plataforma a partir de uma URL pública e incorporada à mensagem.

Request

Authorization
Add parameter in header
x-api-key
Example:
x-api-key: ********************
Body Params application/json

Examples

Responses

🟢200Success
application/json
Body

Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/messages/rcs/card/send' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "receivers": [5516988887777],
    "contactGroups": [],
    "message": "teste rcs Com foto",
    "route": 14,
    "tag": "API-sending",
    "custom": "123-abc",
    "cardImage": "https://img.freepik.com/free-vector/gradient-beautiful-landscape_23-2149122377.jpg",
    "cardTitle": "Salve from API 3",
    "cardMessage": "Imagem envia pelo APIDog",
    "buttons": [
        {
            "text": "sem url"
        },
        {
            "text": "com url",
            "url": "https://comtele.com.br"
        }
    ]
}'
Response Response Example
{
    "hasError": true,
    "message": "string",
    "totalRecords": 0,
    "errors": [
        "string"
    ],
    "object": null
}
Modified at 2025-11-06 13:39:45
Previous
Send RCS (Carrossel) Message
Next
Send RCS (Basic) Message
Built with