Iniciar Atendimento

warning

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

É possível iniciar novos atendimentos no CUBE através da nossa API. Este endpoint centraliza requisições vindas de terceiros, como URAs e Agentes Virtuais.

info

Este endpoint utiliza autenticação via API Key. Certifique-se de enviar os headers X-Api-Key, X-Api-Secret e X-Client-Id em todas as requisições.

Endpoints

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

Exemplo de Corpo JSON

{
    "idPessoa": 123,
    "origemProtocolo": "TELEFONE",
    "tipoAtendimento": "TELEFONE",
    "anonimo": false
}

Chave	Descrição
idPessoa	Numérico - ID da pessoa cadastrada no CUBE. Pode ser enviado posteriormente via Vincular Pessoa.
origemProtocolo	Texto - Canal de origem do atendimento. Padrão: TELEFONE.
tipoAtendimento	Texto - Tipo do atendimento. Padrão: TELEFONE.
anonimo	Booleano - Indica se o atendimento é anônimo. Padrão: false.

tip

Caso a pessoa não seja identificada antes da criação do atendimento, utilize o endpoint Vincular Pessoa após a identificação.

Exemplo de Resposta

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

Chave	Descrição
id	Numérico - ID do atendimento criado. Necessário para as demais operações.
protocolo	Texto - Protocolo gerado automaticamente pelo CUBE.
origemProtocolo	Texto - Canal de origem do atendimento.
tipoAtendimento	Texto - Tipo do atendimento.
status	Texto - Status do atendimento. Valor inicial: EM_ANDAMENTO.
dataAtendimento	Data - Data e hora de abertura do atendimento.

Respostas

Status	Descrição
200	OK - Atendimento iniciado com sucesso.
400	Erro ao criar o atendimento.
401	API Key, Secret ou Client ID inválidos.
429	Limite de requisições excedido.