Berichtsstatus abrufen

Dieses Codeschnipsel zeigt Ihnen, wie Sie den Status eines Berichts abfragen können. Er wird häufig verwendet, um festzustellen, ob eine Berichtserstellung erfolgreich abgeschlossen wurde oder nicht.

Beispiel

SchlüsselBeschreibung
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

Schreiben Sie den Code

Fügen Sie Folgendes zu get-report-status.sh hinzu:

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

Vollständige Quelle anzeigen

Führen Sie Ihren Code aus

Speichern Sie diese Datei auf Ihrem Rechner und führen Sie sie aus:

bash get-report-status.sh

Probieren Sie es aus

  1. Setzen Sie die austauschbaren Variablen. Parameter Gültigkeit kann variieren mit Produkt.

  2. Führen Sie das Skript aus und Sie erhalten eine Antwort ähnlich der folgenden:

{
  "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
    },
    ...
  ]
}

Die file_id wird ebenfalls in der Antwort zurückgegeben, in diesem Fall e87a2d7c-abcd-1234-aa45-9bf17a1eb2a1. Die file_id wird verwendet, um anschließend eine Zip-Datei mit dem Bericht herunterzuladen.

Siehe auch