配信状況取得は、配信予約、配信予約キャンセルを実施した結果を取得します。
配信状況取得は、以下の条件で取得できます。
取得条件
- 配信ID
- リクエストID
- 期間指定
注意事項 返却可能な件数上限は、4,000件となります。 期間指定などで4,000件を超えるリクエストをした場合は、4,000件までのデータがレスポンスとして返却されます。
メソッドとURL
| メソッド | URL |
| GET | https://{HOST名}/send/{delivery_id} |
| GET | https://{HOST名}/send?request_id={request_id} |
| GET | https://{HOST名}/send?timemin=yyyy-mm-ddThh:mm+09:00 &timemax=yyyy-mm-ddThh:mm+09:00 |
リクエスト
URLパラメーター
| 項目 | 説明 |
| delivery_id | 配信ごとに一意でシステム側から発行するID |
| request_id | 配信予約時にお客様側で任意に指定したID |
| timemin/timemax | 配信予約をした期間指定 |
レスポンス
ステータスコード
| コード | メッセージ | 説明 |
| 200 | OK | 正常終了。 |
| 400 | Bad Request | 構文不正。フォーマットやパラメーターの不正。 |
|
404
|
Not Found
|
指定したdelivery_idがありません。 |
| 500 | Internal Server Error | 想定外のエラー。 しばらく経ってから再度実施し、状況が改善しなければ、弊社までお問い合わせください。 |
※実行直後は、配信予約情報の反映がされない場合がございます。時間をおいて実行をお願いします。 上記以外のステータスコードが返却される場合もあります。 その場合は、RFC2616規定のHTTPレスポンスステータスコード一覧をご確認ください。
ボディパラメーター
JSON形式で取得されます。
| 項目 | 型 | 説明 | ||
| items | Object Array | レスポンス情報が設定されます。 | ||
| delivery_id | String | 取得した配信IDが設定されます。 | ||
| status | String | 配信ステータスが設定されます。 詳細説明は以下をご参照ください。 | ||
| settings | Object | 配信予約時のsettingsと同じ内容が設定されます。 詳細説明は以下をご参照ください。 | ||
| sendresult_count | Object | 配信数が設定されます。 | ||
| success | Number | 配信成功数が設定されます。 | ||
| error | Number | 配信エラー数が設定されます。 | ||
| count | Number | itemsの設定された個数が設定されます。 | ||
| total | Number | 返却できないデータも含めた検索結果数が設定されます。 | ||
| message | String | 取得エラー時に補足メッセージが指定されます。 | ||
サンプル
レスポンス
正常
{
"items":[
{
"deliver_id": "000000",
"status": "reserved",
"settings":{
"send_time":"yyyy-mm-ddThh:mm+09:00",
"request_id":"xxxxxxxxxxxxxxxxxxxxxxxxx",
"from":{
"name":"from表示名",
"address":"xxxxxxx@xxx.xx"
},
"reply_to":{
"address":"xxxxxxx@xxx.xx"
},
"tc_option":{
"stop_send":{
"timemin":"hh:mm",
"timemax":"hh:mm"
},
"lifetime":3600,
"retry_interval":60
},
"throttle":300,
"error_count":0
},
"sendresult_count":{
"success": 1,
"error": 0
},
},
{...}
],
"count": 2,
"total": 2
} エラー
{
"message": "Too Many Requests"
}補足情報が返却されます。