Este endpoint permite consultar os chamados criados na conta.
Os resultados são paginados, com até 50 chamados por página. Utilize o parâmetro page para navegar entre as páginas disponíveis.
Endpoint
| Método | Rota | Content-Type |
|---|---|---|
GET | https://api.tomticket.com/v2.0/ticket/list | query string |
Autenticação
Este endpoint utiliza autenticação Bearer Token.
Para utilizá-lo, é necessário possuir um Token de Acesso válido.
O token deve ser enviado no cabeçalho HTTP:
Authorization: Bearer SEU_TOKEN_AQUIParâmetros da requisição
Os parâmetros devem ser enviados pela query string da URL.
Parâmetros da requisição - Consultar chamados
| Campo | Tipo | Obrigatório | Tamanho máximo | Descrição |
|---|---|---|---|---|
page | integer | Não | - | Número da página que será consultada. Cada página contém até 50 chamados. Valor padrão: 1. |
customer_id | string | Não | 250 | Identificador utilizado para localizar o cliente. O formato esperado depende do parâmetro customer_type_id. |
customer_type_id | string | Não | 1 | Define o tipo de identificador informado em customer_id. Opções: I - Identificador interno; E - Endereço de e-mail. Valor padrão: I. |
situation | string | Não | 512 | Filtra os chamados pela situação. É possível enviar vários códigos separados por vírgula. Opções: 0 - Aguardando interação do atendente; 1 - Não iniciada; 2 - Respondido, aguardando resposta do cliente; 3 - Respondido pelo cliente, aguardando resposta; 4 - Cancelada; 5 - Finalizada; 6 - Atendente modificado; 7 - Enviada para equipe de apoio; 8 - Aguardando aprovação de finalização do gerente; 9 - Aguardando aprovação de cancelamento do gerente; 10 - Aguardando aprovação do cliente; 11 - Aguardando avaliação do gerente para encaminhamento ao cliente. |
department_id | string | Não | 512 | Identificador do departamento. Quando informado, retorna somente os chamados vinculados ao departamento. |
operator_id | string | Não | 250 | Identificador do atendente. Quando informado, retorna somente os chamados vinculados ao atendente. O valor null ou uma string vazia pode ser utilizado para localizar chamados sem atendente. |
status_id | string | Não | 512 | Identificador do status. Quando informado, retorna somente os chamados que estejam com o status especificado. |
organization_id | string | Não | 512 | Identificador da organização. Retorna chamados de clientes vinculados à organização informada ou à organização matriz correspondente. |
min_protocol | integer | Não | - | Retorna chamados com protocolo maior ou igual ao valor informado. |
max_protocol | integer | Não | - | Retorna chamados com protocolo menor ou igual ao valor informado. |
creation_date_le | datetime | Não | - | Retorna chamados cuja data de criação seja menor ou igual à data informada. Também aceita os formatos de data dinâmica suportados pela API. |
creation_date_ge | datetime | Não | - | Retorna chamados cuja data de criação seja maior ou igual à data informada. Também aceita os formatos de data dinâmica suportados pela API. |
last_situation_ge | datetime | Não | - | Retorna chamados cuja data da última situação seja maior ou igual à data informada. Esta data é atualizada quando o chamado é criado, respondido ou finalizado. |
last_situation_le | datetime | Não | - | Retorna chamados cuja data da última situação seja menor ou igual à data informada. Esta data é atualizada quando o chamado é criado, respondido ou finalizado. |
last_update_ge | datetime | Não | - | Retorna chamados cuja data da última modificação seja maior ou igual à data informada. O período consultado não pode ser superior a 90 dias. |
lastupdate_ge | datetime | Não | - | Nome legado equivalente a last_update_ge. Recomenda-se utilizar last_update_ge. O período consultado não pode ser superior a 90 dias. |
show_stopwatch | integer | Não | - | Define se os horários cronometrados serão retornados. Opções: 0 - Não exibir; 1 - Exibir. Valor padrão: 0. |
show_tags | integer | Não | - | Define se as tags vinculadas aos chamados serão retornadas. Opções: 0 - Não exibir; 1 - Exibir. Valor padrão: 0. |
order | string | Não | - | Define a direção da ordenação. Opções: ASC - Crescente; DESC - Decrescente. Valor padrão: DESC. |
column | string | Não | - | Campo utilizado para ordenar os resultados. Opções: id, protocol, subject, message, customer.email, customer.id, customer.name, customer.organization.name, priority, work_time, elapsed_time, creation_date, deadline, cost.hourly, cost.overtime, cost.total_final, cost.total_overtime, cost.total_gross, evaluation.problem_solved, evaluation.grade, situation.id, situation.apply_date, status.apply_date, end_date, category.name, departament.name e operator.name. Valor padrão: protocol. |
priority | string | Não | - | Filtra os chamados pela prioridade. É possível enviar vários valores separados por vírgula. Opções: 1 - Baixa; 2 - Normal; 3 - Alta; 4 - Urgente. |
category_id | string | Não | 256 | Identificador da categoria. Quando informado, retorna somente os chamados vinculados à categoria. O valor null ou uma string vazia pode ser utilizado para localizar chamados sem categoria. |
truncate_body | integer | Não | - | Define se o corpo da mensagem deve ser truncado quando ultrapassar 256 KB, reduzindo o volume de dados processado pela API. Valores disponíveis: 0 - Não truncar (padrão); 1 - Truncar. |
JSON de saída
O retorno contém os dados de paginação e uma lista de chamados no campo data.
JSON de saída - Consultar chamados
| Campo | Tipo | Descrição |
|---|---|---|
error | boolean | Informa se ocorreu erro na operação. |
message | string | Mensagem de retorno da operação. |
size | integer | Quantidade total de chamados encontrados. |
pages | integer | Quantidade total de páginas disponíveis. Pode não ser retornado quando nenhum chamado for encontrado. |
next_page | integer | Número da próxima página. Retorna null quando não houver uma próxima página. |
previous_page | integer | Número da página anterior. Retorna null quando não houver uma página anterior. |
data | array | Lista de chamados encontrados. |
id | string | Identificador do chamado. |
protocol | integer | Número do protocolo do chamado. |
subject | string | Título do chamado. |
message | string | Mensagem de abertura do chamado. |
truncated | boolean | Informa se o corpo foi truncado. |
mimetype | string | Formato da mensagem de abertura. Exemplos: text/plain para texto puro e text/html para conteúdo HTML. |
customer | object | Informações do cliente. |
name | string | Nome do cliente. |
email | string | Endereço de e-mail do cliente. |
internal_id | string | Identificador interno do cliente. |
organization | object | Informações da organização vinculada ao cliente. |
id | string | Identificador da organização. |
name | string | Nome da organização. |
priority | integer | Prioridade do chamado. Opções: 1 - Baixa; 2 - Normal; 3 - Alta; 4 - Urgente. |
ticket_type | string | Tipo do chamado. |
work_time | integer | Tempo total trabalhado no chamado, em segundos. |
elapsed_time | integer | Tempo decorrido entre a criação e o encerramento do chamado, em segundos. |
creation_date | datetime | Data e hora de criação do chamado. |
schedule_date | datetime | Data e hora de agendamento do chamado. |
sla | object | Informações dos prazos de SLA. |
startup | object | Informações do SLA de inicialização. |
date | datetime | Data e hora do prazo de inicialização. |
accomplished | boolean | Informa se o SLA de inicialização foi cumprido. |
deadline | object | Informações do SLA de conclusão. |
date | datetime | Data e hora do prazo de conclusão. |
accomplished | boolean | Informa se o SLA de conclusão foi cumprido. |
cost | object | Informações de custo do chamado. |
hourly | number | Valor cobrado por hora. |
overtime | number | Valor cobrado por hora extra. |
total_final | number | Valor final referente às horas normais. |
total_overtime | number | Valor final referente às horas extras. |
total_gross | number | Valor total bruto, considerando horas normais e extras. |
evaluation | object | Avaliação do atendimento. |
problem_solved | boolean | Informa se o cliente declarou que o problema foi resolvido. |
grade | integer | Nota da avaliação. Opções: 5 - Ótimo; 4 - Bom; 3 - Regular; 2 - Ruim; 1 - Péssimo. |
comment | string | Comentário enviado na avaliação. |
first_reply_date | datetime | Data e hora da primeira resposta do chamado. |
end_date | datetime | Data e hora de encerramento do chamado. |
situation | object | Situação atual do chamado. |
id | integer | Código identificador da situação. |
apply_date | datetime | Data e hora em que a situação atual foi aplicada. |
description | string | Descrição da situação. |
category | object | Informações da categoria do chamado. |
id | string | Identificador da categoria. |
name | string | Nome da categoria. |
department | object | Informações do departamento do chamado. |
id | string | Identificador do departamento. |
name | string | Nome do departamento. |
operator | object | Informações do atendente vinculado ao chamado. |
id | string | Identificador do atendente. |
name | string | Nome do atendente. |
status | object | Informações do status atual do chamado. |
id | string | Identificador do status. |
description | string | Descrição do status. |
apply_date | datetime | Data e hora de aplicação do status. |
parent_ticket_id | string | Identificador do chamado de origem, quando o chamado for escalonado. |
active_whatsapp | boolean | Informa se o chamado possui uma conversa ativa pelo WhatsApp. |
closed_by_inactivity | boolean | Informa se o chamado foi encerrado automaticamente por inatividade. |
reopened | boolean | Informa se o chamado já foi reaberto. |
stopwatch | array | Lista de horários cronometrados. Retornado somente quando show_stopwatch=1. |
id | string | Identificador do horário cronometrado. |
start | datetime | Data e hora de início. |
end | datetime | Data e hora de término. |
created_manually | boolean | Informa se o horário foi criado manualmente. |
operator | string | Nome do atendente relacionado ao horário. |
tags | array | Lista de tags vinculadas ao chamado. Retornada somente quando show_tags=1. |
id | string | Identificador da tag. |
label | string | Nome da tag. |
color | string | Cor configurada para a tag. |
success | boolean | Retorna true quando a operação for concluída com sucesso. |
Códigos HTTP
| Código | Descrição |
|---|---|
200 | Consulta realizada com sucesso. |
401 | Token inválido, parâmetro inválido ou valor não aceito pela API. |
404 | Página ou recurso informado não foi encontrado. |
500 | Não foi possível concluir a consulta devido a um erro interno ou indisponibilidade temporária. |