Início / API / Chamados

Avaliar Chamado

Este endpoint permite avaliar um chamado finalizado via API.

Endpoint

MétodoRotaContent-Type
POSThttps://api.tomticket.com/v2.0/ticket/evaluationform-data

Autenticação

Este endpoint utiliza autenticação Bearer Token.

Authorization: Bearer SEU_TOKEN_AQUI

Caso ainda não possua um Token de Acesso, consulte o artigo Criação do Token de Acesso.

Parâmetros da requisição

Parâmetros da requisição - Avaliar chamado

CampoTipoObrigatórioTamanho máximoDescrição
ticket_idstringSim250Identificador do chamado.
problem_solvedstringSim1Informa se o problema foi resolvido. Valores aceitos: Y - Sim; N - Não.
gradeintegerSim1Nota atribuída ao atendimento. Valores aceitos: 5 - Ótimo; 4 - Bom; 3 - Regular; 2 - Ruim; 1 - Péssimo.
commentstringNão4096Comentário da avaliação.
custom_fieldobjectNão-Campos personalizados da avaliação. Deve ser enviado no formato custom_field[id_campo_customizado].

JSON de saída

JSON de saída - Avaliar chamado

CampoTipoDescrição
errorbooleanInforma se ocorreu erro na operação.
messagestringMensagem de retorno da operação.
successbooleanRetorna true quando a operação é concluída com sucesso.

Possíveis erros

Status HTTPMensagemQuando ocorre
403Please insert ticket ID.Quando ticket_id não é informado ou está vazio.
401Invalid token.Quando o token informado é inválido ou não está ativo.
401Insufficient privileges for this operation.Quando o token não possui permissão de escrita.
404Ticket not found.Quando o chamado informado não é encontrado.
403This ticket does not allow this operation at the moment.Quando o chamado importado não permite esta operação no momento.
401Ticket not finished.Quando o chamado ainda não está finalizado.
401Ticket already evaluated.Quando o chamado já possui avaliação registrada.
401Please insert problem_solved.Quando problem_solved não é informado.
401Invalid value for problem_solved.Quando problem_solved é diferente de Y ou N.
401Please insert grade.Quando grade não é informado.
401Invalid value for grade.Quando grade é diferente de 1, 2, 3, 4 ou 5.
406Comment is too long.Quando comment possui mais de 4096 caracteres.
401Custom fields not added, array type not found.Quando custom_field não é enviado como objeto/array.
401Custom field {id} is required.Quando existe campo personalizado obrigatório e ele não foi informado.

Observações

  • O chamado precisa estar finalizado para receber avaliação.
  • Um chamado não pode ser avaliado mais de uma vez.
  • O token utilizado precisa ter permissão de escrita.
  • O campo problem_solved aceita apenas Y ou N.
  • O campo grade aceita valores de 1 a 5.

Exemplo em cURL

curl --request POST \
  --url "https://api.tomticket.com/v2.0/ticket/evaluation" \
  --header "Authorization: Bearer SEU_TOKEN_AQUI" \
  --header "Accept: application/json" \
  --form "ticket_id=TICKET_ID" \
  --form "problem_solved=Y" \
  --form "grade=5" \
  --form "comment=Atendimento excelente."

Exemplo em PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => 'https://api.tomticket.com/v2.0/ticket/evaluation',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_POST => true,
    CURLOPT_POSTFIELDS => [
        'ticket_id' => 'TICKET_ID',
        'problem_solved' => 'Y',
        'grade' => 5,
        'comment' => 'Atendimento excelente.'
    ],
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer SEU_TOKEN_AQUI',
        'Accept: application/json'
    ],
]);

$response = curl_exec($curl);

if ($response === false) {
    throw new Exception('Erro ao avaliar chamado: ' . curl_error($curl));
}

curl_close($curl);

$data = json_decode($response, true);

print_r($data);

Exemplo de resposta

{
    "error": false,
    "message": "Ticket evaluated.",
    "success": true
}
Este artigo foi útil?  
Agradecemos sua avaliação.