Início / API / Chats

Consultar Chat - Individualmente

Este método permite obter informações de um chat de forma individual.


Endpoint

https://api.tomticket.com/v2.0/chat/detail

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
chat_idIdentificador do atendimento.
Sim-String512

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
dataInformações do chat.Object
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
data
messages
Lista com as mensagens trocadas entre atendente e cliente.Array
data
messages
    message
Mensagem enviada.String
data
messages
    date
Data e hora do envio da mensagem.String
data
messages
    sender
Identificação de quem enviou a mensagem.

  • 1 - Atendente
  • 2 - Cliente
Int
data
messages
    attachment
Informações do anexo enviado como mensagem.Array
data
messages
    attachment
        url
URL para download do arquivo.String
data
messages
    attachment
        filename
Nome do arquivo.String
data
messages
    attachment
        mimetype
Mimetype do arquivo.String
data
custom_fields
Lista de campos personalizados utilizados no chat.
Array
data
custom_fields
    open
Lista de campos personalizados utilizados na criação.Array
data
custom_fields
    open
        id
Identificador do campo personalizado.String
data
custom_fields
    open
        label
Nome do campo personalizado.String
data
custom_fields
    open
        value
Valor informado no campo personalizado.String
data
custom_fields
    evaluation
Lista de campos personalizados utilizados na avaliação.Array
data
custom_fields
    evaluation
        id
Identificador do campo personalizado.String
data
custom_fields
    evaluation
        label
Nome do campo personalizado.String
data
custom_fields
    evaluation
        value
Valor informado no campo personalizado.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.