getMailRequestList

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

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

リクエスト

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

リクエストヘッダ

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

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

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

リクエスト例

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

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