getMailRequestStatus

Prev Next

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 Required リクエスト識別のためのメール送信リクエスト ID
  • 一度に複数件のメール送信をリクエストする場合、requestIdは複数のmailIdを含むことができる
readyCompleted Boolean Required リクエスト件数がすべて DBに入力され、送信準備が完了したかどうか
  • true | false
    • true: 送信準備完了(送信完了も含む)
    • false: 送信準備が完了していない
allSentSuccess Boolean Required リクエストされたすべてのメールが送信成功したかどうか
  • true | false
    • true: 成功
    • false: 失敗
requestCount Integer Required 送信リクエスト数
sentCount Integer Required 送信成功した件数
finishCount Integer Required 処理された件数
  • 送信成功、失敗、受信拒否、取り消しを含む
readyCount Integer Required 準備完了したか、発送された件数
  • メール送信のために DBに入力された件数
reservationDate NesDateTime Optional 予約日時
countsByStatus List<CountByStatus> Required 状態別メール件数

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

レスポンスステータスコードの説明は次の通りです。

HTTPステータスコード コード 説明
200 - リクエスト成功
400 - 認証失敗、無効なリクエスト
400 77101 ログイン情報エラー
400 77102 リクエストエラー
400 77103 リクエストしたリソースが存在しない
403 77201 リクエストしたリソースに対する権限がない
403 77202 メールサービスの使用を申し込んでいないユーザーが呼び出した場合
405 77001 サポートしないメソッドタイプ
415 77002 サポートしないメディアタイプ
500 - サーバエラー
500 77301 基本プロジェクトが存在しない
500 77302 外部システム API連携エラー
500 77303 その他の内部サーバエラー

レスポンス例

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

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