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
| Método | Rota | Content-Type |
|---|---|---|
GET | https://api.tomticket.com/v2.0/chat/list | form-data |
Autenticação
Este endpoint utiliza autenticação Bearer Token.
Authorization: Bearer SEU_TOKEN_AQUICaso ainda não possua um Token de Acesso, consulte o artigo Criação do Token de Acesso.
Parâmetros da requisição
Parâmetros da requisição - Consultar Chats
| Campo | Tipo | Obrigatório | Tamanho máximo | Descrição |
|---|---|---|---|---|
page | integer | Não | - | Índice da página que deseja acessar. São exibidos 50 itens a cada página. |
customer_id | string | Não | 250 | Identificador interno do cliente para realizar a busca e atualização das informações. Pode ser o endereço de e-mail do cadastro ou o identificador interno utilizado. |
customer_type_id | string | Não | 1 | Tipo de identificador utilizado para localizar o cliente, sendo I para identificador interno e E para e-mail. |
department_id | string | Não | 512 | Identificador do departamento. Exibe apenas os chats deste departamento. |
organization_id | string | Não | 512 | Identificador de organização e organização matriz. Exibe chats cujo cliente esteja vinculado a essas organizações. |
min_protocol | integer | Não | - | Permite buscar chats que tenham protocolo menor ou igual ao usado na busca. |
max_protocol | integer | Não | - | Permite buscar chats que tenham protocolo maior ou igual ao usado na busca. |
creation_date_le | integer | Não | - | Permite listar chats com a data de criação menor ou igual à data informada. A data deve seguir o padrão YYYY-MM-DD HH:II:SS-TZ, sendo TZ o timezone. |
creation_date_ge | integer | Não | - | Permite listar chats com a data de criação maior ou igual à data informada. A data deve seguir o padrão YYYY-MM-DD HH:II:SS-TZ, sendo TZ o timezone. |
JSON de saída
JSON de saída - Consultar Chats
| Campo | Tipo | Descrição |
|---|---|---|
error | boolean | 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 message para identificar o problema. |
message | string | Detalhes da operação, caso tenha ocorrido ou não um problema. |
success | boolean | Retorna true caso a operação tenha sido concluída com sucesso. |
size | integer | Total de itens encontrados. |
pages | integer | Total de páginas disponíveis para consulta. |
next_page | integer | Próxima página disponível para navegação. Retorna null caso não haja. |
previous_page | integer | Página anterior para navegação. Retorna null caso não haja. |
data | array | Lista com os chats cadastrados. |
id | string | Identificador do chat. |
protocol | integer | Protocolo do chat. |
refer | string | Endereço da página que continha o chat e onde se originou o mesmo. |
geo | array | Informações de geolocalização do usuário com base no IP de origem. |
city | string | Cidade de acesso. |
state | string | Estado de acesso. |
country | string | País de acesso. |
user_agent | string | User Agent do cliente (navegador). |
origin | integer | Código identificador da origem do chat: 1 - Chat Padrão do TomTicket; 2 - Facebook; 3 - WhatsApp (Twillio). |
situation | integer | Código identificador da situação do chat: 1 - Aguardando; 2 - Em conversa; 3 - Finalizado. |
tags | array | Lista de rótulos aplicados ao atendimento. |
id | string | Identificador do rótulo. |
description | string | Nome do rótulo. |
customer | array | Informações do cliente. |
registred | boolean | Caso o cliente tenha iniciado o chat autenticado com e-mail/senha, token JWT ou via Painel do Cliente, retorna true. |
name | string | Nome do cliente. |
email | string | Endereço de e-mail do cliente. |
internal_id | string | Identificador interno do cliente, se for registrado. |
organization | array | Informações da organização do cliente, se o mesmo for registrado. |
id | string | Identificador da organização. |
name | string | Nome da organização. |
creation_date | string | Data e hora em que foi criado o chat. |
conversation | array | Datas para abertura e finalização do chat. |
start | string | Data e hora do início da conversa. |
end | string | Data e hora do fim da conversa. |
evaluation | array | Avaliação do atendimento. |
grade | integer | Identificação da nota enviada pelo cliente: 5 - Ótimo; 4 - Bom; 3 - Regular; 2 - Ruim; 1 - Péssimo. |
comment | string | Comentário da avaliação do atendimento. |
department | array | Informações do departamento do atendimento. |
id | string | Identificador do departamento. |
name | string | Nome do departamento. |
operator | array | Informações do atendente responsável pelo atendimento. |
id | string | Identificador do atendente. |
name | string | Nome do atendente. |
transfered | boolean | Caso o chat tenha sido criado por transferência de outro chat, retorna true. |
transfered_origin | string | Caso transferido, retorna o identificador do chat que gerou ele. |
closed_situation | array | Informações sobre o encerramento do chat. |
type | integer | Identificador do modo de encerramento: 1 - Finalizado pelo cliente; 2 - Finalizado pelo atendente responsável pelo atendimento; 3 - Finalizado por um gerente. |
operator | array | Informações do atendente que realizou o encerramento do chat. |
id | string | Identificador do atendente. |
name | string | Nome do atendente. |
Possíveis erros
| Status HTTP | Mensagem | Quando ocorre |
|---|---|---|
| 401 | Token ou valores enviados não autorizados para uso. | Quando o token ou os valores enviados não estão autorizados. |
| 403 | Recurso não disponível. | Quando o recurso não está disponível. |
| 404 | Recurso não encontrado. | Quando o recurso não é encontrado. |