Quick Start

From zero to first RCS in the queue in a few steps. Start with sk_test_... in Sandbox. Not every device receives RCS — have SMS as plan B.

In short

Send RCS to one or more numbers in international format (E.164, no +)
Choose the type: basic, card, carousel, file, or template
(Optional) Pass from to send via branded agent
Query a send by the id returned in the response
Cancel only while QUEUED or SCHEDULED

Each RCS message costs 140 credits (BASIC) or 200 credits (CARD, CAROUSEL, FILE). Context: Introduction. Scopes: API Key scopes.

Before you start

Key with rcs:send (and rcs:read / rcs:cancel to query or cancel)
Numbers in E.164 (e.g. 5511999999999, no +)
Auth: Authorization: Bearer sk_live_... or x-api-key
Base URL: https://api.notifique.dev

1. Send RCS (text)

to is always an array (up to 500 recipients). One message is created per number.

POST /v1/rcs/messages
Content-Type: application/json
Authorization: Bearer sk_live_xxxxx

{
  "to": ["5511999999999"],
  "type": "basic",
  "payload": {
    "message": "Hello! This is a simple text RCS test."
  }
}

Expected response: 202

{
  "success": true,
  "data": {
    "status": "QUEUED",
    "count": 1,
    "messageIds": ["clrcs1..."]
  }
}

Use the first id in messageIds to query or cancel. Scope: rcs:send.

2. Other send types

On the API reference (RCS tab), open Send RCS and pick an example in the playground. Summary:

CARD (one card)

{
  "to": ["5511999999999"],
  "type": "card",
  "payload": {
    "cardImage": "https://cdn.example.com/rcs/offer.jpg",
    "cardTitle": "Special offer",
    "cardMessage": "Valid until Sunday. Don't miss it!",
    "buttons": [
      { "text": "View offer", "url": "https://example.com/promo" },
      { "text": "Not interested" }
    ]
  }
}

On CARD, use cardMessage for text. The message field is not shown to the recipient.

CAROUSEL (three cards)

{
  "to": ["5511999999999"],
  "type": "carousel",
  "payload": {
    "cards": [
      {
        "cardImage": "https://cdn.example.com/rcs/card-1.jpg",
        "cardTitle": "Option 1",
        "cardMessage": "First card description.",
        "buttons": [{ "text": "Choose 1" }]
      },
      {
        "cardImage": "https://cdn.example.com/rcs/card-2.jpg",
        "cardTitle": "Option 2",
        "cardMessage": "Second card description.",
        "buttons": [{ "text": "Choose 2" }]
      },
      {
        "cardImage": "https://cdn.example.com/rcs/card-3.jpg",
        "cardTitle": "Option 3",
        "cardMessage": "Third card description.",
        "buttons": [{ "text": "Choose 3", "url": "https://example.com/option-3" }]
      }
    ]
  }
}

FILE

{
  "to": ["5511999999999"],
  "type": "file",
  "payload": {
    "message": "Here is the attached document.",
    "file": "https://cdn.example.com/rcs/contract.pdf",
    "fileName": "contract.pdf"
  }
}

Workspace template

{
  "to": ["5511999999999"],
  "type": "template",
  "payload": {
    "templateId": "TEMPLATE_ID",
    "variables": { "name": "Maria", "code": "482910" }
  }
}

With branded agent (`from`)

{
  "from": "inst_rcs_abc123",
  "to": ["5511999999999"],
  "type": "card",
  "payload": {
    "cardImage": "https://cdn.example.com/rcs/offer.jpg",
    "cardTitle": "Brand offer",
    "cardMessage": "Exclusive for you.",
    "buttons": [{ "text": "Buy", "url": "https://example.com/buy" }]
  }
}

Instance must be ACTIVE. Full guide: RCS instances. Use lowercase type: basic, card, carousel, file, or template. messageType is accepted as a legacy alias. Schedule: include "schedule": { "sendAt": "2026-12-31T14:00:00.000Z" } (plan-dependent). In options: priority, webhook (url + secret) for this send only, metadata.

3. List history

GET /v1/rcs/messages?page=1&limit=20
Authorization: Bearer sk_live_xxxxx

Optional filters: status (comma-separated), to, fromDate, toDate. Scope: rcs:read.

4. Query status and sent content

Send POST only returns messageIds and status (202). To see what was sent (payload, messageType, refer), query by id:

GET /v1/rcs/messages/:id
Authorization: Bearer sk_live_xxxxx

Expected response: 200

{
  "success": true,
  "data": {
    "rcsId": "clrcs1...",
    "to": "5511999999999",
    "messageType": "CARD",
    "payload": {
      "message": "",
      "cardImage": "https://cdn.example.com/rcs/offer.jpg",
      "cardTitle": "Special offer",
      "cardMessage": "Valid until Sunday.",
      "buttons": [{ "text": "View offer", "url": "https://example.com/promo" }]
    },
    "refer": "order-123",
    "status": "DELIVERED",
    "sentAt": "2025-02-20T14:00:05.000Z",
    "deliveredAt": "2025-02-20T14:00:30.000Z"
  }
}

List (GET /v1/rcs/messages) also includes payload on each item. Scope: rcs:read.

5. List inbound replies

GET /v1/rcs/inbound?linked=true
Authorization: Bearer sk_live_xxxxx

Returns MO linked to outbound sends (relatedRcsLogId). Detail: GET /v1/rcs/inbound/:id — relatedRcsLog has the same detail level as GET /v1/rcs/messages/:id (rcsId, messageType, payload, status, and delivery timestamps).

6. Cancel

Only with status QUEUED or SCHEDULED:

POST /v1/rcs/messages/:id/cancel
Authorization: Bearer sk_live_xxxxx

If already SENT or DELIVERED, the API returns 400. Scheduled credits are refunded when applicable. Scope: rcs:cancel.

7. Avoid duplicates

Idempotency-Key header on send POST. Repeats within 24 h do not create duplicate sends. See Security and reliability.

8. Webhooks (optional)

Configure rcs.sent, rcs.delivered, rcs.clicked, rcs.failed, and rcs.cancelled to track without polling. Guide: Webhook events.

Next steps

Introduction: when to use and message types
RCS instances: branded agent
Scopes: key permissions
Webhook events: real-time status
Error responses: HTTP codes and code

RCS API

Mensagens

Instâncias

Inbound

In short

Before you start

1. Send RCS (text)

2. Other send types

CARD (one card)

CAROUSEL (three cards)

FILE

Workspace template

With branded agent (`from`)

3. List history

4. Query status and sent content

5. List inbound replies

6. Cancel

7. Avoid duplicates

8. Webhooks (optional)

Next steps

​In short

​Before you start

​1. Send RCS (text)

​2. Other send types

​CARD (one card)

​CAROUSEL (three cards)

​FILE

​Workspace template

​With branded agent (from)

​3. List history

​4. Query status and sent content

​5. List inbound replies

​6. Cancel

​7. Avoid duplicates

​8. Webhooks (optional)

​Next steps

In short

Before you start

1. Send RCS (text)

2. Other send types

CARD (one card)

CAROUSEL (three cards)

FILE

Workspace template

With branded agent (`from`)

3. List history

4. Query status and sent content

5. List inbound replies

6. Cancel

7. Avoid duplicates

8. Webhooks (optional)

Next steps