getMailRequestStatus

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

送信リクエスト IDを使用して、特定のメールの送信リクエストがどのように処理されたか確認します。

リクエスト

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

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

リクエストヘッダ

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

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

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

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

リクエスト例

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

curl --location --request GET 'https://mail.apigw.ntruss.com/api/v1/mails/requests/20181126000000246001/status' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`requestId`	String	-	リクエスト識別のためのメール送信リクエスト ID 一度に複数件のメール送信をリクエストする場合、`requestId`は複数の`mailId`を含むことができる
`readyCompleted`	Boolean	-	リクエスト件数がすべて DBに入力され、送信準備が完了したかどうか `true` \| `false` `true`: 送信準備完了(送信完了も含む) `false`: 送信準備が完了していない
`allSentSuccess`	Boolean	-	リクエストされたすべてのメールが送信成功したかどうか `true` \| `false` `true`: 成功 `false`: 失敗
`requestCount`	Integer	-	送信リクエスト数
`sentCount`	Integer	-	送信成功した件数
`finishCount`	Integer	-	処理された件数送信成功、失敗、受信拒否、取り消しを含む
`readyCount`	Integer	-	準備完了したか、発送された件数メール送信のために DBに入力された件数
`reservationDate`	Object	-	予約日時 NesDateTimeを参照
`countsByStatus`	List	-	状態別メール件数 CountByStatusを参照

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

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

レスポンス例

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

{
  "requestId":"20181126000000246001",
  "readyCompleted":true,
  "allSentSuccess":false,
  "requestCount":35179,
  "sentCount":33502,
  "finishCount":35179,
  "readyCount":35179,
  "reservationDate":null,
  "countsByStatus":[
    {
      "status":{
        "label":"Failed to send",
        "code":"F"
      },
      "count":1415
    },
    {
      "status":{
        "label":"Sent successfully",
        "code":"S"
      },
      "count":33502
    },
    {
      "status":{
        "label":"Unsubscribe",
        "code":"U"
      },
      "count":262
    }
  ]
}