getMailRequestStatus
- 印刷する
- PDF
getMailRequestStatus
- 印刷する
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
送信を要請したrequestIdを伝え、該当するリクエストにより送信中のメールのステータスとステータス別の数を照会します。
GET https://{endpoint}/mails/requests/{requestId}/status
リクエスト
リクエストパラメータ
| パラメータ名 | 必須 | タイプ | 制約事項 | 説明 |
|---|---|---|---|---|
| requestId | Yes | String | Email送信のリクエストID(それぞれの要請を区別するID、一括で複数件のメール送信を要請する場合、requestIdが複数のmailIdを含むことができる。 |
レスポンス
| HTTPステータスコード | 説明 |
|---|---|
| 200 | 成功 |
| 400 | 認証失敗、間違ったリクエスト |
| 500 | サーバエラー |
例示
リクエスト
GET https://mail.apigw.ntruss.com/api/v1/mails/requests/20181126000000246001/status
レスポンス
{
"requestId":"20181126000000246001",
"readyCompleted":true,
"allSentSuccess":false,
"requestCount":35179,
"sentCount":33502,
"finishCount":35179,
"readyCount":35179,
"reservationDate":null,
"countsByStatus":[
{
"status":{
"label":"Failed to send",
"code":"F"
},
"count":1415
},
{
"status":{
"label":"Sent successfully",
"code":"S"
},
"count":33502
},
{
"status":{
"label":"Unsubscribe",
"code":"U"
},
"count":262
}
]
}
属性
| 項目 | 必須 | タイプ | 制約事項 | 説明 |
|---|---|---|---|---|
| requestId | Yes | String | Email送信リクエストのID(それぞれの要請を区別するID、一括で複数件のメール送信を要請する場合、requestIdが複数のmailIdを含むことがある。 | |
| readyCompleted | Yes | Boolean | 送信準備完了の可否・送信を要請した件数がすべてDBに入力され、送信準備ができているかの可否(送信が完了してもtrue) | |
| allSentSuccess | Yes | Boolean | 要請があったすべてのメールが送信できたかの可否 | |
| requestCount | Yes | Integer | 送信リクエストの件数 | |
| sentCount | Yes | Integer | 送信完了(送信成功)の件数 | |
| finishCount | Yes | Integer | 処理が完了した件数(送信成功+失敗+受信拒否+キャンセル) | |
| readyCount | Yes | Integer | 準備完了または送信完了した件数(送信のためにDBに入力された件数) | |
| reservationDate | No | DateTime | 予約日時 | |
| countsByStatus | Yes | List<CountByStatus> | ステータスによるメール数 |
エラーコード
| HTTP Status Code | リターンコード | レスポンスメッセージ |
|---|---|---|
| 400 | 77101 | ログイン情報のエラー |
| 400 | 77102 | BAD_REQUEST |
| 400 | 77103 | リソースが存在しない |
| 403 | 77201 | 権限なし |
| 403 | 77202 | Email商品の利用申込をしていない |
| 405 | 77001 | METHOD_NOT_ALLOWED |
| 415 | 77002 | UNSUPPORTED_MEDIA_TYPE |
| 500 | 77301 | 基本プロジェクトが存在しない |
| 500 | 77302 | 外部システムAPIの連動エラー |
| 500 | 77303 | その他のINTERNAL_SERVER_ERROR |
この記事は役に立ちましたか?