API reference

WhatsApp messages

Send WhatsApp messages (text, template, media or flow) from one of your numbers, list the history with filters and check the status of each send.

3 operations
Base URLhttps://api.messages.ccxcompany.co
AuthenticationBearer with your API key

The technical text below comes from the public contract, openapi.json, in the language the contract was written in.

List messages

GET/messages

Paginated list. Filters: status, numberId, contactId, campaignId, batchId, sentByAccountId, from, to, limit, skip. Default order is createdAt desc.

PII fields (recipient to) are masked unless the caller has pii:full.

Parameters

Field	In	Type	Description
`status`optional	query	`string`	Values:`queuedsendingsentdeliveredreadfailedarchived`
`numberId`optional	query	`string`	Branded Number id (`num_` prefix + 21 nano-id chars).
`contactId`optional	query	`string`	Branded Contact id (`cnt_` prefix + 21 nano-id chars).
`campaignId`optional	query	`string`	Filter by external campaign tag. Used by the dashboard to scope a 'reprocess all failures of this campaign' action.
`batchId`optional	query	`string`	Branded batch id (`btc_` prefix + 21 nano-id chars).
`sentByAccountId`optional	query	`string`	Filter by the operator who sent the message. Powers the dashboard's per-agent view, where every counter has to follow the selected attendant.
`from`optional	query	`string · date-time`	ISO-8601 timestamp in UTC.
`to`optional	query	`string · date-time`	ISO-8601 timestamp in UTC.
`limit`optional	query	`integer`
`skip`optional	query	`integer`

Responses

200Default Response

Response fields and example

Field	Type	Description
`items`required	`object[]`
`items[].id`required	`string`	Branded Message id (`msg_` prefix + 21 nano-id chars).
`items[].organizationId`required	`string`	Branded Organization id (`org_` prefix + 21 nano-id chars).
`items[].channel`optional	`string`	Canal da mensagem. Ausente em linhas antigas, anteriores ao campo — leia como `whatsapp`.Values:`whatsappemailsmsinstagram`
`items[].numberId`optional	`string`	Branded Number id (`num_` prefix + 21 nano-id chars).
`items[].instagramAccountId`optional	`string`	Branded Instagram account id (`iga_` prefix + 21 nano-id chars).
`items[].mediaStorage`optional	`object`
`items[].mediaStorage.mimeType`optional	`string`	Mime REAL do binário, lido do Content-Type.
`items[].mediaStorage.size`optional	`integer`
`items[].mediaStorage.storedAt`optional	`string · date-time`
`items[].contactId`optional	`string`	Branded Contact id (`cnt_` prefix + 21 nano-id chars).
`items[].campaignId`optional	`string`	Optional external campaign tag carried through from the create call. Surfaced as a filter on `GET /messages` and as a selector on `POST /messages/bulk-resend`.
`items[].metadata`optional	`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[].templateId`optional	`string`	Branded Template id (`tpl_` prefix + 21 nano-id chars).
`items[].batchId`optional	`string`	Branded batch id (`btc_` prefix + 21 nano-id chars).
`items[].to`required	`string`	Destino, no formato do canal: telefone E.164 (whatsapp/sms), endereço de e-mail (email) ou IGSID (instagram). PII_SENSITIVE — mascarado a menos que o chamador tenha `pii:full`.
`items[].type`required	`string`	Values:`texttemplatemediainteractive`
`items[].direction`required	`string`	Values:`outboundinbound`
`items[].priority`required	`string`	Values:`normalbulkcritical`
`items[].status`required	`string`	Values:`queuedsendingsentdeliveredreadfailedarchived`
`items[].force`required	`boolean`	When true the worker bypasses token bucket + quiet hours. Persisted for audit; only the `force` route sets it.
`items[].reprocessed`optional	`boolean`	True when a dashboard operator manually reprocessed this message. `replacedBy` points to the new message.
`items[].replacedBy`optional	`string`	Branded Message id (`msg_` prefix + 21 nano-id chars).
`items[].payload`required	`any`	Opaque per-type payload (text body, template ref, etc).
`items[].templateVars`optional	`string[]`
`items[].attempts`required	`integer`
`items[].lastError`optional	`string`	Most recent failure reason. After `cancelAsReprocessed` (or bulk-resend) this is overwritten with a 'substituted by ...' pointer string — see `originalError` for the underlying cause.
`items[].originalError`optional	`string`	Snapshot of `lastError` taken the first time the message is reprocessed. Audit-trail field — never overwritten on subsequent transitions.
`items[].metaMessageId`optional	`string`
`items[].origemDoLink`optional	`object`	De onde veio a mensagem que trouxe o código do link de WhatsApp (fonte, campanha, grupo, anúncio e palavra-chave do link) e o código que estava no texto. Só em mensagem recebida.
`items[].origemDoLink.fonte`optional	`string`	Values:`googlemetatiktokoutra`
`items[].origemDoLink.fonteRotulo`optional	`string`	O nome livre da fonte (`src=` do link) quando `fonte` é `outra`.
`items[].origemDoLink.campanha`optional	`string`
`items[].origemDoLink.grupo`optional	`string`
`items[].origemDoLink.anuncio`optional	`string`
`items[].origemDoLink.palavraChave`optional	`string`
`items[].origemDoLink.codigo`optional	`string`	O código que estava no texto, entre parênteses. O texto da mensagem não é alterado.
`items[].sentByAccountId`optional	`string`
`items[].sentByName`optional	`string`	Operator display name (when sent from the dashboard).
`items[].scheduledAt`optional	`string · date-time`	ISO-8601 timestamp in UTC.
`items[].sentAt`optional	`string · date-time`	ISO-8601 timestamp in UTC.
`items[].deliveredAt`optional	`string · date-time`	ISO-8601 timestamp in UTC.
`items[].readAt`optional	`string · date-time`	ISO-8601 timestamp in UTC.
`items[].failedAt`optional	`string · date-time`	ISO-8601 timestamp in UTC.
`items[].createdAt`required	`string · date-time`	ISO-8601 timestamp in UTC.
`items[].updatedAt`required	`string · date-time`	ISO-8601 timestamp in UTC.
`total`required	`integer`

JSON

{  "items": [    {      "id": "msg_aB3xY9zQ1pTkLmNoPqRsT",      "organizationId": "org_pGgniw5L7CTDSZDwjDrQ2",      "channel": "whatsapp",      "numberId": "num_aB3xY9zQ1pTkLmNoPqRsT",      "instagramAccountId": "iga_aB3xY9zQ1pTkLmNoPqRsT",      "mediaStorage": {        "mimeType": "string",        "size": 0,        "storedAt": "2026-10-16T12:00:00.000Z"      },      "contactId": "cnt_aB3xY9zQ1pTkLmNoPqRsT",      "campaignId": "string",      "metadata": {        "customerId": "123",        "journeyId": "reativacao-q4"      },      "templateId": "tpl_uV2aLwzXMqNmKjHbPiRoT",      "batchId": "btc_aB3xY9zQ1pTkLmNoPqRsT",      "to": "+5511999998888",      "type": "text",      "direction": "outbound",      "priority": "normal",      "status": "queued",      "force": true,      "reprocessed": true,      "replacedBy": "msg_aB3xY9zQ1pTkLmNoPqRsT",      "payload": null,      "templateVars": [        "string"      ],      "attempts": 0,      "lastError": "string",      "originalError": "string",      "metaMessageId": "wamid.HBgN...",      "origemDoLink": {        "fonte": "tiktok",        "fonteRotulo": "bio",        "campanha": "Verão",        "grupo": "Corredores SP",        "anuncio": "Corrida no parque",        "palavraChave": "tênis de corrida",        "codigo": "K7Q2X"      },      "sentByAccountId": "string",      "sentByName": "string",      "scheduledAt": "2026-04-07T17:30:00.000Z",      "sentAt": "2026-04-07T17:30:00.000Z",      "deliveredAt": "2026-04-07T17:30:00.000Z",      "readAt": "2026-04-07T17:30:00.000Z",      "failedAt": "2026-04-07T17:30:00.000Z",      "createdAt": "2026-04-07T17:30:00.000Z",      "updatedAt": "2026-04-07T17:30:00.000Z"    }  ],  "total": 42}

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

Error responses follow RFC 7807 (application/problem+json), with a stable code in the code field. See the error codes

curl example

cURL

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

Required fields only. Swap the sample values for your own.

Send a single outbound message

POST/messages

Persists the message + an outbox row in a single Mongo transaction, then attempts an inline Rabbit publish to messages.outbound with routing key matching the priority. Inline publish failures leave the outbox row pending — the worker poller (Step 19) drains stragglers.

Idempotency: optional. Send Idempotency-Key header (or idempotencyKey in the body — when both are present they MUST match) to make the call replayable for 24h. Same key + same fingerprint → original response is returned. Same key + different body → 409 IDEMPOTENCY_CONFLICT.

Priority routing:

critical → out.priority queue
normal → out.normal queue (default)
bulk → out.bulk queue

Corpo por `type` (o `payload` muda conforme o tipo):

text → { "type": "text", "payload": { "text": { "body": "Olá!" } } }
template → { "type": "template", "payload": { "template": { "name": "boas_vindas", "languageCode": "pt_BR", "components": [] } } } (ou envie templateId + templateVars e a plataforma materializa o template)
media (imagem) → { "type": "media", "payload": { "kind": "image", "media": { "link": "https://…/foto.jpg", "caption": "…" } } }
media (áudio) → { "type": "media", "payload": { "kind": "audio", "media": { "link": "https://…/audio.ogg" } } }
media (vídeo) → { "type": "media", "payload": { "kind": "video", "media": { "link": "https://…/video.mp4", "caption": "…" } } }
media (documento) → { "type": "media", "payload": { "kind": "document", "media": { "link": "https://…/fatura.pdf", "filename": "fatura.pdf" } } }
media (sticker) → { "type": "media", "payload": { "kind": "sticker", "media": { "link": "https://…/sticker.webp" } } }
interactive (flow) → { "type": "interactive", "payload": { "flow": { "metaFlowId": "123…", "flowCta": "Começar", "flowAction": "navigate", "headerText": "…", "bodyText": "…", "mode": "published" } } }

Em media, use media.link (URL pública) OU media.id (mídia já enviada à Meta). caption/filename são opcionais. replyTo (id de mensagem) é aceito em qualquer tipo.

Opt-out: template de MARKETING (templateId com categoria marketing) para contato que pediu para não receber comunicação é recusado com 422 e meta.motivo: "opt_out". Utilidade, autenticação e texto livre na janela de atendimento seguem saindo.

Always returns 201 once the transaction commits — the message IS in the system regardless of the inline publish outcome.

Request body`application/json`

Field	Type	Description
`numberId`required	`string`	Branded Number id (`num_` prefix + 21 nano-id chars).
`to`required	`string`	E.164 phone (recipient).
`type`required	`string`	Values:`texttemplatemediainteractive`
`priority`optional	`string`	Routing priority. Maps to `out.{critical\|normal\|bulk}` queues.Values:`normalbulkcritical`Default:`normal`
`payload`required	`object`	Corpo por tipo (validado ponta-a-ponta pelo worker contra @ccx/meta): `text` → { text: { body } }; `template` → informe templateId (+ templateVars) OU { template: { name, languageCode } }; `media` → { kind: image\|audio\|video\|document\|sticker, media: { link } }; `interactive` → { flow: { metaFlowId, flowCta } }.
`templateId`optional	`string`	Branded Template id (`tpl_` prefix + 21 nano-id chars).
`templateVars`optional	`string[]`
`contactId`optional	`string`	Branded Contact id (`cnt_` prefix + 21 nano-id chars).
`campaignId`optional	`string`	Optional campaign tag carried through to the persisted message. Used by `GET /messages?campaignId=...` and `POST /messages/bulk-resend` filters to scope retries to a single campaign.
`metadata`optional	`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.
`scheduledAt`optional	`string · date-time`	ISO-8601 timestamp in UTC.
`idempotencyKey`optional	`string`	Optional Stripe-style idempotency key. Also accepted via `Idempotency-Key` header — when both are present they MUST match (400 otherwise).

Full body example

JSON

{  "numberId": "num_aB3xY9zQ1pTkLmNoPqRsT",  "to": "+5511999998888",  "type": "text",  "priority": "normal",  "payload": {    "text": {      "body": "Olá! Mensagem de teste do CCX."    }  },  "templateId": "tpl_uV2aLwzXMqNmKjHbPiRoT",  "templateVars": [    "Alice",    "ORDER123"  ],  "contactId": "cnt_aB3xY9zQ1pTkLmNoPqRsT",  "campaignId": "string",  "metadata": {    "customerId": "123",    "journeyId": "reativacao-q4"  },  "scheduledAt": "2026-04-07T17:30:00.000Z",  "idempotencyKey": "checkout-12345"}

Responses

201Default Response

Response fields and example

Field	Type	Description
`id`required	`string`	Branded Message id (`msg_` prefix + 21 nano-id chars).
`organizationId`required	`string`	Branded Organization id (`org_` prefix + 21 nano-id chars).
`channel`optional	`string`	Canal da mensagem. Ausente em linhas antigas, anteriores ao campo — leia como `whatsapp`.Values:`whatsappemailsmsinstagram`
`numberId`optional	`string`	Branded Number id (`num_` prefix + 21 nano-id chars).
`instagramAccountId`optional	`string`	Branded Instagram account id (`iga_` prefix + 21 nano-id chars).
`mediaStorage`optional	`object`
`mediaStorage.mimeType`optional	`string`	Mime REAL do binário, lido do Content-Type.
`mediaStorage.size`optional	`integer`
`mediaStorage.storedAt`optional	`string · date-time`
`contactId`optional	`string`	Branded Contact id (`cnt_` prefix + 21 nano-id chars).
`campaignId`optional	`string`	Optional external campaign tag carried through from the create call. Surfaced as a filter on `GET /messages` and as a selector on `POST /messages/bulk-resend`.
`metadata`optional	`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.
`templateId`optional	`string`	Branded Template id (`tpl_` prefix + 21 nano-id chars).
`batchId`optional	`string`	Branded batch id (`btc_` prefix + 21 nano-id chars).
`to`required	`string`	Destino, no formato do canal: telefone E.164 (whatsapp/sms), endereço de e-mail (email) ou IGSID (instagram). PII_SENSITIVE — mascarado a menos que o chamador tenha `pii:full`.
`type`required	`string`	Values:`texttemplatemediainteractive`
`direction`required	`string`	Values:`outboundinbound`
`priority`required	`string`	Values:`normalbulkcritical`
`status`required	`string`	Values:`queuedsendingsentdeliveredreadfailedarchived`
`force`required	`boolean`	When true the worker bypasses token bucket + quiet hours. Persisted for audit; only the `force` route sets it.
`reprocessed`optional	`boolean`	True when a dashboard operator manually reprocessed this message. `replacedBy` points to the new message.
`replacedBy`optional	`string`	Branded Message id (`msg_` prefix + 21 nano-id chars).
`payload`required	`any`	Opaque per-type payload (text body, template ref, etc).
`templateVars`optional	`string[]`
`attempts`required	`integer`
`lastError`optional	`string`	Most recent failure reason. After `cancelAsReprocessed` (or bulk-resend) this is overwritten with a 'substituted by ...' pointer string — see `originalError` for the underlying cause.
`originalError`optional	`string`	Snapshot of `lastError` taken the first time the message is reprocessed. Audit-trail field — never overwritten on subsequent transitions.
`metaMessageId`optional	`string`
`origemDoLink`optional	`object`	De onde veio a mensagem que trouxe o código do link de WhatsApp (fonte, campanha, grupo, anúncio e palavra-chave do link) e o código que estava no texto. Só em mensagem recebida.
`origemDoLink.fonte`optional	`string`	Values:`googlemetatiktokoutra`
`origemDoLink.fonteRotulo`optional	`string`	O nome livre da fonte (`src=` do link) quando `fonte` é `outra`.
`origemDoLink.campanha`optional	`string`
`origemDoLink.grupo`optional	`string`
`origemDoLink.anuncio`optional	`string`
`origemDoLink.palavraChave`optional	`string`
`origemDoLink.codigo`optional	`string`	O código que estava no texto, entre parênteses. O texto da mensagem não é alterado.
`sentByAccountId`optional	`string`
`sentByName`optional	`string`	Operator display name (when sent from the dashboard).
`scheduledAt`optional	`string · date-time`	ISO-8601 timestamp in UTC.
`sentAt`optional	`string · date-time`	ISO-8601 timestamp in UTC.
`deliveredAt`optional	`string · date-time`	ISO-8601 timestamp in UTC.
`readAt`optional	`string · date-time`	ISO-8601 timestamp in UTC.
`failedAt`optional	`string · date-time`	ISO-8601 timestamp in UTC.
`createdAt`required	`string · date-time`	ISO-8601 timestamp in UTC.
`updatedAt`required	`string · date-time`	ISO-8601 timestamp in UTC.

JSON

{  "id": "msg_aB3xY9zQ1pTkLmNoPqRsT",  "organizationId": "org_pGgniw5L7CTDSZDwjDrQ2",  "channel": "whatsapp",  "numberId": "num_aB3xY9zQ1pTkLmNoPqRsT",  "instagramAccountId": "iga_aB3xY9zQ1pTkLmNoPqRsT",  "mediaStorage": {    "mimeType": "string",    "size": 0,    "storedAt": "2026-10-16T12:00:00.000Z"  },  "contactId": "cnt_aB3xY9zQ1pTkLmNoPqRsT",  "campaignId": "string",  "metadata": {    "customerId": "123",    "journeyId": "reativacao-q4"  },  "templateId": "tpl_uV2aLwzXMqNmKjHbPiRoT",  "batchId": "btc_aB3xY9zQ1pTkLmNoPqRsT",  "to": "+5511999998888",  "type": "text",  "direction": "outbound",  "priority": "normal",  "status": "queued",  "force": true,  "reprocessed": true,  "replacedBy": "msg_aB3xY9zQ1pTkLmNoPqRsT",  "payload": null,  "templateVars": [    "string"  ],  "attempts": 0,  "lastError": "string",  "originalError": "string",  "metaMessageId": "wamid.HBgN...",  "origemDoLink": {    "fonte": "tiktok",    "fonteRotulo": "bio",    "campanha": "Verão",    "grupo": "Corredores SP",    "anuncio": "Corrida no parque",    "palavraChave": "tênis de corrida",    "codigo": "K7Q2X"  },  "sentByAccountId": "string",  "sentByName": "string",  "scheduledAt": "2026-04-07T17:30:00.000Z",  "sentAt": "2026-04-07T17:30:00.000Z",  "deliveredAt": "2026-04-07T17:30:00.000Z",  "readAt": "2026-04-07T17:30:00.000Z",  "failedAt": "2026-04-07T17:30:00.000Z",  "createdAt": "2026-04-07T17:30:00.000Z",  "updatedAt": "2026-04-07T17:30:00.000Z"}

400RFC 7807 problem details for BAD_REQUEST (400).
401RFC 7807 problem details for UNAUTHORIZED (401).
403RFC 7807 problem details for FORBIDDEN (403).
409RFC 7807 problem details for CONFLICT (409).
422RFC 7807 problem details for VALIDATION_ERROR (422).

Error responses follow RFC 7807 (application/problem+json), with a stable code in the code field. See the error codes

curl example

cURL

curl -X POST 'https://api.messages.ccxcompany.co/messages' \  -H "Authorization: Bearer $CCX_API_KEY" \  -H "Idempotency-Key: order-4821" \  -H "Content-Type: application/json" \  -d '{    "numberId": "num_aB3xY9zQ1pTkLmNoPqRsT",    "to": "+5511999998888",    "type": "text",    "payload": {      "text": {        "body": "Olá! Mensagem de teste do CCX."      }    }  }'

Required fields only. Swap the sample values for your own.

Get a single message

GET/messages/{id}

Returns the persisted Message including current status. Cross-tenant requests get 404 (Mongo Guardian filter masks existence).

Parameters

Field	In	Type	Description
`id`required	path	`string`	Branded Message id (`msg_` prefix + 21 nano-id chars).

Responses

200Default Response

Response fields and example

Field	Type	Description
`id`required	`string`	Branded Message id (`msg_` prefix + 21 nano-id chars).
`organizationId`required	`string`	Branded Organization id (`org_` prefix + 21 nano-id chars).
`channel`optional	`string`	Canal da mensagem. Ausente em linhas antigas, anteriores ao campo — leia como `whatsapp`.Values:`whatsappemailsmsinstagram`
`numberId`optional	`string`	Branded Number id (`num_` prefix + 21 nano-id chars).
`instagramAccountId`optional	`string`	Branded Instagram account id (`iga_` prefix + 21 nano-id chars).
`mediaStorage`optional	`object`
`mediaStorage.mimeType`optional	`string`	Mime REAL do binário, lido do Content-Type.
`mediaStorage.size`optional	`integer`
`mediaStorage.storedAt`optional	`string · date-time`
`contactId`optional	`string`	Branded Contact id (`cnt_` prefix + 21 nano-id chars).
`campaignId`optional	`string`	Optional external campaign tag carried through from the create call. Surfaced as a filter on `GET /messages` and as a selector on `POST /messages/bulk-resend`.
`metadata`optional	`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.
`templateId`optional	`string`	Branded Template id (`tpl_` prefix + 21 nano-id chars).
`batchId`optional	`string`	Branded batch id (`btc_` prefix + 21 nano-id chars).
`to`required	`string`	Destino, no formato do canal: telefone E.164 (whatsapp/sms), endereço de e-mail (email) ou IGSID (instagram). PII_SENSITIVE — mascarado a menos que o chamador tenha `pii:full`.
`type`required	`string`	Values:`texttemplatemediainteractive`
`direction`required	`string`	Values:`outboundinbound`
`priority`required	`string`	Values:`normalbulkcritical`
`status`required	`string`	Values:`queuedsendingsentdeliveredreadfailedarchived`
`force`required	`boolean`	When true the worker bypasses token bucket + quiet hours. Persisted for audit; only the `force` route sets it.
`reprocessed`optional	`boolean`	True when a dashboard operator manually reprocessed this message. `replacedBy` points to the new message.
`replacedBy`optional	`string`	Branded Message id (`msg_` prefix + 21 nano-id chars).
`payload`required	`any`	Opaque per-type payload (text body, template ref, etc).
`templateVars`optional	`string[]`
`attempts`required	`integer`
`lastError`optional	`string`	Most recent failure reason. After `cancelAsReprocessed` (or bulk-resend) this is overwritten with a 'substituted by ...' pointer string — see `originalError` for the underlying cause.
`originalError`optional	`string`	Snapshot of `lastError` taken the first time the message is reprocessed. Audit-trail field — never overwritten on subsequent transitions.
`metaMessageId`optional	`string`
`origemDoLink`optional	`object`	De onde veio a mensagem que trouxe o código do link de WhatsApp (fonte, campanha, grupo, anúncio e palavra-chave do link) e o código que estava no texto. Só em mensagem recebida.
`origemDoLink.fonte`optional	`string`	Values:`googlemetatiktokoutra`
`origemDoLink.fonteRotulo`optional	`string`	O nome livre da fonte (`src=` do link) quando `fonte` é `outra`.
`origemDoLink.campanha`optional	`string`
`origemDoLink.grupo`optional	`string`
`origemDoLink.anuncio`optional	`string`
`origemDoLink.palavraChave`optional	`string`
`origemDoLink.codigo`optional	`string`	O código que estava no texto, entre parênteses. O texto da mensagem não é alterado.
`sentByAccountId`optional	`string`
`sentByName`optional	`string`	Operator display name (when sent from the dashboard).
`scheduledAt`optional	`string · date-time`	ISO-8601 timestamp in UTC.
`sentAt`optional	`string · date-time`	ISO-8601 timestamp in UTC.
`deliveredAt`optional	`string · date-time`	ISO-8601 timestamp in UTC.
`readAt`optional	`string · date-time`	ISO-8601 timestamp in UTC.
`failedAt`optional	`string · date-time`	ISO-8601 timestamp in UTC.
`createdAt`required	`string · date-time`	ISO-8601 timestamp in UTC.
`updatedAt`required	`string · date-time`	ISO-8601 timestamp in UTC.

JSON

{  "id": "msg_aB3xY9zQ1pTkLmNoPqRsT",  "organizationId": "org_pGgniw5L7CTDSZDwjDrQ2",  "channel": "whatsapp",  "numberId": "num_aB3xY9zQ1pTkLmNoPqRsT",  "instagramAccountId": "iga_aB3xY9zQ1pTkLmNoPqRsT",  "mediaStorage": {    "mimeType": "string",    "size": 0,    "storedAt": "2026-10-16T12:00:00.000Z"  },  "contactId": "cnt_aB3xY9zQ1pTkLmNoPqRsT",  "campaignId": "string",  "metadata": {    "customerId": "123",    "journeyId": "reativacao-q4"  },  "templateId": "tpl_uV2aLwzXMqNmKjHbPiRoT",  "batchId": "btc_aB3xY9zQ1pTkLmNoPqRsT",  "to": "+5511999998888",  "type": "text",  "direction": "outbound",  "priority": "normal",  "status": "queued",  "force": true,  "reprocessed": true,  "replacedBy": "msg_aB3xY9zQ1pTkLmNoPqRsT",  "payload": null,  "templateVars": [    "string"  ],  "attempts": 0,  "lastError": "string",  "originalError": "string",  "metaMessageId": "wamid.HBgN...",  "origemDoLink": {    "fonte": "tiktok",    "fonteRotulo": "bio",    "campanha": "Verão",    "grupo": "Corredores SP",    "anuncio": "Corrida no parque",    "palavraChave": "tênis de corrida",    "codigo": "K7Q2X"  },  "sentByAccountId": "string",  "sentByName": "string",  "scheduledAt": "2026-04-07T17:30:00.000Z",  "sentAt": "2026-04-07T17:30:00.000Z",  "deliveredAt": "2026-04-07T17:30:00.000Z",  "readAt": "2026-04-07T17:30:00.000Z",  "failedAt": "2026-04-07T17:30:00.000Z",  "createdAt": "2026-04-07T17:30:00.000Z",  "updatedAt": "2026-04-07T17:30:00.000Z"}

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

Error responses follow RFC 7807 (application/problem+json), with a stable code in the code field. See the error codes

curl example

cURL

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

Required fields only. Swap the sample values for your own.

Stuck on a route? Talk to the people who run the API.

Start free Talk to sales

WhatsApp messages

List messages

Parameters

Responses

curl example

Send a single outbound message

Request bodyapplication/json

Responses

curl example

Get a single message

Parameters

Responses

curl example

Other API areas

Stuck on a route? Talk to the people who run the API.

Request body`application/json`