配信予約後に配信処理をおこなったメールアドレスの配信結果を取得します。 未配信の場合、データの取得はできません。
配信状況取得は、以下の条件で取得できます。取得条件
- 配信ID
- 期間指定
注意事項 返却可能な件数上限は、20,000件となります。上限値を超えた場合は、上限値以降のデータは返却されませんので、必要なデータが含まれるよう検索条件を変更してご利用ください。
メソッドとURL
メソッド | URL |
GET | https://{HOST名}/mailing-list/{delivery_id} |
GET | https://{HOST名}/mailing-list?timemin=yyyy-mm-ddThh:mm+09:00 &timemax=yyyy-mm-ddThh:mm+09:00 |
リクエスト
URLパラメーター
No | 項目 | 説明 |
1 | delivery_id | 配信予約を行った際に発行されるID |
2 | timemin/timemax | 配信予定日時で検索する場合に、期間指定で指定する。 |
レスポンス
ステータスコード
コード | メッセージ | 説明 |
200 | OK | 正常終了。 |
400 | Bad Request | 構文不正。フォーマットやパラメーターの不正。 |
404 | Not Found | 指定されたdelivery_idがありません。 |
500 | Internal Server Error | 想定外のエラー。 しばらく経ってから再実施頂き、状況が改善しなければ、弊社までお問い合わせください。 |
上記以外のステータスコードが返却される場合もあります。 その場合は、RFC2616規定のHTTPレスポンスステータスコード一覧をご確認ください。
ボディーパラメーター
JSON形式で取得されます。
項目 | 型 | 説明 | |
items | Object Array | レスポンス情報が設定されます。 | |
mail_id | String | 各宛先毎に割り当てられたメールID。 | |
destination_type | String | 宛先アドレスのタイプ。 | |
to | String | 宛先のメールアドレス。 | |
from | Object | 送信時に指定したfromアドレス。 | |
status | Number | メールアドレス単位の送信成否。 | |
message | String | 配信結果情報。 詳細は以下をご参照ください。 | |
timestamp | String | statusが更新された日時が設定されます。 | |
count | Number | itemsの設定された個数が設定されます。 | |
total | Number | 返却できないデータも含めた検索結果数が設定されます。 | |
message | String | 取得エラー時に補足メッセージが指定されます。 |
宛先アドレスのタイプ
配信予約で指定した、宛先アドレスのタイプが設定されます。 返却される値は、To
、Cc
、Bcc
の3種類となります。
メールアドレス単位の配信ステータス
配信結果により、以下の値が設定されます。
数値 | 説明 |
0 | 送信中 |
1 | 送信完了 |
2 | 送信失敗 |
3 | 送信対象外 エラーフィルターによるフィルタリングで送信対象から除外 (cc/bccの宛先で、toの宛先がフィルタリングされた場合も含む) |
※配信予約API実行直後は、配信予約情報の反映がされておらず「”message”: “Not Found”」が返却される場合がございます。時間をおいて実行をお願いします。
配信結果情報
配信処理を実施した際の送信結果や、バウンスメール受信によるエラー情報が登録されます。
注意事項 バウンスメールの情報は、長文の場合、一部抜粋表示となります
サンプル
レスポンス
正常
{
"items":[
{
"mail_id":"0000000",
"destination_type":"To",
"to":"xxxxxxxxx@xxxx.jp",
"from":"xxxxxxx@xxx.jp",
"status":1,
"message":"250 Requested mail action okay completed",
"timestamp":"2020-01-01T00:00:00+09:00"
}
],
"count": 1,
"total":1
}
エラー
{
"message":"Too Many Requests"
}