Início / API / Chamados

Consultar Chamado - Individualmente

Este método permite consultar os detalhes de um chamado.


Endpoint

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

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
ticket_idIdentificador do chamado.Sim
-
String
512
show_stopwatchPermite listar os horário cronometrados no chamado.

Opções Disponíveis:
  • 0 - Não Exibir
  • 1 - Exibir
Não0Int-
show_staggered_ticketsPermite listar os chamados escalonados deste chamado.

Opções Disponíveis:
  • 0 - Não Exibir
  • 1 - Exibir
Não0Int-

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
dataDetalhes do chamado.Object
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
work_time
Informações do tempo de trabalho.Object
data
work_time
   start
Hora de início de trabalho para a resposta que foi informada pelo atendente.String
data
work_time
   end
Hora de início de trabalho para a resposta que foi informada pelo atendente.String
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
attachment
Lista de anexos enviados na criação do chamado.Array
data
attachment
    url
URL para download do arquivo.String
data
attachment
    name
Nome do arquivo.String
data
attachment
    size
Tamanho do arquivo em bytes.Int
data
replies
Lista com todas as respostas enviadas por atendente e cliente.Array
data
replies
    id
Identificador único para a mensagem.String
data
replies
    sender_type
Identificador de quem enviou a mensagem.

  • C - Cliente
  • A - Atendente
String
data
replies
    message
Conteúdo da mensagem enviada.String
data
replies
    sender
Nome do atendente, caso a mensagem tenha sido enviada pelo atendente.String
data
replies
    date
Data e hora de envio da resposta.String
data
replies
    attachment
Lista de anexos enviados na criação do chamado.Array
data
replies
    attachment
        url
URL para download do arquivo.String
data
replies
    attachment
        name
Nome do arquivo.String
data
replies
    attachment
        size
Tamanho do arquivo em bytes.String
data
custom_fields
Lista de campos personalizados utilizados.Array
data
custom_fields
    open
Lista de campos personalizados utilizados na criação.Array
data
custom_fields
    open
        id
Identificador do campo personalizado.String
data
custom_fields
    open
        label
Nome do campo personalizado.String
data
custom_fields
    open
        value
Valor informado no campo personalizado.String
data
custom_fields
    evaluation
Lista de campos personalizados utilizados na avaliação.Array
data
custom_fields
    evaluation
        id
Identificador do campo personalizado.String
data
custom_fields
    evaluation
        label
Nome do campo personalizado.String
data
custom_fields
    evaluation
        value
Valor informado no campo personalizado.String
data
custom_fields
    closed
Lista de campos personalizados utilizados na finalização.Array
data
custom_fields
    closed
        id
Identificador do campo personalizado.String
data
custom_fields
    closed
        label
Nome do campo personalizado.String
data
custom_fields
    closed
        value
Valor informado no campo personalizado.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
Lista de status aplicados no chamado.Array
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
data
status
   message
Mensagem enviada na aplicação do status.String
data
status
   start
Detalhes do status aplicado.Object
data
status
   start
      operator
Informações do atendente que iniciou o status e quando ele foi aplicado.Object
data
status
   start
      operator
            id
Identificador do atendente.String
data
status
   start
      operator
            name
Nome do atendente.String
data
status
   start
      operator
            date
Data em que o status foi aplicado.String
data
status
   end
Detalhes da abertura do chamado.Object
data
status
   end
      operator
Informações do atendente que encerrou o status.Object
data
status
   end
      operator
            id
Identificador do atendente.String
data
status
   end
      operator
            name
Nome do atendente.String
data
status
   end
      operator
            date
Data em que o status foi encerrado.String
data
staggered
Lista com chamados escalonados deste chamado.Array
data
staggered
   id
Identificador do chamado.String
data
staggered
   protocol
Protocolo do chamado.Int
data
staggered
   subject
Assunto do chamadoString

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.