Cancelar Atendimento

atenção

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

Cancela um atendimento em aberto. Substitui a rota de cancelamento para vocalização na URA, centralizando as requisições vindas de terceiros.

dica

Para obter os IDs dos motivos de cancelamento disponíveis, consulte o endpoint Listar Motivos de Cancelamento.

Endpoints

Método	URL
POST	https://{{url}}/cube/api/v3/atendimentos/{{idAtendimento}}/cancelar

Parâmetros de URL

Parâmetro	Descrição
idAtendimento*	Numérico - ID do atendimento retornado ao Iniciar Atendimento.

Exemplo de Corpo JSON

{
    "idMotivoCancelamento": 1,
    "descricaoMotivoCancelamento": "Cliente desistiu durante o atendimento."
}

Chave	Descrição
idMotivoCancelamento*	Numérico - ID do motivo de cancelamento cadastrado no CUBE.
descricaoMotivoCancelamento	Texto - Descrição complementar do motivo de cancelamento.

dica

Os campos marcados com * são obrigatórios.

Respostas

Status	Descrição
204	No Content - Atendimento cancelado com sucesso.
400	Erro ao cancelar o atendimento.
401	API Key, Secret ou Client ID inválidos.
429	Limite de requisições excedido.