Consultar Chat - Individualmente

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

Endpoint

MétodoRotaContent-Type
GEThttps://api.tomticket.com/v2.0/chat/detailform-data

Autenticação

Este endpoint utiliza autenticação Bearer Token.

Authorization: Bearer SEU_TOKEN_AQUI

Caso 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 Chat - Individualmente

CampoTipoObrigatórioTamanho máximoDescrição
chat_idstringSim512Identificador do atendimento.

JSON de saída

JSON de saída - Consultar Chat - Individualmente

CampoTipoDescrição
errorbooleanIndica se ocorreu um erro. Retorna false quando a consulta é realizada com sucesso.
messagestringMensagem sobre a operação. Retorna null quando a consulta é realizada com sucesso.
dataobjectDados do chat consultado.
idstringIdentificador do chat.
protocolintegerNúmero do protocolo do atendimento.
referstringEndereço da página em que o chat foi iniciado. Pode retornar null.
geoobjectDados de geolocalização associados ao acesso do cliente.
citystringCidade de origem do acesso. Pode retornar null.
statestringEstado de origem do acesso. Pode retornar null.
countrystringPaís de origem do acesso. Pode retornar null.
user_agentstringInformações do navegador ou aplicativo utilizado pelo cliente. Pode retornar null.
originintegerOrigem do atendimento: 1 = chat padrão do TomTicket; 2 = Facebook; 3 = WhatsApp via Twilio.
situationintegerSituação do atendimento: 1 = aguardando; 2 = em conversa; 3 = finalizado. Retorna 0 quando a situação não corresponde a esses estados.
tagsarrayRótulos aplicados ao atendimento. Retorna null quando não houver rótulos disponíveis.
idstringIdentificador do rótulo.
descriptionstringDescrição do rótulo.
customerobjectDados do cliente associado ao atendimento.
registredbooleanIndica se o atendimento está associado a um cliente cadastrado. O nome registred corresponde ao campo retornado pela API.
namestringNome do cliente cadastrado ou, quando indisponível, nome informado na abertura do atendimento. Pode retornar null.
emailstringE-mail do cliente cadastrado ou, quando indisponível, e-mail informado no atendimento. Pode retornar null.
phonestringTelefone do cliente cadastrado ou, quando indisponível, número de origem do atendimento via WhatsApp. Pode retornar null.
internal_idstringIdentificador interno do cliente na conta. Pode retornar null.
organizationobjectOrganização associada ao cadastro do cliente.
idstringIdentificador da organização. Retorna null quando não houver organização associada.
namestringNome da organização. Pode retornar null.
creation_datedatetimeData e hora de criação do atendimento.
conversationobjectDatas de início e término da conversa.
startdatetimeData e hora de início do atendimento. Pode retornar null quando o atendimento ainda não tiver iniciado.
enddatetimeData e hora de finalização do atendimento. Pode retornar null quando o atendimento ainda não tiver terminado.
evaluationobjectAvaliação do atendimento.
avaliacaointegerNota da avaliação, de 1 a 5. Retorna 0 quando não houver uma avaliação reconhecida.
commentstringComentário registrado na avaliação. Pode retornar null.
departmentobjectDepartamento associado ao atendimento.
idstringIdentificador do departamento. Pode retornar null.
namestringNome do departamento. Pode retornar null.
operatorobjectAtendente responsável pelo atendimento.
idstringIdentificador do atendente responsável. Pode retornar null quando não houver atendente associado.
namestringNome do atendente responsável. Pode retornar null.
transferedbooleanIndica se este atendimento foi criado a partir da transferência de outro chat.
transfered_originstringIdentificador do chat que originou a transferência. Retorna null quando o atendimento não tiver origem em uma transferência.
closed_situationobjectInformações sobre o encerramento do atendimento.
typeintegerCó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.
operatorobjectAdministrador registrado como responsável pelo encerramento.
idstringIdentificador do administrador que encerrou o atendimento. Retorna null quando não houver responsável registrado.
namestringNome do administrador que encerrou o atendimento. Pode retornar null.
custom_fieldsobjectCampos personalizados registrados na abertura e na avaliação do atendimento.
openarrayCampos personalizados da abertura do atendimento. Retorna null quando não houver campos registrados.
idstringIdentificador do registro do campo personalizado preenchido na abertura. Pode retornar null.
labelstringNome do campo personalizado.
valuestringValor registrado no campo personalizado. Pode retornar null.
evaluationarrayCampos personalizados da avaliação do atendimento. Retorna null quando não houver campos registrados.
idstringIdentificador do campo personalizado de avaliação. Pode retornar null.
labelstringNome do campo personalizado.
valuestringValor registrado no campo personalizado. Pode retornar null.
messagesarrayMensagens registradas na conversa. Retorna null quando não houver mensagens.
messagestringConteúdo da mensagem. Pode retornar null.
datedatetimeData e hora da mensagem.
senderintegerOrigem da mensagem: 1 = atendente; 2 = cliente.
attachmentobjectArquivo anexado à mensagem. Retorna null quando a mensagem não possuir anexo.
urlstringURL do arquivo anexado.
filenamestringNome do arquivo anexado. Pode retornar null.
mimetypestringTipo MIME do arquivo anexado. Pode retornar null.
successbooleanIndica se a operação foi concluída com sucesso.

Possíveis erros

Status HTTPMensagemQuando ocorre
200Operação realizada com sucesso.Quando a consulta é executada com sucesso.
401Token ou valores enviados não autorizados para uso.Quando o token ou os valores enviados não são autorizados.
403Recurso não disponível.Quando o recurso não está disponível.
404Recurso não encontrado.Quando o recurso não é encontrado.

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