{"info":{"_postman_id":"3662db5d-5420-49d2-b837-09eba945998d","name":"API Cxpress","description":"

Bienvenido a la documentación de la API de integración de Cxpress

Este documento presenta la especificación técnica de las solicitudes disponibles para interactuar con la API, permitiendo realizar consultas y modificaciones desde aplicaciones externas. También se incluyen las instrucciones para la generación del token de autenticación, esencial para garantizar el acceso seguro a los endpoints. Este guía tiene como objetivo proporcionar toda la información necesaria para un consumo eficiente, estructurado y confiable de la API, facilitando la integración con sistemas externos de forma segura y estandarizada.

Estructura

La documentación está organizada por versiones, dando prioridad a la versión más reciente de la API.
\n
En caso de que un determinado endpoint no esté documentado en la versión más actual, se debe utilizar el endpoint disponible en la versión más reciente en la que esté documentado.
\n
La API de Cxpress tiene un límite de 300 solicitudes por minuto por dirección IP. Si este límite se excede dentro de un período de 60 segundos, se aplicará automáticamente un bloqueo de seguridad de 10 minutos a la dirección IP responsable de las solicitudes.
\n

Generación de una entidad de integración

Para crear una nueva entidad de integración, el usuario con perfil de PROPIETARIO de la empresa debe seguir la siguiente ruta dentro de la plataforma:

Menú lateral → Configuraciones → Empresa → API

\n\n

StartFragmentEn la pantalla de API

Haz clic en el botón ubicado en la esquina superior de la interfaz:

\n\n

Al presionar ese botón, se mostrará un modal donde se deberán completar los siguientes datos:

Nombre: Nombre identificador de la entidad de integración.
\n
Permisos: Selección de los endpoints a los que el token podrá acceder.
\n

\n\n

Una vez creada la entidad de integración, se generarán y se entregarán al usuario el API Token y el Refresh Token. Estos tokens permiten autenticar solicitudes y realizar modificaciones en la plataforma Cxpress a través de la integración con sistemas externos.

⚠️ Importante: Los tokens se muestran solamente una vez después de su creación. Asegúrate de guardarlos en un lugar seguro.

\n\n

Validez y gestión de tokens

El API Token tiene una validez de 1 hora. Pasado este tiempo, queda automáticamente invalidado.
\n
El Refresh Token tiene una validez de 168 horas (7 días). Una vez vencido, ya no será posible generar nuevos tokens de acceso a partir de él.
\n

El Token de Integración aparecerá en la lista de la interfaz, pero no podrá ser editado.

Si es necesario cambiar los permisos de acceso, el usuario deberá crear un nuevo token y establecer los permisos deseados en el momento de su creación.

\n\n

En la sección Endpoints 1.0 de este documento se detallan las respuestas de todos los endpoints accesibles mediante un Token de Integración, así como las instrucciones para su utilización.

Configuración de Webhook

La funcionalidad de webhook permite que sistemas externos sean notificados automáticamente cada vez que ocurran determinados eventos en la plataforma de Cxpress.

En la pantalla de API, haz clic en el botón ubicado encima del listado de Tokens:

\n\n

Campos de Configuración

Al presionar este botón, se mostrará un modal donde se deberán completar las siguientes informaciones:

Endpoint: URL de destino a la cual se enviarán las notificaciones de eventos. Es la dirección configurada para recibir las solicitudes HTTP generadas por el mecanismo de webhook.
\n
Eventos: Permite seleccionar los eventos que deben activar notificaciones hacia el endpoint configurado. Es posible habilitar individualmente los siguientes tipos de eventos:
\n
- Creación (create): Se dispara cuando una de las entidades disponibles es creada en Cxpress.
  \n
- Actualización (update): Se dispara cuando una de las entidades disponibles es modificada en Cxpress.
  \n
\n

\n\n

Entidades Disponibles

Las notificaciones de webhook abarcan los eventos ocurridos para los siguientes tipos de entidades:

Consumidor
\n
Ticket
\n
Tarea
\n
Sector
\n
Etiquetas de Tickets
\n
Etiquetas de Consumidores
\n
Campos Personalizados
\n

Funcionamiento

Al activar un tipo de evento (Creación o Actualización), el sistema enviará automáticamente una notificación HTTP POST al endpoint configurado cada vez que se produzca la acción correspondiente en una de las entidades disponibles.

El payload de la solicitud incluirá los datos actualizados o recién creados de la entidad, permitiendo que el sistema externo reaccione en tiempo real a los cambios.

Ejemplo de Caso de Uso

Al habilitar el evento de creación (create), el endpoint configurado será activado cada vez que una de las entidades disponibles sea creada en el sistema. La solicitud enviada al endpoint contendrá, en el cuerpo (payload), los datos de la entidad recién creada.

Por ejemplo, en el caso del evento de creación de la entidad Sector, el cuerpo de la solicitud tendrá la siguiente estructura:

{\n  \"entity\": \"sector\",\n  \"type\": \"create\",\n  \"data\": {\n    \"id\": \"4f36f4aa-78do-462d-bcoa-a74beb69452b\",\n    \"company id\": \"G6cce6aBge-Oaeo-4e4c-Seac-e7d5ecaafaa7\",\n    \"name\": \"Setor teste\",\n    \"updated at\": \"2025-05-08T16:02:37.5692\",\n    \"deleted at\": null,\n    \"active\": true,\n    \"created at\": \"2025-05-08T16:02:37.5692\",\n    \"employees user ids\": [\n      \"981c9949-2327-4fO0e-98d2-2a61f7ecbeaf\",\n      \"feda355a-a75b-4a8a-b599-e2do2c23f983\"\n    ],  \n    \"key words\": [\n      \"teste\"\n    ]\n  }\n}\n\n

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Generación de una entidad de integración","slug":"generacion-de-una-entidad-de-integracion"},{"content":"Configuración de Webhook","slug":"configuracion-de-webhook"}],"owner":"45421173","collectionId":"3662db5d-5420-49d2-b837-09eba945998d","publishedId":"2sB2x6mXha","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"232960"},"publishDate":"2025-06-13T13:30:57.000Z"},"item":[{"name":"Endpoints 1.0","item":[{"name":"Actualizar Token","id":"1d1d102d-57db-468f-98b6-5772898e3d3c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[{"key":"Origin","value":"https://{Seu domínio}.app.cxpress.io/","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"refresh_token\": \"{Refresh_Token}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.cxpress.io/external/update/token","description":"

Actualiza la autenticación del API Token después de su expiración. La solicitud debe contener un cuerpo (body) en formato JSON con un Refresh Token válido. La respuesta de la solicitud será:

un nuevo API Token válido
\n
un nuevo Refresh Token válido
\n

Este endpoint no requiere que el permiso esté habilitado en la interfaz para su uso, a diferencia de los demás endpoints de este documento.

\n","urlObject":{"protocol":"https","path":["external","update","token"],"host":["api","cxpress","io"],"query":[],"variable":[]}},"response":[{"id":"2cd7ce0b-1e18-413f-8b7d-62fe4e869296","name":"Actualizar Token","originalRequest":{"method":"PUT","header":[{"key":"Origin","value":"https://{Seu domínio}.app.cxpress.io/","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"refresh_token\": \"Refresh_Token0Refresh_Token0Refresh_Token0Refresh_Token0Refresh_Token0Refresh_Token0Refresh_Token0Refresh_Token0Refresh_Token0Refresh_Token0Refresh_Token0Refresh_Token0Refresh_Token0Refresh_Token0Refresh_Token0Refresh_Token0Refresh_Token0Refresh_Token0Refresh_Token0\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.cxpress.io/external/update/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n\t\"message\": \"Token actualizado con éxito.\",\r\n\t\"code_cxpress\": 6700,\r\n\t\"token\": \"Token1Token1Token1Token1Token1Token1Token1Token1Token1Token1Token1Token1Token1Token1Token1Token1Token1Token1Token1Token1Token1Token1Token1Token1Token1Token1Token1Token1Token1Token1Token1Token1Token1Token1\",\r\n\t\"refresToken\": \"Refresh_Token1Refresh_Token1Refresh_Token1Refresh_Token1Refresh_Token1Refresh_Token1Refresh_Token1Refresh_Token1Refresh_Token1Refresh_Token1Refresh_Token1Refresh_Token1Refresh_Token1Refresh_Token1Refresh_Token1Refresh_Token1Refresh_Token1Refresh_Token1\"\r\n}"}],"_postman_id":"1d1d102d-57db-468f-98b6-5772898e3d3c"},{"name":"Listar consumidores","id":"069e994e-fb8e-4932-950d-ff7c03377242","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Origin","value":"https://{Tu dominio}.app.cxpress.io/","type":"text"}],"url":"https://api.cxpress.io/external/consumer","description":"

Devuelve la información de todos los consumidores vinculados a la empresa.

Incluye parámetros de consulta.

\n","urlObject":{"protocol":"https","path":["external","consumer"],"host":["api","cxpress","io"],"query":[{"disabled":true,"description":{"content":"

Define el número máximo de consumidores que se devolverán por página.

\n","type":"text/plain"},"key":"limit","value":"integer > 0, opcional"},{"disabled":true,"description":{"content":"

Especifica el número de página que se devolverá en el listado paginado de consumidores.

\n","type":"text/plain"},"key":"page","value":"integer > 0, opcional"},{"disabled":true,"description":{"content":"

Permite filtrar consumidores con base en una string de búsqueda. La búsqueda se aplica sobre los siguientes campos: name, email, document_number, phone, whatsapp, instagram, twitter, facebook, youtube y adress.

\n","type":"text/plain"},"key":"search","value":"string, opcional"},{"disabled":true,"description":{"content":"

Define el campo por el cual deben ordenarse los resultados. Actualmente, el valor soportado es: name.

\n","type":"text/plain"},"key":"sort_by","value":"string, opcional"},{"disabled":true,"description":{"content":"

Indica la dirección del ordenamiento de los resultados. Los valores permitidos son: asc (orden ascendente) o desc (orden descendente).

\n","type":"text/plain"},"key":"order_by","value":"string, opcional"},{"disabled":true,"description":{"content":"

Filtra los consumidores con base en un arreglo de IDs de etiquetas de consumidores. Los valores deben estar separados por comas. Ejemplo: tag_id1,tag_id2,tag_id3.

\n","type":"text/plain"},"key":"tags","value":"array[string], opcional"},{"disabled":true,"description":{"content":"

Filtra los consumidores con base en un arreglo de IDs de operadores. Los valores deben estar separados por comas. Ejemplo: employee_id1,employee_id2,employee_id3.

\n","type":"text/plain"},"key":"employee","value":"array[string], opcional"},{"disabled":true,"description":{"content":"

Define si el filtro debe considerar todas las tags de consumidores registradas en la empresa. Valores aceptados: true o false.

\n","type":"text/plain"},"key":"allTags","value":"boolean, opcional"},{"disabled":true,"description":{"content":"

Filtra los consumidores que fueron registrados automáticamente al contactar a la empresa a través del canal de telefonía. Valores aceptados: true o false.

\n","type":"text/plain"},"key":"is_for_dialer","value":"boolean, opcional"}],"variable":[]}},"response":[{"id":"533783e1-0fbb-422f-bcac-7c76b748cb0e","name":"Listar consumidores","originalRequest":{"method":"GET","header":[{"key":"Origin","value":"https://{Tu dominio}.app.cxpress.io/","type":"text"}],"url":"https://api.cxpress.io/external/consumer"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n\t\"message\": \"éxito.\",\r\n\t\"consumers\": [\r\n\t\t{\r\n\t\t\t\"name\": \"01\",\r\n\t\t\t\"lastname\": null,\r\n\t\t\t\"user_id\": \"6d2904bd-cadc-40a3-9ac8-b7b13c0ae1a9\",\r\n\t\t\t\"email\": null,\r\n\t\t\t\"document_number\": null,\r\n\t\t\t\"phone\": \"558765876699\",\r\n\t\t\t\"address\": null,\r\n\t\t\t\"whatsapp\": null,\r\n\t\t\t\"employee_user_id\": null,\r\n\t\t\t\"direct_attendance_n2\": false,\r\n\t\t\t\"created_by_employee\": \"false\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"name\": \"02 espanha\",\r\n\t\t\t\"lastname\": null,\r\n\t\t\t\"user_id\": \"2bcf3319-09a3-4fd2-82f4-e3c6fb88beda\",\r\n\t\t\t\"email\": null,\r\n\t\t\t\"document_number\": null,\r\n\t\t\t\"phone\": \"34612345678\",\r\n\t\t\t\"address\": null,\r\n\t\t\t\"whatsapp\": null,\r\n\t\t\t\"employee_user_id\": null,\r\n\t\t\t\"direct_attendance_n2\": false,\r\n\t\t\t\"created_by_employee\": \"false\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"name\": \"11\",\r\n\t\t\t\"lastname\": null,\r\n\t\t\t\"user_id\": \"a1874711-399a-45d9-98bf-63d39ddad466\",\r\n\t\t\t\"email\": \"1@email.com\",\r\n\t\t\t\"document_number\": null,\r\n\t\t\t\"phone\": null,\r\n\t\t\t\"address\": null,\r\n\t\t\t\"whatsapp\": null,\r\n\t\t\t\"employee_user_id\": null,\r\n\t\t\t\"direct_attendance_n2\": false,\r\n\t\t\t\"created_by_employee\": \"true\"\r\n\t\t}\r\n ],\r\n\t\"code_cxpress\": 1400,\r\n\t\"pagination\": {\r\n\t\t\"total\": 3,\r\n\t\t\"lastPage\": 1,\r\n\t\t\"prevPage\": null,\r\n\t\t\"nextPage\": null,\r\n\t\t\"perPage\": 100,\r\n\t\t\"currentPage\": 1,\r\n\t\t\"from\": 0,\r\n\t\t\"to\": 100\r\n\t}\r\n}"}],"_postman_id":"069e994e-fb8e-4932-950d-ff7c03377242"},{"name":"Mostrar consumidor","id":"5da9fe8f-c603-4e36-ab2b-f72e419c9c20","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Origin","value":"https://{Tu dominio}.app.cxpress.io/","type":"text"}],"url":"https://api.cxpress.io/external/consumer/{user_id}","description":"

Muestra la información de un consumidor específico.

Se debe proporcionar el user_id del consumidor cuyas informaciones se mostrarán en el endpoint, similar al ejemplo presentado en el cURL de la sección \"Ejemplo\".

\n","urlObject":{"protocol":"https","path":["external","consumer","{user_id}"],"host":["api","cxpress","io"],"query":[],"variable":[]}},"response":[{"id":"ae2fdc88-53a3-4900-b988-d9fff5c60789","name":"Mostrar consumidor","originalRequest":{"method":"GET","header":[{"key":"Origin","value":"https://{Tu dominio}.app.cxpress.io/","type":"text"}],"url":"https://api.cxpress.io/external/consumer/191efbd3-1cab-4f7e-8ec1-7ae173e57dc3"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n\t\"message\": \"éxito.\",\r\n\t\"consumers\": [\r\n\t\t{\r\n\t\t\t\"id\": \"6cf3a2fc-bf53-4a53-86bd-71e05cd4f41a\",\r\n\t\t\t\"user_id\": \"191efbd3-1cab-4f7e-8ec1-7ae173e57dc3\",\r\n\t\t\t\"name\": \"Marcos 2\",\r\n\t\t\t\"lastname\": null,\r\n\t\t\t\"document_number\": null,\r\n\t\t\t\"email\": \"email@gmail.com\",\r\n\t\t\t\"phone\": null,\r\n\t\t\t\"instagram\": null,\r\n\t\t\t\"twitter\": null,\r\n\t\t\t\"facebook\": null,\r\n\t\t\t\"youtube\": null,\r\n\t\t\t\"whatsapp\": null,\r\n\t\t\t\"address\": null,\r\n\t\t\t\"observations\": null,\r\n\t\t\t\"webchat\": null,\r\n\t\t\t\"employee_user_id\": null,\r\n\t\t\t\"instagram_user\": null,\r\n\t\t\t\"facebook_user\": null,\r\n\t\t\t\"line_type_whatsapp\": null,\r\n\t\t\t\"direct_attendance_n2\": false,\r\n\t\t\t\"created_by_employee\": \"true\",\r\n\t\t\t\"tags\": [\r\n\t\t\t\tnull\r\n\t\t\t],\r\n\t\t\t\"custom_fields\": []\r\n\t\t}\r\n\t],\r\n\t\"code_cxpress\": 1400\r\n}"}],"_postman_id":"5da9fe8f-c603-4e36-ab2b-f72e419c9c20"},{"name":"Crear consumidor","id":"7ccf4bd4-dfc6-444f-a5a6-b3dbab1ab2dc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Origin","value":"https://{Tu dominio}.app.cxpress.io/","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"string\",\r\n \"lastname\": \"string\",\r\n \"document_number\": \"string\",\r\n \"email_addresses\": [\r\n \"email@email.com\"\r\n ],\r\n \"phone\": \"Teléfono en el formato código de país (DDI) + código de área (DDD) + número\",\r\n \"twitter\": \"string\",\r\n \"observations\": \"string\",\r\n \"youtube\": \"string\",\r\n \"address\": \"string\",\r\n \"whatsapp_numbers\": [\r\n \"Teléfono en el formato código de país (DDI) + código de área (DDD) + número\",\r\n ], \r\n \"custom_fields\": [\r\n {\r\n \"custom_field_id\": \"id\",\r\n \"value\": [\r\n \"Solo texto | Solo dígitos | Todos los tipos de caracteres\"\r\n ]\r\n }\r\n ],\r\n \"employee_user_id\": \"id\",\r\n \"tags\": [\r\n \"id\"\r\n ],\r\n \"direct_attendance_n2\": false\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.cxpress.io/external/consumer","description":"

Crea un nuevo consumidor vinculado a la empresa.

La solicitud debe contener un cuerpo (body) en formato JSON con el siguiente campo obligatorio:

name (string) – Nombre del consumidor.
\n
- Debe completarse con una cadena de texto.
\n

Los demás campos son opcionales:

lastname (string) – Apellido del consumidor.
\n
- Debe completarse con una string de texto.
\n
document_number (string) – Documento del consumidor.
\n
- Debe completarse con una string de texto.
\n
email_addresses [] (array[string]) – Correo(s) electrónico(s) del consumidor.
\n
- Debe completarse con uno o más correos electrónicos válidos.
\n
phone (string) – Teléfono del consumidor.
\n
- Debe completarse con un número de teléfono válido, con el formato: DDI + DDD + número.
  \n
  - Ejemplo: 551121222324
  \n
\n
twitter (string) – Twitter del consumidor.
\n
- Debe completarse con una string de texto.
\n
observations (string) – Observaciones del consumidor.
\n
- Debe completarse con una string de texto.
\n
youtube (string) – YouTube del consumidor.
\n
- Debe completarse con una string de texto.
\n
address (string) – Dirección del consumidor.
\n
- Debe completarse con una string de texto.
\n
whatsapp_numbers [] (array[string]) – Número(s) de WhatsApp del consumidor.
\n
- Debe completarse con uno o más números de teléfono válidos, en el formato: Código de país + código de área + número.
  \n
  - Ejemplo: 5511999887766
  \n
\n
custom_fields [] (array[object]) - Campos personalizados asociados al consumidor. Cada elemento debe contener:
\n
- id (string) – ID del campo personalizado
  \n
- value (string) – Valor correspondiente, según el tipo del campo
  \n
- ⚠️ Atención: Solo se aceptan campos personalizados del tipo consumidor. Campos personalizados de ticket generarán error.
  \n
- El valor (value) debe respetar el tipo del campo:
  \n
  - Texto: acepta solo letras (a–z, A–Z), incluyendo caracteres con acentos (ej.: é, ñ, ç, ó). No acepta espacios.
    \n
  - Numérico: acepta solo dígitos (0–9). No acepta espacios.
    \n
  - General: acepta cualquier carácter, incluidos espacios y símbolos especiales.
    \n
  \n
\n
employee_user_id (string) – ID del operador responsable del consumidor.
\n
- Debe completarse con el user_id de un operador.
\n
tags [] (array[string]) – Lista de IDs de las tags asociadas al consumidor.
\n
- Debe completarse con un array de string, donde cada cadena representa el id de una tag vinculada al consumidor.
  \n
- Las tags deben tener el campo active con el valor
  \n
  - true.
  \n
\n
direct_attendance_n2 (boolean) – Define si el consumidor debe ser dirigido directamente a atención humana (Nivel 2), sin pasar por el chatbot (Nivel 1).
\n
- Debe completarse con true o false.
  \n
  - false: sigue el flujo normal mediante el chatbot.
    \n
  - true: el ticket se creará directamente en atención humana.
    \n
  \n
\n

Reglas de unicidad

La creación del consumidor será rechazada si algún valor de los siguientes campos ya existe en otro consumidor, para evitar la duplicación de datos:

document_number
\n
email_addresses
\n
phone
\n
twitter
\n
youtube
\n
whatsapp_numbers
\n

\n","urlObject":{"protocol":"https","path":["external","consumer"],"host":["api","cxpress","io"],"query":[],"variable":[]}},"response":[{"id":"eecf1c6d-4838-47b5-8f9e-a32f7cf7e9ed","name":"Crear consumidor","originalRequest":{"method":"POST","header":[{"key":"Origin","value":"https://{Tu dominio}.app.cxpress.io/","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"abcde\",\r\n \"lastname\": \"fghi\",\r\n \"whatsapp_numbers\": [\r\n \"5581999887766\"\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.cxpress.io/external/consumer"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n\t\"message\": \"éxito.\",\r\n\t\"consumers\": [\r\n\t\t{\r\n\t\t\t\"id\": \"77110679-5c1c-4fae-b0ae-ddff5d3f1f94\",\r\n\t\t\t\"user_id\": \"5ccb32d0-63be-4f51-8bdc-145af4f7977a\",\r\n\t\t\t\"name\": \"abcde\",\r\n\t\t\t\"lastname\": \"fghi\",\r\n\t\t\t\"document_number\": null,\r\n\t\t\t\"email\": null,\r\n\t\t\t\"phone\": null,\r\n\t\t\t\"instagram\": null,\r\n\t\t\t\"twitter\": null,\r\n\t\t\t\"facebook\": null,\r\n\t\t\t\"youtube\": null,\r\n\t\t\t\"whatsapp\": null,\r\n\t\t\t\"address\": null,\r\n\t\t\t\"observations\": null,\r\n\t\t\t\"webchat\": null,\r\n\t\t\t\"employee_user_id\": null,\r\n\t\t\t\"instagram_user\": null,\r\n\t\t\t\"facebook_user\": null,\r\n\t\t\t\"line_type_whatsapp\": null,\r\n\t\t\t\"direct_attendance_n2\": false\r\n\t\t}\r\n\t],\r\n\t\"code_cxpress\": 1400\r\n}"}],"_postman_id":"7ccf4bd4-dfc6-444f-a5a6-b3dbab1ab2dc"},{"name":"Editar consumidor","id":"329890ee-16a8-4698-963e-b40d2d7d179c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":false},"method":"PUT","header":[{"key":"Origin","value":"https://{Tu dominio}.app.cxpress.io/","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"id\": \"user_id\",\r\n \"name\": \"string\",\r\n \"lastname\": \"string\",\r\n \"document_number\": \"string\",\r\n \"email_addresses\": [\r\n \"email@email.com\"\r\n ],\r\n \"phone\": \"Teléfono en el formato código de país (DDI) + código de área (DDD) + número\",\r\n \"twitter\": \"string\",\r\n \"observations\": \"string\",\r\n \"youtube\": \"string\",\r\n \"address\": \"string\",\r\n \"whatsapp_numbers\": [\r\n \"Teléfono en el formato código de país (DDI) + código de área (DDD) + número\",\r\n ], \r\n \"custom_fields\": [\r\n {\r\n \"custom_field_id\": \"id\",\r\n \"value\": [\r\n \"Solo texto | Solo dígitos | Todos los tipos de caracteres\"\r\n ]\r\n }\r\n ],\r\n \"employee_user_id\": \"id\",\r\n \"tags\": [\r\n \"id\"\r\n ],\r\n \"direct_attendance_n2\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.cxpress.io/external/consumer","description":"

Actualiza los datos de un consumidor existente vinculado a la empresa.
La solicitud debe contener un cuerpo (body) en formato JSON con los siguientes criterios:

Campo obligatorio:

Id (string) – Identificador único del consumidor que será actualizado.
\n
- Debe completarse con el user_id del consumidor que será actualizado.
\n

Reglas de la edición:

1 - Además del campo id, el cuerpo de la solicitud debe contener al menos uno de los campos siguientes para que la actualización se procese con éxito:

Campos mínimos requeridos:

name
\n
lastname
\n
phone
\n
email_addresses
\n
document_number
\n
twitter
\n
observations
\n

2 - Los siguientes campos no podrán actualizarse mientras el consumidor tenga tickets en curso, ya sea por atención humana o por atención de chatbot.

email_addresses
\n
whatsapp_numbers
\n

3 - Los demás campos disponibles para actualización siguen las mismas reglas de validación descritas en el endpoint Crear consumidor.

4 - Solo los campos que serán actualizados deben enviarse en el body. Los demás campos ya completados que no se incluyan en el body permanecerán con el mismo valor después de que se ejecute la solicitud de edición.

\n","urlObject":{"protocol":"https","path":["external","consumer"],"host":["api","cxpress","io"],"query":[],"variable":[]}},"response":[{"id":"d1c9efef-cf45-402a-bc45-3cb4861f2459","name":"Editar consumidor","originalRequest":{"method":"PUT","header":[{"key":"Origin","value":"https://{Tu dominio}.app.cxpress.io/","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"id\": \"26f0945e-7d18-4782-8249-f3ff46e29b77\",\r\n\t\"name\": \"abcdfgh\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.cxpress.io/external/consumer"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n\t\"message\": \"Consumidor actualizado con éxito.\",\n\t\"consumer\": {\n\t\t\"id\": \"1c1f8aaf-88bf-4e1c-8248-1984116b7e37\",\n\t\t\"user_id\": \"26f0945e-7d18-4782-8249-f3ff46e29b77\",\n\t\t\"name\": \"abcdfgh\",\n\t\t\"lastname\": null,\n\t\t\"document_number\": null,\n\t\t\"email\": null,\n\t\t\"phone\": null,\n\t\t\"instagram\": null,\n\t\t\"twitter\": null,\n\t\t\"facebook\": null,\n\t\t\"youtube\": null,\n\t\t\"whatsapp\": null,\n\t\t\"address\": null,\n\t\t\"observations\": null,\n\t\t\"webchat\": null,\n\t\t\"instagram_user\": null,\n\t\t\"facebook_user\": null,\n\t\t\"line_type_whatsapp\": null,\n\t\t\"direct_attendance_n2\": false,\n \"whatsapp_numbers\": [\n\t\t\t{\n\t\t\t\t\"number\": \"5511999887766\",\n\t\t\t\t\"line_type\": \"mobile\"\n\t\t\t}\n\t\t],\n\t\t\"email_addresses\": null,\n\t\t\"custom_fields\": []\n\t},\n\t\"code_cxpress\": 1400\n}"}],"_postman_id":"329890ee-16a8-4698-963e-b40d2d7d179c"},{"name":"Eliminar consumidor","id":"8c07a75a-74c0-4473-8f45-a6757005d7bf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":false},"method":"DELETE","header":[{"key":"Origin","value":"https://{Tu dominio}.app.cxpress.io/","type":"text"}],"url":"https://api.cxpress.io/external/consumer/{user_id}","description":"

Deleta un consumidor de la empresa.

El id del consumidor que será eliminado debe ser informado en el endpoint, similar al ejemplo presentado en el cURL en Example.

Cuando un consumidor es eliminado y posee tickets con estado Nuevo, Abierto, Pendiente o En espera en el momento de la eliminación, todos esos tickets en curso serán automáticamente finalizados. Después de esta acción, dejarán de mostrarse en la lista de tickets.

Devuelve la información de todas las tags de consumidores vinculadas a la empresa.
Cuenta con parámetros de consulta.

\n","urlObject":{"protocol":"https","path":["external","consumer-tag"],"host":["api","cxpress","io"],"query":[{"disabled":true,"description":{"content":"

Especifica el número de página que se devolverá en el listado paginado de tags de consumidores.

\n","type":"text/plain"},"key":"page","value":"integer > 0, opcional"},{"disabled":true,"description":{"content":"

Define el número máximo de tags de consumidores que se devolverán por página.

\n","type":"text/plain"},"key":"limit","value":"integer > 0, opcional"},{"disabled":true,"description":{"content":"

Filtra el listado devolviendo todas las tags de consumidores activas o inactivas. Este parámetro debe completarse con true (tags activas) o false (tags inactivas).

\n","type":"text/plain"},"key":"active","value":"boolean, opcional"},{"disabled":true,"description":{"content":"

Permite filtrar tags de consumidores con base en una string de búsqueda. La búsqueda se aplica sobre los siguientes campos: id y name.

\n","type":"text/plain"},"key":"search","value":"string, opcional"},{"disabled":true,"description":{"content":"

Define el campo por el cual deben ordenarse los resultados. Actualmente, los valores soportados son: name, reference_id, active, created_at.

\n","type":"text/plain"},"key":"sort_by","value":"string, opcional"},{"disabled":true,"description":{"content":"

Indica la dirección del ordenamiento de los resultados. Los valores permitidos son: asc (orden ascendente) o desc (orden descendente).

\n","type":"text/plain"},"key":"order_by","value":"string, opcional"}],"variable":[]}},"response":[{"id":"3684e06c-aa84-4656-9c2c-26f161386630","name":"Listar tags de consumidores","originalRequest":{"method":"GET","header":[{"key":"Origin","value":"https://{Tu dominio}.app.cxpress.io/","type":"text"}],"url":"https://api.cxpress.io/external/consumer-tag"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n\t\"message\": \"Solicitud atendida con éxito.\",\r\n\t\"tags\": [\r\n\t\t{\r\n\t\t\t\"id\": \"74cccdc3-8bb8-4f51-9108-92708dcdffb0\",\r\n\t\t\t\"reference_id\": 38,\r\n\t\t\t\"name\": \"atag\",\r\n\t\t\t\"active\": false,\r\n\t\t\t\"created_at\": \"2024-10-02T12:11:04.904Z\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"id\": \"aedd89db-f829-4879-883b-a5986c4935b8\",\r\n\t\t\t\"reference_id\": 54,\r\n\t\t\t\"name\": \"a_teste\",\r\n\t\t\t\"active\": true,\r\n\t\t\t\"created_at\": \"2024-12-30T18:04:26.897Z\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"id\": \"2baf9081-a458-4f84-9649-ee25d1c4aea0\",\r\n\t\t\t\"reference_id\": 1,\r\n\t\t\t\"name\": \"con12\",\r\n\t\t\t\"active\": true,\r\n\t\t\t\"created_at\": \"2024-04-08T13:50:30.572Z\"\r\n\t\t}\r\n\t],\r\n\t\"code_cxpress\": 5500,\r\n\t\"pagination\": {\r\n\t\t\"total\": 3,\r\n\t\t\"lastPage\": 1,\r\n\t\t\"prevPage\": null,\r\n\t\t\"nextPage\": null,\r\n\t\t\"perPage\": 100,\r\n\t\t\"currentPage\": 1,\r\n\t\t\"from\": 0,\r\n\t\t\"to\": 3\r\n\t}\r\n}"}],"_postman_id":"fb554636-86e9-473f-9127-3f8f73dce1ce"},{"name":"Crear tag de consumidor","id":"f8f74260-8eea-413b-a7c7-c58d3e19ccee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[{"key":"Origin","value":"https://{Tu dominio}.app.cxpress.io/","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"active\": true,\r\n \"name\": \"string\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.cxpress.io/external/consumer-tag","description":"

Crea una tag de consumidor vinculada a la empresa.
Esta tag de consumidor puede asociarse a un consumidor mediante los endpoints Crear consumidor y Editar consumidor, siempre que el valor del campo active sea true.
El cuerpo de la solicitud (body) contiene los siguientes campos obligatorios:

active (boolean) - Campo para indicar si la tag de consumidor está activa o no.
\n
- Debe llenarse con true o false.
\n
name (string) - Nombre de la tag de consumidor.
\n
- Debe llenarse con una string.
  \n
- No puede tener el mismo nombre que otra tag de consumidor.
  \n
\n

\n","urlObject":{"protocol":"https","path":["external","consumer-tag"],"host":["api","cxpress","io"],"query":[],"variable":[]}},"response":[{"id":"10c0fbec-42c1-4670-a1d2-0bd52e283825","name":"Crear tag de consumidor","originalRequest":{"method":"POST","header":[{"key":"Origin","value":"https://{Tu dominio}.app.cxpress.io/","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"active\": true,\r\n \"name\": \"teste2905\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.cxpress.io/external/consumer-tag"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"message\": \"Solicitud atendida con éxito.\",\n \"code_cxpress\": 5500\n}"}],"_postman_id":"f8f74260-8eea-413b-a7c7-c58d3e19ccee"},{"name":"Editar tag de consumidor","id":"a4a9fa5c-a843-45e4-b61c-5ebbf6e79240","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":false},"method":"PUT","header":[{"key":"Origin","value":"https://{Tu dominio}.app.cxpress.io/","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"active\": true,\r\n \"name\": \"string\",\r\n \"id\": \"id\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.cxpress.io/external/consumer-tag","description":"

Actualiza la información de una tag de consumidor vinculada a la empresa.
La solicitud debe contener un cuerpo (body) en formato JSON y debe incluir el campo:

id (string) - Identificador único de la tag de consumidor que será actualizada.
\n
- Debe llenarse con un id de una tag de consumidor.
\n

Los demás campos son los mismos que en la creación de tags de consumidor y siguen las mismas reglas del endpoint Crear tag de consumidor.

\n","urlObject":{"protocol":"https","path":["external","consumer-tag"],"host":["api","cxpress","io"],"query":[],"variable":[]}},"response":[{"id":"5581b89a-6f5b-415f-8edc-15dcc1f208d1","name":"Editar tag de consumidor","originalRequest":{"method":"PUT","header":[{"key":"Origin","value":"https://{Tu dominio}.app.cxpress.io/","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"active\": true,\r\n \"name\": \"teste2905\",\r\n\t\"id\": \"48a8ae11-0d70-408f-8a5b-973e58a3f85d\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.cxpress.io/external/consumer-tag"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"message\": \"Solicitud atendida con éxito.\",\n \"code_cxpress\": 5500,\n \"tag\": {\n \"id\": \"48a8ae11-0d70-408f-8a5b-973e58a3f85d\",\n \"reference_id\": 55,\n \"name\": \"teste2905\",\n \"active\": true,\n \"created_at\": \"2025-05-29T20:25:03.470Z\"\n }\n}"}],"_postman_id":"a4a9fa5c-a843-45e4-b61c-5ebbf6e79240"},{"name":"Listar tickets","id":"152ffb9f-bddc-4aa1-84f6-2348dd8d3d21","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[{"key":"Origin","value":"https://{Tu dominio}.app.cxpress.io/","type":"text"}],"url":"https://api.cxpress.io/external/ticket","description":"

Devuelve la información de todas las atenciones vinculadas a la empresa.

Cuenta con parámetros de consult.

\n","urlObject":{"protocol":"https","path":["external","ticket"],"host":["api","cxpress","io"],"query":[{"disabled":true,"description":{"content":"

Define el número máximo de tickets que se devolverán por página.

\n","type":"text/plain"},"key":"limit","value":"integer > 0, opcional"},{"disabled":true,"description":{"content":"

Especifica el número de página que se devolverá en el listado paginado de tickets.

\n","type":"text/plain"},"key":"page","value":"integer > 0, opcional"},{"disabled":true,"description":{"content":"

Filtra el listado devolviendo los tickets que tienen un determinado estado. Este parámetro debe completarse con un valor de status_id.

\n","type":"text/plain"},"key":"status","value":"string, opcional"},{"disabled":true,"description":{"content":"

Filtra el listado devolviendo los tickets que pertenecen a un canal. Este parámetro debe completarse con un valor de channel_id.

\n","type":"text/plain"},"key":"channel","value":"string, opcional"},{"disabled":true,"description":{"content":"

Filtra el listado devolviendo los tickets que pertenecen a un determinado operador. Este parámetro debe completarse con un valor de user_id.

\n","type":"text/plain"},"key":"employee","value":"string, opcional"},{"disabled":true,"description":{"content":"

Filtra el listado devolviendo todos los tickets que fueron atendidos por chatbot. El valor de este parámetro debe ser true o false.

\n","type":"text/plain"},"key":"bot","value":"boolean, opcional"},{"disabled":true,"description":{"content":"

Filtra los tickets con base en un arreglo de claves de automatizaciones. Los valores deben separarse por comas. Ejemplo: entity_key1,entity_key2,entity_key3.

\n","type":"text/plain"},"key":"automation","value":"array[string], opcional"},{"disabled":true,"description":{"content":"

Filtra el listado de tickets por un período determinado. Debe usarse junto con end_date.

\n","type":"text/plain"},"key":"start_date","value":"data no formato ISO 8601 ex.: YYYY-MM-DD, opcional"},{"disabled":true,"description":{"content":"

Filtra el listado de tickets por un período determinado. Debe usarse junto con start_date.

\n","type":"text/plain"},"key":"end_date","value":"data no formato ISO 8601 ex.: YYYY-MM-DD, opcional"},{"disabled":true,"description":{"content":"

Permite filtrar tickets con base en una string de búsqueda. La búsqueda se aplica al campo ticket_reference_id del ticket y a los campos del consumidor: name, lastname, email, whatsapp y phone.

\n","type":"text/plain"},"key":"search","value":"string, opcional"},{"disabled":true,"description":{"content":"

Filtra el listado devolviendo los tickets que pertenecen a un sector. Este parámetro debe completarse con un valor de sector_id.

\n","type":"text/plain"},"key":"sector","value":"string, opcional"},{"disabled":true,"description":{"content":"

Indica la dirección del ordenamiento de los resultados. Los valores permitidos son: asc (orden ascendente) o desc (orden descendente).

\n","type":"text/plain"},"key":"order_by","value":"string, opcional"},{"disabled":true,"description":{"content":"

Define el campo por el cual deben ordenarse los resultados. Actualmente, los valores soportados son: home_ticket_update_at y updated_level2_at.

\n","type":"text/plain"},"key":"sort_by","value":"string, opcional"},{"disabled":true,"description":{"content":"

Filtra los tickets con base en un arreglo de IDs de tags de tickets. Los valores deben separarse por comas. Ejemplo: tag_id1,tag_id2,tag_id3.

\n","type":"text/plain"},"key":"tags","value":"array[string], opcional"},{"disabled":true,"description":{"content":"

Filtra el listado devolviendo los tickets que fueron leídos o no. Este parámetro debe completarse con los valores true (leídos) o false (no leídos).

\n","type":"text/plain"},"key":"was_read","value":"boolean, opcional"},{"disabled":true,"description":{"content":"

Filtra el listado devolviendo los tickets que tienen o no un sector asignado. Este parámetro debe completarse con el valor true.

\n","type":"text/plain"},"key":"is_all_sectors","value":"boolean, opcional"}],"variable":[]}},"response":[{"id":"37962921-f149-4f6d-87a1-2beb071ec3e9","name":"Listar tickets","originalRequest":{"method":"GET","header":[{"key":"Origin","value":"https://{Tu dominio}.app.cxpress.io/","type":"text"}],"url":"https://api.cxpress.io/external/ticket"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"message\": \"Solicitud atendida con éxito.\",\n \"code_cxpress\": 700,\n \"tickets\": [\n {\n \"id\": \"2f61bd86-ddd3-46c6-ab9e-03746502303f\",\n \"status_id\": \"daddbd66-1dd2-4008-94c9-7fcb9b1a5800\",\n \"updated_at\": \"2025-05-29T15:10:49.614Z\",\n \"updated_level2_at\": \"2025-05-29T13:41:42.781Z\",\n \"channel_id\": \"3f3fa530-fd3e-4018-ab98-4d9c3cd5406a\",\n \"deleted_at\": null,\n \"ticket_reference_id\": \"30595\",\n \"subject\": \"test\",\n \"who_is_viewing\": null,\n \"consumer_last_message\": \"2025-05-29T13:41:43.156Z\",\n \"processing\": false,\n \"who_is_viewing_user_id\": null,\n \"home_ticket_update_at\": \"2025-05-29T13:41:43.156Z\",\n \"requester_user\": {\n \"name\": \"Alana\",\n \"lastname\": null\n },\n \"assigned_employee\": {\n \"name\": null,\n \"lastname\": null\n },\n \"sector\": {\n \"id\": \"e937f3c3-2ad7-4e53-b02d-ae963c9a723f\",\n \"name\": \"AAA Setor API teste\"\n },\n \"bold\": false,\n \"last_message\": \"eteste\\n\\n-- \\n[image: Elife]\\n\\n[image: We deliver insights] \\n *Alana Tenório*\\n_cel: *+55 87 99950-2991*\\n\\nwww.elife.com.br\\n\",\n \"tags\": null,\n \"custom_fiejds\": null\n },\n {\n \"id\": \"6ff4ec2f-ebc9-447c-91ea-0758f0405fd9\",\n \"status_id\": \"b58c1105-0ffe-4d07-a7d6-751389fc3008\",\n \"updated_at\": \"2025-05-29T14:09:35.161Z\",\n \"updated_level2_at\": \"2025-05-28T16:08:22.594Z\",\n \"channel_id\": \"3f3fa530-fd3e-4018-ab98-4d9c3cd5406a\",\n \"deleted_at\": null,\n \"ticket_reference_id\": \"30573\",\n \"subject\": \"texte\",\n \"who_is_viewing\": null,\n \"consumer_last_message\": \"2025-05-28T16:11:41.557Z\",\n \"processing\": false,\n \"who_is_viewing_user_id\": null,\n \"home_ticket_update_at\": \"2025-05-28T16:11:41.557Z\",\n \"requester_user\": {\n \"name\": \"Alana\",\n \"lastname\": null\n },\n \"assigned_employee\": {\n \"name\": \"Alana\",\n \"lastname\": null\n },\n \"sector\": {\n \"id\": \"e937f3c3-2ad7-4e53-b02d-ae963c9a723f\",\n \"name\": \"AAA Setor API externa\"\n },\n \"bold\": false,\n \"last_message\": \"Recebido.\\n\\nEm qua., 28 de mai. de 2025 às 13:11,\\n\\nescreveu:\\n\\n>\\n> AAAAAAAA\\n>\\n> *Alana | Teste Ari 03*\\n> ------------------------------\\n> ------------------------------\\n>\\n\",\n \"tags\": null,\n \"custom_fiejds\": null\n },\n {\n \"id\": \"8e10b67b-388d-42f1-8b64-c5db46acb430\",\n \"status_id\": \"daddbd66-1dd2-4008-94c9-7fcb9b1a5800\",\n \"updated_at\": \"2025-05-29T12:29:52.759Z\",\n \"updated_level2_at\": \"2025-05-28T12:18:35.195Z\",\n \"channel_id\": \"3f3fa530-fd3e-4018-ab98-4d9c3cd5406a\",\n \"deleted_at\": null,\n \"ticket_reference_id\": \"30572\",\n \"subject\": \"TesteDeEnvio\",\n \"who_is_viewing\": null,\n \"consumer_last_message\": \"2025-05-28T12:18:35.669Z\",\n \"processing\": false,\n \"who_is_viewing_user_id\": null,\n \"home_ticket_update_at\": \"2025-05-28T12:18:35.669Z\",\n \"requester_user\": {\n \"name\": \"email3@gmail.com\",\n \"lastname\": null\n },\n \"assigned_employee\": {\n \"name\": null,\n \"lastname\": null\n },\n \"sector\": {\n \"id\": \"e937f3c3-2ad7-4e53-b02d-ae963c9a723f\",\n \"name\": \"AAA Setor API externa\"\n },\n \"bold\": false,\n \"last_message\": \"AAAAA\\n\",\n \"tags\": null,\n \"custom_fiejds\": null\n },\n {\n \"id\": \"ade030ec-5044-4182-a374-69ddd99e9b11\",\n \"status_id\": \"0ec35dbb-398e-4c2f-996c-933af162c950\",\n \"updated_at\": \"2025-05-29T12:30:05.762Z\",\n \"updated_level2_at\": \"2025-05-28T11:42:19.775Z\",\n \"channel_id\": \"3f3fa530-fd3e-4018-ab98-4d9c3cd5406a\",\n \"deleted_at\": null,\n \"ticket_reference_id\": \"30570\",\n \"subject\": \"ticket\",\n \"who_is_viewing\": null,\n \"consumer_last_message\": null,\n \"processing\": false,\n \"who_is_viewing_user_id\": null,\n \"home_ticket_update_at\": \"2025-05-28T11:43:05.102Z\",\n \"requester_user\": {\n \"name\": \"email2@gmail.com\",\n \"lastname\": null\n },\n \"assigned_employee\": {\n \"name\": \"Alana\",\n \"lastname\": null\n },\n \"sector\": {\n \"id\": null,\n \"name\": null\n },\n \"bold\": false,\n \"last_message\": \"oi\",\n \"tags\": null,\n \"custom_fiejds\": null\n },\n {\n \"id\": \"13a3ff38-125d-4a4a-b455-d1841287a96f\",\n \"status_id\": \"0ec35dbb-398e-4c2f-996c-933af162c950\",\n \"updated_at\": \"2025-05-29T12:30:47.758Z\",\n \"updated_level2_at\": \"2025-05-28T11:19:48.735Z\",\n \"channel_id\": \"3f3fa530-fd3e-4018-ab98-4d9c3cd5406a\",\n \"deleted_at\": null,\n \"ticket_reference_id\": \"30569\",\n \"subject\": \"ticket com cc e cco\",\n \"who_is_viewing\": null,\n \"consumer_last_message\": null,\n \"processing\": false,\n \"who_is_viewing_user_id\": null,\n \"home_ticket_update_at\": \"2025-05-28T11:20:34.247Z\",\n \"requester_user\": {\n \"name\": \"email1@gmail.com\",\n \"lastname\": null\n },\n \"assigned_employee\": {\n \"name\": \"Alana\",\n \"lastname\": null\n },\n \"sector\": {\n \"id\": null,\n \"name\": null\n },\n \"bold\": false,\n \"last_message\": \"oi\",\n \"tags\": null,\n \"custom_fiejds\": null\n },\n {\n \"id\": \"33c8efe0-4ecc-4936-888a-5c94ce9c7b12\",\n \"status_id\": \"daddbd66-1dd2-4008-94c9-7fcb9b1a5800\",\n \"updated_at\": \"2025-05-28T17:18:03.021Z\",\n \"updated_level2_at\": \"2025-04-22T13:28:50.057Z\",\n \"channel_id\": \"33be81d8-88ac-4e08-bb4d-cf69fd23267f\",\n \"deleted_at\": null,\n \"ticket_reference_id\": \"30123\",\n \"subject\": \"WhatsApp\",\n \"who_is_viewing\": null,\n \"consumer_last_message\": \"2025-04-22T13:41:18.599Z\",\n \"processing\": false,\n \"who_is_viewing_user_id\": null,\n \"home_ticket_update_at\": \"2025-04-22T13:41:18.636Z\",\n \"requester_user\": {\n \"name\": \"Narciso\",\n \"lastname\": null\n },\n \"assigned_employee\": {\n \"name\": null,\n \"lastname\": null\n },\n \"sector\": {\n \"id\": \"4f5024e5-d88d-4ce6-8db6-e4f9a83a9f03\",\n \"name\": \"Setor\"\n },\n \"bold\": false,\n \"last_message\": \"atendimento humano\",\n \"tags\": null,\n \"custom_fiejds\": null\n }\n ],\n \"pagination\": {\n \"total\": 6,\n \"lastPage\": 1,\n \"prevPage\": null,\n \"nextPage\": null,\n \"perPage\": 100,\n \"currentPage\": 1,\n \"from\": 0,\n \"to\": 6\n }\n}"}],"_postman_id":"152ffb9f-bddc-4aa1-84f6-2348dd8d3d21"},{"name":"Listar historial de tickets","id":"89c97f64-ecf3-44b4-bb10-73d01fa61b5b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Origin","value":"https://{Tu dominio}.app.cxpress.io/","type":"text"}],"url":"https://api.cxpress.io/external/historic","description":"

Retorna la información de todas las atenciones finalizadas vinculadas a la empresa. Este endpoint incluye:

Tickets finalizados después de atención humana
\n
Tickets finalizados únicamente con atención por chatbot
\n
Tickets de telefonía, en los cuales:
\n
- Las llamadas fueron finalizadas solo en el voicebot, o
  \n
- Las llamadas no fueron atendidas por ninguna extensión de un agente humano.
  \n
\n
Tickets eliminados.
\n

Cuenta con parámetros de consulta.

Para cada una de las opciones mencionadas arriba, este documento presenta versiones con sus respectivos parámetros de filtrado. Estos endpoints están detallados más adelante en este documento.

\n","urlObject":{"protocol":"https","path":["external","historic"],"host":["api","cxpress","io"],"query":[{"disabled":true,"description":{"content":"

Define el número máximo de tickets que se devolverán por página.

\n","type":"text/plain"},"key":"limit","value":"integer > 0, opcional"},{"disabled":true,"description":{"content":"

Especifica el número de página que se devolverá en el listado paginado de tickets.

\n","type":"text/plain"},"key":"page","value":"integer > 0, opcional"},{"disabled":true,"description":{"content":"

Indica la dirección del ordenamiento de los resultados. Los valores permitidos son: asc (orden ascendente) o desc (orden descendente).

\n","type":"text/plain"},"key":"order_by","value":"string, opcional"},{"disabled":true,"description":{"content":"

Define el campo por el cual deben ordenarse los resultados. Actualmente, los valores soportados son: 'finished_at',\n 'created_at',\n 'updated_level2_at',\n 'deleted_at',

\n","type":"text/plain"},"key":"sort_by","value":"string, opcional"},{"disabled":true,"description":{"content":"

Filtra el listado devolviendo los tickets que tienen un determinado estado. Este parámetro debe completarse con un valor de status_id. Siendo el valor de cada estado de ticket:\nNuevo - daddbd66-1dd2-4008-94c9-7fcb9b1a5800\nAbierto - b58c1105-0ffe-4d07-a7d6-751389fc3008\nPendiente - 0ec35dbb-398e-4c2f-996c-933af162c950\nEn espera - 3dd9b9ac-7399-4ce8-b22c-a513eb473803\nResuelto - 2b45ba71-fa68-4ce5-bf16-14f31d43ba1a\nAbandonado - 2f955a38-e8cf-4033-bf6c-

\n","type":"text/plain"},"key":"status","value":"string, opcional"},{"disabled":true,"description":{"content":"

Filtra el listado devolviendo los tickets que pertenecen a un canal. Este parámetro debe completarse con un valor de channel_id.

\n","type":"text/plain"},"key":"channel","value":"string, opcional"},{"disabled":true,"description":{"content":"

Filtra el listado devolviendo los tickets que pertenecen a un determinado operador. Este parámetro debe completarse con un valor de user_id.

\n","type":"text/plain"},"key":"employee","value":"string, opcional"},{"disabled":true,"description":{"content":"

Filtra el listado devolviendo todos los tickets que fueron atendidos por chatbot. El valor de este parámetro debe ser true o false