Lista SMS
GET/v2/sms/messages
Ordem decrescente de criação. limit default 50, teto 200.
A lista é do ambiente da credencial que lê: uma chave ccx_test_* vê os envios de sandbox e nada mais. Para ler a produção, use uma chave ccx_live_*.
Permissão: sms:read.
Parâmetros
| Campo | Onde | Tipo | Descrição |
|---|---|---|---|
statusopcional | query | string | Valores:queuedsendingsentdeliveredfailedundelivered |
regionopcional | query | string | Valores:BRINTL |
contactIdopcional | query | string | |
campaignIdopcional | query | string | |
phoneopcional | query | string | |
fromopcional | query | string · date-time | |
toopcional | query | string · date-time | |
limitopcional | query | integer | |
skipopcional | query | integer |
Respostas
200Default ResponseCampos e exemplo da resposta
Campo Tipo Descrição itemsobrigatórioobject[]items[].idobrigatóriostringitems[].statusobrigatóriostringValores: queuedsendingsentdeliveredfailedundelivereditems[].envobrigatóriostringValores: livetestitems[].reasonopcionalstringValores: invalid_numbercarrier_rejectedblacklistedexpiredindeterminateabandoneditems[].routeopcionalstringValores: premiumotpla_dedicadaitems[].toobrigatóriostringitems[].providerobrigatóriostringValores: aws-snsaws-eumpontaltechccx-sandboxitems[].encodingopcionalstringValores: GSM-7UCS-2items[].lengthopcionalintegeritems[].segmentsopcionalintegeritems[].createdAtobrigatóriostring · date-timeitems[].sentAtopcionalstring · date-timeitems[].deliveredAtopcionalstring · date-timeitems[].failedAtopcionalstring · date-timeitems[].providerReceiptopcionalobjectitems[].providerReceipt.idobrigatóriostringitems[].providerReceipt.typeobrigatóriostringValores: api_messageapi_fastapi_replyitems[].providerReceipt.toobrigatóriostringitems[].providerReceipt.messageopcionalstringitems[].providerReceipt.referenceopcionalstringitems[].providerReceipt.statusobrigatóriostringitems[].providerReceipt.statusDescriptionobrigatóriostringitems[].providerReceipt.receivedopcionalstringitems[].providerReceipt.bill_factoropcionalnumberitems[].providerReceipt.account_idopcionalnumberitems[].providerReceipt.account_referenceopcionalstringitems[].providerReceipt.channelopcionalstring | nullValores: SMSRCSWHATSAPPitems[].contactIdopcionalstringitems[].campaignIdopcionalstringitems[].metadataopcionalobjectMetadados 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. totalobrigatóriointegerJSON{ "items": [ { "id": "string", "status": "queued", "env": "live", "reason": "invalid_number", "route": "premium", "to": "string", "provider": "aws-sns", "encoding": "GSM-7", "length": 0, "segments": 1, "createdAt": "2026-10-16T12:00:00.000Z", "sentAt": "2026-10-16T12:00:00.000Z", "deliveredAt": "2026-10-16T12:00:00.000Z", "failedAt": "2026-10-16T12:00:00.000Z", "providerReceipt": { "id": "string", "type": "api_message", "to": "string", "message": "string", "reference": "string", "status": "string", "statusDescription": "string", "received": "string", "bill_factor": 0, "account_id": 0, "account_reference": "string", "channel": "SMS" }, "contactId": "string", "campaignId": "string", "metadata": {} } ], "total": 0}
401RFC 7807 problem details for UNAUTHORIZED (401).403RFC 7807 problem details for FORBIDDEN (403).422RFC 7807 problem details for VALIDATION_ERROR (422).
As respostas de erro seguem o formato RFC 7807 (application/problem+json), com um código estável no campo code. Ver os códigos de erro
Exemplo em curl
curl 'https://api.messages.ccxcompany.co/v2/sms/messages' \ -H "Authorization: Bearer $CCX_API_KEY"