{"info":{"_postman_id":"aa1245fc-a2be-4dcb-9a14-5da48a23074d","name":"API Cxpress","description":"

Bem-vindo à documentação da API de integração da Cxpress.

Este documento apresenta a especificação técnica das requisições disponíveis para interação com a API, permitindo a realização de consultas e alterações a partir de aplicações externas. Também estão incluídas as instruções para geração do token de autenticação, essencial para garantir o acesso seguro aos endpoints. Este guia tem como objetivo fornecer todas as informações necessárias para o consumo eficiente, estruturado e confiável da API, viabilizando a integração com sistemas externos de forma segura e padronizada.

Estrutura

A documentação está organizada por versões, com prioridade para a versão mais recente da API.
\n
Caso um determinado endpoint não esteja documentado na versão mais atual, deve-se utilizar o endpoint disponível na versão mais recente em que ela estiver documentada.
\n
A API da Cxpress possui limite de 300 requisições por minuto por IP. Caso esse limite seja excedido dentro do período de 60 segundos, será aplicado automaticamente um bloqueio de segurança de 10 minutos para o IP responsável pelas requisições.
\n

Gerando uma entidade de integração

Para criar uma nova entidade de integração, o usuário com perfil de PROPRIETÁRIO da empresa deve seguir o caminho abaixo dentro da plataforma:

Menu lateral -> Configurações -> Empresa -> API

\n\n

Na tela de API, clique no botão localizado no canto superior da interface:

\n\n

Ao acionar esse botão, será exibido um modal onde deverão ser preenchidas as seguintes informações:

Nome do token: Nome de identificação da entidade de integração.
\n
Permissões: Seleção dos endpoints que o token poderá acessar.
\n

\n\n

Após a criação da entidade de integração, o API Token e o Refresh Token serão gerados e disponibilizados ao usuário. Esses tokens permitem autenticar requisições e realizar alterações na plataforma Cxpress por meio da integração com sistemas externos.

⚠️ Importante: Os tokens são exibidos apenas uma vez após a criação. Certifique-se de armazená-los em local seguro.

\n\n

Validade e Gerenciamento de Tokens

O API Token possui validade de 1 hora. Após esse período, ele é automaticamente invalidado.
\n
O Refresh Token tem validade de 168 horas (7 dias). Após sua expiração, não será mais possível gerar novos tokens de acesso a partir dele.
\n

O Token de Integração será exibido na listagem da interface, porém não poderá ser editado. Caso seja necessário alterar as permissões de acesso, o usuário deverá criar um novo token e definir as permissões desejadas no momento da criação.

\n\n

Na seção Endpoints 1.0 deste documento, estão detalhadas as respostas de todos os endpoints acessíveis por meio de um Token de Integração, bem como as instruções para sua utilização.

Configuração de Webhook

A funcionalidade de webhook permite que sistemas externos sejam notificados automaticamente sempre que determinados eventos ocorrerem na plataforma da Cxpress.

Na tela de API, clique no botão localizado acima da listagem de Tokens:

\n\n

Campos de Configuração

Ao acionar esse botão, será exibido um modal onde deverão ser preenchidas as seguintes informações:

Endpoint: URL de destino para a qual as notificações de eventos serão encaminhadas. Trata-se do endereço configurado para recebimento das requisições HTTP geradas pelo mecanismo de webhook.
\n
Eventos: Permite a seleção dos eventos que deverão acionar notificações para o endpoint configurado. É possível habilitar individualmente os seguintes tipos de eventos:
\n
- Criação (create) - Disparado quando uma das entidades disponíveis é criada na Cxpress.
  \n
- Atualização (update) - Disparado quando uma das entidades disponíveis é modificada na Cxpress.
  \n
\n

\n\n

Entidades Disponíveis

As notificações de webhook englobam os eventos ocorridos para os seguintes tipos de entidades:

Consumidor
\n
Ticket
\n
Tarefa
\n
Setor
\n
Tags de Tickets
\n
Tags de Consumidores
\n
Campos Customizados
\n

Funcionamento

Ao ativar um tipo de evento (Criação ou Atualização), o sistema enviará automaticamente uma notificação HTTP POST para o endpoint configurado sempre que a ação correspondente a uma entidade disponível ocorrer.

O payload da requisição incluirá os dados atualizados ou recém-criados da entidade, permitindo que o sistema externo reaja em tempo real às mudanças.

Exemplo de Caso de Uso

Ao habilitar o evento de criação (create), o endpoint configurado será acionado sempre que uma das entidades disponíveis for criada no sistema. A requisição enviada ao endpoint conterá, no corpo (payload), os dados da entidade recém-criada.

Por exemplo, no caso do evento de criação da entidade Setor, o corpo da requisição será estruturado da seguinte forma:

{\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      \"esquerda\"\n    ]\n  }\n}\n\n

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Gerando uma entidade de integração","slug":"gerando-uma-entidade-de-integracao"},{"content":"Configuração de Webhook","slug":"configuracao-de-webhook"}],"owner":"45421173","collectionId":"aa1245fc-a2be-4dcb-9a14-5da48a23074d","publishedId":"2sB2qi8HcV","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"232960"},"publishDate":"2025-06-03T21:31:20.000Z"},"item":[{"name":"Endpoints 1.0","item":[{"name":"Atualizar Token","id":"23322e5b-5d3c-460d-89e9-4544469de58f","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":"

Atualiza a autenticação da API Token após sua expiração. A requisição deve conter um corpo (body) no formato JSON com um Refresh Token válido. O retorno da requisição será:

uma nova API Token válida
\n
um novo Refresh Token válido
\n

Esse endpoint não necessita de que a permissão seja habilitada na interface para utilização igual aos demais endpoints desse documento.

\n","urlObject":{"protocol":"https","path":["external","update","token"],"host":["api","cxpress","io"],"query":[],"variable":[]}},"response":[{"id":"8aeed608-77c9-4502-a2c2-90ef3e5f925d","name":"Atualizar 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 atualizado com sucesso.\",\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":"23322e5b-5d3c-460d-89e9-4544469de58f"},{"name":"Listar consumidores","id":"a135adbd-8f5e-4e02-bdeb-f83b5302f81a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[{"key":"Origin","value":"https://{Seu domínio}.app.cxpress.io/","type":"text"}],"url":"https://api.cxpress.io/external/consumer","description":"

Retorna as informações de todos os consumidores vinculados à empresa.

Possui parâmetros de consulta.

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

Define o número máximo de consumidores a serem retornados por página.

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

Especifica o número da página a ser retornada na listagem paginada de consumidores.

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

Permite a filtragem de consumidores com base em uma string de busca. A pesquisa é aplicada sobre os seguintes campos: 'name', 'email', 'document_number', 'phone', 'whatsapp', 'instagram', 'twitter', 'facebook', 'youtube' e 'adress'.

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

Define o campo pelo qual os resultados devem ser ordenados. Atualmente, o valor suportado é: 'name'

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

Indica a direção da ordenação dos resultados. Os valores permitidos são: 'asc' (ordem crescente) ou 'desc' (ordem decrescente).

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

Filtra os consumidores com base em um array de IDs de tags de consumidores. Os valores devem ser separados por vírgula.\nExemplo: tag_id1,tag_id2,tag_id3.

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

Filtra os consumidores com base em um array de IDs de operadores. Os valores devem ser separados por vírgula.\nExemplo: employee_id1,employee_id2,employee_id3.

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

Define se o filtro deve considerar todas as tags de consumidores cadastradas na empresa. Valores aceitos: 'true' ou 'false'

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

Filtra os consumidores que foram cadastrados automaticamente ao entrarem em contato com a empresa via o canal de Telefonia. Valores aceitos: 'true' ou 'false'

\n","type":"text/plain"},"key":"is_for_dialer","value":"boolean, opcional"}],"variable":[]}},"response":[{"id":"902f6127-4281-4dd0-b30f-d1da6150886b","name":"Listar consumidores","originalRequest":{"method":"GET","header":[{"key":"Origin","value":"https://{Seu domínio}.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\": \"sucesso\",\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":"a135adbd-8f5e-4e02-bdeb-f83b5302f81a"},{"name":"Exibir consumidor","id":"8b32b1f2-0927-44c2-872a-561799528bdd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Origin","value":"https://{Seu domínio}.app.cxpress.io/","type":"text"}],"url":"https://api.cxpress.io/external/consumer/{user_id}","description":"

Exibe as informações de um consumidor específico.

O user_id do consumidor no qual as informações serão exibidas deve ser informado no endpoint, semelhante ao exemplo apresentado no cURL em Example.

\n","urlObject":{"protocol":"https","path":["external","consumer","{user_id}"],"host":["api","cxpress","io"],"query":[],"variable":[]}},"response":[{"id":"c33c9064-2ca7-4dec-8b03-f6b7798b1a5c","name":"Exibir consumidor","originalRequest":{"method":"GET","header":[{"key":"Origin","value":"https://{Seu domínio}.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\": \"sucesso\",\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":"8b32b1f2-0927-44c2-872a-561799528bdd"},{"name":"Criar consumidor","id":"4af4bfa0-44af-4b87-b1ac-821496f979da","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[{"key":"Origin","value":"https://{Seu domínio}.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\": \"Telefone no formato DDI + 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 \"Telefone no formato DDI + DDD + Número\"\r\n ],\r\n \"custom_fields\": [\r\n {\r\n \"custom_field_id\": \"id\",\r\n \"value\": [\r\n \"Somente texto | Somente digitos | Todos os 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":"

Cria um novo consumidor vinculado à empresa.

A requisição deve conter um corpo (body) no formato JSON com o seguinte campo obrigatório:

name (string) - Nome do consumidor.
\n
- Deve ser preenchido com uma string.
\n

Os demais campos são opcionais:

lastname (string) - Sobrenome do consumidor.
\n
- Deve ser preenchido com uma string.
\n
document_number (string) - Documento do consumidor.
\n
- Deve ser preenchido com uma string.
\n
email_addresses [] (array[string]) - E-mail(s) do consumidor
\n
- Deve ser preenchido com um ou mais e-mails válidos.
\n
phone (string) - Telefone do consumidor.
\n
- Deve ser preenchido com um número de telefone válido, com o formato: DDI + DDD + número.
  \n
  - Exemplo: 551121222324
  \n
\n
twitter (string) - Twitter do consumidor.
\n
- Deve ser preenchido com uma string.
\n
observations (string) - Observações do consumidor.
\n
- Deve ser preenchido com uma string.
\n
youtube (string) - Youtube do consumidor.
\n
- Deve ser preenchido com uma string.
\n
address (string) - Endereço do consumidor
\n
- Deve ser preeenchido com uma string.
\n
whatsapp_numbers [] (array[string]) - número(s) de WhatsApp do consumidor.
\n
- Deve ser preenchido com um ou mias números de telefone válido, com o formato: DDI + DDD + número.
  \n
  - Exemplo: 5511999887766
  \n
\n
custom_fields [] (array[object]) - Campos customizados associados ao consumidor. Cada item deve conter:
\n
- id (string) - ID do campo customizado
  \n
- value (string) - Valor correspondente, de acordo com o tipo do campo
  \n
- ⚠️ Atenção: Apenas campos customizados de consumidor são aceitos. Campos customizados de ticket causarão erro.
  \n
- O valor (value) deve respeitar o tipo do campo:
  \n
  - Texto: Aceita apenas letras (a–z, A–Z), incluindo caracteres com acentos (ex.: é, ã, ç, õ). Não aceita espaços.
    \n
  - Numérico: aceita apenas dígitos (0-9). Não aceita espaços.
    \n
  - Geral: aceita qualquer caractere, inclusive espaços e símbolos especiais.
    \n
  \n
\n
employee_user_id (string) - ID do operador responsável pelo consumidor.
\n
- Deve ser preenchido com o user_id de um operador.
\n
tags [] (array[string]) - Lista de IDs das tags associadas ao consumidor.
\n
- Deve ser preenchido com um array de strings, onde cada string representa o id de uma tag vinculada ao consumidor.
  \n
- As tags necessitam ter o campo active com o valor true.
  \n
\n
direct_attendance_n2 (boolean) - Define se o consumidor deve ser encaminhado diretamente para atendimento humano (Nível 2), sem passar pelo atendimento do chatbot (Nível 1).
\n
- Deve ser preenchido com true ou false.
  \n
  - false: segue o fluxo normal via chatbot.
    \n
  - true: o ticket será criado diretamente no atendimento humano.
    \n
  \n
\n

Regras de unicidade

A criação do consumidor será rejeitada se algum valor dos seguintes campos já existir em outro consumidor, para evitar duplicidade de dados:

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":"6c5b0f85-f881-418b-a62d-c2458802b90e","name":"Criar consumidor","originalRequest":{"method":"POST","header":[{"key":"Origin","value":"https://{Seu domínio}.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\": \"sucesso\",\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":"4af4bfa0-44af-4b87-b1ac-821496f979da"},{"name":"Editar consumidor","id":"54efee49-070c-4844-a7df-ed7ec11b5f4e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":false},"method":"PUT","header":[{"key":"Origin","value":"https://{Seu domínio}.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\": \"Telefone no formato DDI + 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 \"Telefone no formato DDI + DDD + Número\"\r\n ],\r\n \"custom_fields\": [\r\n {\r\n \"custom_field_id\": \"id\",\r\n \"value\": [\r\n \"Somente texto | Somente digitos | Todos os 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":"

Atualiza os dados de um consumidor existente vinculado à empresa.

A requisição deve conter um corpo (body) em formato JSON com os seguintes critérios:

Campo obrigatório:

Id (string) - Identificador único do consumidor que será atualizado.
\n
- Deve ser preenchido com o user_id do consumidor que será atualizado.
\n

Regras da edição:

1 - Além do campo id, o corpo da requisição deve conter ao menos um dos campos abaixo para que a atualização seja processada com sucesso:

Campos mínimos exigidos:

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

2 - Os seguintes campos não poderão ser atualizados enquanto o consumidor possuir tickets em andamento, seja por atendimento humano (N2) ou atendimento chatbot (N1):

email_addresses
\n
whatsapp_numbers
\n

3 - Os demais campos disponíveis para atualização seguem as mesmas regras de validação descritas no endpoint Criar consumidor.

4 - Apenas os campos que serão atualizados devem ser enviados no body. Os demais campos já preenchidos que não serão inclusos no body, permanecerão com o mesmo valor após a requisição de edição ser executada.

\n","urlObject":{"protocol":"https","path":["external","consumer"],"host":["api","cxpress","io"],"query":[],"variable":[]}},"response":[{"id":"c0f8a092-2ded-4283-9519-a781da7212a8","name":"Editar consumidor","originalRequest":{"method":"PUT","header":[{"key":"Origin","value":"https://{Seu domínio}.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 atualizado com sucesso\",\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\"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":"54efee49-070c-4844-a7df-ed7ec11b5f4e"},{"name":"Excluir consumidor","id":"350d8c7d-fcb9-4d99-8d29-0729eb7319a7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":false},"method":"DELETE","header":[{"key":"Origin","value":"https://{Seu domínio}.app.cxpress.io/","type":"text"}],"url":"https://api.cxpress.io/external/consumer/{user_id}","description":"

Deleta um consumidor da empresa.

O id do consumidor que será deletado deve ser informado no endpoint, semelhante ao exemplo apresentado no cURL em Example.

Quando um consumidor é excluído e possui tickets com status de Novo, Aberto, Pendente ou Em espera no momento da exclusão, todos esses tickets em andamento serão automaticamente finalizados. Após essa ação, eles deixarão de ser exibidos na listagem de tickets.

Retorna as informações de todas as tags de consumidores vinculadas à empresa.

Possui parâmetros de consulta.

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

Especifica o número da página a ser retornada na listagem paginada de tags de consumidores.

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

Define o número máximo de tags de consumidores a serem retornados por página.

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

Filtra a listagem retornando todas as tags de consumidores ativas ou inativas. Esse parâmetro deve ser preenchido com 'true' (tags ativas) ou 'false' (tags inativas).

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

Permite a filtragem de tags de consumidores com base em uma string de busca. A pesquisa é aplicada sobre os seguintes campos: 'id' e 'name'

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

Define o campo pelo qual os resultados devem ser ordenados. Atualmente, os valores suportados são: 'name', 'reference_id', 'active', 'created_at'

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

Indica a direção da ordenação dos resultados. Os valores permitidos são: 'asc' (ordem crescente) ou 'desc' (ordem decrescente).

\n","type":"text/plain"},"key":"order_by","value":"string, opcional"}],"variable":[]}},"response":[{"id":"4fc483fe-7aca-4724-9f8b-5d236a5ae1c7","name":"Listar tags de consumidores","originalRequest":{"method":"GET","header":[{"key":"Origin","value":"https://{Seu domínio}.app.cxpress.io/","type":"text"}],"url":{"raw":"https://api.cxpress.io/external/consumer-tag","protocol":"https","host":["api","cxpress","io"],"path":["external","consumer-tag"],"query":[{"key":"page","value":"integer > 0","description":"(Opcional) Página a ser exibida na listagem de tags","type":"text","disabled":true},{"key":"limit","value":"integer > 0","description":"(Opcional) Limite de tags exibidas por página","type":"text","disabled":true},{"key":"active","value":"boolean","description":"(Opcional) Filtro booleano para listar as tags ativas. Possui os valores 'true' e 'false'","type":"text","disabled":true},{"key":"search","value":"string","description":"(Opcional) Filtra pelo campo de pesquisar tag. O sistema permite a pesquisa por tags pelos campos: “ID” e \"Nome\"","type":"text","disabled":true},{"key":"sort_by","value":"string","description":"(Opcional) Filtro de ordenação por campo. É possível filtrar pelos valores: 'name', 'reference_id', 'active', 'created_at'","type":"text","disabled":true},{"key":"order_by","value":"string","description":"(Opcional) Filtro de tipo de ordenação por conteúdo. Os valores são: 'asc' ou 'desc'","type":"text","disabled":true}]}},"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\": \"Requisição atendida com sucesso.\",\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":"67386068-4267-4ced-9ee4-2636c44db316"},{"name":"Criar tag de consumidor","id":"090fcdbb-adc7-44a9-a747-4b2b97dc6c89","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[{"key":"Origin","value":"https://{Seu domínio}.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":"

Cria uma tag de consumidor vinculada à empresa.

Essa tag de consumidor pode ser associada a um consumidor por meio dos endpoints Criar consumidor e Editar consumidor desde que o valor do campo active seja true.

O corpo da requisição (body) contém os seguintes campos obrigatórios:

active (boolean) - Campo para indicar se a tag de consumidor está ativa ou não.
\n
- Deve ser preenchido com true ou false.
\n
name (string) - Nome da tag de consumidor.
\n
- Deve ser preenchida com uma string.
  \n
- Não pode possuir o mesmo nome de outra tag de consumidor.
  \n
\n

\n","urlObject":{"protocol":"https","path":["external","consumer-tag"],"host":["api","cxpress","io"],"query":[],"variable":[]}},"response":[{"id":"cb1fc239-413a-4972-b89a-d357a6803704","name":"Criar tag de consumidor","originalRequest":{"method":"POST","header":[{"key":"Origin","value":"https://{Seu domínio}.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\": \"Requisição atendida com sucesso.\",\n \"code_cxpress\": 5500\n}"}],"_postman_id":"090fcdbb-adc7-44a9-a747-4b2b97dc6c89"},{"name":"Editar tag de consumidor","id":"f671b9fd-370c-445e-bbe0-4cc0ab39bfc6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":false},"method":"PUT","header":[{"key":"Origin","value":"https://{Seu domínio}.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":"

Atualiza as informações de uma tag de consumidor vinculada à empresa.

A requisição deve conter um corpo (body) em formato JSON e necessita ter o campo:

id (string) - Identifcador único da tag de consumidor que será atualizada.
\n
- Deve ser preenchido com um id de uma tag de consumidor.
\n

Os demais campos são os mesmos da criação de tags de consumidores e possuem as mesmas regras do endpoint Criar tag de consumidor.

\n","urlObject":{"protocol":"https","path":["external","consumer-tag"],"host":["api","cxpress","io"],"query":[],"variable":[]}},"response":[{"id":"ba034582-4f40-4a7d-8313-3c917efbc6bf","name":"Editar tag de consumidor","originalRequest":{"method":"PUT","header":[{"key":"Origin","value":"https://{Seu domínio}.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\": \"Requisição atendida com sucesso.\",\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":"f671b9fd-370c-445e-bbe0-4cc0ab39bfc6"},{"name":"Listar tickets","id":"94d57141-8ed6-4c3e-a5c5-78a011d25f9c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[{"key":"Origin","value":"https://{Seu domínio}.app.cxpress.io/","type":"text"}],"url":"https://api.cxpress.io/external/ticket","description":"

Retorna as informações de todos os atendimentos vinculados à empresa.

Possui parâmetros de consulta.

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

Define o número máximo de tickets a serem retornados por página.

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

Especifica o número da página a ser retornada na listagem paginada de tickets.

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

Filtra a listagem retornando os tickets que possuem um determinado status. Esse parâmetro deve ser preenchido com um valor de 'status_id'. Sendo o valor de cada status de ticket:\nNovo - daddbd66-1dd2-4008-94c9-7fcb9b1a5800\nAberto - b58c1105-0ffe-4d07-a7d6-751389fc3008\nPendente - 0ec35dbb-398e-4c2f-996c-933af162c950\nEm espera - 3dd9b9ac-7399-4ce8-b22c-a513eb473803

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

Filtra a listagem retornando os tickets que pertencem a um canal. Esse parâmetro deve ser preenchido com um valor de 'channel_id'.

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

Filtra a listagem retornando os tickets que pertencem a um determinado operador. Esse parâmetro deve ser preenchido com um valor de 'user_id'.

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

Filtra a listagem retornando todos os tickets que tiveram atendimento chatbot. O valor desse parâmetro deve ser 'true' ou 'false'

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

Filtra os tickets com base em um array de keys de automações. Os valores devem ser separados por vírgula.\nExemplo: entity_key1,entity_key2,entity_key3.

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

Filtra a listagem por tickets por um determinado período. Preicsa ser complementado com o 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 a listagem por ticketspor um determinado período. Preicsa ser complementado com o 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 a filtragem de tickets com base em uma string de busca. A pesquisa é aplicada sobre o campo de ticket: 'ticket_reference_id' e pelos campos de consumidor: 'name', 'lastname', 'email', 'whatsapp' e 'phone'.

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

Filtra a listagem retornando os tickets que pertencem a um setor. Esse parâmetro deve ser preenchido com um valor de 'sector_id'.

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

Indica a direção da ordenação dos resultados. Os valores permitidos são: 'asc' (ordem crescente) ou 'desc' (ordem decrescente).

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

Define o campo pelo qual os resultados devem ser ordenados. Atualmente, os valores suportados são: 'home_ticket_update_at' e 'updated_level2_at'.

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

Filtra os tickets com base em um array de IDs de tags de tickets. Os valores devem ser separados por vírgula.\nExemplo: tag_id1,tag_id2,tag_id3.

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

Filtra a listagem retornando os tickets que foram lidos ou não. Esse parâmetro deve ser preenchido com os valores 'true' (tickets lidos) ou 'false' (tickets não lidos);

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

Filtra a listagem retornando os tickets que possuem setor ou não. Esse parâmetro deve ser preenchido com o valor 'true'.

\n","type":"text/plain"},"key":"is_all_sectors","value":"boolean, opcional"}],"variable":[]}},"response":[{"id":"4028361e-54a8-41a4-96c0-08590280ba8a","name":"Listar tickets","originalRequest":{"method":"GET","header":[{"key":"Origin","value":"https://{Seu domínio}.app.cxpress.io/","type":"text"}],"url":{"raw":"https://api.cxpress.io/external/ticket","protocol":"https","host":["api","cxpress","io"],"path":["external","ticket"],"query":[{"key":"limit","value":"integer > 0, opcional","description":"Define o número máximo de tickets a serem retornados por página.","type":"text","disabled":true},{"key":"page","value":"integer > 0, opcional","description":"Especifica o número da página a ser retornada na listagem paginada de tickets.","type":"text","disabled":true},{"key":"status","value":"string, opcional","description":"Filtra a listagem retornando os tickets que possuem um determinado status. Esse parâmetro deve ser preenchido com um valor de 'status_id'. Sendo o valor de cada status de ticket:\nNovo - daddbd66-1dd2-4008-94c9-7fcb9b1a5800\nAberto - b58c1105-0ffe-4d07-a7d6-751389fc3008\nPendente - 0ec35dbb-398e-4c2f-996c-933af162c950\nEm espera - 3dd9b9ac-7399-4ce8-b22c-a513eb473803","disabled":true},{"key":"channel","value":"string, opcional","description":"Filtra a listagem retornando os tickets que pertencem a um canal. Esse parâmetro deve ser preenchido com um valor de 'channel_id'.","type":"text","disabled":true},{"key":"employee","value":"string, opcional","description":"Filtra a listagem retornando os tickets que pertencem a um determinado agente. Esse parâmetro deve ser preenchido com um valor de 'user_id'.","type":"text","disabled":true},{"key":"bot","value":"boolean, opcional","description":"Filtra a listagem retornando todos os tickets que tiveram atendimento chatbot. O valor desse parâmetro deve ser 'true' ou 'false'","type":"text","disabled":true},{"key":"automation","value":"array[string], opcional","description":"Filtra os tickets com base em um array de keys de automações. Os valores devem ser separados por vírgula.\nExemplo: entity_key1,entity_key2,entity_key3.","type":"text","disabled":true},{"key":"start_date","value":"data no formato ISO 8601 ex.: YYYY-MM-DD, opcional","description":"Filtra a listagem por tickets por um determinado período. Preicsa ser complementado com o end_date","type":"text","disabled":true},{"key":"end_date","value":"data no formato ISO 8601 ex.: YYYY-MM-DD, opcional","description":"Filtra a listagem por ticketspor um determinado período. Preicsa ser complementado com o start_date","type":"text","disabled":true},{"key":"search","value":"string, opcional","description":"Permite a filtragem de tickets com base em uma string de busca. A pesquisa é aplicada sobre o campo de ticket: 'ticket_reference_id' e pelos campos de consumidor: 'name', 'lastname', 'email', 'whatsapp' e 'phone'.","type":"text","disabled":true},{"key":"sector","value":"string, opcional","description":"Filtra a listagem retornando os tickets que pertencem a um setor. Esse parâmetro deve ser preenchido com um valor de 'sector_id'.","type":"text","disabled":true},{"key":"order_by","value":"string, opcional","description":"Indica a direção da ordenação dos resultados. Os valores permitidos são: 'asc' (ordem crescente) ou 'desc' (ordem decrescente).","type":"text","disabled":true},{"key":"sort_by","value":"string, opcional","description":"Define o campo pelo qual os resultados devem ser ordenados. Atualmente, os valores suportados são: 'home_ticket_update_at' e 'updated_level2_at'.","type":"text","disabled":true},{"key":"tags","value":"array[string], opcional","description":"Filtra os tickets com base em um array de IDs de tags de tickets. Os valores devem ser separados por vírgula.\nExemplo: tag_id1,tag_id2,tag_id3.","type":"text","disabled":true},{"key":"was_read","value":"boolean, opcional","description":"Filtra a listagem retornando os tickets que foram lidos ou não. Esse parâmetro deve ser preenchido com os valores 'true' (tickets lidos) ou 'false' (tickets não lidos);","type":"text","disabled":true},{"key":"is_all_sectors","value":"boolean, opcional","description":"Filtra a listagem retornando os tickets que possuem setor ou não. Esse parâmetro deve ser preenchido com o valor 'true'.","type":"text","disabled":true}]}},"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\": \"Requisição atendida com sucesso.\",\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":"94d57141-8ed6-4c3e-a5c5-78a011d25f9c"},{"name":"Listar histórico de tickets","id":"2a8045a6-3dbe-4d19-8486-4ed9ada4dbfa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Origin","value":"https://{Seu domínio}.app.cxpress.io/","type":"text"}],"url":"https://api.cxpress.io/external/historic","description":"

Retorna as informações de todos os atendimentos finalizados vinculados à empresa. Estão inclusos nesse endpoint:

Tickets finalizados após atendimento humano
\n
Tickets finalizados somente com atendimento chatbot
\n
Tickets finalizados de telefonia, nos quais:
\n
- As chamadas foram finalizadas somente no voicebot ou
  \n
- As chamadas não foram atendidas por nenhum ramal de atendente humano.
  \n
\n
Tickets excluídos.
\n

Possui parâmetros de consulta.

Para cada uma dessas opções acima, neste documento existem as versões com os seus respectivos parâmetros de filtragem. Esses endpoints estão detalhados mais abaixo nesse documento.

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

Define o número máximo de tickets a serem retornados por página.

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

Especifica o número da página a ser retornada na listagem paginada de tickets.

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

Indica a direção da ordenação dos resultados. Os valores permitidos são: 'asc' (ordem crescente) ou 'desc' (ordem decrescente).

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

Define o campo pelo qual os resultados devem ser ordenados. Atualmente, os valores suportados são: 'finished_at',\n 'created_at',\n 'updated_level2_at',\n 'deleted_at',