getMailRequestList

メール送信リクエストした内訳リストを照会します。

リクエスト

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

メソッド	URI
GET	/mails/requests

リクエストヘッダ

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

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

パラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`startUtc`	Long	Conditional	照会するリクエスト内訳の開始日時 1970年1月1日 00:00:00 協定世界時(UTC)からの経過時間を1/1000秒に換算した整数 `startUtc`または`startDateTime`のうち1つは必ず入力 `startDateTime`より優先適用
`startDateTime`	String	Conditional	照会するリクエスト内訳の開始日時(UTC+9:00) 使用可能な形式 yyyy-MM-dd yyyy-MM-dd HH:mm yyyy-MM-dd HH:mm:ss.SSS yyyy-MM-dd HH:mm:ss SSS `startUtc`または`startDateTime`のうち1つは必ず入力 `startUtc`が優先適用
`endUtc`	Long	Conditional	照会するリクエスト内訳の終了日時 1970年1月1日 00:00:00 協定世界時(UTC)からの経過時間を1/1000秒に換算した整数 `endUtc`または`endDateTime`のうち1つは必ず入力 `endDateTime`より優先適用
`endDateTime`	String	Conditional	照会するリクエスト内訳の終了日時(UTC+9:00) 使用可能な形式 yyyy-MM-dd yyyy-MM-dd HH:mm yyyy-MM-dd HH:mm:ss.SSS yyyy-MM-dd HH:mm:ss SSS `endUtc`または`endDateTime`のうち1つは必ず入力 `endUtc`が優先適用
`requestId`	String	Optional	リクエスト識別のためのメール送信リクエスト ID 一度に複数件のメール送信をリクエストする場合、`requestId`は複数の`mailId`を含むことができる
`mailId`	String	Optional	メール識別用の固有 ID
`dispatchType`	String	Optional	メール送信をリクエストする際に使用されたツール `CONSOLE` \| `API`
`title`	String	Optional	メールの件名 like検索をサポート
`templateSid`	Integer	Optional	メール作成に使用されたテンプレートの SID getTemplateStructureを通じて確認
`senderAddress`	String	Optional	送信者のメールアドレス
`recipientAddress`	String	Optional	受信者メールアドレス
`sendStatus`	List[String]	Optional	メールの送信状態 `P` \|`R` \| `I` \| `S` \| `F` \| `U` \| `C` \| `PF` `P`: 送信準備中 `R`: 送信準備 `I`: 送信中 `S`: 送信成功 `F`: 送信失敗 `U`: 受信拒否 `C`: 送信取り消し `PF`: 一部失敗
`size`	Integer	Optional	ページごとのレコード数 10 (デフォルト)
`page`	Integer	Optional	照会対象のページインデックス 0以上
`sort`	String	Optional	ソート基準 `createUtc` \| `recipientCount` \| `reservationUtc` \| `sendUtc` \| `statusCode` `createUtc`: 作成日時 `recipientCount`: 受信者数 `reservationUtc`: 送信予約日時 `sendUtc`: 送信完了日時 `statusCode`: 送信状態 property(,asc\|desc)形式 `asc` (デフォルト) 複数のソート基準を設定可能

リクエスト例

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

curl --location --request GET 'https://mail.apigw.ntruss.com/api/v1/mails/requests?dispatchType=API&startDateTime=2018-11-01%2000:00&size=5&sendStatus=S&page=0&endDateTime=2018-11-20%2023:59' \
--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	-	リクエスト内訳リストの詳細 RequestListResponseを参照
`last`	Boolean	-	最後のページかどうか
`totalElements`	Integer	-	総レコード数
`totalPages`	Integer	-	総ページ数
`first`	Boolean	-	最初のページかどうか
`numberOfElements`	Integer	-	現在ページのレコード数
`size`	Integer	-	ページごとのレコード数
`number`	Integer	-	現在ページのインデックス(0からスタート)
`sort`	List	-	ソート基準 Sortを参照

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

Cloud Outbound Mailer APIで共通して使用されるレスポンスステータスコードの詳細は、Cloud Outbound Mailerのレスポンスステータスコードをご参照ください。

レスポンス例

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

{
  "content":[
    {
      "requestId":"20181120000000000299",
      "requestDate":{
        "utc":1542675575268,
        "formattedDate":"2018-11-20",
        "formattedDateTime":"2018-11-20 09:59:35 268"
      },
      "templateSid":null,
      "templateName":null,
      "emailStatus":{
        "label":"送信成功",
        "code":"S"
      },
      "senderAddress":"no_reply@domain.com",
      "senderName":null,
      "dispatchType":"API",
      "elapsedTime":"00:00:05.230",
      "sendDate":{
        "utc":1542675580498,
        "formattedDate":"2018-11-20",
        "formattedDateTime":"2018-11-20 09:59:40 498"
      },
      "reservationDate":null,
      "requestCount":100,
      "recipientCount":100
    },
    {
      "requestId":"20181113000000000499",
      "requestDate":{
        "utc":1542071645647,
        "formattedDate":"2018-11-13",
        "formattedDateTime":"2018-11-13 10:14:05 647"
      },
      "templateSid":null,
      "templateName":null,
      "emailStatus":{
        "label":"送信成功",
        "code":"S"
      },
      "senderAddress":"a@a.com",
      "senderName":null,
      "dispatchType":"API",
      "elapsedTime":"00:00:00.475",
      "sendDate":{
        "utc":1542071646122,
        "formattedDate":"2018-11-13",
        "formattedDateTime":"2018-11-13 10:14:06 122"
      },
      "reservationDate":null,
      "requestCount":1,
      "recipientCount":1
    },
    {
      "requestId":"20181113000000000299",
      "requestDate":{
        "utc":1542071618910,
        "formattedDate":"2018-11-13",
        "formattedDateTime":"2018-11-13 10:13:38 910"
      },
      "templateSid":null,
      "templateName":null,
      "emailStatus":{
        "label":"送信成功",
        "code":"S"
      },
      "senderAddress":"a@a.com",
      "senderName":null,
      "dispatchType":"API",
      "elapsedTime":"00:00:02.142",
      "sendDate":{
        "utc":1542071621052,
        "formattedDate":"2018-11-13",
        "formattedDateTime":"2018-11-13 10:13:41 052"
      },
      "reservationDate":null,
      "requestCount":1,
      "recipientCount":1
    },
    {
      "requestId":"20181109000063986599",
      "requestDate":{
        "utc":1541752179226,
        "formattedDate":"2018-11-09",
        "formattedDateTime":"2018-11-09 17:29:39 226"
      },
      "templateSid":13,
      "templateName":"test",
      "emailStatus":{
        "label":"送信成功",
        "code":"S"
      },
      "senderAddress":"no_reply@a.com",
      "senderName":"test",
      "dispatchType":"API",
      "elapsedTime":"00:15:02.312",
      "sendDate":{
        "utc":1541753081538,
        "formattedDate":"2018-11-09",
        "formattedDateTime":"2018-11-09 17:44:41 538"
      },
      "reservationDate":null,
      "requestCount":100000,
      "recipientCount":100000
    },
    {
      "requestId":"20181109000063886499",
      "requestDate":{
        "utc":1541752150850,
        "formattedDate":"2018-11-09",
        "formattedDateTime":"2018-11-09 17:29:10 850"
      },
      "templateSid":13,
      "templateName":"test",
      "emailStatus":{
        "label":"送信成功",
        "code":"S"
      },
      "senderAddress":"no_reply@a.com",
      "senderName":"test",
      "dispatchType":"API",
      "elapsedTime":"00:00:17.004",
      "sendDate":{
        "utc":1541752167854,
        "formattedDate":"2018-11-09",
        "formattedDateTime":"2018-11-09 17:29:27 854"
      },
      "reservationDate":null,
      "requestCount":1000,
      "recipientCount":1000
    }
  ],
  "last":false,
  "totalElements":21,
  "totalPages":5,
  "first":true,
  "numberOfElements":5,
  "sort":[
    {
      "direction":"DESC",
      "property":"createUtc",
      "ignoreCase":false,
      "nullHandling":"NATIVE",
      "ascending":false,
      "descending":true
    }
  ],
  "size":5,
  "number":0
}