Lista de informes

Esta operación está obsoleta. Utilice el método "Obtener registros de forma sincrónica por intervalo de fechas" y utilice la función REPORTS-USAGE producto. También puede utilizar el "Crear informe de forma asíncrona" con el REPORTS-USAGE en la carga útil.

Este fragmento de código muestra cómo listar todas las solicitudes de informes asíncronos con el estado especificado. Si es necesario, también puede especificar un intervalo de fechas.

Tenga en cuenta que existe un periodo de conservación de datos de 4 días, por lo que los informes con más de 4 días de antigüedad no aparecerán en la lista.

Ejemplo

ClaveDescripción
VONAGE_API_KEY

Your Vonage API key (see it on your dashboard).

VONAGE_API_SECRET

Your Vonage API secret (also available on your dashboard).

ACCOUNT_ID

The account ID (same as VONAGE_API_KEY) for the account you want to generate reports, or retrieve records for.

REPORT_STATUS

Status of report generation, can be any of PENDING, PROCESSING, SUCCESS, ABORTED, FAILED, TRUNCATED. For report listing, status is passed in as a comma-separated list of report status values.

Si no especifica un intervalo de fechas, recibirá los informes generados durante los siete días anteriores.

Escriba el código

Añada lo siguiente a list-reports.sh:

curl -u "$VONAGE_API_KEY:$VONAGE_API_SECRET" \
     "https://api.nexmo.com/v2/reports?account_id=$ACCOUNT_ID&status=$REPORT_STATUS"

Ver fuente completa

Ejecute su código

Guarde este archivo en su máquina y ejecútelo:

bash list-reports.sh

Pruébalo

  1. Configura las variables reemplazables. Parámetro validez puede variar con producto.

  2. Ejecute el script y recibirá una respuesta similar a la siguiente:

{
  "self_link": "https://api.nexmo.com/v2/reports?account_id=abcd1234&status=SUCCESS",
  "items_count": 17,
  "reports": [
    {
      "request_id": "ri3p58f-48598ea7-1234-5678-90ab-faabd79abcde",
      "request_status": "SUCCESS",
      "direction": "outbound",
      "product": "SMS",
      "account_id": "abcd1234",
      "date_start": "2020-05-21T13:27:00+0000",
      "date_end": "2020-05-21T13:57:00+0000",
      "include_subaccounts": false,
      "status": "delivered",
      "include_message": false,
      "receive_time": "2020-06-03T15:24:31+0000",
      "start_time": "2020-06-03T15:24:32+0000",
      "_links": {
        "self": {
          "href": "https://api.nexmo.com/v2/reports/ri3p58f-48598ea7-1234-5678-90ab-faabd79abcde"
        },
        "download_report": {
          "href": "https://api.nexmo.com/v3/media/e87a2d7c-abcd-1234-aa45-9bf17a1eb2a1"
        }
      },
      "items_count": 4
    },
    ...
  ]
}

Tenga en cuenta el informe request_id está en la respuesta. También la file_iden este caso e87a2d7c-abcd-1234-aa45-9bf17a1eb2a1.

Ver también