Programadores

GET/v3/cdrs

Consultar os registros de chamadas da conta

Obtenha os registros de chamadas recebidas e efetuadas do período padrão compatível e conheça as limitações dos relatórios.

Nesta página
  1. Obter os registros de chamadas da conta
  2. Requisições
  3. Período padrão dos relatórios
  4. Resposta
  5. Campos do registro
  6. Erros e limitações dos relatórios

Obter os registros de chamadas da conta

Consulte os registros de chamadas recebidas ou efetuadas da sua conta de API. Esses registros contêm informações privadas sobre chamadas e faturamento. Mantenha-os em fluxos de trabalho autorizados no lado do servidor e evite gravá-los em logs ou compartilhá-los sem necessidade.

Este endpoint legado tem atualmente um período de datas padrão fixo e não oferece paginação. Use o fluxo de histórico de chamadas e exportação do portal quando precisar de um período de relatório diferente ou de exportações históricas de grande volume; os parâmetros de datas personalizadas deste endpoint não são confiáveis.

Requisições

Autentique-se por HTTPS usando sua conta de API habilitada, a partir do endereço IP de origem permitido para ela. O exemplo usa credenciais em variáveis de ambiente. As requisições compatíveis com o período padrão não precisam de corpo.

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  https://api.multitel.net/v3/cdrs
Caminhos de requisição de registros de chamadas
CaminhoEscopo
/v3/cdrsRegistros de chamadas recebidas da conta no período de datas padrão.
/v3/cdrs/{number}Registros de chamadas recebidas cujo número corresponde exatamente ao número fornecido. Dê preferência à sequência completa de dígitos usada no seu inventário.
/v3/cdrs/all/outboundRegistros de chamadas efetuadas da conta no período de datas padrão. O ramo de chamadas efetuadas ignora o primeiro argumento do caminho; all é apenas um marcador de posição aqui, não um curinga para chamadas recebidas.

Use exatamente o sentido inbound ou outbound mostrado acima. O ramo de chamadas efetuadas não implementa um filtro por número. Adicionar um número a esse caminho não restringe os resultados de chamadas efetuadas.

Período padrão dos relatórios

A consulta começa à meia-noite da data do calendário do servidor correspondente a 30 dias antes de hoje e termina à meia-noite no início de hoje. Portanto, ela não inclui o restante do dia atual. Não se trata de um período móvel de 720 horas que termina no momento atual.

A implementação atual não oferece suporte confiável aos campos de formulário date_from/date_to: fornecer datas personalizadas deixa sem definição as variáveis que indicam o ano das partições. Não use esses campos em um relatório de produção. Datas na cadeia de consulta e parâmetros de paginação não foram implementados como alternativas.

Resposta

Apenas alguns campos de chamadas recebidas são apresentados para ilustração; os dados são fictícios e não representam o registro completo retornado.

{
  "status": {
    "code": "200",
    "msg": "",
    "results": 1
  },
  "response": [
    {
      "number": "12025550123",
      "callerid": "12025550124",
      "disposition": "ANSWERED",
      "billseconds": "60",
      "billcost": "0.0100",
      "callsid": "11111111111111111111111111111111",
      "date_created": "2026-10-01 12:00:00 UTC"
    }
  ]
}

response é uma lista. A estrutura comum que envolve a resposta pode incluir status.results como contagem de linhas. Os códigos de resultado podem ser cadeias de texto. Um resultado sem registros usa o código 404 da API com a mensagem No entries found, em vez de retornar uma lista vazia como resposta bem-sucedida.

Campos do registro

Principais campos retornados
CamposSignificado
number, calleridNúmero de destino da chamada recebida e identificador de quem chama na projeção de chamadas recebidas.
calling, called, calleridIdentificadores de origem e destino na projeção de chamadas efetuadas. Não deduza uma identidade verificada do assinante a partir do identificador de chamadas.
disposition, billseconds, billcostResultado armazenado da chamada, duração faturada e valor de faturamento armazenado. Os valores podem usar formatos legados de cadeias de texto do banco de dados.
callsidO UUID armazenado da chamada, usado para correlacionar registros.
date_createdUma cadeia de data e hora com o sufixo literal UTC, sem garantia de que seja um carimbo de data e hora ISO8601. Faça a análise explícita do formato retornado.
Outros camposOs registros de chamadas recebidas também incluem dados de diagnóstico sobre falhas, custos, canais, qualidade e origem; os registros de chamadas efetuadas incluem dados de diagnóstico sobre a região de terminação. A resposta completa pode incluir informações de infraestrutura e deve ser tratada como privada.

O endpoint não adiciona ordenação explícita nem paginação. Não presuma que os resultados mais recentes aparecem primeiro, que a ordem das linhas é estável ou que existe um cursor de sincronização incremental. Os campos de faturamento retornados correspondem a registros de chamadas armazenados, não a uma cotação para uma chamada futura.

Erros e limitações dos relatórios

Consulte tanto o status HTTP quanto os campos status.code/status.msg do JSON. A ausência de registros na conta e no período selecionados retorna o código 404 da API. A autenticação e as restrições de IP de origem também se aplicam. Um relatório grande sem paginação ou uma requisição com datas personalizadas que não funcione de forma confiável pode falhar; consultar repetidamente a tabela inteira não é uma estratégia de exportação incremental.

O manipulador revisado contém consultas de leitura e não realiza débitos na conta nem inicia chamadas. Um registro retornado não comprova que uma pessoa atendeu; interprete o resultado e a duração armazenados conforme as necessidades do seu relatório.