Lista todos os chamados via API no TomTicket.
Endpoint
https://api.tomticket.com/chamados/{token}/{pagina}
Coluna | Descrição |
token | Token de acesso único e secreto para sua empresa. Clique aqui para ver como criar. |
pagina | Página de listagem, por padrão deve ser informado o número, são listados 50 chamados por página. |
Método
GET
Parâmetros
Coluna | Descrição | Tipo | Tamanho Máximo |
Parâmetros Opcionais | |||
idcliente | Identificador do cliente, irá apenas mostrar os chamados daquele cliente | String | 250 |
tipo_identificacao | Busca por identificador interno ou por emailI - Identificador interno (Padrão) E - Email do cliente | String | 1 |
situacao | Situação do chamado, separado por ","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 avaliação do gerente 9 - Aguardando avaliação do gerente | String | 10 |
ordem | Ordenação dos itens.0 - Ordem decrescente 1 - Ordem crescente | Int | - |
coluna | Nome da coluna que será usada para realizar a ordenação (Padrão protocolo). | String | 20 |
lastsituation_lesser | Permite listar chamados com a data de situação sendo menor e igual que o epoch (Unix Timestamp) informado. Para pesquisa desse campo é filtrado usando o timezone UTC+0000, então a data deverá ser convertida para essa timezone. Exemplo: se sua região é America/Sao_Paulo e deseja buscar os chamados criados antes das 14:00 (UTC-2 (Horário de Verão)) deverá primeiro converter as 14:00 para o UTC 0, que irá resultar em 16:00. | Int | - |
lastsituation_upper | Permite listar chamados com a data de situação sendo maior e igual que o epoch(Unix Timestamp) informado. Para pesquisa desse campo é filtrado usando o timezone UTC+0000, então a data deverá ser convertida para essa timezone. Exemplo: se sua região é America/Sao_Paulo e deseja buscar os chamados criados depois das 14:00 (UTC-2 (Horário de Verão)) deverá primeiro converter as 14:00 para o UTC 0, que irá resultar em 16:00. | Int | - |
last_creation_lesser | Permite listar chamados com a data de criação sendo menor e igual que o epoch (Unix Timestamp) informado. Para pesquisa desse campo é filtrado usando o timezone UTC+0000, então a data deverá ser convertida para essa timezone. Exemplo: se sua região é America/Sao_Paulo e deseja buscar os chamados criados antes das 14:00 (UTC-2 (Horário de Verão)) deverá primeiro converter as 14:00 para o UTC 0, que irá resultar em 16:00. | Int | - |
last_creation_upper | Permite listar chamados com a data de criação sendo maior e igual que o epoch(Unix Timestamp) informado. Para pesquisa desse campo é filtrado usando o timezone UTC+0000, então a data deverá ser convertida para essa timezone. Exemplo: se sua região é America/Sao_Paulo e deseja buscar os chamados criados depois das 14:00 (UTC-2 (Horário de Verão)) deverá primeiro converter as 14:00 para o UTC 0, que irá resultar em 16:00. | Int | - |
departament_id | Identificador do departamento, irá mostrar apenas os chamados deste departamento. | String | 250 |
status | Identificador de status, irá mostrar chamados que estejam com este status. | String | 250 |
organizacao | Identificador de organização e organização matriz, irá mostrar chamados cujo o cliente esteja vinculado nessas organizações. | String | 250 |
protocolo_min | Permite buscar chamados que tenham o menor valor igual ao usado na busca. Exemplo: Buscar cujo o protocolo devem iniciar em #123 - protocolo_min=123 | Int | - |
protocolo_max | Permite buscar chamados que tenham o maior valor igual ao usado na busca. Exemplo: Buscar cujo o protocolo máximo deve ser #456 - protocolo_max=456 | Int | - |
stopwatch | Permite listar os horário cronometrados num chamado. O valor deve ser 1 para ativar a listagem. | Int | - |
Retorno
O retorno é feito no formato JSON.
Coluna | Descrição | Tipo |
erro | Informa 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 |
total_itens | Total de itens que a pesquisa retornou | Integer |
mensagem | Detalhes da operação, caso tenha ocorrido ou não um problema. | String |
idchamado | Identificador do chamado. | String |
protocolo | Protocolo do chamado. | String |
titulo | Título do chamado. | String |
mensagem | Mensagem informado pelo cliente. | String |
mimetype | Formato da mensagem, text/plain para texto puro e text/html para conteúdo com formatação. | String |
nomecliente | Nome do cliente. | String |
email_cliente | Endereço de email do cliente. | String |
id_cliente | Identificador interno do cliente. | String |
nomeorganizacao | Nome da organização do cliente. | String |
prioridade | Identificador da prioridade do chamado.1 - Baixo 2 - Normal 3 - Alto 4 - Urgente | Int |
tipochamado | Tipo de chamado.I - Interno (Criado entre atendentes) E - Externo (Criado pelo cliente externo) | String |
tempotrabalho | Tempo em segundos de quanto foi trabalhado. | Int |
tempoabertura | Tempo em segundos desde a data de abertura do chamado. | Int |
data_criacao | Data e hora de criação do chamado. | Timestamp |
deadline | Data e hora para encerrar o chamado. | Timestamp |
valoritemhora | Valor a ser cobrado por hora. | Float |
valoritemhoraextra | Valor a ser cobrado por hora extra. | Float |
valorfinal | Valor final do chamado. | Float |
valorfinalextra | Valor final da hora extra. | Float. |
valorfinalbruto | Valor de soma de do final + hora extra. | Float |
avaliadoproblemaresolvido | Define se o problema foi resolvido.S - Sim N - Não | String |
avaliadoatendimento | Avaliação do atendimento. B-Bom, R-Ruim, P-Péssimo, O-Ótimo, M-Regular,B - Bom R - Ruim P - Péssimo O - Ótimo M - Regular | String |
avaliacaocomentario | Observação do atendimento. | String |
dataprimeiraresposta | Data/hora em que o chamado recebeu a primeira resposta. | Timestamp |
dataencerramento | Data/hora em que o chamado foi finalizado. | Timestamp |
ultimasituacao | Código da última situação do chamado.1 - Aceito pelo atendente 2 - Respondida pelo atendente 3 - Respondida pelo usuário 4 - Cancelada 5 - Finalizada 6 - Troca de atendente 7 - Envio para equipe de suporte | String |
dataultimasituacao | Data que ocorreu a última situação. | Timestamp |
sla_inicializacao_cumprido | Informa se o SLA de Inicialização foi cumprido. Caso nulo significa que não possui SLA de inicialização definido. | Boolean |
sla_deadline_cumprido | Informa se o SLA de Deadline foi cumprido. Caso nulo significa que não possui SLA de deadline definido. | Boolean |
descsituacao | Descrição da situação. | String |
categoria | Categoria do chamado. | String |
departamento | Departamento do chamado. | String |
atendente | Nome do atendente responsável pelo chamado. | String |
id_cliente | Identificador interno do cliente | String |
status | Descrição do status do chamado | String |
dataultimostatus | Data e hora que o último status foi definido no chamado | Timestamp |
nomeorganizacao | Nome da organização do cliente | String |
stopwatch | Lista com horários cronometrados. | Array |
stopwatch id | Identificador único do horário. | String |
stopwatch start | Data e hora de início do horário cronometrado. | Timestamp |
stopwatch end | Data e hora de fim do horário cronometrado. | Timestamp |
stopwatch created_manually | Define se o horário foi criado manualmente ou através do recurso. True: O horário foi adicionado manualmente. False:O horário foi criado pelo sistema de cronômetro. | Boolean |
stopwatch operator | Atendente que criou o horário. | String |
parent_ticket_id | Identificador do chamado pai, caso este seja um chamado escalonado. | String |