コンテンツにスキップ

ビデオ ステータス

この API ガイドでは、一括リクエストのステータスを確認するプロセスの概要を説明します。

CSV ファイル内の連絡先の数によっては、一括リクエストの処理に時間がかかる場合があります。リクエストを開始したら、ステータスを確認して進行状況を監視する必要があります。進行状況はパーセンテージで表示されます。 🦊

クイック スタート

一括リクエストの進行状況を確認する方法について詳しく見ていきましょう。

一括ステータスの取得

一括リクエストの進行状況を確認するには、リクエスト生成または 一括リスト API から取得した 'id' を 'video_id' として指定します。応答として、次の内容が返されます。

  • 'progress': リクエストの現在の進行状況 (パーセンテージ)。
  • 'status': リクエストの全体的なステータス。
  • 'video_links_csv': ビデオをダウンロードするための URL が含まれています。

このエンドポイントは複数回呼び出すことができます。これにより、部分的な結果も csv で返されます。ビデオ生成が進行中の場合、ステータスは「進行中」となり、進行状況は 100 未満になります。すべてのビデオが生成されると、ステータスは「完了」となり、進行状況は 100 になります。

curl --request GET  \
     --url 'https://api.immersive-fox.com/v1/bulk_requests/video/<video_id>'  \
     --header 'X-Api-Key: <your-api-key>'  \
     --header 'Content-Type: application/json'

=== 「応答（進行中）」

```javascript
{
    "id": 494,
    "csv_file_name": "my_contacts.csv",
    "progress": 55,
    "status": "in-progress",
    "video_links_csv": "https://my-bucket-name.s3.eu-central-1.amazonaws.com/my_contact_videos.csv"
}
```

=== 「回答（完了）」

```javascript
{
    "id": 494,
    "csv_file_name": "my_contacts.csv",
    "progress": 100,
    "status": "Completed",
    "video_links_csv": "https://my-bucket-name.s3.eu-central-1.amazonaws.com/my_contact_videos.csv"
}
```