Referencia de la API

Listas estáticas

Mantén listas estáticas de contactos desde tu sistema: crea, renombra y borra listas y añade, sustituye o quita hasta 50.000 miembros por llamada.

8 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 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.

Respuestas

200Default Response

Campos y ejemplo de la respuesta

Campo	Tipo	Descripción
`items`obligatorio	`object[]`
`items[].id`obligatorio	`string`
`items[].name`obligatorio	`string`
`items[].description`opcional	`string`
`items[].size`obligatorio	`integer`
`items[].createdAt`obligatorio	`string`
`items[].updatedAt`obligatorio	`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).

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/lists' \  -H "Authorization: Bearer $CCX_API_KEY"

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

Cria uma lista estática

POST/v2/lists

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

Permissão: contacts:write.

Cuerpo de la petición`application/json`

Campo	Tipo	Descripción
`name`obligatorio	`string`	Nome da lista — único na organização.
`description`opcional	`string`

Ejemplo completo del cuerpo

JSON

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

Respuestas

201Default Response
Campos y ejemplo de la respuesta
Campo Tipo Descripción
idobligatorio string
nameobligatorio string
descriptionopcional string
sizeobligatorio integer
createdAtobligatorio string
updatedAtobligatorio 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	Descripción
`id`obligatorio	`string`
`name`obligatorio	`string`
`description`opcional	`string`
`size`obligatorio	`integer`
`createdAt`obligatorio	`string`
`updatedAt`obligatorio	`string`

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/lists' \  -H "Authorization: Bearer $CCX_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'

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

Lê uma lista estática

GET/v2/lists/{id}

Permissão: contacts: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
idobligatorio string
nameobligatorio string
descriptionopcional string
sizeobligatorio integer
createdAtobligatorio string
updatedAtobligatorio 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	Descripción
`id`obligatorio	`string`
`name`obligatorio	`string`
`description`opcional	`string`
`size`obligatorio	`integer`
`createdAt`obligatorio	`string`
`updatedAt`obligatorio	`string`

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/lists/<id>' \  -H "Authorization: Bearer $CCX_API_KEY"

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

Renomeia ou descreve uma lista estática

PATCH/v2/lists/{id}

Permissão: contacts:write.

Parámetros

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

Cuerpo de la petición`application/json`

Campo	Tipo	Descripción
`name`opcional	`string`
`description`opcional	`string`

Ejemplo completo del cuerpo

JSON

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

Respuestas

200Default Response
Campos y ejemplo de la respuesta
Campo Tipo Descripción
idobligatorio string
nameobligatorio string
descriptionopcional string
sizeobligatorio integer
createdAtobligatorio string
updatedAtobligatorio 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	Descripción
`id`obligatorio	`string`
`name`obligatorio	`string`
`description`opcional	`string`
`size`obligatorio	`integer`
`createdAt`obligatorio	`string`
`updatedAt`obligatorio	`string`

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

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

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	Dónde	Tipo	Descripción
`id`obligatorio	ruta	`string`

Respuestas

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).

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 DELETE 'https://api.messages.ccxcompany.co/v2/lists/<id>' \  -H "Authorization: Bearer $CCX_API_KEY"

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

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	Dónde	Tipo	Descripción
`id`obligatorio	ruta	`string`

Cuerpo de la petición`application/json`

Campo	Tipo	Descripción
`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.

Ejemplo completo del cuerpo

JSON

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

Respuestas

200Default Response

Campos y ejemplo de la respuesta

Campo	Tipo	Descripción
`listId`obligatorio	`string`
`matched`obligatorio	`integer`
`added`obligatorio	`integer`
`removed`obligatorio	`integer`
`total`obligatorio	`integer`
`notFoundCount`obligatorio	`integer`
`notFound`obligatorio	`object`
`notFound.externalIds`obligatorio	`string[]`
`notFound.contactIds`obligatorio	`string[]`
`notFound.phones`obligatorio	`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).

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/lists/<id>/members' \  -H "Authorization: Bearer $CCX_API_KEY" \  -H "Content-Type: application/json" \  -d '{}'

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

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	Dónde	Tipo	Descripción
`id`obligatorio	ruta	`string`

Cuerpo de la petición`application/json`

Campo	Tipo	Descripción
`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.

Ejemplo completo del cuerpo

JSON

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

Respuestas

200Default Response

Campos y ejemplo de la respuesta

Campo	Tipo	Descripción
`listId`obligatorio	`string`
`matched`obligatorio	`integer`
`added`obligatorio	`integer`
`removed`obligatorio	`integer`
`total`obligatorio	`integer`
`notFoundCount`obligatorio	`integer`
`notFound`obligatorio	`object`
`notFound.externalIds`obligatorio	`string[]`
`notFound.contactIds`obligatorio	`string[]`
`notFound.phones`obligatorio	`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).

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

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

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	Dónde	Tipo	Descripción
`id`obligatorio	ruta	`string`

Cuerpo de la petición`application/json`

Campo	Tipo	Descripción
`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.

Ejemplo completo del cuerpo

JSON

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

Respuestas

200Default Response

Campos y ejemplo de la respuesta

Campo	Tipo	Descripción
`listId`obligatorio	`string`
`matched`obligatorio	`integer`
`added`obligatorio	`integer`
`removed`obligatorio	`integer`
`total`obligatorio	`integer`
`notFoundCount`obligatorio	`integer`
`notFound`obligatorio	`object`
`notFound.externalIds`obligatorio	`string[]`
`notFound.contactIds`obligatorio	`string[]`
`notFound.phones`obligatorio	`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).

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/lists/<id>/members/remove' \  -H "Authorization: Bearer $CCX_API_KEY" \  -H "Content-Type: application/json" \  -d '{}'

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.

Listas estáticas

Respuestas

Ejemplo en curl

Cuerpo de la peticiónapplication/json

Respuestas

Ejemplo en curl

Parámetros

Respuestas

Ejemplo en curl

Parámetros

Cuerpo de la peticiónapplication/json

Respuestas

Ejemplo en curl

Parámetros

Respuestas

Ejemplo en curl

Parámetros

Cuerpo de la peticiónapplication/json

Respuestas

Ejemplo en curl

Parámetros

Cuerpo de la peticiónapplication/json

Respuestas

Ejemplo en curl

Parámetros

Cuerpo de la peticiónapplication/json

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`

Cuerpo de la petición`application/json`

Cuerpo de la petición`application/json`

Cuerpo de la petición`application/json`

Cuerpo de la petición`application/json`