A computer showing a few icons related to reports API, a magnifier, graphs, video, call and more, a padlock, a robot.

A Reports API do Vonage já está disponível para o público em geral

Publicado em October 9, 2025

Tempo de leitura: 6 minutos

Introdução

Estamos muito animados em apresentar a Reports API for Vonage, uma API que permite que você visualize e utilize seus dados de comunicação em uma plataforma centralizada. Em vez de extrair dados de várias fontes e combiná-los, agora você conta com uma única API que oferece uma visão consistente de suas comunicações, tornando o trabalho mais rápido, simples e fácil.

Principais recursos

Com a Reports API, você pode acompanhar o status das entregas, acessar informações de cobrança, detectar possíveis fraudes e até mesmo inserir dados em tempo real em seus próprios painéis. Em resumo, é o seu centro único para monitorar e gerenciar as comunicações.

Não é necessária nenhuma configuração

A API já está disponível para todos os clientes da Vonage. Basta ter sua chave e seu segredo da API para começar a fazer consultas.

Visão geral completa dos dados

A Reports API oferece uma interface única para visualizar e gerenciar todos os seus dados de comunicação. Ela consolida os dados de uso de uma ampla gama de produtos da Vonage, incluindo:

  • SMS API, incluindo controle de tráfego

  • Voice API (In-App Voice, chamadas via WebSocket, conversão de texto em fala, ASR, AMD, SIP, PSTN)

  • Messages API (WhatsApp, RCS, SMS/MMS, Viber, Facebook Messenger, Instagram)

  • Verify

  • APIs de rede (Identity Insights, incluindo a Number Insight API)

  • Video API

  • Conversation API (Eventos e Mensagens)

Opções flexíveis de preços

A Reports API oferece opções flexíveis de preços para que você possa escolher o modelo que melhor se adapte ao seu volume de relatórios e aos seus padrões de uso.

  1. Modelo “Pay As You Go” com preços escalonados incrementais: A partir de 1º de maio de 2026, o modelo padrão de preços “Pague conforme o uso” utilizará preços escalonados incrementais. Isso significa que você será cobrado com base no número de registros, ou CDRs, retornados pelas suas solicitações à Reports API dentro de um único mês civil ou faturamento. Um registro é um Registro de Detalhes de Chamada (CDR) ou uma entrada de dados retornada em um relatório. Por exemplo, se uma solicitação de relatório retornar 500 linhas de dados, isso conta como 500 registros.

    Com a estrutura de preços por faixas incrementais, volumes maiores de registros são cobrados a taxas progressivamente mais baixas. À medida que seu uso mensal aumenta, descontos são aplicados automaticamente, reduzindo seu custo médio por registro. O uso é zerado no início de cada novo mês de faturamento. Para conhecer os limites e taxas das faixas mais recentes, consulte a página oficial de preços da Reports API.

  2. Plano Ilimitado: Uma mensalidade fixa para usuários que consomem muito tráfego, disponível apenas para apenas para clientes pós-pagos. Recomendado se você estiver consultando mais de 1 milhão de registros por mês ou 12 milhões por ano. Entre em contato com seu gerente de contas para mudar para este plano.

Duas maneiras de recuperar dados

  • As consultas síncronas são ótimas para relatórios rápidos e pequenos (até cerca de 10.000 registros).

  • As consultas assíncronas são projetadas para relatórios de grande porte, com até cerca de 7 milhões de registros por vez.

Filtragem avançada

Filtre por intervalo de datas, ID do evento, números de telefone ou subcontas para encontrar exatamente o que você precisa.

Gerenciamento de subcontas

Se sua empresa tiver várias subcontas, você pode consultar cada uma delas separadamente. Isso agiliza consultas mais extensas e mantém seus dados organizados.

Disponibilidade em tempo real

Os dados estão, em sua maioria, disponíveis em tempo real, embora haja algumas diferenças dependendo do produto:

  • Voice API: os dados ficam disponíveis assim que a chamada terminar.

  • Verify API: Os dados ficam prontos assim que o fluxo de trabalho for concluído. Os dados do canal ficam disponíveis instantaneamente

  • Video API: Disponível entre 30 e 120 minutos após o processamento.

  • Na maioria das outras APIs: as atualizações ocorrem instantaneamente.

Casos de uso na prática

A Reports API pode ajudá-lo a resolver muitos desafios comuns:

  • Relatórios de uso e cobrança: acesse registros detalhados de chamadas e registros de mensagens para localizar faturas e monitorar custos.

  • Acompanhamento do status de entrega: verifique o status de uma mensagem ou chamada instantaneamente, sem precisar recuperar todo o conjunto de dados.

  • Controle financeiro: gere notas fiscais para subcontas, ideal para revendedores que gerenciam vários clientes.

  • Gerenciamento de campanhas: acompanhe o desempenho quase em tempo real e ajuste as campanhas de acordo com os resultados.

  • Detecção de fraudes: identificar padrões de fraude e tomar medidas utilizando o produto Fraud Defender .

  • Painéis em tempo real: dados de uso em tempo real em ferramentas de BI ou painéis personalizados para obter insights imediatos.

Melhores práticas

Aqui estão algumas dicas para aproveitar ao máximo a Reports API:

  • Otimização de consultas com filtros: utilize filtros (como intervalos de datas, IDs ou números de telefone) para recuperar apenas os dados necessários, reduzindo assim os custos e aumentando a eficiência.

  • Melhores práticas para monitorar o status das mensagens: Solicite relatórios usando o parâmetro id para rastrear com eficiência o status mais recente da mensagem sem chamadas repetidas.

  • Otimização de solicitações com todas as suas subcontas: Para contas principais com mais de 10 subcontas, primeiro recupere a lista de subcontas por meio da API de subcontas e, em seguida, chame a Reports API separadamente para cada subconta e para a própria conta principal.

  • Entendendo a estrutura de preços e o modelo “Pague conforme o uso”: como as cobranças são feitas por registro por relatório, use o painel do Analytics para estimar o volume de CDR e evitar solicitações duplicadas desnecessárias.

  • Limitações de processamento: Respeite o limite de tamanho de 1 GB para relatórios assíncronos e os limites de taxa (5 solicitações assíncronas ou 10 solicitações síncronas por segundo), dividindo as solicitações em blocos com o uso de filtros.

  • Escolha entre o método síncrono e o assíncrono: utilize o método síncrono para necessidades menores de dados em tempo real e o método assíncrono para conjuntos de dados maiores ou exportações em CSV entre várias subcontas.

  • Monitoramento eficaz do uso da API: acompanhe o uso internamente ou utilize o produto gratuito REPORTS-USAGE para analisar os últimos 13 meses de atividade da Reports API e otimizar o desempenho.

Você pode obter todos os detalhes sobre cada um deles em nossa documentação.

Conclusão

A Reports API da Vonage já está disponível e pronta para ajudá-lo a acompanhar, analisar e gerenciar todas as suas métricas de comunicação. Seja para otimizar campanhas, controlar custos, automatizar o faturamento e o acompanhamento do uso ou detectar fraudes, essa Reports API oferece total visibilidade e controle. Para começar a usar a Reports API, consulte a documentação da Reports API e comece a desenvolver.

Tem alguma dúvida ou quer compartilhar o que está criando?

Fique conectado e acompanhe as últimas notícias, dicas e eventos para desenvolvedores.

Compartilhar:

https://a.storyblok.com/f/270183/384x384/b68093ec17/diana-pham.png
Diana PhamRepresentante de Desenvolvedores

Diana é defensora de desenvolvedores na Vonage. Ela gosta de comer ostras frescas.