getMailList

Classic/VPC環境で利用できます。

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

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド	URI
GET	/mails/requests/{requestId}/mails

リクエストヘッダ

Cloud Outbound Mailer APIで共通して使用されるヘッダの詳細は、Cloud Outbound Mailerのリクエストヘッダをご参照ください。

リクエストパスパラメータ

リクエストパスパラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`requestId`	String	Required	リクエスト識別のためのメール送信リクエスト ID 一度に複数件のメール送信をリクエストする場合、`requestId`は複数の`mailId`を含むことができる

リクエストクエリパラメータ

リクエストクエリパラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`mailId`	String	Optional	メール識別用の固有 ID
`recipientAddress`	String	Optional	受信者メールアドレス
`title`	String	Optional	メールの件名 like検索をサポート
`sendStatus`	List[String]	Optional	メールの送信状態 `R` \| `I` \| `S` \| `F` \| `U` \| `C` \| `PF` `R`: 送信準備 `I`: 送信中 `S`: 送信成功 `F`: 送信失敗 `U`: 受信拒否 `C`: 送信取り消し `PF`: 一部失敗
`size`	Integer	Optional	ページごとのレコード数 10 (デフォルト)
`page`	Integer	Optional	照会対象のページインデックス 0以上
`sort`	String	Optional	ソート基準 `id` \| `createUtc` \| `statusCode` `id`: メール ID `createUtc`: 作成日時 `statusCode`: 送信状態 property(,asc\|desc)形式 `asc` (デフォルト) 複数のソート基準を設定可能

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request GET 'https://mail.apigw.ntruss.com/api/v1/mails/requests/20181120000000010999/mails?size=5&sendStatus=S&sendStatus=PF&page=0' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`content`	List	-	メール送信リクエストの詳細 MailListResponseを参照
`last`	Boolean	-	最後のページであるか否か
`totalElements`	Integer	-	総レコード数
`totalPages`	Integer	-	総ページ数
`first`	Boolean	-	最初のページなのか否か
`numberOfElements`	Integer	-	現在ページのレコード数
`sort`	List	-	ソート基準 Sortを参照
`size`	Integer	-	ページごとのレコード数
`number`	Integer	-	現在ページのインデックス 0以上

レスポンスステータスコード

Cloud Outbound Mailer APIで共通して使用されるヘッダの詳細は、Cloud Outbound Mailerのリクエストヘッダをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
  "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
}