Referência da API

Listas estáticas

Mantenha listas estáticas de contatos pelo seu sistema: crie, renomeie e apague listas e adicione, substitua ou remova até 50 mil membros por chamada.

8 operações
URL basehttps://api.messages.ccxcompany.co
AutenticaçãoBearer com a sua chave de API

O texto técnico abaixo vem do contrato público, o openapi.json, no idioma em que o contrato foi escrito.

Lista as listas estáticas

GET/v2/lists

Listas estáticas são audiências mantidas pelo SEU sistema: quem está nelas é quem a API colocou. Cada item traz size, o número de contatos na lista agora. Para os contatos, use GET /contacts?listId=.

Permissão: contacts:read.

Respostas

200Default Response

Campos e exemplo da resposta

Campo	Tipo	Descrição
`items`obrigatório	`object[]`
`items[].id`obrigatório	`string`
`items[].name`obrigatório	`string`
`items[].description`opcional	`string`
`items[].size`obrigatório	`integer`
`items[].createdAt`obrigatório	`string`
`items[].updatedAt`obrigatório	`string`

JSON

{  "items": [    {      "id": "string",      "name": "string",      "description": "string",      "size": 0,      "createdAt": "string",      "updatedAt": "string"    }  ]}

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

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

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

Só os campos obrigatórios. Troque os valores de exemplo pelos seus.

Cria uma lista estática

POST/v2/lists

O nome é único na organização (409 se repetir).

Permissão: contacts:write.

Corpo da requisição`application/json`

Campo	Tipo	Descrição
`name`obrigatório	`string`	Nome da lista — único na organização.
`description`opcional	`string`

Exemplo completo do corpo

JSON

{  "name": "string",  "description": "string"}

Respostas

201Default Response
Campos e exemplo da resposta
Campo Tipo Descrição
idobrigatório string
nameobrigatório string
descriptionopcional string
sizeobrigatório integer
createdAtobrigatório string
updatedAtobrigatório string
JSON
```
{  "id": "string",  "name": "string",  "description": "string",  "size": 0,  "createdAt": "string",  "updatedAt": "string"}
```
400RFC 7807 problem details for BAD_REQUEST (400).
401RFC 7807 problem details for UNAUTHORIZED (401).
403RFC 7807 problem details for FORBIDDEN (403).
404RFC 7807 problem details for NOT_FOUND (404).
409RFC 7807 problem details for CONFLICT (409).
422RFC 7807 problem details for VALIDATION_ERROR (422).

Campo	Tipo	Descrição
`id`obrigatório	`string`
`name`obrigatório	`string`
`description`opcional	`string`
`size`obrigatório	`integer`
`createdAt`obrigatório	`string`
`updatedAt`obrigatório	`string`

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

curl -X POST 'https://api.messages.ccxcompany.co/v2/lists' \  -H "Authorization: Bearer $CCX_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'

Só os campos obrigatórios. Troque os valores de exemplo pelos seus.

Lê uma lista estática

GET/v2/lists/{id}

Permissão: contacts:read.

Parâmetros

Campo	Onde	Tipo	Descrição
`id`obrigatório	caminho	`string`

Respostas

200Default Response
Campos e exemplo da resposta
Campo Tipo Descrição
idobrigatório string
nameobrigatório string
descriptionopcional string
sizeobrigatório integer
createdAtobrigatório string
updatedAtobrigatório string
JSON
```
{  "id": "string",  "name": "string",  "description": "string",  "size": 0,  "createdAt": "string",  "updatedAt": "string"}
```
400RFC 7807 problem details for BAD_REQUEST (400).
401RFC 7807 problem details for UNAUTHORIZED (401).
403RFC 7807 problem details for FORBIDDEN (403).
404RFC 7807 problem details for NOT_FOUND (404).
422RFC 7807 problem details for VALIDATION_ERROR (422).

Campo	Tipo	Descrição
`id`obrigatório	`string`
`name`obrigatório	`string`
`description`opcional	`string`
`size`obrigatório	`integer`
`createdAt`obrigatório	`string`
`updatedAt`obrigatório	`string`

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

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

Só os campos obrigatórios. Troque os valores de exemplo pelos seus.

Renomeia ou descreve uma lista estática

PATCH/v2/lists/{id}

Permissão: contacts:write.

Parâmetros

Campo	Onde	Tipo	Descrição
`id`obrigatório	caminho	`string`

Corpo da requisição`application/json`

Campo	Tipo	Descrição
`name`opcional	`string`
`description`opcional	`string`

Exemplo completo do corpo

JSON

{  "name": "string",  "description": "string"}

Respostas

200Default Response
Campos e exemplo da resposta
Campo Tipo Descrição
idobrigatório string
nameobrigatório string
descriptionopcional string
sizeobrigatório integer
createdAtobrigatório string
updatedAtobrigatório string
JSON
```
{  "id": "string",  "name": "string",  "description": "string",  "size": 0,  "createdAt": "string",  "updatedAt": "string"}
```
400RFC 7807 problem details for BAD_REQUEST (400).
401RFC 7807 problem details for UNAUTHORIZED (401).
403RFC 7807 problem details for FORBIDDEN (403).
404RFC 7807 problem details for NOT_FOUND (404).
409RFC 7807 problem details for CONFLICT (409).
422RFC 7807 problem details for VALIDATION_ERROR (422).

Campo	Tipo	Descrição
`id`obrigatório	`string`
`name`obrigatório	`string`
`description`opcional	`string`
`size`obrigatório	`integer`
`createdAt`obrigatório	`string`
`updatedAt`obrigatório	`string`

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

curl -X PATCH 'https://api.messages.ccxcompany.co/v2/lists/<id>' \  -H "Authorization: Bearer $CCX_API_KEY" \  -H "Content-Type: application/json" \  -d '{}'

Só os campos obrigatórios. Troque os valores de exemplo pelos seus.

Apaga uma lista estática

DELETE/v2/lists/{id}

Apaga a lista; os contatos continuam na base, só deixam de estar nela.

Permissão: contacts:write.

Parâmetros

Campo	Onde	Tipo	Descrição
`id`obrigatório	caminho	`string`

Respostas

204Default Response
400RFC 7807 problem details for BAD_REQUEST (400).
401RFC 7807 problem details for UNAUTHORIZED (401).
403RFC 7807 problem details for FORBIDDEN (403).
404RFC 7807 problem details for NOT_FOUND (404).
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

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

Só os campos obrigatórios. Troque os valores de exemplo pelos seus.

Adiciona membros à lista

POST/v2/lists/{id}/members

Entra quem veio; ninguém sai. Quem já estava não conta em added.

Identificadores aceitos, juntos ou separados: externalIds (o Customer ID do seu sistema), contactIds (cnt_…) e phones (E.164). Até 50.000 por chamada; lista maior entra em lotes de POST …/members.

Quem não existe na base não é criado: volta em notFound (amostra de até 100 por tipo) e em notFoundCount. Para criar, importe antes com POST /contacts/import.

Permissão: contacts:write.

Parâmetros

Campo	Onde	Tipo	Descrição
`id`obrigatório	caminho	`string`

Corpo da requisição`application/json`

Campo	Tipo	Descrição
`externalIds`opcional	`string[]`	Customer IDs do seu sistema (o `externalId` do contato).
`contactIds`opcional	`string[]`	Ids CCX (`cnt_…`).
`phones`opcional	`string[]`	Telefones em E.164.

Exemplo completo do corpo

JSON

{  "externalIds": [    "string"  ],  "contactIds": [    "string"  ],  "phones": [    "string"  ]}

Respostas

200Default Response

Campos e exemplo da resposta

Campo	Tipo	Descrição
`listId`obrigatório	`string`
`matched`obrigatório	`integer`
`added`obrigatório	`integer`
`removed`obrigatório	`integer`
`total`obrigatório	`integer`
`notFoundCount`obrigatório	`integer`
`notFound`obrigatório	`object`
`notFound.externalIds`obrigatório	`string[]`
`notFound.contactIds`obrigatório	`string[]`
`notFound.phones`obrigatório	`string[]`

JSON

{  "listId": "string",  "matched": 0,  "added": 0,  "removed": 0,  "total": 0,  "notFoundCount": 0,  "notFound": {    "externalIds": [      "string"    ],    "contactIds": [      "string"    ],    "phones": [      "string"    ]  }}

400RFC 7807 problem details for BAD_REQUEST (400).
401RFC 7807 problem details for UNAUTHORIZED (401).
403RFC 7807 problem details for FORBIDDEN (403).
404RFC 7807 problem details for NOT_FOUND (404).
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

curl -X POST 'https://api.messages.ccxcompany.co/v2/lists/<id>/members' \  -H "Authorization: Bearer $CCX_API_KEY" \  -H "Content-Type: application/json" \  -d '{}'

Só os campos obrigatórios. Troque os valores de exemplo pelos seus.

Substitui os membros da lista

PUT/v2/lists/{id}/members

A lista passa a ser exatamente quem veio: entra quem não estava, sai quem não veio. Se nenhum identificador achar contato, a chamada é recusada com 422 e a lista não muda (para esvaziar, use …/members/remove).

Quem não existe na base não é criado: volta em notFound (amostra de até 100 por tipo) e em notFoundCount. Para criar, importe antes com POST /contacts/import.

Permissão: contacts:write.

Parâmetros

Campo	Onde	Tipo	Descrição
`id`obrigatório	caminho	`string`

Corpo da requisição`application/json`

Campo	Tipo	Descrição
`externalIds`opcional	`string[]`	Customer IDs do seu sistema (o `externalId` do contato).
`contactIds`opcional	`string[]`	Ids CCX (`cnt_…`).
`phones`opcional	`string[]`	Telefones em E.164.

Exemplo completo do corpo

JSON

{  "externalIds": [    "string"  ],  "contactIds": [    "string"  ],  "phones": [    "string"  ]}

Respostas

200Default Response

Campos e exemplo da resposta

Campo	Tipo	Descrição
`listId`obrigatório	`string`
`matched`obrigatório	`integer`
`added`obrigatório	`integer`
`removed`obrigatório	`integer`
`total`obrigatório	`integer`
`notFoundCount`obrigatório	`integer`
`notFound`obrigatório	`object`
`notFound.externalIds`obrigatório	`string[]`
`notFound.contactIds`obrigatório	`string[]`
`notFound.phones`obrigatório	`string[]`

JSON

{  "listId": "string",  "matched": 0,  "added": 0,  "removed": 0,  "total": 0,  "notFoundCount": 0,  "notFound": {    "externalIds": [      "string"    ],    "contactIds": [      "string"    ],    "phones": [      "string"    ]  }}

400RFC 7807 problem details for BAD_REQUEST (400).
401RFC 7807 problem details for UNAUTHORIZED (401).
403RFC 7807 problem details for FORBIDDEN (403).
404RFC 7807 problem details for NOT_FOUND (404).
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

curl -X PUT 'https://api.messages.ccxcompany.co/v2/lists/<id>/members' \  -H "Authorization: Bearer $CCX_API_KEY" \  -H "Content-Type: application/json" \  -d '{}'

Só os campos obrigatórios. Troque os valores de exemplo pelos seus.

Remove membros da lista

POST/v2/lists/{id}/members/remove

Sai quem veio. Os contatos continuam na base.

Quem não existe na base não é criado: volta em notFound (amostra de até 100 por tipo) e em notFoundCount. Para criar, importe antes com POST /contacts/import.

Permissão: contacts:write.

Parâmetros

Campo	Onde	Tipo	Descrição
`id`obrigatório	caminho	`string`

Corpo da requisição`application/json`

Campo	Tipo	Descrição
`externalIds`opcional	`string[]`	Customer IDs do seu sistema (o `externalId` do contato).
`contactIds`opcional	`string[]`	Ids CCX (`cnt_…`).
`phones`opcional	`string[]`	Telefones em E.164.

Exemplo completo do corpo

JSON

{  "externalIds": [    "string"  ],  "contactIds": [    "string"  ],  "phones": [    "string"  ]}

Respostas

200Default Response

Campos e exemplo da resposta

Campo	Tipo	Descrição
`listId`obrigatório	`string`
`matched`obrigatório	`integer`
`added`obrigatório	`integer`
`removed`obrigatório	`integer`
`total`obrigatório	`integer`
`notFoundCount`obrigatório	`integer`
`notFound`obrigatório	`object`
`notFound.externalIds`obrigatório	`string[]`
`notFound.contactIds`obrigatório	`string[]`
`notFound.phones`obrigatório	`string[]`

JSON

{  "listId": "string",  "matched": 0,  "added": 0,  "removed": 0,  "total": 0,  "notFoundCount": 0,  "notFound": {    "externalIds": [      "string"    ],    "contactIds": [      "string"    ],    "phones": [      "string"    ]  }}

400RFC 7807 problem details for BAD_REQUEST (400).
401RFC 7807 problem details for UNAUTHORIZED (401).
403RFC 7807 problem details for FORBIDDEN (403).
404RFC 7807 problem details for NOT_FOUND (404).
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

curl -X POST 'https://api.messages.ccxcompany.co/v2/lists/<id>/members/remove' \  -H "Authorization: Bearer $CCX_API_KEY" \  -H "Content-Type: application/json" \  -d '{}'

Só os campos obrigatórios. Troque os valores de exemplo pelos seus.

Travou em alguma rota? Fale com quem mantém a API.

Criar conta grátis Falar com vendas

Criando a conta pelo site, você ganha R$ 10 de crédito de teste.

Listas estáticas

Respostas

Exemplo em curl

Corpo da requisiçãoapplication/json

Respostas

Exemplo em curl

Parâmetros

Respostas

Exemplo em curl

Parâmetros

Corpo da requisiçãoapplication/json

Respostas

Exemplo em curl

Parâmetros

Respostas

Exemplo em curl

Parâmetros

Corpo da requisiçãoapplication/json

Respostas

Exemplo em curl

Parâmetros

Corpo da requisiçãoapplication/json

Respostas

Exemplo em curl

Parâmetros

Corpo da requisiçãoapplication/json

Respostas

Exemplo em curl

Outras áreas da API

Travou em alguma rota? Fale com quem mantém a API.

Corpo da requisição`application/json`

Corpo da requisição`application/json`

Corpo da requisição`application/json`

Corpo da requisição`application/json`

Corpo da requisição`application/json`