EstadoDesarrolladoresSociosPTENESIniciar sesión
Habla con ventasEmpieza gratis
Empieza gratis
Habla con ventasEmpieza gratis
Iniciar sesiónEstadoPTENES

Referencia de la API

Segmentos

Crea segmentos dinámicos por etiqueta, atributo, opt-in, canal o última interacción, consulta el recuento y una muestra antes de guardar y edita los guardados.

  • 6 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.

List saved segments

GET/v2/segments

Returns the org's saved segments (dynamic contact lists). Supports name search + pagination.

Parámetros

CampoDóndeTipoDescripción
qopcionalquerystringFilter segments by name substring.
limitopcionalqueryintegerPage size (default 50).
skipopcionalqueryintegerOffset for pagination.

Respuestas

  • 200Default Response

    Campos y ejemplo de la respuesta
    JSON
    {}

  • 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/segments' \  -H "Authorization: Bearer $CCX_API_KEY"
Solo los campos obligatorios. Cambia los valores de ejemplo por los tuyos.

Create a saved segment

POST/v2/segments

Persists a named, filter-based dynamic list. filters is an AND-joined array of leaf conditions (tag / attribute / optIn / lastInteraction / channel); at least one is required.

For nested AND/OR logic, send the recursive filterTree instead — when present it takes precedence over filters.

Cuerpo de la peticiónapplication/json

CampoTipoDescripción
nameobligatoriostring
descriptionopcionalstring
filtersobligatorioobject[]
filters[].fieldopcionalstringValores:channel
filters[].operatoropcionalstringValores:has
filters[].valueopcionalstringValores:whatsappemail
filters[].keyopcionalstring
filterTreeopcionalobject
filterTree.kindopcionalstringValores:group
filterTree.filteropcionalobject
filterTree.filter.fieldopcionalstringValores:channel
filterTree.filter.operatoropcionalstringValores:has
filterTree.filter.valueopcionalstringValores:whatsappemail
filterTree.filter.keyopcionalstring
filterTree.operatoropcionalstringValores:andor
filterTree.nodesopcionalany[]
Ejemplo completo del cuerpo
JSON
{  "name": "string",  "description": "string",  "filters": [    {      "field": "tag",      "operator": "is",      "value": "string"    }  ],  "filterTree": {    "kind": "leaf",    "filter": {      "field": "tag",      "operator": "is",      "value": "string"    }  }}

Respuestas

  • 200Default Response

    Campos y ejemplo de la respuesta
    JSON
    {}

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

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/segments' \  -H "Authorization: Bearer $CCX_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "filters": [      {        "field": "tag",        "operator": "is",        "value": "string"      }    ]  }'
Solo los campos obligatorios. Cambia los valores de ejemplo por los tuyos.

Get a saved segment

GET/v2/segments/{segmentId}

Returns a single segment by id. Cross-tenant ids return 404.

Parámetros

CampoDóndeTipoDescripción
segmentIdobligatoriorutastringSegment id (seg_…).

Respuestas

  • 200Default Response

    Campos y ejemplo de la respuesta
    JSON
    {}

  • 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/segments/<segmentId>' \  -H "Authorization: Bearer $CCX_API_KEY"
Solo los campos obligatorios. Cambia los valores de ejemplo por los tuyos.

Update a saved segment

PATCH/v2/segments/{segmentId}

Partial update. Any of name, description, filters, filterTree may be sent; omitted fields are unchanged.

Parámetros

CampoDóndeTipoDescripción
segmentIdobligatoriorutastringSegment id (seg_…).

Cuerpo de la peticiónapplication/json

CampoTipoDescripción
nameopcionalstring
descriptionopcionalstring
filtersopcionalobject[]
filters[].fieldopcionalstringValores:channel
filters[].operatoropcionalstringValores:has
filters[].valueopcionalstringValores:whatsappemail
filters[].keyopcionalstring
filterTreeopcionalobject
filterTree.kindopcionalstringValores:group
filterTree.filteropcionalobject
filterTree.filter.fieldopcionalstringValores:channel
filterTree.filter.operatoropcionalstringValores:has
filterTree.filter.valueopcionalstringValores:whatsappemail
filterTree.filter.keyopcionalstring
filterTree.operatoropcionalstringValores:andor
filterTree.nodesopcionalany[]
Ejemplo completo del cuerpo
JSON
{  "name": "string",  "description": "string",  "filters": [    {      "field": "tag",      "operator": "is",      "value": "string"    }  ],  "filterTree": {    "kind": "leaf",    "filter": {      "field": "tag",      "operator": "is",      "value": "string"    }  }}

Respuestas

  • 200Default Response

    Campos y ejemplo de la respuesta
    JSON
    {}

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

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/segments/<segmentId>' \  -H "Authorization: Bearer $CCX_API_KEY" \  -H "Content-Type: application/json" \  -d '{}'
Solo los campos obligatorios. Cambia los valores de ejemplo por los tuyos.

Delete a saved segment

DELETE/v2/segments/{segmentId}

Hard delete. Returns 204 with no body.

Parámetros

CampoDóndeTipoDescripción
segmentIdobligatoriorutastringSegment id (seg_…).

Respuestas

  • 204Default Response

  • 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 -X DELETE 'https://api.messages.ccxcompany.co/v2/segments/<segmentId>' \  -H "Authorization: Bearer $CCX_API_KEY"
Solo los campos obligatorios. Cambia los valores de ejemplo por los tuyos.

Preview a segment (count + sample) without persisting

POST/v2/segments/preview

Evaluate a tentative filter set and get back the match count + a sample of contact ids, without saving a segment. Same filters / filterTree shape as create.

Cuerpo de la peticiónapplication/json

CampoTipoDescripción
filtersobligatorioobject[]
filters[].fieldopcionalstringValores:channel
filters[].operatoropcionalstringValores:has
filters[].valueopcionalstringValores:whatsappemail
filters[].keyopcionalstring
filterTreeopcionalobject
filterTree.kindopcionalstringValores:group
filterTree.filteropcionalobject
filterTree.filter.fieldopcionalstringValores:channel
filterTree.filter.operatoropcionalstringValores:has
filterTree.filter.valueopcionalstringValores:whatsappemail
filterTree.filter.keyopcionalstring
filterTree.operatoropcionalstringValores:andor
filterTree.nodesopcionalany[]
Ejemplo completo del cuerpo
JSON
{  "filters": [    {      "field": "tag",      "operator": "is",      "value": "string"    }  ],  "filterTree": {    "kind": "leaf",    "filter": {      "field": "tag",      "operator": "is",      "value": "string"    }  }}

Respuestas

  • 200Default Response

    Campos y ejemplo de la respuesta
    JSON
    {}

  • 401RFC 7807 problem details for UNAUTHORIZED (401).

  • 403RFC 7807 problem details for FORBIDDEN (403).

  • 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/segments/preview' \  -H "Authorization: Bearer $CCX_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "filters": [      {        "field": "tag",        "operator": "is",        "value": "string"      }    ]  }'
Solo los campos obligatorios. Cambia los valores de ejemplo por los tuyos.

Otras áreas de la API

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

Empieza gratisHabla con ventas

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