Consultar Chamado - Individualmente - TomTicket

Recurso Premium Recurso Enterprise

Este endpoint permite consultar os detalhes completos de um chamado.

Endpoint

Método	Rota	Content-Type
`GET`	`https://api.tomticket.com/v2.0/ticket/detail`	`query string`

Autenticação

Este endpoint utiliza autenticação Bearer Token.

Authorization: Bearer SEU_TOKEN_AQUI

Parâmetros da requisição

Parâmetros da requisição - Consultar detalhes de um chamado

Campo	Tipo	Obrigatório	Tamanho máximo	Descrição
`ticket_id`	string	Sim	512	Identificador do chamado.
`show_stopwatch`	integer	Não	-	Permite listar os horários cronometrados no chamado. Valores aceitos: 0 - Não exibir; 1 - Exibir. Valor padrão: 0.
`show_staggered_tickets`	integer	Não	-	Permite listar os chamados escalonados deste chamado. Valores aceitos: 0 - Não exibir; 1 - Exibir. Valor padrão: 0.
`show_tags`	integer	Não	-	Permite listar as tags vinculadas ao chamado. Valores aceitos: 0 - Não exibir; 1 - Exibir. Valor padrão: 0.

JSON de saída

JSON de saída - Consultar detalhes de um chamado

Campo	Tipo	Descrição
`error`	boolean	Informa se ocorreu erro na operação.
`message`	string	Mensagem de retorno da operação.
`data`	object	Detalhes do chamado.
`id`	string	Identificador do chamado.
`protocol`	integer	Protocolo do chamado.
`subject`	string	Título do chamado.
`message`	string	Mensagem de abertura do chamado.
`mimetype`	string	Mimetype da mensagem de abertura. Exemplos: text/plain para texto puro; 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.
`id`	string	Identificador do cliente.
`internal_id`	string	Identificador interno do cliente.
`organization`	object	Informações da organização do cliente.
`name`	string	Nome da organização.
`id`	string	Identificador da organização.
`priority`	integer	Código da prioridade. Valores: 1 - Baixo; 2 - Normal; 3 - Alto; 4 - Urgente.
`ticket_type`	string	Tipo do chamado. Valores possíveis: Internal ou External.
`work_time`	integer	Tempo trabalhado, em segundos.
`elapsed_time`	integer	Tempo em segundos desde a abertura do chamado até o encerramento.
`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 de SLA do chamado.
`startup`	object	Informações de SLA de inicialização.
`date`	datetime	Data e hora do prazo de inicialização.
`accomplished`	boolean	Retorna true caso o prazo de inicialização tenha sido cumprido.
`deadline`	object	Informações de SLA de deadline.
`date`	datetime	Data e hora do prazo de deadline.
`accomplished`	boolean	Retorna true caso o prazo de deadline tenha sido cumprido.
`cost`	object	Informações de custo do chamado.
`hourly`	number	Valor a ser cobrado por hora.
`overtime`	number	Valor a ser cobrado por hora extra.
`total_gross`	number	Valor bruto total.
`total_final`	number	Valor final do chamado.
`total_overtime`	number	Valor final de hora extra.
`evaluation`	object	Avaliação do atendimento.
`problem_solved`	boolean	Retorna true caso o problema tenha sido resolvido.
`grade`	integer	Nota enviada pelo cliente. Valores: 5 - Ótimo; 4 - Bom; 3 - Regular; 2 - Ruim; 1 - Péssimo.
`comment`	string	Comentário da avaliação.
`first_reply_date`	datetime	Data e hora da primeira resposta.
`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 da última situação aplicada.
`description`	string	Descrição da situação.
`category`	object	Categoria do chamado.
`id`	string	Identificador da categoria.
`name`	string	Nome da categoria.
`department`	object	Departamento do chamado.
`id`	string	Identificador do departamento.
`name`	string	Nome do departamento.
`operator`	object	Atendente vinculado ao chamado.
`id`	string	Identificador do atendente.
`name`	string	Nome do atendente.
`current_status`	object	Status atual do chamado.
`id`	string	Identificador do status atual.
`description`	string	Descrição do status atual.
`apply_date`	datetime	Data de aplicação do status atual.
`status`	array	Lista de status aplicados no chamado.
`id`	string	Identificador do status.
`description`	string	Descrição do status.
`apply_date`	datetime	Data de aplicação do status.
`message`	string	Mensagem enviada na aplicação do status.
`start`	object	Informações de início do status.
`operator`	object	Atendente que iniciou o status.
`id`	string	Identificador do atendente.
`name`	string	Nome do atendente.
`date`	datetime	Data de início do status.
`end`	object	Informações de encerramento do status.
`operator`	object	Atendente que encerrou o status.
`id`	string	Identificador do atendente.
`name`	string	Nome do atendente.
`date`	datetime	Data de encerramento do status.
`parent_ticket_id`	string	Identificador do chamado pai, quando o chamado for escalonado.
`attachments`	array	Lista de anexos enviados na criação do chamado.
`name`	string	Nome do arquivo.
`url`	string	URL para download do arquivo.
`size`	integer	Tamanho do arquivo em bytes.
`replies`	array	Lista de respostas enviadas por clientes e atendentes.
`id`	string	Identificador único da mensagem.
`sender_type`	string	Tipo de remetente. Valores: C - Cliente; A - Atendente.
`message`	string	Conteúdo da mensagem enviada.
`sender`	string	Nome de quem enviou a mensagem.
`date`	datetime	Data e hora de envio da resposta.
`work_time`	object	Informações de tempo de trabalho da resposta.
`start`	datetime	Data/hora de início do trabalho.
`end`	datetime	Data/hora de fim do trabalho.
`attachments`	array	Lista de anexos enviados na resposta.
`name`	string	Nome do arquivo.
`url`	string	URL para download do arquivo.
`size`	integer	Tamanho do arquivo em bytes.
`custom_fields`	object	Campos personalizados utilizados no chamado.
`open`	array	Campos personalizados utilizados na abertura.
`id`	string	Identificador do campo personalizado.
`label`	string	Nome do campo personalizado.
`value`	string	Valor informado.
`closed`	array	Campos personalizados utilizados na finalização.
`id`	string	Identificador do campo personalizado.
`label`	string	Nome do campo personalizado.
`value`	string	Valor informado.
`evaluation`	array	Campos personalizados utilizados na avaliação.
`id`	string	Identificador do campo personalizado.
`label`	string	Nome do campo personalizado.
`value`	string	Valor informado.
`stopwatch`	array	Lista de horários cronometrados. Retornado quando show_stopwatch=1.
`id`	string	Identificador do horário.
`start`	datetime	Data e hora de início.
`end`	datetime	Data e hora de fim.
`created_manually`	boolean	Retorna true quando o horário foi criado manualmente.
`operator`	string	Nome do atendente.
`staggered`	array	Lista de chamados escalonados. Retornado quando show_staggered_tickets=1.
`id`	string	Identificador do chamado.
`protocol`	integer	Protocolo do chamado.
`subject`	string	Assunto do chamado.
`tags`	array	Lista de tags do chamado. Retornado quando show_tags=1.
`id`	string	Identificador da tag.
`label`	string	Nome da tag.
`color`	string	Cor da tag.
`active_whatsapp`	boolean	Informa se o chamado possui WhatsApp ativo.
`closed_by_inactivity`	boolean	Informa se o chamado foi encerrado por inatividade.
`reopened`	boolean	Informa se o chamado já foi reaberto.
`success`	boolean	Retorna true quando a operação é concluída com sucesso.

Possíveis erros

Status HTTP	Mensagem	Quando ocorre
`401`	`Enter the ticket ID.`	Quando `ticket_id` não é informado.
`401`	`Invalid token.`	Quando o token informado é inválido ou não está ativo.
`404`	`Ticket not found.`	Quando o chamado informado não é encontrado.

Observações

Os parâmetros devem ser enviados via query string.
Use show_stopwatch=1 para retornar os horários cronometrados.
Use show_staggered_tickets=1 para retornar os chamados escalonados.
Use show_tags=1 para retornar as tags vinculadas ao chamado.

Exemplo em cURL

curl --request GET \
  --url "https://api.tomticket.com/v2.0/ticket/detail?ticket_id=TICKET_ID&show_stopwatch=1&show_staggered_tickets=1&show_tags=1" \
  --header "Authorization: Bearer SEU_TOKEN_AQUI" \
  --header "Accept: application/json"

Exemplo em PHP

<?php

$ticketId = 'TICKET_ID';

$url = 'https://api.tomticket.com/v2.0/ticket/detail?' . http_build_query([
    'ticket_id' => $ticketId,
    'show_stopwatch' => 1,
    'show_staggered_tickets' => 1,
    'show_tags' => 1
]);

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => $url,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPGET => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer SEU_TOKEN_AQUI',
        'Accept: application/json'
    ],
]);

$response = curl_exec($curl);

curl_close($curl);

$data = json_decode($response, true);

print_r($data);

Exemplo de resposta

{
    "error": false,
    "message": null,
    "data": {
        "id": "TICKET_ID",
        "protocol": 123456,
        "subject": "Assunto do chamado",
        "message": "Mensagem de abertura do chamado",
        "customer": {
            "name": "Cliente Exemplo",
            "email": "[email protected]"
        }
    },
    "success": true
}

Base de Conhecimento
TomTicket

Consultar Chamado - Individualmente

Endpoint

Autenticação

Parâmetros da requisição

Parâmetros da requisição - Consultar detalhes de um chamado

JSON de saída

JSON de saída - Consultar detalhes de um chamado

Possíveis erros

Observações

Exemplo em cURL

Exemplo em PHP

Exemplo de resposta

Sumário

Base de Conhecimento TomTicket

Consultar Chamado - Individualmente

Endpoint

Autenticação

Parâmetros da requisição

Parâmetros da requisição - Consultar detalhes de um chamado

JSON de saída

JSON de saída - Consultar detalhes de um chamado

Possíveis erros

Observações

Exemplo em cURL

Exemplo em PHP

Exemplo de resposta

Sumário

Base de Conhecimento
TomTicket