Início / API / Chamados

Consultar Chamados

Este método permite consultar todos os chamados criados em sua conta.

A consulta de chamados exibe 50 itens por página, sendo necessário navegar entre as páginas para consultar outros resultados.

Endpoint

https://api.tomticket.com/v2.0/ticket/list

Método HTTP

GET

Content Type

form-data

Autenticação

Authorization: Bearer {SEU-TOKEN-AQUI}

Parâmetros Query String

Os parâmetros Query String são enviadas diretamente na URL após o símbolo de "?" ao final do endpoint. Cada parâmetro e valor deve ser enviado com o nome dele e valor, separados pelo símbolo de "=", como por exemplo nomeParametro=ValorParametro. Para enviar mais de um parâmetro, deve separá-los, usando símbolo "&", como por exemplo nomeParametro1=ValorParametro1&nomeParametro2=ValorParametro2.


ChaveDescriçãoObrigatórioValor PadrãoTipoTamanho Máximo
pageÍndice da página que deseja acessar. São exibidos 50 itens a cada página.Não1Int-
customer_idIdentificador interno do cliente para realizar a busca e atualização das informações. Pode ser o endereço de email do cadastro ou identificador interno utilizado.
Não-String250
customer_type_id
Tipo de identificador utilizado para localizar o cliente, sendo:
I - Identificador interno
E - Email
Não
I
String
1
situationSituação do chamado. Deve ser enviado separado por vírgula.

Exemplo: ...?situation=1,2,3.

Opções Disponíveis:
  • 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
Não-String512
department_idIdentificador do departamento, irá mostrar apenas os chamados deste departamento.Não-String512
status_idIdentificador de status, irá mostrar chamados que estejam com este status.Não-String512
organization_idIdentificador de organização e organização matriz, irá mostrar chamados cujo o cliente esteja vinculado nessas organizações.Não-String512
min_protocolPermite buscar chamados que tenham o protocolo menor ou igual ao usado na busca.

Caso de Uso: Buscar chamados cujo o protocolo deve ser igual ou menor que 123.
min_protocol=123		Não-Int-
max_protocolPermite buscar chamados que tenham o protocolo maior ou igual ao usado na busca.

Caso de Uso: Buscar chamados cujo o protocolo deve ser igual ou maior que 456.
max_protocol=456		Não-Int-
creation_date_lePermite listar chamados com a data de criação sendo menor e igual a data informada.
A data deve seguir o padrão YYYY-MM-DD HH:II:SS-TZ, sendo TZ o timezone.

Exemplo: 1 de Fevereiro de 1970, 14:30 no timezone America/Sao_Paulo (-03) será: 1970-02-01 14:30:59-0300		Não-String-
creation_date_gePermite listar chamados com a data de criação sendo maior e igual a data informada.
A data deve seguir o padrão YYYY-MM-DD HH:II:SS-TZ, sendo TZ o timezone.

Exemplo: 1 de Fevereiro de 1970, 14:30 no timezone America/Sao_Paulo (-03) será: 1970-02-01 14:30:00-0300		Não-String-
last_situation_gePermite listar chamados com a data da última situação sendo menor e igual a data informada. Está data é atualizada quando um chamado é aberto, respondido ou finalizado.
A data deve seguir o padrão YYYY-MM-DD HH:II:SS-TZ, sendo TZ o timezone.

Exemplo: 1 de Fevereiro de 1970, 14:30 no timezone America/Sao_Paulo (-03) será: 1970-02-01 14:30:59-0300		Não-String-
last_situation_lePermite listar chamados com a data da última situação sendo maior e igual a data informada. Está data é atualizada quando um chamado é aberto, respondido ou finalizado.
A data deve seguir o padrão YYYY-MM-DD HH:II:SS-TZ, sendo TZ o timezone.

Exemplo: 1 de Fevereiro de 1970, 14:30 no timezone America/Sao_Paulo (-03) será: 1970-02-01 14:30:00-0300		Não-String-
lastupdate_gePermite listar chamados com a data da última modificação sendo maior e igual a data informada. . Está data é atualizada sempre que ocorrer qualquer modificação no chamado.
A data deve seguir o padrão YYYY-MM-DD HH:II:SS-TZ, sendo TZ o timezone.

Exemplo: 1 de Fevereiro de 1970, 14:30 no timezone America/Sao_Paulo (-03) será: 1970-02-01 14:30:00-0300		Não-String-
show_stopwatchPermite listar os horário cronometrados num chamado.

Opções Disponíveis:
  • 0 - Não Exibir
  • 1 - Exibir
Não0Int-
orderDefinição da ordem de exibição dos registros.

Opções Disponíveis:
  • DESC - Ordem decrescente: Z-A,9-0
  • ASC - Ordem crescente: 0-9,A-Z
NãoDESCString-
columnIdentificação da coluna para ordenação

Opções Disponíveis:
  • protocol: Protocolo
  • subject: Assunto
  • customer.email: Endereço de email do cliente
  • priority: Prioridade
  • deadline: Data de Deadline
  • customer.name: Nome do Cliente
  • evaluation.problem_solved: Problema Resolvido
  • evaluation.grade: Nota da Avaliação
  • customer.organization.name: Nome da Organização
  • situation.id: Identificador da Situação
  • situation.apply_date: Data da última situação
  • status.apply_date: Data de aplicação do status
  • end_date: Data de encerramento
  • category.name: Nome da Categoria
  • departament.name: Nome do Departamento
  • operator.name: Nome do Atendente
  • customer.id: Identificador interno do cliente
NãoprotocolString-

Retorno

Descrição do retorno em JSON.

ColunaDescrição da ColunaTipo
errorInforma 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
messageDetalhes da operação, caso tenha ocorrido ou não um problema.String
successRetorna true caso a operação tenha sido concluída com sucesso.Boolean
sizeTotal de itens encontrados.Int
pagesTotal de páginas disponíveis para consulta.Int
next_pagePróxima página disponível para navegação. Retornará NULL caso não houver.Int
previous_pagePágina anterior para navegação. Retornará NULL caso não houver.Int
dataLista com os chamados cadastrados.Array
data
id
Identificador do chamado.String
data
protocol
Protocolo do chamado.Int
data
subject
Título do chamado.String
data
message
Mensagem de abertura do chamado.String
data
mimetype
Mimetype da mensagem de abertura.

  • text/plain: Texto Puro, geralmente para chamados criados via API ou Painel do Cliente.
  • text/html: Conteúdo HTML, geralmente para chamados criados via Painel do Atendnte ou Email.
String
data
customer
Informações do cliente.Array
data
customer
    name
Nome do cliente.String
data
customer
    email
Endereço de email do cliente.String
data
customer
    internal_id
Identificador iterno do cliente.String
data
customer
    organization
Informações da organização do cliente, se o mesmo for registrado.Array
data
customer
    organization
        id
Identificador da organização.String
data
customer
    organization
        name
Nome da organização.String
data
priority
Código identificador da prioridade do chamado.
  • 1 - Baixo
  • 2 - Normal
  • 3 - Alto
  • 4 - Urgente
Int
data
ticket_type
Tipo de chamado.
  • I - Chamado Interno
  • E - Chamado Externo
  • S - Chamado Escalonado
Int
data
work_time
Tempo, em segundos, de quanto foi trabalhado.Int
data
elapsed_time
Tempo em segundos desde a data de abertura do chamado.Int
data
creation_date
Data e hora de criação do chamado.String
data
schedule_date
Data e hora de agendamento do chamado.String
data
parent_ticket_id
Caso seja um chamado escalonado, irá exibir o identificador do chamado pai.String
data
cost
Informações de custo do chamadoObject
data
cost
    hourly
Valor a ser cobrado por hora.Float
data
cost
    overtime
Valor a ser cobrado por hora extra.Float
data
cost
    total_final
Valor final do chamado.Float
data
cost
    total_overtime
Valor final da hora extra.Float
data
cost
    total_gross
Valor de soma de do final + hora extra.Float
data
evaluation
Avaliação do atendimento.Array
data
evaluation
    problem_solved
Retorna TRUE caso o problema tenha sido resolvido.Boolean
data
evaluation
    grade
Identificação da nota enviada pelo cliente.

  • 5 - Ótimo
  • 4 - Bom
  • 3 - Regular
  • 2 - Ruim
  • 1 - Péssimo
Int
data
evaluation
    comment
Comentário da avaliação do atendimento.String
data
first_reply_date
Data e hora em que o chamado recebeu a primeira resposta.String
data
end_date
Data e hora em que o chamado foi finalizado.end_date
data
situation
Informações da situação em que o chamado se encontra.Object
data
situation
    id
Código identificador da situação.

Opções Disponíveis:
  • 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
Int
data
situation
    apply_date
Data em que a última situação ocorreu.String
data
situation
    description
Nome da situação.String
data
sla
Informações de SLA de Deadline e Inicialização.Array
data
sla
    startup
Informações de SLA de Inicialização.Object
data
sla
    startup
        date
Data e hora do prazo do SLA.String
data
sla
    startup
        accomplished
Retorna TRUE caso o prazo não tenha expirado.Boolean
data
sla
    deadline
Informações de SLA de Deadline.Object
data
sla
    deadline
        date
Data e hora do prazo do SLA.String
data
sla
    deadline
        accomplished
Retorna TRUE caso o prazo não tenha expirado.Boolean
data
stopwatch
Lista com os horários cronômetrrados.Array
data
stopwatch
    id
Identificador interno do horário.String
data
stopwatch
    start
Data e hora de início do horário cronometrado.String
data
stopwatch
    end
Data e hora de fim do horário cronometrado.String
data
stopwatch
    created_manually
Retorna TRUE caso o horário tenha sido criado manualmente.Boolean
data
stopwatch
    operator
Nome do atendente que criou o horário de forma manual.String
data
category
Informações da categoria do chamadoObject
data
category
   id
Código identificador da categoria.String
data
category
   name
Descrição da categoria.String
data
department
Informações do departamento do chamadoObject
data
department
   id
Código identificador do departamento.String
data
department
   name
Descrição do departamento.String
data
operator
Informações do atendente do chamadoObject
data
operator
   id
Código identificador do atendente.String
data
operator
   name
Descrição do atendente.String
data
status
Informações do status aplicado no chamado.Object
data
status
   id
Código identificador do status.String
data
status
   description
Descrição do status.String
data
status
   apply_date
Data de aplicação do status.String

Código de Retorno

Descrição do código HTTP de retorno.

CódigoDescrição
200Operação realizada com sucesso.
401Token ou valores enviados não autorizados para uso.
403Recurso não disponível.
404Recurso não encontrado.

Disponibilidade

Recurso Premium Recurso Enterprise

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