Listar Chamados

Lista todos os chamados via API no TomTicket.


Endpoint

https://api.tomticket.com/chamados/{token}/{pagina}


ColunaDescrição
tokenToken de acesso único e secreto para sua empresa. Clique aqui para ver como criar.
paginaPá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

ColunaDescrição
Tipo
Tamanho Máximo
Parâmetros Opcionais
idclienteIdentificador do cliente, irá apenas mostrar os chamados daquele clienteString
250
tipo_identificacaoBusca por identificador interno ou por email

I - Identificador interno (Padrão)
E - Email do cliente

String1
situacaoSituaçã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
ordemOrdenação dos itens.

0 - Ordem decrescente
1 - Ordem crescente
Int-
colunaNome da coluna que será usada para realizar a ordenação (Padrão protocolo).String20
lastsituation_lesserPermite 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_upperPermite 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_lesserPermite 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_upperPermite 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_idIdentificador do departamento, irá mostrar apenas os chamados deste departamento.String250
statusIdentificador de status, irá mostrar chamados que estejam com este status.String250
organizacaoIdentificador de organização e organização matriz, irá mostrar chamados cujo o cliente esteja vinculado nessas organizações.String250
protocolo_minPermite 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_maxPermite 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.




ColunaDescriçãoTipo
erroInforma 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_itensTotal de itens que a pesquisa retornouInteger
mensagemDetalhes da operação, caso tenha ocorrido ou não um problema.String
idchamadoIdentificador do chamado.String
protocoloProtocolo do chamado.String
tituloTítulo do chamado.String
mensagemMensagem informado pelo cliente.String
mimetypeFormato da mensagem, text/plain para texto puro e text/html para conteúdo com formatação.
String
nomeclienteNome do cliente.String
email_clienteEndereço de email do cliente.String
id_clienteIdentificador interno do cliente.String
nomeorganizacaoNome da organização do cliente.String
prioridadeIdentificador da prioridade do chamado.

1 - Baixo
2 - Normal
3 - Alto
4 - Urgente
Int
tipochamadoTipo de chamado.

I - Interno (Criado entre atendentes)
E - Externo (Criado pelo cliente externo)
String
tempotrabalhoTempo em segundos de quanto foi trabalhado.Int
tempoaberturaTempo em segundos desde a data de abertura do chamado.Int
data_criacaoData e hora de criação do chamado.Timestamp
deadlineData e hora para encerrar o chamado.Timestamp
valoritemhoraValor a ser cobrado por hora.Float
valoritemhoraextraValor a ser cobrado por hora extra.Float
valorfinalValor final do chamado.Float
valorfinalextraValor final da hora extra.Float.
valorfinalbrutoValor de soma de do final + hora extra.Float
avaliadoproblemaresolvidoDefine se o problema foi resolvido.

S - Sim
N - Não
String
avaliadoatendimentoAvaliaçã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
avaliacaocomentarioObservaçã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
ultimasituacaoCó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
dataultimasituacaoData 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
descsituacaoDescrição da situação.String
categoriaCategoria do chamado.String
departamentoDepartamento do chamado.String
atendenteNome do atendente responsável pelo chamado.String
id_clienteIdentificador interno do clienteString
statusDescrição do status do chamadoString
dataultimostatusData e hora que o último status foi definido no chamadoTimestamp
nomeorganizacaoNome da organização do clienteString
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



Was this article helpful?  
We appreciate your review.