Reports API

Cuando utilizas nuestras API de comunicación, se crean dos tipos de registros: los registros del servidor y los registros detallados de llamadas (CDR), que son registros transaccionales de la actividad. La Reports API te permite descargar tus CDR. Puedes filtrar tus CDR en función de atributos como los números de teléfono de origen y destino, el estado, el periodo de tiempo y mucho más. Consulte la lista de parámetros admitidos. Puede incluir el cuerpo del mensaje/texto y descargar informes para cualquiera de sus subcuentas.

Puede utilizar la API de Reports en una amplia variedad de casos de uso, entre los que se incluyen:

• Facturación a clientes: descargue las transacciones relacionadas con todas sus subcuentas y utilice los datos de precios incluidos para determinar lo que debe facturar a sus clientes.
• Conciliación de facturas: compare sus datos de uso con la factura que ha recibido.
• Supervisión y análisis: añade datos CDR en tiempo real a tu sistema de inteligencia empresarial o de análisis para correlacionarlos con otros eventos.
• Gestión de campañas: controle el rendimiento de su campaña mediante herramientas de autoservicio.
• Depuración: solucione problemas explorando hasta 13 meses de datos de uso detallados.
• Prevención del fraude - Identifique el fraude y controle los patrones para bloquear a los usuarios que utilicen el Defensor del Fraude producto.

Puede consultar sus CDR utilizando una amplia gama de filtros. Los registros de datos se conservan durante trece meses (periodo máximo de conservación) o 90 días para Video API. Los registros de más de trece meses (o 90 días para Video API) no se pueden obtener porque se borran automáticamente del sistema.

Funcionamiento síncrono y asíncrono

En función de tu patrón de consultas, puedes elegir uno de los dos enfoques para la Reports API:

1. Sincrónico
2. Asíncrono

El síncrono Esta versión está optimizada para recuperaciones frecuentes y periódicas de pequeños lotes de registros de datos. El tamaño habitual de los lotes oscila entre un registro y decenas de miles por consulta.

El asíncrono está optimizada para consultas de datos poco frecuentes y de gran tamaño. Los tamaños de lote habituales oscilan entre varios miles y millones de registros.

Resumen de características

En la siguiente tabla se comparan las características de los métodos síncronos y asíncronos de uso de la Reports API:

Productos compatibles

• SMS API
• Messages API:
  • SMS/MMS
  • RCS
  • WhatsApp
  • Viber
  • Instagram
  • Messenger
• Voice API:
  • SIP
  • RTPC
  • WebRTC
  • ASR
  • TTS
  • AMD
• Video API
• Conversation API
• Verify API
• Entender los Numbers
• Reports API
• API de red (con el nombre de producto NETWORK_API-EVENT):
  • API de Identity Insights

Precios

Para consultar los precios, visita esta página. Los precios que figuran en los ejemplos siguientes son meramente ilustrativos.

Vea cómo El sistema de precios de la Reports API funciona.

Ejemplo de precios (GET solicitudes)

Supongamos que quieres recuperar los registros de SMS del último minuto y resulta que hay 300 registros en ese periodo de tiempo. El coste total de este informe será el siguiente:

Ejemplo de precios (POST solicitudes)

Supongamos que crea un informe SMS para recuperar un día de datos y este informe contiene 10.000 CDR, entonces el cargo total por este informe será el siguiente:

¿Cómo puede comprobar el uso de su Reports API?

Puede comprobar el uso de su Reports API cargando registros de forma sincrónica o creando un informe de forma asincrónica para el producto "REPORTS-USAGE".

Recuperar registros de forma sincrónica

Utiliza una solicitud HTTP GET para recuperar esta información:

Recibirá una respuesta similar a la que figura a continuación. En "items_count": 3 indica que se extrajeron 3 informes durante el periodo de búsqueda.

{
  "_links": {
    "self": {
      "href": "https://api.nexmo.com/v2/reports/records?account_id=<API-KEY>&product=REPORTS-USAGE&date_start=YYYY-MM-DDTHH%3AMM%3ASSZ&date_end=YYYY-MM-DDTHH%3AMM%3ASSZ"
    }
  },
  "request_id": "555042c5-368a-4fd2-b983-f24197692bac",
  "request_status": "SUCCESS",
  "received_at": "2021-10-07T09:08:58+00:00",
  "price": 0.0,
  "currency": "",
  "limit": 1000,
  "items_count": 3,
  "include_subaccounts": false,
  "records": [
    ...
  ],
  "product": "REPORTS-USAGE",
  "account_id": "<API-KEY>",
  "date_start": "2021-10-06T00:00:00+00:00",
  "date_end": "2021-10-07T23:59:00+00:00",
  "endpoint_type": "PUBLIC"
}

Recuperar registros de forma asíncrona

Los registros se pueden recuperar de forma asíncrona creando un informe asíncrono y configurando el product a "REPORTS-USAGE". El siguiente ejemplo muestra cómo crear un informe asíncrono:

Para más información, consulta el crear un informe CSV utilizando la línea de comandos página.

Fragmentos de código

• Antes de empezar
• Cancelar informe
• Consultar el estado del informe
• Crear un informe de forma asíncrona
• Descargar el archivo del informe
• Lista de informes
• Obtener registros por fechas
• Obtener registros por UUID

Tutoriales

• Crear un informe CSV utilizando la línea de comandos
• Crear un informe CSV con una herramienta gráfica
• Obtener registros JSON utilizando la línea de comandos

Referencia API

• Referencia de la API Reports