Berichte auflisten

Dieser Vorgang ist veraltet. Bitte verwenden Sie die "Datensätze synchron nach Datumsbereich abrufen" Snippet und verwenden Sie die REPORTS-USAGE Produkt. Sie können auch die "Bericht asynchron erstellen" Schnipsel mit dem REPORTS-USAGE Produkt in der Nutzlast.

Dieses Code-Snippet zeigt Ihnen, wie Sie alle asynchronen Berichtsanforderungen mit dem angegebenen Status auflisten können. Falls erforderlich, können Sie auch einen Datumsbereich angeben.

Beachten Sie, dass die Daten 4 Tage lang aufbewahrt werden, so dass Berichte, die älter als 4 Tage sind, nicht aufgelistet werden.

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

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.

Wenn Sie keinen Datumsbereich angeben, erhalten Sie die Berichte, die in den letzten sieben Tagen erstellt wurden.

Schreiben Sie den Code

Fügen Sie Folgendes zu list-reports.sh hinzu:

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

Vollständige Quelle anzeigen

Führen Sie Ihren Code aus

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

bash list-reports.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
    },
    ...
  ]
}

Beachten Sie den Bericht request_id ist in der Antwort enthalten. Auch die file_idIn diesem Fall e87a2d7c-abcd-1234-aa45-9bf17a1eb2a1.

Siehe auch