Este método permite obter informações de um chat de forma individual.
Endpoint
| Método | Rota | Content-Type |
|---|
GET | https://api.tomticket.com/v2.0/chat/detail | form-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
| 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 | Informa se ocorreu um erro na operação. |
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. |
data | object | Informações do chat. |
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 baseado no IP de origem. |
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. |
customer | array | Informações do cliente. |
creation_date | string | Data e hora em que foi criado o chat. |
conversation | array | Datas para abertura e finalização do chat. |
evaluation | array | Avaliação do atendimento. |
department | array | Informações do departamento do atendimento. |
operator | array | Informações do atendente responsável pelo atendimento. |
transfered | boolean | Caso o chat tenha sido criado através de transferência de outro chat, retornará como true. |
transfered_origin | string | Caso transferido, retorna o identificador do chat que gerou ele. |
closed_situation | array | Informações sobre o encerramento do chat. |
messages | array | Lista com as mensagens trocadas entre atendente e cliente. |
custom_fields | array | Lista de campos personalizados utilizados no chat. |
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. |
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. |
Agradecemos sua avaliação.