getMailList
- 印刷する
- PDF
getMailList
- 印刷する
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
送信リクエストした特定のリクエスト IDによって作成されたメールリストを照会します。
GET https://{endpoint}/mails/requests/{requestId}/mails
リクエスト
リクエストパラメータ
パラメータ名 | 要否 | タイプ | 制約事項 | 説明 |
---|---|---|---|---|
requestId | Yes | String | Url pathに含まれる | Email送信リクエスト ID(各リクエストを区分する ID、一度に複数件のメール送信をリクエストする場合、requestIdが複数の mailIdを含むことが可能 |
mailId | No | String | Email ID(各メールを1件ずつ区分する ID) | |
recipientAddress | No | String | メールアドレスのフォーマット | 受信者のメールアドレス |
title | No | String | like検索サポート | メールの件名 |
sendStatus | No | List<String> | R: 送信準備、I: 送信中、S: 送信成功、F: 送信失敗、U: 受信拒否、C: 送信キャンセル、PF: 一部失敗 | Emailの送信状態 |
size | No | Integer | Default:10 | ページごとのレコード数 |
page | No | Integer | Default:0 | 結果の受け取りを希望するページの index (0..N) |
sort | No | String | id: mailId、 createUtc: 作成日時、 statusCode: 送信状態 | ソート基準フィールド(形式: property(,asc|desc)): 基本のソート方向は昇順(asc)であり、複数のフィールドをソート基準として使用可能 |
レスポンス
HTTPステータスコード | 説明 |
---|---|
200 | 成功 |
400 | 認証失敗、不正なリクエスト |
500 | サーバエラー |
例
リクエスト例
GET https://mail.apigw.ntruss.com/api/v1/mails/requests/20181120000000010999/mails?size=5&sendStatus=S&sendStatus=PF&page=0
レスポンス例
{
"content": [
{
"requestId": "20181120000000010999",
"requestDate": {
"utc": 1542694793101,
"formattedDate": "2018-11-20",
"formattedDateTime": "2018-11-20 15:19:53 101"
},
"mailId": "20181120000000011009",
"title": "test!",
"templateSid": 41,
"templateName": "test2",
"emailStatus": {
"label": "一部失敗",
"code": "PF"
},
"senderAddress": "a@ac.om",
"senderName": "testUser",
"sendDate": {
"utc": 1542694793856,
"formattedDate": "2018-11-20",
"formattedDateTime": "2018-11-20 15:19:53 856"
},
"representativeRecipient": "test0@ncp-mail.com(30)",
"reservationStatus": {
"label": "即時発送",
"code": "N"
},
"advertising": false
},
{
"requestId": "20181120000000010999",
"requestDate": {
"utc": 1542694793101,
"formattedDate": "2018-11-20",
"formattedDateTime": "2018-11-20 15:19:53 101"
},
"mailId": "20181120000000011109",
"title": "test!",
"templateSid": 41,
"templateName": "test2",
"emailStatus": {
"label": "発送成功",
"code": "S"
},
"senderAddress": "a@ac.om",
"senderName": "testUser",
"sendDate": {
"utc": 1542694793655,
"formattedDate": "2018-11-20",
"formattedDateTime": "2018-11-20 15:19:53 655"
},
"representativeRecipient": "test36@ncp-mail.com(12)",
"reservationStatus": {
"label": "即時発送",
"code": "N"
},
"advertising": false
}
],
"last": true,
"totalElements": 2,
"totalPages": 1,
"first": true,
"numberOfElements": 2,
"sort": [
{
"direction": "DESC",
"property": "createUtc",
"ignoreCase": false,
"nullHandling": "NATIVE",
"ascending": false,
"descending": true
}
],
"size": 5,
"number": 0
}
属性
項目 | 要否 | タイプ | 制約事項 | 説明 |
---|---|---|---|---|
totalElements | Yes | Integer | 総レコード数 | |
totalPages | Yes | Integer | 総ページ数 | |
numberOfElements | Yes | Integer | 現在ページのレコード数 | |
first | Yes | Boolean | 最初のページ有無 | |
last | Yes | Boolean | 最後のページ有無 | |
number | Yes | Integer | 現在ページの index(0始まり) | |
size | Yes | Integer | ページごとのレコード数 | |
sort | Yes | List<Sort> | ソート | |
content | No | List<MailListResponse> | 詳細 |
エラーコード
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 |
この記事は役に立ちましたか?