getMailList
    • PDF

    getMailList

    • PDF

    Article Summary

    送信リクエストした特定のリクエスト IDによって作成されたメールリストを照会します。

    GET https://{endpoint}/mails/requests/{requestId}/mails
    

    リクエスト

    リクエストパラメータ

    パラメータ名要否タイプ制約事項説明
    requestIdYesStringUrl pathに含まれるEmail送信リクエスト ID(各リクエストを区分する ID、一度に複数件のメール送信をリクエストする場合、requestIdが複数の mailIdを含むことが可能
    mailIdNoStringEmail ID(各メールを1件ずつ区分する ID)
    recipientAddressNoStringメールアドレスのフォーマット受信者のメールアドレス
    titleNoStringlike検索サポートメールの件名
    sendStatusNoList<String>R: 送信準備、I: 送信中、S: 送信成功、F: 送信失敗、U: 受信拒否、C: 送信キャンセル、PF: 一部失敗Emailの送信状態
    sizeNoIntegerDefault:10ページごとのレコード数
    pageNoIntegerDefault:0結果の受け取りを希望するページの index (0..N)
    sortNoStringid: 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
    }
    

    属性

    項目要否タイプ制約事項説明
    totalElementsYesInteger総レコード数
    totalPagesYesInteger総ページ数
    numberOfElementsYesInteger現在ページのレコード数
    firstYesBoolean最初のページ有無
    lastYesBoolean最後のページ有無
    numberYesInteger現在ページの index(0始まり)
    sizeYesIntegerページごとのレコード数
    sortYesList<Sort>ソート
    contentNoList<MailListResponse>詳細

    エラーコード

    HTTP Status Codeリターンコードレスポンスメッセージ
    40077101ログイン情報エラー
    40077102BAD_REQUEST
    40077103リソースが存在しない
    40377201権限なし
    40377202Email商品の使用申請をしない
    40577001METHOD_NOT_ALLOWED
    41577002UNSUPPORTED_MEDIA_TYPE
    50077301基本プロジェクトが存在しない
    50077302外部システム APIの連携エラー
    50077303その他の INTERNAL_SERVER_ERROR

    この記事は役に立ちましたか?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.