Quick Start - Notifique

Do zero ao primeiro RCS na fila em poucos passos. Comece com sk_test_... no Sandbox. Nem todo aparelho recebe RCS, tenha SMS como plano B.

Em poucas palavras

Envie RCS para um ou vários números em formato internacional (E.164, sem +).
Consulte um envio pelo id retornado na resposta.
Cancele só enquanto estiver QUEUED ou SCHEDULED.

Cada mensagem RCS consome 60 créditos. Contexto: Introdução. Escopos: Escopos da API Key.

Antes de começar

Chave com rcs:send (e rcs:read / rcs:cancel se for consultar ou cancelar)
Números em E.164 (ex.: 5511999999999, sem +)
Autenticação: Authorization: Bearer sk_live_... ou x-api-key
Base URL: https://api.notifique.dev

1. Enviar RCS

Dois caminhos, escolha o que combina com sua integração:

1A, Pelo painel

RCS → Novo envio
Escolha o tipo (BASIC, CARD, etc.) e preencha o conteúdo
Informe o(s) número(s) e dispare

1B, Pela API

to é sempre um array (até 100 destinatários). Uma mensagem é criada por número.

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

{
  "to": ["5511999999999"],
  "type": "basic",
  "payload": {
    "message": "Olá! Este é um RCS de teste com texto simples."
  }
}

Resposta esperada: 202

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

messageIds é o campo canônico; rcsIds é alias de compatibilidade. Escopo: rcs:send.

Enviar com template

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

Referência: template-api. type em minúsculo é o campo canônico. O alias messageType em MAIÚSCULO (ex.: "BASIC") continua aceito. Agendar, inclua "schedule": { "sendAt": "2026-12-31T14:00:00.000Z" } (depende do plano). Em options: priority, webhook (url + secret) só para esse envio, metadata.

2. Outros tipos (CARD, CAROUSEL, FILE)

Altere type e o payload. Exemplo CARD:

{
  "to": ["5511999999999"],
  "type": "card",
  "payload": {
    "message": "Confira nossa promoção",
    "cardImage": "https://seusite.com/imagem.jpg",
    "cardTitle": "Oferta especial",
    "cardMessage": "Válida até domingo",
    "buttons": [
      { "text": "Ver oferta", "url": "https://seusite.com/promo" }
    ]
  }
}

Payloads de CAROUSEL e FILE: referência da API na aba RCS.

3. Consultar status

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

Resposta esperada: 200

{
  "success": true,
  "data": {
    "rcsId": "clrcs1...",
    "to": "5511999999999",
    "messageType": "BASIC",
    "status": "DELIVERED",
    "sentAt": "2025-02-20T14:00:00.000Z",
    "deliveredAt": "2025-02-20T14:00:30.000Z"
  }
}

Escopo: rcs:read.

4. Cancelar

Só com status QUEUED ou SCHEDULED:

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

Se já estiver SENT ou DELIVERED, a API retorna 400. Créditos do agendamento voltam para o workspace quando aplicável. Escopo: rcs:cancel.

5. Evitar duplicata

Header Idempotency-Key no POST de envio. Repetições em até 24 h não criam dois envios iguais. Veja Segurança e confiabilidade.

6. Webhooks (opcional)

Configure rcs.sent, rcs.delivered, rcs.clicked, rcs.failed e rcs.cancelled para acompanhar sem polling. Guia: Eventos dos webhooks.

Todos os tipos de envio

Na referência da API (aba RCS), abra Enviar RCS (POST /v1/...) e escolha o exemplo no playground: Basic, Card, Carrossel, Arquivo, Template, Agendado.

Próximos passos

Introdução: quando usar e tipos de mensagem
Escopos: permissões da chave
Eventos dos webhooks: status em tempo real
Respostas de erro: códigos HTTP e code

​Em poucas palavras

​Antes de começar

​1. Enviar RCS

​1A, Pelo painel

​1B, Pela API

​Enviar com template

​2. Outros tipos (CARD, CAROUSEL, FILE)

​3. Consultar status

​4. Cancelar

​5. Evitar duplicata

​6. Webhooks (opcional)

​Todos os tipos de envio

​Próximos passos

Em poucas palavras

Antes de começar

1. Enviar RCS

1A, Pelo painel

1B, Pela API

Enviar com template

2. Outros tipos (CARD, CAROUSEL, FILE)

3. Consultar status

4. Cancelar

5. Evitar duplicata

6. Webhooks (opcional)

Todos os tipos de envio

Próximos passos