Início / API / Chats

Consultar Chats

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.


ChaveDescriçãoObrigatórioValor PadrãoTipoTamanho Máximo
pageÍndice da página que deseja acessar. São exibidos 50 itens a cada página.Não1Int-
customer_idIdentificador 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-String250
customer_type_id
Tipo de identificador utilizado para localizar o cliente, sendo:
I - Identificador interno
E - Email
Não
I
String
1
department_idIdentificador do departamento, irá mostrar apenas os chats deste departamento.Não-String512
organization_idIdentificador de organização e organização matriz, irá mostrar chats cujo o cliente esteja vinculado nessas organizações.Não-String512
min_protocolPermite 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_protocolPermite 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_lePermite 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_gePermite 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.

ColunaDescrição da ColunaTipo
errorInforma 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
messageDetalhes da operação, caso tenha ocorrido ou não um problema.String
successRetorna true caso a operação tenha sido concluída com sucesso.Boolean
sizeTotal de itens encontrados.Int
pagesTotal de páginas disponíveis para consulta.Int
next_pagePróxima página disponível para navegação. Retornará NULL caso não houver.Int
previous_pagePágina anterior para navegação. Retornará NULL caso não houver.Int
dataLista com os chats cadastrados.Array
data
id
Identificador do chat.String
data
protocol
Protocolo do chat.Int
data
refer
Endereço da página que continha o chat e onde se originou o mesmo.String
data
geo
Informações de Geolocalização do usuário baseado no IP de origem.Array
data
geo
    city
Cidade de acesso.String
data
geo
    state
Estado de acesso.String
data
geo
    country
País de acesso.String
data
user_agent
User Agent do cliente (navegador).String
data
origin
Código identificador da origem do chat.
  • 1 - Chat Padrão do TomTicket
  • 2 - Facebook
  • 3 - WhatsApp (Twillio)
Int
data
situation
Código identificador da situação do chat.
  • 1 - Aguardando
  • 2 - Em conversa
  • 3 - Finalizado
Int
data
tags
Lista de rótulos aplicados ao atendimento.Array
data
tags
    id
Identificador do rótulo.String
data
tags
    description
Nome do rótulo.String
data
customer
Informações do cliente.Array
data
customer
    registred
Caso o cliente tenha iniciado o chat se autenticado com email/senha, token JWT ou via Painel do Cliente, irá retornar TRUE.Boolean
data
customer
    name
Nome do cliente.String
data
customer
    email
Endereço de email do cliente.String
data
customer
    internal_id
Identificador interno do cliente, se for registrado.String
data
customer
    organization
Informações da organização do cliente, se o mesmo for registrado.Array
data
customer
    organization
        id
Identificador da organização.String
data
customer
    organization
        name
Nome da organização.String
data
creation_date
Data e hora em que foi criado o chat.String
data
conversation
Datas para abertura e finalização do chat.Array
data
conversation
    start
Data e hora do início da conversa.String
data
conversation
    end
Data e hora do fim da conversa.String
data
evaluation
Avaliação do atendimento.Array
data
evaluation
    grade
Identificação da nota enviada pelo cliente.

  • 5 - Ótimo
  • 4 - Bom
  • 3 - Regular
  • 2 - Ruim
  • 1 - Péssimo
Int
data
evaluation
    comment
Comentário da avaliação do atendimento.String
data
department
Informações do departamento do atendimento.Array
data
department
    id
Identificador do departamento.String
data
department
    name
Nome do departamento.String
data
operator
Informações do atendente responsável pelo atendimento.Array
data
operator
    id
Identificador do atendente.String
data
operator
    name
Nome do atendente.String
data
transfered
Caso o chat tenha sido criado através de transferência de outro chat, retornará como TRUE.Boolean
data
transfered_origin
Caso transferido, retorna o identificador do chat que gerou ele.String
data
closed_situation
Informações sobre o o encerramento do chat.Array
data
closed_situation
    type
Identificador do modo de encerramento.

  • 1 - Finalizado pelo cliente
  • 2 - Finalizado pelo atendente responsável pelo atendimento
  • 3 - Finalizado por um gerente
Int
data
closed_situation
    operator
Informações do atendente que realizou o encerramento do chat.Array
data
closed_situation
    operator
        id
Identificador do atendente.String
data
closed_situation
    operator
        name
Nome do atendente.String

Código de Retorno

Descrição do código HTTP de retorno.

CódigoDescrição
200Operação realizada com sucesso.
401Token ou valores enviados não autorizados para uso.
403Recurso não disponível.
404Recurso não encontrado.

Disponibilidade

Recurso Premium Recurso Enterprise

Este artigo foi útil?  
Agradecemos sua avaliação.