Consultar el estado del informe

Este fragmento de código muestra cómo obtener el estado de un informe. Suele utilizarse para determinar si la generación de un informe se ha completado correctamente o no.

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).

REQUEST_ID

The request ID returned when a report was created

Escriba el código

Añada lo siguiente a get-report-status.sh:

curl -u "$VONAGE_API_KEY:$VONAGE_API_SECRET" \
     "https://api.nexmo.com/v2/reports/$REQUEST_ID"

Ver fuente completa

Ejecute su código

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

bash get-report-status.sh

Requisitos previos

Install-Package Vonage

Crea un archivo llamado GetReport.cs y añade el siguiente código:

var credentials = Credentials.FromApiKeyAndSecret(VONAGE_API_KEY, VONAGE_API_SECRET);
Client = new VonageClient(credentials);

Ver fuente completa

Escriba el código

Añada lo siguiente a GetReport.cs:

var request = GetReportRequest.Build()
    .WithReportId(requestId)
    .Create();
var response = await Client.ReportsClient.GetReportAsync(request);

Ver fuente completa

Pruébalo

  1. Configura las variables reemplazables. Parámetro La validez puede variar en función de 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
    },
    ...
  ]
}

El file_id también se devuelve en la respuesta, en este caso e87a2d7c-abcd-1234-aa45-9bf17a1eb2a1. En file_id se utiliza para descargar posteriormente un archivo Zip de informes.

Véase también