Bericht asynchron erstellen

Dieses Codeschnipsel zeigt Ihnen, wie Sie einen Bericht asynchron unter Verwendung eines Datumsbereichs erstellen können.

Dies ist ein asynchroner Aufruf und wird daher sofort zurückgegeben. Sie können den aktuellen Status der Berichtserstellung mit Berichtsstatus abrufen. Nach Fertigstellung können Sie den Bericht mit Bericht abrufen. Alternativ können Sie auch eine Rückruf-URL festlegen und eine Benachrichtigung erhalten, wenn die Berichterstellung abgeschlossen ist.

Der Datumsbereich ist bei dieser Aufforderung auf 13 Monate begrenzt.

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_DIRECTION

Either inbound or outbound

REPORT_PRODUCT

Specifies the product for which reports and records are obtained. Can be one of SMS, VOICE-CALL, WEBSOCKET-CALL, VERIFY-API, NUMBER-INSIGHT, MESSAGES, CONVERSATIONS, or ASR.

REQUEST_ID

The request ID returned when a report was created

DATE_START

Date of time window from when you want to start gathering records in ISO-8601 format.

DATE_END

Date of time window from when you want to stop gathering records in ISO-8601 format.

STATUS

Status of message or call.

Schreiben Sie den Code

Fügen Sie Folgendes zu create-async-report.sh hinzu:

curl -X POST "https://api.nexmo.com/v2/reports" \
  -H 'Content-Type: application/json; charset=utf-8' \
  -u "$VONAGE_API_KEY:$VONAGE_API_SECRET" \
  -d $'{
  "product": "'$REPORT_PRODUCT'",
  "account_id": "'$ACCOUNT_ID'",
  "direction": "'$REPORT_DIRECTION'",
  "status": "'$STATUS'",
  "date_start": "'$DATE_START'",
  "date_end": "'$DATE_END'"
}'

Vollständige Quelle anzeigen

Führen Sie Ihren Code aus

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

bash create-async-report.sh

Probieren Sie es aus

  1. Legen Sie die austauschbaren Variablen für Ihren Account fest.

  2. Für dieses Beispiel setzen Sie REPORT_PRODUCT zu einem der SMS, VOICE oder MESSAGES.

  3. Legen Sie anhand der Tabelle die Werte für die übrigen Variablen fest.

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

{
  "request_id": "ri3p58f-42d57cfd-1234-5678-9abc-67580d95f54a",
  "request_status": "PENDING",
  "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,
  "include_message": false,
  "receive_time": "2020-06-04T10:53:32+0000",
  "_links": {
    "self": {
      "href": "https://api.nexmo.com/v2/reports/ri3p58f-42d57cfd-1234-5678-9abc-67580d95f54a"
    }
  }
}

Wenn Sie eine Rückruf-URL festlegen, erhalten Sie einen Rückruf auf diese URL mit demselben Inhalt wie im vorherigen Schritt.

Siehe auch