Este método permite listar todos os atendimentos de chat que sua conta possui.
A consulta de chats exibe 50 itens por página, sendo necessário navegar entre as páginas para consultar outros resultados.
Endpoint
https://api.tomticket.com/v2.0/chat/list
Método HTTP
GET
Content Type
form-data
Autenticação
Authorization: Bearer {SEU-TOKEN-AQUI}
Parâmetros Query String
Os parâmetros Query String são enviadas diretamente na URL após o símbolo de "?" ao final do endpoint. Cada parâmetro e valor deve ser enviado com o nome dele e valor, separados pelo símbolo de "=", como por exemplo nomeParametro=ValorParametro. Para enviar mais de um parâmetro, deve separá-los, usando símbolo "&", como por exemplo nomeParametro1=ValorParametro1&nomeParametro2=ValorParametro2.
| Chave | Descrição | Obrigatório | Valor Padrão | Tipo | Tamanho Máximo |
|---|---|---|---|---|---|
| page | Índice da página que deseja acessar. São exibidos 50 itens a cada página. | Não | 1 | Int | - |
| customer_id | Identificador interno do cliente para realizar a busca e atualização das informações. Pode ser o endereço de email do cadastro ou identificador interno utilizado. | Não | - | String | 250 |
| customer_type_id | Tipo de identificador utilizado para localizar o cliente, sendo: I - Identificador interno E - Email | Não | I | String | 1 |
| department_id | Identificador do departamento, irá mostrar apenas os chats deste departamento. | Não | - | String | 512 |
| organization_id | Identificador de organização e organização matriz, irá mostrar chats cujo o cliente esteja vinculado nessas organizações. | Não | - | String | 512 |
| min_protocol | Permite buscar chats que tenham o protocolo menor ou igual ao usado na busca. Caso de Uso: Buscar chats cujo o protocolo deve ser igual ou menor que 123. min_protocol=123 | Não | - | Int | - |
| max_protocol | Permite buscar chats que tenham o protocolo maior ou igual ao usado na busca. Caso de Uso: Buscar chats cujo o protocolo deve ser igual ou maior que 456. max_protocol=456 | Não | - | Int | - |
| creation_date_le | Permite listar chats com a data de criação sendo menor e igual a data informada. A data deve seguir o padrão YYYY-MM-DD HH:II:SS-TZ, sendo TZ o timezone. Exemplo: 1 de Fevereiro de 1970, 14:30 no timezone America/Sao_Paulo (-03) será: 1970-02-01 14:30:59-0300 | Não | - | Int | - |
| creation_date_ge | Permite listar chats com a data de criação sendo maior e igual a data informada. A data deve seguir o padrão YYYY-MM-DD HH:II:SS-TZ, sendo TZ o timezone. Exemplo: 1 de Fevereiro de 1970, 14:30 no timezone America/Sao_Paulo (-03) será: 1970-02-01 14:30:00-0300 | Não | - | Int | - |
Retorno
Descrição do retorno em JSON.
| Coluna | Descrição da Coluna | Tipo |
|---|---|---|
| error | Informa se ocorreu um erro na operação. Se o retorno for false, então significa que a operação ocorreu com sucesso e não ocorreram problemas. Caso o retorno seja true, ocorreu um erro e será necessário verificar o campo mensagem para identificar o problema. | Boolean |
| message | Detalhes da operação, caso tenha ocorrido ou não um problema. | String |
| success | Retorna true caso a operação tenha sido concluída com sucesso. | Boolean |
| size | Total de itens encontrados. | Int |
| pages | Total de páginas disponíveis para consulta. | Int |
| next_page | Próxima página disponível para navegação. Retornará NULL caso não houver. | Int |
| previous_page | Página anterior para navegação. Retornará NULL caso não houver. | Int |
| data | Lista com os chats cadastrados. | Array |
| dataid | Identificador do chat. | String |
| dataprotocol | Protocolo do chat. | Int |
| datarefer | Endereço da página que continha o chat e onde se originou o mesmo. | String |
| datageo | Informações de Geolocalização do usuário baseado no IP de origem. | Array |
| datageo city | Cidade de acesso. | String |
| datageo state | Estado de acesso. | String |
| datageo country | País de acesso. | String |
| datauser_agent | User Agent do cliente (navegador). | String |
| dataorigin | Código identificador da origem do chat.
| Int |
| datasituation | Código identificador da situação do chat.
| Int |
| datatags | Lista de rótulos aplicados ao atendimento. | Array |
| datatags id | Identificador do rótulo. | String |
| datatags description | Nome do rótulo. | String |
| datacustomer | Informações do cliente. | Array |
| datacustomer registred | Caso o cliente tenha iniciado o chat se autenticado com email/senha, token JWT ou via Painel do Cliente, irá retornar TRUE. | Boolean |
| datacustomer name | Nome do cliente. | String |
| datacustomer email | Endereço de email do cliente. | String |
| datacustomer internal_id | Identificador interno do cliente, se for registrado. | String |
| datacustomer organization | Informações da organização do cliente, se o mesmo for registrado. | Array |
| datacustomer organization id | Identificador da organização. | String |
| datacustomer organization name | Nome da organização. | String |
| datacreation_date | Data e hora em que foi criado o chat. | String |
| dataconversation | Datas para abertura e finalização do chat. | Array |
| dataconversation start | Data e hora do início da conversa. | String |
| dataconversation end | Data e hora do fim da conversa. | String |
| dataevaluation | Avaliação do atendimento. | Array |
| dataevaluation grade | Identificação da nota enviada pelo cliente.
| Int |
| dataevaluation comment | Comentário da avaliação do atendimento. | String |
| datadepartment | Informações do departamento do atendimento. | Array |
| datadepartment id | Identificador do departamento. | String |
| datadepartment name | Nome do departamento. | String |
| dataoperator | Informações do atendente responsável pelo atendimento. | Array |
| dataoperator id | Identificador do atendente. | String |
| dataoperator name | Nome do atendente. | String |
| datatransfered | Caso o chat tenha sido criado através de transferência de outro chat, retornará como TRUE. | Boolean |
| datatransfered_origin | Caso transferido, retorna o identificador do chat que gerou ele. | String |
| dataclosed_situation | Informações sobre o o encerramento do chat. | Array |
| dataclosed_situation type | Identificador do modo de encerramento.
| Int |
| dataclosed_situation operator | Informações do atendente que realizou o encerramento do chat. | Array |
| dataclosed_situation operator id | Identificador do atendente. | String |
| dataclosed_situation operator name | Nome do atendente. | String |
Código de Retorno
Descrição do código HTTP de retorno.
| Código | Descrição |
|---|---|
| 200 | Operação realizada com sucesso. |
| 401 | Token ou valores enviados não autorizados para uso. |
| 403 | Recurso não disponível. |
| 404 | Recurso não encontrado. |
Disponibilidade
