A Reports API da Vonage agora oferece suporte à Video API

Introdução

A Reports API da Vonage agora oferece suporte à Video API—mas apenas para o usuários do Painel da API da Vonage (Unificado) . Se você for um usuário do usuário do OpenTok Dashboard , esse recurso não está disponível.
Até agora, os desenvolvedores que trabalham com a Video API dependiam principalmente da API Insights para análises detalhadas das sessões. Com essa atualização, você também pode acessar dados de vídeo por meio da Reports API, o que oferece um único local para obter informações de uso e relatórios de outras APIs da Vonage, como SMS, Mensagens, Voicee Verify.

O que é a Reports API?

A Reports API é uma forma centralizada de recuperar dados de uso e relatórios em todos os produtos da Vonage, agora disponível para o serviço de Video, oferecendo aos desenvolvedores e às empresas uma maneira consistente de acompanhar dados de atividade, faturamento e conformidade.

Por que usar a Reports API?

Isso simplifica a geração de relatórios, reunindo dados de uso e faturamento de várias APIs da Vonage em um único formato padronizado. Para obter mais informações sobre a Reports API, você pode consultar o artigo de lançamento aqui ou ler um tutorial sobre uma implementação usando o Laravel como exemplo.

Reports API x API de Insights

Antes de entrarmos em detalhes sobre como usar a Reports API para dados de vídeo, vamos comparar brevemente essa API com as APIs Insights e Advanced Insights. A tabela abaixo destaca as principais diferenças para que você possa identificar qual produto é mais adequado ao seu caso de uso.

All features compared

Como usar a Reports API para dados da Video API

A Reports API para vídeo está disponível, no momento, apenas por meio da API REST. Ela não pode ser acessada pelo Painel da Vonage; portanto, você precisará enviar suas solicitações usando um cliente REST.

Pré-requisitos

• Account do Unified Video

• Sua chave e seu segredo da API

• Um cliente REST (por exemplo, cURL, Postman)

Passo 1. Escolha o tipo de relatório

• Relatórios síncronos: resultados rápidos para conjuntos de dados menores.

• Relatórios assíncronos: mais indicados para conjuntos de dados maiores ou intervalos de tempo mais longos. São executados em segundo plano e fornecem um link para download.
  Para mais detalhes, consulte Diferenças entre operação síncrona e assíncrona.

Etapa 2. Solicitar e obter um relatório

2.1 Exemplo de relatório síncrono

Envie sua solicitação

curl -X GET "https://api.nexmo.com/v2/reports/records?product=VIDEO-API&account_id=$VONAGE_API_KEY&date_start=2025-09-27T00:00:00Z&date_end=2025-09-30T23:59:59Z" \
-u "$VONAGE_API_KEY:$VONAGE_API_SECRET"

Exemplo de resposta (resumido para maior clareza)

"records": [
        {
            "account_id": "xxxxx",
            "feature_name": "Subscriber minutes",
            "session_id": "xxxxx",
            "meeting_id": "",
            "subscriber_id": "xxxxx",
            "archive_id": "",
            "broadcast_id": "",
            "hls_id": "",
            "composer_id": "",
            "application_id": "xxxxx",
            "duration": "120.0",
            "date_start": "2025-09-29T11:29:12+00:00",
            "date_end": "2025-09-29T11:30:22+00:00",
            "total_price": "0",
            "currency": "EUR",
            "id": "xxxxx"
        },

Consulte a referência da API sobre relatórios síncronos para obter uma descrição completa dos campos disponíveis e suas definições.

2.2 Exemplo de relatório assíncrono

Envie sua solicitação

curl -X POST "https://api.nexmo.com/v2/reports" \
  -u "$VONAGE_API_KEY:$VONAGE_API_SECRET" \
  -H "Content-Type: application/json" \
  -d '{
    "product": "VIDEO-API",
    "account_id": "$VONAGE_API_KEY",
    "date_start": "2025-09-01T00:00:00Z",
    "date_end": "2025-09-30T23:59:59Z",
    "callback_url": "https://webhook.site/b7dd039b-afc7-464b-8fbd-1ef84820eaed"
  }'

Exemplo de resultado (CSV) (resumido para maior clareza)

ID_da_conta,nome_do_recurso,ID_da_sessão,ID_do_aplicativo,duração,data_inicial,data_final,preço_total,moeda
xxxxx,Experience Composer,xxxxx,xxxxx,7,2025-09-29T11:30:05+00:00,2025-09-29T11:30:12+00:00,0,EUR
xxxxx,Minutos do assinante,xxxxx,xxxxx,120,29/09/2025 11:29:12 +00:00,29/09/2025 11:30:22 +00:00,0,EUR
xxxxx,Interconexão,xxxxx,xxxxx,120,29/09/2025 11:29:12 +00:00,29/09/2025 11:30:22 +00:00,0,0094596,EUR

Para simplificar, mostrei aqui apenas o básico. Para obter o guia passo a passo completo sobre como criar relatórios assíncronos, consulte o artigo.

Pronto para explorar a Reports API para vídeo?

Agora você pode acessar seus dados de uso e faturamento da Video API por meio da Reports API — tudo em um só lugar. Para dúvidas técnicas sobre a Reports API para Video, entre em contato com nossa Equipe de Suporte da Video API pelo portal de suporte. Está pensando em migrar do OpenTok para o Unified? Este é um ótimo momento para explorar os recursos aprimorados de relatórios. Entre em contato com seu Account Manager para obter detalhes sobre a migração.