Quick Start

Del cero al primer RCS en cola en pocos pasos. Empiece con sk_test_... en Sandbox. No todo dispositivo recibe RCS — tenga SMS como plan B.

En pocas palabras

Envíe RCS a uno o varios números en formato internacional (E.164, sin +)
Elija el tipo: basic, card, carousel, file o template
(Opcional) Informe from para enviar por agente de marca
Consulte un envío por el id retornado en la respuesta
Cancele solo mientras esté QUEUED o SCHEDULED

Cada mensaje RCS consume 140 créditos (BASIC) o 200 créditos (CARD, CAROUSEL, FILE). Contexto: Introducción. Ámbitos: Ámbitos de la API Key.

Antes de empezar

Clave con rcs:send (y rcs:read / rcs:cancel si va a consultar o cancelar)
Números en E.164 (ej.: 5511999999999, sin +)
Autenticación: Authorization: Bearer sk_live_... o x-api-key
URL base: https://api.notifique.dev

1. Enviar RCS (texto)

to es siempre un array (hasta 500 destinatarios). Se crea un mensaje por número.

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

{
  "to": ["5511999999999"],
  "type": "basic",
  "payload": {
    "message": "¡Hola! Este es un RCS de prueba con texto simple."
  }
}

Respuesta esperada: 202

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

Use el primer id de messageIds para consultar o cancelar. Ámbito: rcs:send.

2. Otros tipos de envío

En la referencia de la API (pestaña RCS), abra Enviar RCS y elija el ejemplo en el playground. Resumen:

CARD (una tarjeta)

{
  "to": ["5511999999999"],
  "type": "card",
  "payload": {
    "cardImage": "https://cdn.example.com/rcs/oferta.jpg",
    "cardTitle": "Oferta especial",
    "cardMessage": "Válida hasta el domingo. ¡Aproveche!",
    "buttons": [
      { "text": "Ver oferta", "url": "https://example.com/promo" },
      { "text": "No me interesa" }
    ]
  }
}

En CARD, use cardMessage para el texto. El campo message no se muestra al destinatario.

CAROUSEL (tres tarjetas)

{
  "to": ["5511999999999"],
  "type": "carousel",
  "payload": {
    "cards": [
      {
        "cardImage": "https://cdn.example.com/rcs/card-1.jpg",
        "cardTitle": "Opción 1",
        "cardMessage": "Descripción de la primera tarjeta.",
        "buttons": [{ "text": "Elegir 1" }]
      },
      {
        "cardImage": "https://cdn.example.com/rcs/card-2.jpg",
        "cardTitle": "Opción 2",
        "cardMessage": "Descripción de la segunda tarjeta.",
        "buttons": [{ "text": "Elegir 2" }]
      },
      {
        "cardImage": "https://cdn.example.com/rcs/card-3.jpg",
        "cardTitle": "Opción 3",
        "cardMessage": "Descripción de la tercera tarjeta.",
        "buttons": [{ "text": "Elegir 3", "url": "https://example.com/opcion-3" }]
      }
    ]
  }
}

FILE (archivo)

{
  "to": ["5511999999999"],
  "type": "file",
  "payload": {
    "message": "Adjunto el documento.",
    "file": "https://cdn.example.com/rcs/contrato.pdf",
    "fileName": "contrato.pdf"
  }
}

Plantilla del workspace

{
  "to": ["5511999999999"],
  "type": "template",
  "payload": {
    "templateId": "ID_DE_PLANTILLA",
    "variables": { "nombre": "María", "codigo": "482910" }
  }
}

Con agente de marca (`from`)

{
  "from": "inst_rcs_abc123",
  "to": ["5511999999999"],
  "type": "card",
  "payload": {
    "cardImage": "https://cdn.example.com/rcs/oferta.jpg",
    "cardTitle": "Oferta de la marca",
    "cardMessage": "Exclusivo para usted.",
    "buttons": [{ "text": "Comprar", "url": "https://example.com/comprar" }]
  }
}

La instancia debe estar ACTIVE. Guía completa: Instancias RCS. Use type en minúsculas: basic, card, carousel, file o template. messageType se acepta como alias legado. Programar: incluya "schedule": { "sendAt": "2026-12-31T14:00:00.000Z" } (depende del plan). En options: priority, webhook (url + secret) solo para ese envío, metadata.

3. Listar historial

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

Filtros opcionales: status (coma), to, fromDate, toDate. Ámbito: rcs:read.

4. Consultar estado y contenido enviado

El POST de envío solo devuelve messageIds y estado (202). Para ver lo enviado (payload, messageType, refer), consulte por id:

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

Respuesta esperada: 200

{
  "success": true,
  "data": {
    "rcsId": "clrcs1...",
    "to": "5511999999999",
    "messageType": "CARD",
    "payload": {
      "message": "",
      "cardImage": "https://cdn.example.com/rcs/oferta.jpg",
      "cardTitle": "Oferta especial",
      "cardMessage": "Válida hasta el domingo.",
      "buttons": [{ "text": "Ver oferta", "url": "https://example.com/promo" }]
    },
    "refer": "pedido-123",
    "status": "DELIVERED",
    "sentAt": "2025-02-20T14:00:05.000Z",
    "deliveredAt": "2025-02-20T14:00:30.000Z"
  }
}

El listado (GET /v1/rcs/messages) también trae payload en cada ítem. Ámbito: rcs:read.

5. Listar respuestas recibidas

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

Devuelve MO vinculados a envíos outbound (relatedRcsLogId). Detalle: GET /v1/rcs/inbound/:id — relatedRcsLog tiene el mismo nivel de detalle que GET /v1/rcs/messages/:id (rcsId, messageType, payload, estado y timestamps de entrega).

6. Cancelar

Solo con estado QUEUED o SCHEDULED:

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

Si ya está SENT o DELIVERED, la API devuelve 400. Los créditos del programado vuelven al workspace cuando aplica. Ámbito: rcs:cancel.

7. Evitar duplicados

Header Idempotency-Key en el POST de envío. Repeticiones en hasta 24 h no crean dos envíos iguales. Vea Seguridad y confiabilidad.

8. Webhooks (opcional)

Configure rcs.sent, rcs.delivered, rcs.clicked, rcs.failed y rcs.cancelled para seguir sin polling. Guía: Eventos de webhooks.

Próximos pasos

Introducción: cuándo usar y tipos de mensaje
Instancias RCS: agente de marca
Ámbitos: permisos de la clave
Eventos de webhooks: estado en tiempo real
Respuestas de error: códigos HTTP y code

API RCS

Mensagens

Instâncias

Inbound

En pocas palabras

Antes de empezar

1. Enviar RCS (texto)

2. Otros tipos de envío

CARD (una tarjeta)

CAROUSEL (tres tarjetas)

FILE (archivo)

Plantilla del workspace

Con agente de marca (`from`)

3. Listar historial

4. Consultar estado y contenido enviado

5. Listar respuestas recibidas

6. Cancelar

7. Evitar duplicados

8. Webhooks (opcional)

Próximos pasos

​En pocas palabras

​Antes de empezar

​1. Enviar RCS (texto)

​2. Otros tipos de envío

​CARD (una tarjeta)

​CAROUSEL (tres tarjetas)

​FILE (archivo)

​Plantilla del workspace

​Con agente de marca (from)

​3. Listar historial

​4. Consultar estado y contenido enviado

​5. Listar respuestas recibidas

​6. Cancelar

​7. Evitar duplicados

​8. Webhooks (opcional)

​Próximos pasos

En pocas palabras

Antes de empezar

1. Enviar RCS (texto)

2. Otros tipos de envío

CARD (una tarjeta)

CAROUSEL (tres tarjetas)

FILE (archivo)

Plantilla del workspace

Con agente de marca (`from`)

3. Listar historial

4. Consultar estado y contenido enviado

5. Listar respuestas recibidas

6. Cancelar

7. Evitar duplicados

8. Webhooks (opcional)

Próximos pasos