Referencia de la API

RCS

Envía mensajes RCS con respaldo por SMS, lista los envíos del entorno de tu clave y consulta por qué canal llegó de verdad cada mensaje al dispositivo.

3 operaciones
URL basehttps://api.messages.ccxcompany.co
AutenticaciónBearer con tu clave de API

El texto técnico de abajo viene del contrato público, openapi.json, en el idioma en que se escribió el contrato.

Lista mensagens RCS

GET/v2/rcs/messages

As mensagens da sua organização, mais recentes primeiro. O ambiente vem da credencial: uma chave de sandbox lista só o que saiu no sandbox.

Permissão: rcs:read.

Parámetros

Campo	Dónde	Tipo	Descripción
`status`opcional	query	`string`	Valores:`queuedsentdeliveredreadfailed`
`channel`opcional	query	`string`	Valores:`rcssms`
`campaignId`opcional	query	`string`
`limit`opcional	query	`integer`

Respuestas

200Default Response

Campos y ejemplo de la respuesta

Campo	Tipo	Descripción
`items`obligatorio	`object[]`
`items[].id`obligatorio	`string`
`items[].to`obligatorio	`string`
`items[].content`obligatorio	`object`
`items[].content.text`opcional	`string`
`items[].content.card`opcional	`object`
`items[].route`obligatorio	`string`	Valores:`easy_rcseasy_otp_rcs`
`items[].status`obligatorio	`string`	Valores:`queuedsentdeliveredreadfailed`
`items[].channel`opcional	`string`	Valores:`rcssms`
`items[].env`obligatorio	`string`	Valores:`livetest`
`items[].contactId`opcional	`string`
`items[].campaignId`opcional	`string`
`items[].metadata`opcional	`object`	Metadados de correlação do seu sistema (ex.: customerId, journeyId), devolvidos intactos em todo webhook desta mensagem. Até 20 chaves; chave começa por letra e usa [A-Za-z0-9_.-] (até 64); valor é texto (até 256), número ou booleano. Não envie dado pessoal aqui.
`items[].failureReason`opcional	`string`
`items[].sentAt`opcional	`string · date-time`
`items[].deliveredAt`opcional	`string · date-time`
`items[].readAt`opcional	`string · date-time`
`items[].createdAt`obligatorio	`string · date-time`
`nextCursor`opcional	`string`

JSON

{  "items": [    {      "id": "string",      "to": "string",      "content": {        "text": "string"      },      "route": "easy_rcs",      "status": "queued",      "channel": "rcs",      "env": "live",      "contactId": "string",      "campaignId": "string",      "metadata": {},      "failureReason": "string",      "sentAt": "2026-10-16T12:00:00.000Z",      "deliveredAt": "2026-10-16T12:00:00.000Z",      "readAt": "2026-10-16T12:00:00.000Z",      "createdAt": "2026-10-16T12:00:00.000Z"    }  ],  "nextCursor": "string"}

401RFC 7807 problem details for UNAUTHORIZED (401).
403RFC 7807 problem details for FORBIDDEN (403).

Las respuestas de error siguen el formato RFC 7807 (application/problem+json), con un código estable en el campo code. Ver los códigos de error

Ejemplo en curl

cURL

curl 'https://api.messages.ccxcompany.co/v2/rcs/messages' \  -H "Authorization: Bearer $CCX_API_KEY"

Solo los campos obligatorios. Cambia los valores de ejemplo por los tuyos.

Envio síncrono: a resposta chega depois de o provedor aceitar (ou recusar). A entrega é assíncrona e chega no seu webhook como rcs.delivered, rcs.read ou rcs.failed (com data.channel dizendo se saiu por RCS ou pelo fallback de SMS).

`Idempotency-Key` é obrigatória. Repetir a chave com o mesmo corpo devolve a resposta original e não envia nada; corpo diferente é 409.

Conteúdo — dois formatos, e o campo escolhe a rota interna:

`content`	vira
`{ "text": "…" }`	mensagem simples, até 160 caracteres
`{ "card": { … } }`	cartão com título, descrição, imagem e até 4 botões

Botões (suggestions) aceitam openUrl, call e reply. fileUrl precisa ser HTTPS em domínio público — o aparelho baixa a mídia direto.

Fallback para SMS — o RCS não chega em todo aparelho. Quando você declara fallback, quem não tem RCS recebe um SMS com aquele texto; sem `fallback`, essa pessoa não recebe nada. O texto do fallback é limitado a 160 caracteres sem acentos: acento leva o SMS para UCS-2 e muda o que ele custa.

Canal do desfecho: a resposta traz channel só depois que o provedor informa por onde a mensagem saiu (rcs ou sms). No aceite ele vem ausente — e ausente significa "ainda não se sabe", nunca "foi por RCS".

Ambiente: vem da credencial, nunca do corpo.

Preço: cobrado por MENSAGEM (não por segmento, como o SMS): um cartão longo custa o mesmo que um texto curto. Rotas: easy_rcs e easy_otp_rcs (Cl. 8.7). Saldo insuficiente é 402.

Opt-out: na rota easy_rcs, destinatário cujo contato pediu para não receber comunicação é recusado com 422 e meta.motivo: "opt_out". easy_otp_rcs é transacional e sai sempre.

Permissão: rcs:send.

Cuerpo de la petición`application/json`

Campo	Tipo	Descripción
`to`obligatorio	`string`
`content`obligatorio	`object`	Conteúdo: `{text}` para mensagem simples (até 160) ou `{card}` para cartão com imagem e até 4 botões.
`content.text`opcional	`string`
`content.card`opcional	`object`
`content.card.title`obligatorio	`string`
`content.card.description`obligatorio	`string`
`content.card.fileUrl`opcional	`string · uri`
`content.card.suggestions`opcional	`object[]`
`route`obligatorio	`string`	Rota tarifária (obrigatória): easy_rcs \| easy_otp_rcs.Valores:`easy_rcseasy_otp_rcs`
`fallback`opcional	`object`	Texto enviado por SMS quando o aparelho não suporta RCS. Sem ele, o destinatário sem RCS não recebe nada.
`fallback.text`obligatorio	`string`
`contactId`opcional	`string`
`campaignId`opcional	`string`
`metadata`opcional	`object`	Metadados de correlação do seu sistema (ex.: customerId, journeyId), devolvidos intactos em todo webhook desta mensagem. Até 20 chaves; chave começa por letra e usa [A-Za-z0-9_.-] (até 64); valor é texto (até 256), número ou booleano. Não envie dado pessoal aqui.
`trackLinks`opcional	`boolean`	true troca as URLs do texto e dos botões openUrl por links curtos e publica `rcs.clicked` a cada clique. `fileUrl` não é trocada.

Ejemplo completo del cuerpo

JSON

{  "to": "string",  "content": {    "text": "string"  },  "route": "easy_rcs",  "fallback": {    "text": "string"  },  "contactId": "string",  "campaignId": "string",  "metadata": {},  "trackLinks": true}

Respuestas

201Default Response

Campos y ejemplo de la respuesta

Campo	Tipo	Descripción
`id`obligatorio	`string`
`to`obligatorio	`string`
`content`obligatorio	`object`
`content.text`opcional	`string`
`content.card`opcional	`object`
`content.card.title`obligatorio	`string`
`content.card.description`obligatorio	`string`
`content.card.fileUrl`opcional	`string · uri`
`content.card.suggestions`opcional	`object[]`
`route`obligatorio	`string`	Valores:`easy_rcseasy_otp_rcs`
`status`obligatorio	`string`	Valores:`queuedsentdeliveredreadfailed`
`channel`opcional	`string`	Valores:`rcssms`
`env`obligatorio	`string`	Valores:`livetest`
`contactId`opcional	`string`
`campaignId`opcional	`string`
`metadata`opcional	`object`	Metadados de correlação do seu sistema (ex.: customerId, journeyId), devolvidos intactos em todo webhook desta mensagem. Até 20 chaves; chave começa por letra e usa [A-Za-z0-9_.-] (até 64); valor é texto (até 256), número ou booleano. Não envie dado pessoal aqui.
`failureReason`opcional	`string`
`sentAt`opcional	`string · date-time`
`deliveredAt`opcional	`string · date-time`
`readAt`opcional	`string · date-time`
`createdAt`obligatorio	`string · date-time`

JSON

{  "id": "string",  "to": "string",  "content": {    "text": "string"  },  "route": "easy_rcs",  "status": "queued",  "channel": "rcs",  "env": "live",  "contactId": "string",  "campaignId": "string",  "metadata": {},  "failureReason": "string",  "sentAt": "2026-10-16T12:00:00.000Z",  "deliveredAt": "2026-10-16T12:00:00.000Z",  "readAt": "2026-10-16T12:00:00.000Z",  "createdAt": "2026-10-16T12:00:00.000Z"}

400RFC 7807 problem details for BAD_REQUEST (400).
401RFC 7807 problem details for UNAUTHORIZED (401).
402RFC 7807 problem details for PAYMENT_REQUIRED (402).
403RFC 7807 problem details for FORBIDDEN (403).
409RFC 7807 problem details for CONFLICT (409).
412RFC 7807 problem details for PRECONDITION_FAILED (412).
422RFC 7807 problem details for VALIDATION_ERROR (422).
502RFC 7807 problem details for DEPENDENCY_FAILED (502).
503RFC 7807 problem details for SERVICE_UNAVAILABLE (503).

Las respuestas de error siguen el formato RFC 7807 (application/problem+json), con un código estable en el campo code. Ver los códigos de error

Ejemplo en curl

cURL

curl -X POST 'https://api.messages.ccxcompany.co/v2/rcs/messages' \  -H "Authorization: Bearer $CCX_API_KEY" \  -H "Idempotency-Key: order-4821" \  -H "Content-Type: application/json" \  -d '{    "to": "string",    "content": {      "text": "string"    },    "route": "easy_rcs"  }'

Solo los campos obligatorios. Cambia los valores de ejemplo por los tuyos.

Consulta uma mensagem RCS

GET/v2/rcs/messages/{id}

O estado atual de um envio, incluindo o channel por onde ele de fato saiu quando o provedor já informou.

Permissão: rcs:read.

Parámetros

Campo	Dónde	Tipo	Descripción
`id`obligatorio	ruta	`string`

Respuestas

200Default Response

Campos y ejemplo de la respuesta

Campo	Tipo	Descripción
`id`obligatorio	`string`
`to`obligatorio	`string`
`content`obligatorio	`object`
`content.text`opcional	`string`
`content.card`opcional	`object`
`content.card.title`obligatorio	`string`
`content.card.description`obligatorio	`string`
`content.card.fileUrl`opcional	`string · uri`
`content.card.suggestions`opcional	`object[]`
`route`obligatorio	`string`	Valores:`easy_rcseasy_otp_rcs`
`status`obligatorio	`string`	Valores:`queuedsentdeliveredreadfailed`
`channel`opcional	`string`	Valores:`rcssms`
`env`obligatorio	`string`	Valores:`livetest`
`contactId`opcional	`string`
`campaignId`opcional	`string`
`metadata`opcional	`object`	Metadados de correlação do seu sistema (ex.: customerId, journeyId), devolvidos intactos em todo webhook desta mensagem. Até 20 chaves; chave começa por letra e usa [A-Za-z0-9_.-] (até 64); valor é texto (até 256), número ou booleano. Não envie dado pessoal aqui.
`failureReason`opcional	`string`
`sentAt`opcional	`string · date-time`
`deliveredAt`opcional	`string · date-time`
`readAt`opcional	`string · date-time`
`createdAt`obligatorio	`string · date-time`

JSON

{  "id": "string",  "to": "string",  "content": {    "text": "string"  },  "route": "easy_rcs",  "status": "queued",  "channel": "rcs",  "env": "live",  "contactId": "string",  "campaignId": "string",  "metadata": {},  "failureReason": "string",  "sentAt": "2026-10-16T12:00:00.000Z",  "deliveredAt": "2026-10-16T12:00:00.000Z",  "readAt": "2026-10-16T12:00:00.000Z",  "createdAt": "2026-10-16T12:00:00.000Z"}

401RFC 7807 problem details for UNAUTHORIZED (401).
403RFC 7807 problem details for FORBIDDEN (403).
404RFC 7807 problem details for NOT_FOUND (404).

Las respuestas de error siguen el formato RFC 7807 (application/problem+json), con un código estable en el campo code. Ver los códigos de error

Ejemplo en curl

cURL

curl 'https://api.messages.ccxcompany.co/v2/rcs/messages/<id>' \  -H "Authorization: Bearer $CCX_API_KEY"

Solo los campos obligatorios. Cambia los valores de ejemplo por los tuyos.

¿Atascado en una ruta? Habla con quienes mantienen la API.

Empieza gratis Habla con ventas

Si creas la cuenta desde la web, recibes 5 US$ de crédito de prueba.

RCS

Lista mensagens RCS

Parámetros

Respuestas

Ejemplo en curl

Envia uma mensagem RCS

Cuerpo de la petición`application/json`

Respuestas

Ejemplo en curl

Consulta uma mensagem RCS

Parámetros

Respuestas

Ejemplo en curl

Otras áreas de la API

¿Atascado en una ruta? Habla con quienes mantienen la API.

RCS

Lista mensagens RCS

Parámetros

Respuestas

Ejemplo en curl

Envia uma mensagem RCS

Cuerpo de la peticiónapplication/json

Respuestas

Ejemplo en curl

Consulta uma mensagem RCS

Parámetros

Respuestas

Ejemplo en curl

Otras áreas de la API

¿Atascado en una ruta? Habla con quienes mantienen la API.

Cuerpo de la petición`application/json`