一括電子メール検証: ジョブ・ステータスの取得
get
/api/v3/email/batch/job/{jobid}
一括Eメール検証ジョブ・ステータスの取得:
このAPIを使用すると、ジョブ・ステータスを取得できます。
入力: /api/v3/email/batch/verifyレスポンスの値を使用して、jobid
というパス・パラメータを定義します。
出力: jobid
、status
、totalVerifiedEmails
、completedOn
を含むJSONオブジェクト。
レスポンスの例: { "jobId": "1000080", "status": "Complete", "totalVerifiedEmails": "3", "completedOn": "2024-01-03 11:33:17.474" }
「ジョブの状態」
ステータス・エンドポイントをコールするときに受信できる状態は次のとおりです:
状態 | 説明 |
---|---|
Pending | ジョブは送信されましたが、まだ開始されていません。 |
Verifying | ジョブは進行中です。 |
Complete | ジョブが完了し、取得の準備ができました。 |
Failed | ジョブはエラーのため失敗しました。 該当する場合は、アカウントにクレジットが適用されます。 |
リクエスト
パス・パラメータ
この操作にはリクエスト本文がありません。
トップに戻るレスポンス
サポートされるメディア・タイプ
- application/json; charset=UTF-8
200 レスポンス
成功
ルート・スキーマ : スキーマ
タイプ:
object
401 レスポンス
承認されていません
403 レスポンス
禁止
500 レスポンス
リクエスト中に予期しないエラーが発生しました。