Guia

Autenticação

A API usa autenticação por chave + domínio, sem login OAuth. Cada requisição autenticada deve enviar os dois headers abaixo; a chave só é aceita para o domínio ao qual está associada.

X-API-Key

Chave privada do usuário, fornecida pela Telenova. Trate como senha.

obrigatório em /cdr, /recording e /extensions

X-Domain

Domínio associado à conta. Exemplo: empresa.telenova.com.br.

obrigatório em /cdr, /recording e /extensions

Formato da requisição

Os endpoints / e /health não exigem credenciais.

HTTP · valores de exemplo

GET /cdr?start=2025-11-26T00:00:00&end=2025-11-26T23:59:59&limit=100 HTTP/1.1
Host: api.telenova.com.br
X-API-Key: SUA_API_KEY
X-Domain: empresa.telenova.com.br
Accept: application/json

Guarde as credenciais no servidor

Leia a chave de variáveis de ambiente do seu back-end.

.env

# .env do seu servidor (nunca no front-end nem no repositório)
TELENOVA_API_KEY=SUA_API_KEY
TELENOVA_DOMAIN=empresa.telenova.com.br

Node.js

const res = await fetch(`${process.env.TELENOVA_BASE_URL}/cdr?start=2025-11-26T00:00:00&end=2025-11-26T23:59:59`, {
  headers: {
    "X-API-Key": process.env.TELENOVA_API_KEY,
    "X-Domain": process.env.TELENOVA_DOMAIN,
  },
});

Erros comuns

422 — header obrigatório ausente ou parâmetro inválido (formato de data, limit fora de 1–1000). Estrutura documentada na especificação.
404 — em /recording, quando não existe gravação para o UUID.
Códigos para chave inválida ou domínio não correspondente não estão descritos na especificação atual; trate qualquer 4xx como falha de autorização/validação.

422 · EXEMPLO de corpo (HTTPValidationError)

{
  "detail": [
    {
      "loc": ["header", "x-api-key"],
      "msg": "Field required",
      "type": "missing"
    }
  ]
}

Boas práticas

Nunca exponha a API Key em aplicações front-end, apps móveis ou repositórios.
Faça as chamadas a partir do seu servidor e use HTTPS.
Em caso de vazamento, solicite a substituição da chave à Telenova.

Nenhum exemplo desta página contém credenciais reais.