Parâmetros da requisição - Consultar Chat - Individualmente
Campo
Tipo
Obrigatório
Tamanho máximo
Descrição
chat_id
string
Sim
512
Identificador do atendimento.
JSON de saída
JSON de saída - Consultar Chat - Individualmente
Campo
Tipo
Descrição
error
boolean
Indica se ocorreu um erro. Retorna false quando a consulta é realizada com sucesso.
message
string
Mensagem sobre a operação. Retorna null quando a consulta é realizada com sucesso.
data
object
Dados do chat consultado.
id
string
Identificador do chat.
protocol
integer
Número do protocolo do atendimento.
refer
string
Endereço da página em que o chat foi iniciado. Pode retornar null.
geo
object
Dados de geolocalização associados ao acesso do cliente.
city
string
Cidade de origem do acesso. Pode retornar null.
state
string
Estado de origem do acesso. Pode retornar null.
country
string
País de origem do acesso. Pode retornar null.
user_agent
string
Informações do navegador ou aplicativo utilizado pelo cliente. Pode retornar null.
origin
integer
Origem do atendimento: 1 = chat padrão do TomTicket; 2 = Facebook; 3 = WhatsApp via Twilio.
situation
integer
Situação do atendimento: 1 = aguardando; 2 = em conversa; 3 = finalizado. Retorna 0 quando a situação não corresponde a esses estados.
tags
array
Rótulos aplicados ao atendimento. Retorna null quando não houver rótulos disponíveis.
id
string
Identificador do rótulo.
description
string
Descrição do rótulo.
customer
object
Dados do cliente associado ao atendimento.
registred
boolean
Indica se o atendimento está associado a um cliente cadastrado. O nome registred corresponde ao campo retornado pela API.
name
string
Nome do cliente cadastrado ou, quando indisponível, nome informado na abertura do atendimento. Pode retornar null.
email
string
E-mail do cliente cadastrado ou, quando indisponível, e-mail informado no atendimento. Pode retornar null.
phone
string
Telefone do cliente cadastrado ou, quando indisponível, número de origem do atendimento via WhatsApp. Pode retornar null.
internal_id
string
Identificador interno do cliente na conta. Pode retornar null.
organization
object
Organização associada ao cadastro do cliente.
id
string
Identificador da organização. Retorna null quando não houver organização associada.
name
string
Nome da organização. Pode retornar null.
creation_date
datetime
Data e hora de criação do atendimento.
conversation
object
Datas de início e término da conversa.
start
datetime
Data e hora de início do atendimento. Pode retornar null quando o atendimento ainda não tiver iniciado.
end
datetime
Data e hora de finalização do atendimento. Pode retornar null quando o atendimento ainda não tiver terminado.
evaluation
object
Avaliação do atendimento.
avaliacao
integer
Nota da avaliação, de 1 a 5. Retorna 0 quando não houver uma avaliação reconhecida.
comment
string
Comentário registrado na avaliação. Pode retornar null.
department
object
Departamento associado ao atendimento.
id
string
Identificador do departamento. Pode retornar null.
name
string
Nome do departamento. Pode retornar null.
operator
object
Atendente responsável pelo atendimento.
id
string
Identificador do atendente responsável. Pode retornar null quando não houver atendente associado.
name
string
Nome do atendente responsável. Pode retornar null.
transfered
boolean
Indica se este atendimento foi criado a partir da transferência de outro chat.
transfered_origin
string
Identificador do chat que originou a transferência. Retorna null quando o atendimento não tiver origem em uma transferência.
closed_situation
object
Informações sobre o encerramento do atendimento.
type
integer
Código do encerramento: 0 = sem encerramento identificado; 1 = finalizado com situação interna F; 2 = encerrado com situação interna Y sem administrador de encerramento registrado; 3 = encerrado com situação interna Y e administrador de encerramento registrado.
operator
object
Administrador registrado como responsável pelo encerramento.
id
string
Identificador do administrador que encerrou o atendimento. Retorna null quando não houver responsável registrado.
name
string
Nome do administrador que encerrou o atendimento. Pode retornar null.
custom_fields
object
Campos personalizados registrados na abertura e na avaliação do atendimento.
open
array
Campos personalizados da abertura do atendimento. Retorna null quando não houver campos registrados.
id
string
Identificador do registro do campo personalizado preenchido na abertura. Pode retornar null.
label
string
Nome do campo personalizado.
value
string
Valor registrado no campo personalizado. Pode retornar null.
evaluation
array
Campos personalizados da avaliação do atendimento. Retorna null quando não houver campos registrados.
id
string
Identificador do campo personalizado de avaliação. Pode retornar null.
label
string
Nome do campo personalizado.
value
string
Valor registrado no campo personalizado. Pode retornar null.
messages
array
Mensagens registradas na conversa. Retorna null quando não houver mensagens.
message
string
Conteúdo da mensagem. Pode retornar null.
date
datetime
Data e hora da mensagem.
sender
integer
Origem da mensagem: 1 = atendente; 2 = cliente.
attachment
object
Arquivo anexado à mensagem. Retorna null quando a mensagem não possuir anexo.
url
string
URL do arquivo anexado.
filename
string
Nome do arquivo anexado. Pode retornar null.
mimetype
string
Tipo MIME do arquivo anexado. Pode retornar null.
success
boolean
Indica se a operação foi concluída com sucesso.
Possíveis erros
Status HTTP
Mensagem
Quando ocorre
200
Operação realizada com sucesso.
Quando a consulta é executada com sucesso.
401
Token ou valores enviados não autorizados para uso.
Quando o token ou os valores enviados não são autorizados.