Consultar atendimento pelo protocolo

atenção

Em desenvolvimento - ainda não disponível em produção

Busca um atendimento a partir do protocolo informado pelo munícipe.

O protocolo de atendimento é formado pelo ano da abertura seguido do ID do atendimento com 10 dígitos. São aceitos os dois formatos:

• com hífen, como retornado em Iniciar Atendimento: 2026-0000000456;
• sem separador, como retornado pelo Integrador CTI: 20260000000456.

Endpoints

Método	URL
GET	https://{{url}}/cube/api/v3/atendimentos/protocolo/{{protocolo}}

Respostas

Exemplo de corpo da resposta

{
    "id": 456,
    "protocolo": "2026-0000000456",
    "idPessoa": 123,
    "idUsuarioAbertura": 10,
    "status": "EM_ANDAMENTO",
    "dataAtendimento": "2026-10-30T10:00:00.000Z",
    "anonimo": false,
    "tipoAtendimento": "TELEFONE"
}

Os campos são os mesmos da resposta de Iniciar Atendimento, exceto origemProtocolo, que não é retornado nesta consulta. idPessoa só aparece quando há pessoa vinculada; idUsuarioAbertura é o usuário da chave de API que abriu o atendimento.

Em atendimentos encerrados, a resposta traz também dataConclusao. Em atendimentos cancelados, traz o motivo:

{
    "id": 456,
    "status": "CANCELADO",
    "dataConclusao": "2026-10-30T10:05:00.000Z",
    "idMotivoCancelamento": 1,
    "motivoCancelamento": "Ligação Caiu",
    "descricaoMotivoCancelamento": "Munícipe desligou durante o atendimento."
}

Chave	Descrição
dataConclusao	Data de encerramento (finalização ou cancelamento)
idMotivoCancelamento	ID do motivo de cancelamento (ver Listar Motivos de Cancelamento)
motivoCancelamento	Nome do motivo de cancelamento
descricaoMotivoCancelamento	Descrição complementar informada no cancelamento

Atendimentos finalizados não têm motivo: o CUBE registra apenas o status FINALIZADO e a dataConclusao.

Status da resposta

Status	Descrição
200	OK - Retorna o atendimento.
400	Protocolo em formato inválido.
401	API Key, Secret ou Client ID inválidos.
429	Limite de requisições excedido.