Obter Protocolo
atenção
Em desenvolvimento - ainda não disponível em produção
::: warning Em desenvolvimento - ainda não disponível em produção :::
Endpoint utilizado por sistemas de telefonia (dialers) para obter um número de protocolo do CUBE antes ou durante o início de um atendimento receptivo.
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.
dica
O CUBE mantém um pool de protocolos pré-gerados por tenant para garantir baixa latência na resposta. Recomenda-se utilizar este endpoint no momento do atendimento da chamada pelo agente.
Endpoint
| Método | URL |
|---|---|
| POST | https://{{url}}/cube/api/v3/integrator/vendor/inbound/protocolo |
Corpo da Requisição
Este endpoint não requer corpo na requisição.
Exemplo de Resposta
20260000000001
| Chave | Descrição |
|---|---|
| protocolo | Texto - Número do protocolo gerado. Formato: ano (4 dígitos) + sequencial (10 dígitos), sem separador. |
Respostas
| Status | Descrição |
|---|---|
| 200 | OK - Protocolo retornado com sucesso. |
| 401 | API Key, Secret ou Client ID inválidos. |
| 429 | Limite de requisições excedido. |
| 502 | Falha ao obter protocolo junto ao CUBE. Tente novamente. |