レポートステータスの取得

このコード・スニペットでは、レポートのステータスを取得する方法を示します。レポート生成が正常に完了したかどうかを判断するためによく使用されます。

例

キー説明
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

Write the code

Add the following to get-report-status.sh:

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

View full source

Run your code

Save this file to your machine and run it:

bash get-report-status.sh

試してみる

  1. 交換可能な変数を設定する。 パラメータ 有効期限は以下の通りである。 製品.

  2. スクリプトを実行すると、次のような応答が返ってくる：

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

について file_id もレスポンスで返される。 e87a2d7c-abcd-1234-aa45-9bf17a1eb2a1.その file_id は、その後レポートのZipファイルをダウンロードするために使用されます。

参照