Reports API de Vonage ahora admite Video API

Introducción

La API de Reports de Vonage ahora es compatible con la API de Video-pero sólo para Panel de API de Vonage (unificado) de Vonage. Si eres un usuario de OpenTok Dashboard esta función no está disponible.
Hasta ahora, los desarrolladores que trabajaban con la Video API dependían principalmente de la Insights API para el análisis detallado de las sesiones. Con esta actualización, también puedes acceder a los datos de Video a través de Reports API, lo que te brinda un único lugar para obtener información de uso e informes de otras API de Vonage como SMS, Mensajes, Voicey Verify.

¿Qué es la Reports API?

En Reports API es una forma centralizada de recuperar datos de uso e informes en todos los productos de Vonage, ahora disponible para Video, que ofrece a los desarrolladores y empresas una forma coherente de realizar un seguimiento de los datos de actividad, facturación y cumplimiento.

¿Por qué utilizar Reports API?

Simplifica la generación de informes al reunir los datos de uso y facturación de múltiples API de Vonage en un formato consistente. Para obtener más información sobre Reports API, puedes ver el artículo de lanzamiento aquí, o leer un tutorial sobre alguna implementación usando Laravel como ejemplo.

API de Reports API frente a API de Insights

Antes de entrar de lleno en cómo utilizar la Reports API para los datos de Video, comparémosla brevemente con las API Insights y Advanced Insights. En la tabla siguiente se destacan las principales diferencias para que pueda ver qué producto es más aplicable a su caso de uso.

All features compared

Cómo utilizar la Reports API para los datos de la Video API

Actualmente, Reports API para Video sólo está disponible a través de REST API. No se puede acceder a ella desde el panel de Vonage, por lo que tendrás que hacer tus solicitudes usando un cliente REST.

Requisitos previos

• Cuenta de Video Unificado

• Su clave y secreto API

• Un cliente REST (por ejemplo, cURL, Postman)

Paso 1. Seleccione el tipo de informe Elija el tipo de informe

• Informes síncronos: Resultados rápidos para conjuntos de datos más pequeños.

• Informes asíncronos: Mejor para conjuntos de datos más grandes o intervalos de tiempo más largos. Se ejecuta en segundo plano y ofrece un enlace de descarga.
  Para más detalles, consulte Diferencias entre el funcionamiento síncrono y asíncrono.

Paso 2. Solicitar y recuperar un informe Solicitar y recuperar un informe

2.1 Ejemplo de informe sincrónico

Envíe su solicitud

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"

Ejemplo de respuesta (recortada para mayor claridad)

"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"
        },

Véase la Referencia API para informes síncronos para obtener un desglose completo de los campos disponibles y sus definiciones.

2.2 Ejemplo de informe asíncrono

Envíe su solicitud

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"
  }'

Ejemplo de resultado (CSV) (recortado para mayor claridad)

Account_id,feature_name,session_id,application_id,duration,date_start,date_end,total_price,currency
xxxxx,Experience composer,xxxxx,xxxxx,7,2025-09-29T11:30:05+00:00,2025-09-29T11:30:12+00:00,0,EUR
xxxxx,Subscriber minutes,xxxxx,xxxxx,120,2025-09-29T11:29:12+00:00,2025-09-29T11:30:22+00:00,0,EUR
xxxxx,Interconnect,xxxxx,xxxxx,120,2025-09-29T11:29:12+00:00,2025-09-29T11:30:22+00:00,0.0094596,EUR

Para simplificar las cosas, aquí sólo he mostrado lo básico. Para ver la guía completa paso a paso para crear informes asíncronos, consulte el artículo.

¿Listo para explorar la API de Reports para Video?

Ahora puede acceder a sus datos de uso y facturación de la Video API a través de la Reports API, todo en un mismo lugar. Si tiene preguntas técnicas sobre la Reports API para Video, póngase en contacto con nuestro equipo de asistencia de la Video API desde el portal de asistencia. ¿Estás pensando en cambiar de OpenTok a Unified? Este es un buen momento para explorar las capacidades mejoradas de generación de informes. Ponte en contacto con tu Account Manager para conocer los detalles de la migración.