配信レスポンス
ユーザーが送信したメールステータスの一覧
このリストに対してクエリ操作を実行できます。
呼び出しアドレス
| データセンター | URL |
|---|---|
| シンガポール | https://email.api.engagelab.cc |
| トルコ | https://emailapi-tr.engagelab.com |
REST APIを使用する際は、選択したデータセンターが適切なベースURLに対応していることを確認してください。
POST/v1/email_status
URL
https://email.api.engagelab.cc/v1/email_status
https://email.api.engagelab.cc/v1/email_status
このコードブロックはフローティングウィンドウ内に表示されます
HTTPリクエストメソッド
GET
GET
このコードブロックはフローティングウィンドウ内に表示されます
リクエストヘッダー
| ヘッダー | タイプ | 必須 | 説明 |
|---|---|---|---|
| Authorization | String | true | Basic base64(api_user:api_key) |
クエリパラメータの説明
| パラメータ | タイプ | 必須 | 説明 |
|---|---|---|---|
| offset | string | No | クエリ開始位置、範囲 [0-]、デフォルトは0 |
| limit | int | No | クエリ件数、範囲 [0-100]、デフォルトは100 |
| send_date | string | Yes | 送信日、形式 yyyy-MM-dd |
| string | No | 受信者アドレス | |
| email_ids | string | No | メール送信API呼び出しで正常に返されたEmailId。複数のアドレスは';'で区切ります。例: email_ids=a;b;c |
| api_user | string | No | ユーザーの特定のAPI_USER |
| domain_name | string | No | 受信ドメイン、例: gmail.com |
| label_id | string | No | ユーザーが作成したラベルに対応するラベルID |
| status | string | No | 配信レスポンスステータスをクエリします。リクエスト値は18; 配信済みの値は1; ソフトバウンスの値は5; 無効なメールの値は4。 |
| sub_status | string | No | 無効なメールまたはソフトバウンスのサブクラスをクエリします。複数の無効なサブクラスは';'で区切ります。例: subStatus=a;b;c。このパラメータを指定すると、statusパラメータは無効になります。 |
注意:
- 各クエリはデフォルトで100件のレコードのみを返します。クエリ条件に一致するレコード数が100を超える場合、offsetおよびlimitパラメータを手動で指定する必要があります。
- 各クエリで取得した対応するレコードは、ユーザーが渡したパラメータに基づいて10分間キャッシュされます。
- このインターフェースは、各ユーザーアカウントが1分間にインターフェースを60回呼び出すことを制限します。要件を満たさない場合は、WebHookを使用してください。
- メールアドレスを渡すことで、send_dateの30日以内にそのアドレスの配信詳細をクエリできます。メールアドレスを渡さない場合、send_dateのデータ詳細のみをクエリできます。
| sub_status | sub_stat_desc |
|---|---|
| 401 | 無効なメール - プラットフォームブラックリスト |
| 402 | 無効なメール - 配信解除済み |
| 403 | 無効なメール - サーバー到達不能 |
| 404 | 無効なメール - アドレス形式エラー |
| 405 | 無効なメール - IPまたはドメイン拒否 |
| 406 | 無効なメール - アドレスが存在しない |
| 407 | 無効なメール - スパム |
| 408 | 無効なメール - 送信者/受信者拒否 |
| 409 | 無効なメール - その他 |
| 503 | ソフトバウンス - サービス到達不能 |
| 505 | ソフトバウンス - IPまたはドメイン拒否 |
| 506 | ソフトバウンス - メールアドレスが存在しない |
| 507 | ソフトバウンス - 迷惑メール対策による拒否 |
| 508 | ソフトバウンス - 送信者/受信者拒否 |
| 509 | ソフトバウンス - その他 |
リクエスト例
curl "https://email.api.engagelab.cc/v1/email_status?send_date=2022-11-21&email_ids=***;***" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl "https://email.api.engagelab.cc/v1/email_status?send_date=2022-11-21&email_ids=***;***" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
このコードブロックはフローティングウィンドウ内に表示されます
レスポンスの説明
| パラメータ | 説明 |
|---|---|
| 受信者アドレス | |
| email_id | メール送信API呼び出しで正常に返されたEmailId |
| api_user | api_user名 |
| status | 配信ステータス |
| status_desc | 配信ステータスの説明 |
| sub_status | 401-509の無効ステータスコード |
| sub_status_desc | 無効またはソフトバウンスのサブクラスの説明 |
| request_time | リクエスト時間 |
| update_time | ステータス更新時間 |
| response_message | 送信結果メッセージ |
レスポンス例
{
"result": [
{
"email_id": "1668065941982_15_2032_7460.sc-10_2_226_96-test0$1720f4a1d6af047181@hotmail.com",
"api_user": "zymtest4",
"email": "1720f4a1d6af047181@hotmail.com",
"request_time": "2022-11-10T15:39:01+0800",
"update_time": "2022-11-10T17:34:16+0800",
"status": 4,
"sub_status": 409,
"status_desc": "Invalid Email",
"sub_status_desc": "Other",
"response_message": "Other(scheduler: deleted)"
}
],
"total": "48675",
"count": 1
}
{
"result": [
{
"email_id": "1668065941982_15_2032_7460.sc-10_2_226_96-test0$1720f4a1d6af047181@hotmail.com",
"api_user": "zymtest4",
"email": "1720f4a1d6af047181@hotmail.com",
"request_time": "2022-11-10T15:39:01+0800",
"update_time": "2022-11-10T17:34:16+0800",
"status": 4,
"sub_status": 409,
"status_desc": "Invalid Email",
"sub_status_desc": "Other",
"response_message": "Other(scheduler: deleted)"
}
],
"total": "48675",
"count": 1
}
このコードブロックはフローティングウィンドウ内に表示されます
