Login
      目次 x
      PUSH API
        • 印刷する
        • PDF
        目次

        PUSH API

          • 印刷する
          • PDF
          Article Summary

          基本情報

          API URL

          https://sens.apigw.ntruss.com/push/v2

          SENS Push API Swaggerに移動する

          API Header

          項目Mandatory説明
          Content-TypeMandatoryリクエスト Body Content Typeを application/jsonに指定(POST)
          x-ncp-apigw-timestampMandatory1970年1月1日 00:00:00 協定世界時(UTC)からの経過時間をミリ秒(Millisecond)で表したもの。
          API Gatewayサーバとの時間差が5分以上の場合は無効なリクエストとみなす
          x-ncp-iam-access-keyMandatoryポータルまたは Sub Accountが発行した Access Key ID
          x-ncp-apigw-signature-v2Mandatory上記ユースケースの Bodyを Access Key Idとマッピングする SecretKeyで暗号化した署名
          HMAC暗号化アルゴリズムは HmacSHA256を使用

          NAVERクラウドプラットフォームの認証キーおよび Signature作成ガイドに移動する

          参考

          FCM(GCM)タイプは、2024年6月20日にサービス提供が終了します。FCMv1に移行するには、FCMv1移行ガイドをご参照ください。

          デバイス

          デバイストークンの登録

          デバイストークンを登録し、ユーザーにバインドします。

          リクエスト URL

          POST https://sens.apigw.ntruss.com/push/v2/services/{serviceId}/users

Content-Type: application/json; charset=utf-8
x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

          Path Variables

          項目MandatoryType説明備考
          serviceIdMandatoryStringサービス IDプロジェクト登録時に発行されたサービス ID

          Headers

          API Headerに移動する

          リクエスト Body

          {
    "userId":"string",
    "country":"string",
    "language":"string",
    "timezone":"integer",
    "channelName":"string",
    "deviceType":"(GCM|FCMv1|APNS)",
    "deviceToken":"string",
    "isNotificationAgreement":"boolean",
    "isAdAgreement":"boolean",
    "isNightAdAgreement":"boolean"
}
          項目MandatoryType説明備考
          userIdMandatoryStringユーザー ID- ユーザーを識別する ID
          - 最大128文字
          countryOptionalString国コード- デバイスの国設定(デフォルト: KR)
          - ISO-3166-1 alpha-2
          - 英大文字のみ使用可能
          languageOptionalString言語コード- デバイスの言語設定(デフォルト: ko)
          - ISO-639-1
          - 英小文字のみ使用可能
          timezoneOptionalIntegerタイムゾーン- Number of seconds away from UTC(デフォルト: 32400)
          - Example: 28800 (UTC+8)
          channelNameOptionalString登録するチャンネル名登録されたチャンネル名を入力するとチャンネルに追加
          deviceTypeMandatoryStringデバイスのタイプ- FCMv1: Android
          - APNS: iOS
          - GCM: Android (deprecated 2024.6.19.)
          deviceTokenMandatoryStringデバイストークン
          isNotificationAgreementMandatoryBooleanプッシュ通知の受信有無falseはすべてのプッシュを非受信
          isAdAgreementMandatoryBooleanプッシュ型広告の受信有無falseはプッシュ型広告を非受信
          (messageType: AD)
          isNightAdAgreementMandatoryBoolean夜間のプッシュ型広告の受信有無falseは夜間プッシュ型広告を非受信
          (messageType: AD)
          (夜間 - 午後9時～翌日午前8時)

          レスポンス Body

          なし

          レスポンス Status

          HTTP StatusDesc
          201Created(登録完了)
          400Bad Request
          401Unauthorized
          403Forbidden
          404Not Found
          500Internal Server Error

          デバイストークンの照会

          登録されたデバイス/ユーザーを照会します。

          リクエスト URL

          GET https://sens.apigw.ntruss.com/push/v2/services/{serviceId}/users/{userId}

x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

          Path Variables

          項目MandatoryType説明備考
          serviceIdMandatoryStringサービス IDプロジェクト登録時に発行されたサービス ID
          userIdMandatoryStringユーザー IDデバイストークン登録時にバインドしたユーザー ID

          Headers

          API Headerに移動する

          リクエスト Body

          なし

          レスポンス Body

          {
    "userId":"string",
    "country":"string",
    "language":"string",
    "timezone":"integer",
    "channelName":"string",
    "notificationAgreement":"boolean",
    "adAgreement":"boolean",
    "nightAdAgreement":"boolean",
    "notificationAgreementTime":"datetime",
    "adAgreementTime":"datetime",
    "nightAdAgreementTime":"datetime",
    "createTime":"datetime",
    "updateTime":"datetime",
    "devices":[
        {
            "deviceType":"(GCM|FCMv1|APNS)",
            "deviceToken":"string"
        }
    ]
}
          項目MandatoryType説明備考
          userIdMandatoryStringユーザー ID
          countryMandatoryString国コード- デバイスの国設定(デフォルト: KR)
          - ISO-3166-1 alpha-2
          - 英大文字のみ使用可能
          languageMandatoryString言語コード- デバイスの言語設定(デフォルト: ko)
          - ISO-639-1
          - 英小文字のみ使用可能
          - 例外的に zh-Hant/zh-Hans使用可能(大文字小文字区分)
          timezoneMandatoryIntegerタイムゾーン- Number of seconds away from UTC(デフォルト: 32400)
          - Example: 28800 (UTC+8)
          channelNameOptionalString登録されたチャンネル名
          notificationAgreementMandatoryBooleanプッシュ通知の受信有無falseはすべてのプッシュを非受信
          adAgreementMandatoryBooleanプッシュ型広告の受信有無falseはプッシュ型広告を非受信
          (messageType: AD)
          nightAdAgreementMandatoryBoolean夜間のプッシュ型広告の受信有無falseは夜間プッシュ型広告を非受信
          (messageType: AD)
          (夜間 - 午後9時～翌日午前8時)
          notificationAgreementTimeMandatoryDateTimeプッシュ通知メッセージの受信に同意した日時直近に受信同意した日時
          adAgreementTimeMandatoryDateTimeプッシュ型広告の受信に同意した日時直近に受信同意した日時
          nightAdAgreementTimeMandatoryDateTime夜間のプッシュ型広告の受信に同意した日時直近に受信同意した日時
          createTimeMandatoryDateTimeトークンを登録した日時
          updateTimeMandatoryDateTimeトークンを変更した日時
          devices.deviceTypeMandatoryStringデバイスのタイプ- FCMv1: Android
          - APNS: iOS
          - GCM: Android (deprecated 2024.6.19.)
          devices.deviceTokenMandatoryStringデバイストークン

          レスポンス Status

          HTTP StatusDesc
          200OK(照会完了)
          400Bad Request
          401Unauthorized
          403Forbidden
          404Not Found
          500Internal Server Error

          デバイストークンの削除

          ユーザー(userId)にバインドされたデバイスをすべて削除します。ユーザーも一緒に削除されます。

          リクエスト URL

          DELETE https://sens.apigw.ntruss.com/push/v2/services/{serviceId}/users/{userId}

x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

          Path Variables

          項目MandatoryType説明備考
          serviceIdMandatoryStringサービス IDプロジェクト登録時に発行されたサービス ID
          userIdMandatoryStringユーザー IDデバイストークン登録時にバインドしたユーザー ID

          Headers

          API Headerに移動する

          リクエスト Body

          なし

          レスポンス Body

          なし

          レスポンス Status

          HTTP StatusDesc
          204No Content(削除完了)
          400Bad Request
          401Unauthorized
          403Forbidden
          404Not Found
          500Internal Server Error

          チャンネル

          チャンネルの作成

          チャンネルを作成します。

          リクエスト URL

          POST https://sens.apigw.ntruss.com/push/v2/services/{serviceId}/channels

Content-Type: application/json; charset=utf-8
x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

          Path Variables

          項目MandatoryType説明備考
          serviceIdMandatoryStringサービス IDプロジェクト登録時に発行されたサービス ID
          channelNameMandatoryStringチャンネル名作成するチャンネル名

          Headers

          API Headerに移動する

          リクエスト Body

          {
    "channelName":"string",
    "channelDesc":"string"
}
          項目MandatoryType説明備考
          channelNameMandatoryStringチャンネル名作成するチャンネル名
          channelDescOptionalStringチャンネルの説明作成するチャンネルの説明

          レスポンス Body

          なし

          レスポンス Status

          HTTP StatusDesc
          201Created(追加完了)
          400Bad Request
          401Unauthorized
          403Forbidden
          404Not Found
          409Conflict (チャンネル名重複)
          500Internal Server Error

          チャンネルの変更

          チャンネルを変更します。

          リクエスト URL

          PUT https://sens.apigw.ntruss.com/push/v2/services/{serviceId}/channels

Content-Type: application/json; charset=utf-8
x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

          Path Variables

          項目MandatoryType説明備考
          serviceIdMandatoryStringサービス IDプロジェクト登録時に発行されたサービス ID

          Headers

          API Headerに移動する

          リクエスト Body

          [
    {
        "channelName":"string",
        "channelDesc":"string"
    }
]
          項目MandatoryType説明備考
          channelNameMandatoryStringチャンネル名- 1回のリクエストで1000件までリクエスト可能(List)
          - チャンネル名に該当する説明がアップデート
          - 変更するチャンネル名
          channelDescOptionalStringチャンネルの説明変更したチャンネルの説明

          レスポンス Body

          [
    {
        "channelName": "string",
        "channelDesc": "string",
        "createTime": "localDateTime",
        "updateTime": "localDateTime"
    }
]
          項目MandatoryType説明備考
          channelNameMandatoryStringチャンネル名作成するチャンネル名
          channelDescOptionalStringチャンネルの説明変更したチャンネルの説明
          createTimeMandatoryString作成時間format: LocalDateTime
          updateTimeOptionalString変更時間format: LocalDateTime

          レスポンス Status

          HTTP StatusDesc
          200OK
          400Bad Request
          401Unauthorized
          403Forbidden
          404Not Found
          429Too Many Request
          500Internal Server Error

          チャンネル照会

          チャンネルを照会します。

          リクエスト URL

          GET https://sens.apigw.ntruss.com/push/v2/services/{serviceId}/channels

Content-Type: application/json; charset=utf-8
x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

          Path Variables

          項目MandatoryType説明備考
          serviceIdMandatoryStringサービス IDプロジェクト登録時に発行されたサービス ID

          Parameters

          項目MandatoryType説明備考
          channelNameOptionalStringチャンネル名- like照会結果を返す
          - 作成したチャンネル名
          pageSizeOptionalIntegerページサイズ- default: 100
          - 0～100までの数字のみ入力可能
          pageIndexOptionalIntegerページインデックスdefault: 0

          Headers

          API Headerに移動する

          リクエスト Body

          なし

          レスポンス Body

          [
    {
        "channelName": "string",
        "channelDesc": "string",
        "createTime": "localDateTime",
        "updateTime": "localDateTime"
    }
]
          項目MandatoryType説明備考
          channelNameMandatoryStringチャンネル名作成したチャンネル名
          channelDescOptionalStringチャンネルの説明作成したチャンネルの説明
          createTimeMandatoryString作成時間format: LocalDateTime
          updateTimeOptionalString変更時間format: LocalDateTime

          レスポンス Status

          HTTP StatusDesc
          200OK
          400Bad Request
          401Unauthorized
          403Forbidden
          404Not Found
          429Too Many Request
          500Internal Server Error

          チャンネルの削除

          チャンネルを削除します。

          リクエスト URL

          DELETE https://sens.apigw.ntruss.com/push/v2/services/{serviceId}/channels

Content-Type: application/json; charset=utf-8
x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

          Path Variables

          項目MandatoryType説明備考
          serviceIdMandatoryStringサービス IDプロジェクト登録時に発行されたサービス ID

          Headers

          API Headerに移動する

          リクエスト Body

          [
    {
        "channelName":"string"
    }
]
          項目MandatoryType説明備考
          channelNameMandatoryStringチャンネル名- 1回のリクエストで1000件までリクエスト可能(List)
          - 削除するチャンネル名

          レスポンス Body

          なし

          レスポンス Status

          HTTP StatusDesc
          204No Content
          400Bad Request
          401Unauthorized
          403Forbidden
          404Not Found
          429Too Many Request
          500Internal Server Error

          チャンネルにユーザーを追加

          チャンネルにユーザーを追加します。

          リクエスト URL

          POST https://sens.apigw.ntruss.com/push/v2/services/{serviceId}/channels/{channelName}/users/{userId}

x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

          Path Variables

          項目MandatoryType説明備考
          serviceIdMandatoryStringサービス IDプロジェクト登録時に発行されたサービス ID
          channelNameMandatoryStringチャンネル名ユーザーを追加するチャンネル名
          userIdMandatoryStringユーザー IDデバイストークン登録時にバインドしたユーザー ID

          Headers

          API Headerに移動する

          リクエスト Body

          なし

          レスポンス Body

          なし

          レスポンス Status

          HTTP StatusDesc
          201Created(追加完了)
          400Bad Request
          401Unauthorized
          403Forbidden
          404Not Found
          500Internal Server Error

          チャンネルからユーザーを削除

          チャンネルからユーザーを削除します。

          リクエスト URL

          DELETE https://sens.apigw.ntruss.com/push/v2/services/{serviceId}/channels/{channelName}/users/{userId}

x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

          Path Variables

          項目MandatoryType説明備考
          serviceIdMandatoryStringサービス IDプロジェクト登録時に発行されたサービス ID
          channelNameMandatoryStringチャンネル名ユーザーを削除するチャンネル名
          userIdMandatoryStringユーザー IDデバイストークン登録時にバインドしたユーザー ID

          Headers

          API Headerに移動する

          リクエスト Body

          なし

          レスポンス Body

          なし

          レスポンス Status

          HTTP StatusDesc
          204No Content(削除完了)
          400Bad Request
          401Unauthorized
          403Forbidden
          404Not Found
          500Internal Server Error

          メッセージ

          メッセージ送信

          メッセージを送信します。

          リクエスト URL

          POST https://sens.apigw.ntruss.com/push/v2/services/{serviceId}/messages

Content-Type: application/json; charset=utf-8
x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

          Path Variables

          項目MandatoryType説明備考
          serviceIdMandatoryStringサービス IDプロジェクト登録時に発行されたサービス ID

          Headers

          API Headerに移動する

          リクエスト Body

          {
  "messageType": "(AD | NOTIF)",
  "target": {
    "type": "(ALL | CHANNEL | USER)",
    "deviceType": "(GCM | FCMv1 | APNS)",
    "to": [
      "string",
      "string"
    ],
    "country": [
      "string",
      "string"
    ]
  },
  "message": {
    "default": {
      "content": "string",
      "custom": {
        "customKey1": "customValue1",
        "customKey2": "customValue2"
      },
      "option": {},
      "i18n": {
        "default": {
          "content": "string",
          "custom": {
            "customKey1": "customValue1",
            "customKey2": "customValue2"
          }
        },
        "[language]": {
          "content": "string",
          "custom": {
            "customKey1": "customValue1",
            "customKey2": "customValue2"
          }
        }
      }
    },
    "gcm": {
      "content": "string",
      "custom": {
        "customKey1": "customValue1",
        "customKey2": "customValue2"
      },
      "option": {},
      "i18n": {
        "default": {
          "content": "string",
          "custom": {
            "customKey1": "customValue1",
            "customKey2": "customValue2"
          }
        },
        "[language]": {
          "content": "string",
          "custom": {
            "customKey1": "customValue1",
            "customKey2": "customValue2"
          }
        }
      }
    },
    "fcmv1": {
      "content": "string",
      "custom": {
        "customKey1": "customValue1",
        "customKey2": "customValue2"
      },
      "option": {},
      "i18n": {
        "default": {
          "content": "string",
          "custom": {
            "customKey1": "customValue1",
            "customKey2": "customValue2"
          }
        },
        "[language]": {
          "content": "string",
          "custom": {
            "customKey1": "customValue1",
            "customKey2": "customValue2"
          }
        }
      }
    },
    "apns": {
      "content": "string",
      "custom": {
        "customKey1": "customValue1",
        "customKey2": "customValue2"
      },
      "option": {},
      "i18n": {
        "default": {
          "content": "string",
          "custom": {
            "customKey1": "customValue1",
            "customKey2": "customValue2"
          }
        },
        "[language]": {
          "content": "string",
          "custom": {
            "customKey1": "customValue1",
            "customKey2": "customValue2"
          }
        }
      }
    }
  },
  "reserveTime": "yyyy-MM-dd HH:mm",
  "reserveTimeZone": "string",
  "scheduleCode": "string"
}
          項目MandatoryType説明備考
          messageTypeOptionalStringメッセージタイプ- NOTIF: 通知メッセージ
          - AD: プッシュ型広告
          - (default: NOTIF)
          target.typeMandatoryString受信対象のタイプ- ALL: サービスに登録されたすべてのデバイス
          - CHANNEL: チャンネルに登録されたすべてのデバイス
          - USER: ユーザーにバインドされたすべてのデバイス
          target.deviceTypeOptionalString受信対象のデバイスタイプ- FCMv1: Android
          - APNS: iOS
          - GCM: Android (deprecated 2024.6.19.)
          - nullの場合すべてのデバイス
          target.toOptionalArray of String受信対象の識別子- ALL: 入力の必要なし
          - CHANNEL: チャンネル名
          - USER: ユーザー ID
          - 最大100個
          target.countryOptionalArray of String受信対象の国コード- 受信対象デバイスの国コード
          - ISO-3166-1 alpha-2
          - 大文字のみ使用可能
          messageMandatoryObject共通送信メッセージメッセージ規格は以下の共通メッセージ規格を参照
          message.i18nOptionalObjectデバイス言語別の多言語メッセージ処理のためのオブジェクトメッセージ規格は以下の多言語メッセージ規格を参照
          reserveTimeOptionalString予約日時メッセージの送信予約日時(yyyy-MM-dd HH:mm)
          reserveTimeZoneOptionalString予約日時のタイムゾーン- 予約日時のタイムゾーン(デフォルト: Asia/Seoul)
          - 対応タイムゾーンリスト
          - TZ database name値を使用
          scheduleCodeOptionalStringスケジュールコード登録するスケジュールコード
          参考
          • Androidデバイスのメッセージ送信時に GCM/FCMの両方をサポートし、NAVERクラウドプラットフォーム SENSでは Typeを GCMとして使用します。
          • target.deviceTypeを GCMまたは FCMv1に指定すると、すべての Androidデバイスにメッセージが送信されるのではなく、その Typeで登録されたデバイストークンを持つ Userにのみメッセージが送信されます。
          • 同じデバイスのトークンが GCM、FCMv1の両方に登録されている場合、target.deviceType: ALLまたは指定せずにメッセージを送信すると、重複して受信されることがあります。

          共通メッセージ

          • メッセージ送信 requestBodyの message項目が、共通メッセージのための規格である。
          • message.default.XXX、message.gcm.XXX、message.fcmv1.XXX、message.apns.XXXで区分でき、message.defaultは必ず作成してください。
          • defaultのみ作成すると、すべての Push Typeに同じメッセージが送信され、gcm、fcmv1、apnsを作成すると、各 Push Type別にメッセージを分離できます。
          • 適用優先順位: gcm = fcmv1 = apns > default
          • messageに以下の表の通りメッセージを作成すると、各 Push Typeに合わせてメッセージが作成されて送信されます。
          messageのサブ項目MandatoryTypeGCM/FCMv1APNS
          contentOptionalStringdata.contentalert or alert.body
          customOptionalObjectdata.KEYに指定
          * FCMv1: customKey:customValue形式 = string:string          		apsと同レベルの KEYに指定
          optionOptionalObject以下の Push Type別の使用可能な optionを参照
          i18nOptionalObject
          参考

          メッセージの送信時に message.fcmv1を別途構成しないと、message.gcm > message.defaultの優先順位でメッセージを使用することになるので、FCMv1で変更された部分によってメッセージ送信に影響を与えることがあります。

          多言語メッセージ

          • デバイスに設定された languageに応じて、多言語メッセージを処理するための規格です。
          • message.default.XXX、message.[language].XXXで区分でき、languageは ISO-639-1標準に従って小文字のみ使用できます。ただし、例外的に中国語簡体/繁体に対応するため、zh-Hant、zh-Hansは使用できます。
            • ISO-639-1
            • 小文字のみ使用可能
            • zh-Hant/zh-Hans使用可能(大文字小文字区分)
          • languageは、デバイス登録時に設定された言語コード基準です。
          • 適用優先順位は、message.content、message.customより高いです。
          i18nのサブ項目MandatoryTypeGCM/FCMv1APNS
          contentMandatoryStringdata.contentalert or alert.body
          customOptionalObjectdata.KEYに指定
          * FCMv1: customKey:customValue形式 = string:string          		apsと同レベルの KEYに指定

          Push Type別の使用可能な option

          参考

          FCMv1タイプでは、メッセージ情報ガイドが以下のように変更されます。

          • delay while idleオプションを削除
          • time to liveオプション名を ttlに変更

          レスポンス Body

          {
    "requestId":"string",
    "requestTime":"string",
    "statusCode":"string",
    "statusName":"string"
}
          項目MandatoryType説明備考
          requestIdMandatoryStringリクエスト ID
          requestTimeMandatoryDateTimeリクエスト時間
          statusCodeMandatoryStringリクエスト状態コード以下の Response Codeを参照
          statusNameMandatoryStringリクエスト状態名- success: 成功
          - reserved: 予約中
          - scheduled: スケジュール中
          - fail: 失敗

          レスポンス Status

          HTTP StatusDesc
          202Accepted(送信リクエスト完了)
          400Bad Request
          401Unauthorized
          403Forbidden
          404Not Found
          500Internal Server Error

          メッセージ送信結果の照会

          メッセージの送信結果を照会します。

          リクエスト URL

          GET https://sens.apigw.ntruss.com/push/v2/services/{serviceId}/messages/{requestId}

x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

          Path Variables

          項目MandatoryType説明備考
          serviceIdMandatoryStringサービス IDプロジェクト登録時に発行されたサービス ID
          requestIdMandatoryStringメッセージ送信リクエスト IDメッセージ送信時に返されるリクエスト識別子

          Headers

          API Headerに移動する

          リクエスト Body

          なし

          レスポンス Body

          {
    "requestId":"string",
    "requestTime":"string",
    "statusCode":"string",
    "statusName":"string",
    "messageStatusCode":"string",
    "messageStatusName":"string",
    "completeTime":"string",
    "targetCount":"integer",
    "sentCount":"integer",
    "messageType":"string",
    "target":{
        ...
    },
    "message":{
        ...
    }
}
          項目MandatoryType説明備考
          requestIdMandatoryStringリクエスト ID
          requestTimeMandatoryDateTimeリクエスト時間
          statusCodeMandatoryStringリクエスト状態コード- 202: 成功
          - その他: 失敗
          statusNameMandatoryStringリクエスト状態名- success: 成功
          - fail: 失敗
          messageStatusCodeMandatoryString送信状態コード- 200: 成功
          - その他: 失敗
          messageStatusNameMandatoryString送信状態名- success: 成功
          - processing: 処理中
          - fail: 失敗
          completeTimeMandatoryDateTime送信完了時間
          targetCountMandatoryIntegerリクエスト対象デバイスの数
          sentCountMandatoryInteger送信成功デバイスの数
          messageTypeMandatoryStringメッセージタイプ- NOTIF: 通知メッセージ
          - AD: プッシュ型広告
          targetMandatoryObjectリクエスト target情報
          messageMandatoryObjectリクエスト message情報

          レスポンス Status

          HTTP StatusDesc
          200OK(照会完了)
          400Bad Request
          401Unauthorized
          403Forbidden
          404Not Found
          500Internal Server Error

          予約メッセージ

          予約メッセージ状態の照会

          メッセージの送信予約状態を照会します。

          GET https://sens.apigw.ntruss.com/push/v2/services/{serviceId}/reservations/{reserveId}/reserve-status

x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

          Path Variables

          項目MandatoryType説明備考
          serviceIdMandatoryStringサービス IDプロジェクト登録時に発行されたサービス ID
          reserveIdMandatoryString予約メッセージ ID予約送信リクエスト照会時に返されるメッセージ識別子(requestId)

          Headers

          API Headerに移動する

          リクエスト Body

          なし

          レスポンス Body

          {
  "reserveId": "string",
  "reserveTimeZone": "string",
  "reserveTime": "string",
  "reserveStatus": "string"
}
          項目MandatoryType説明備考
          reserveIdMandatoryString予約メッセージ ID予約送信リクエスト照会時に返されるメッセージ識別子(requestId)
          reserveTimeMandatoryString予約日時メッセージの送信予約日時(yyyy-MM-dd HH:mm)
          reserveTimeZoneMandatoryString予約日時のタイムゾーン- 予約日時のタイムゾーン(デフォルト: Asia/Seoul)
          - 対応タイムゾーンリスト
          - TZ database name値を使用
          reserveStatusMandatoryString予約状態- READY: 送信待機
          - PROCESSING: 送信リクエスト中
          - CANCELED: 送信キャンセル
          - FAIL: 送信リクエスト失敗
          - DONE: 送信リクエスト成功
          - STALE: 送信リクエスト失敗(時間オーバー)

          レスポンス Status

          HTTP StatusDesc
          200OK(照会完了)
          400Bad Request
          401Unauthorized
          403Forbidden
          404Not Found
          500Internal Server Error

          予約メッセージのキャンセル

          メッセージの送信予約をキャンセルします。

          DELETE https://sens.apigw.ntruss.com/push/v2/services/{serviceId}/reservations/{reserveId}

x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

          Path Variables

          項目MandatoryType説明備考
          serviceIdMandatoryStringサービス IDプロジェクト登録時に発行されたサービス ID
          reserveIdMandatoryString予約メッセージ ID予約送信リクエスト照会時に返されるメッセージ識別子(requestId)

          Headers

          API Headerに移動する

          リクエスト Body

          なし

          レスポンス Body

          なし

          レスポンス Status

          HTTP StatusDesc
          204No Content(削除完了)
          400Bad Request
          401Unauthorized
          403Forbidden
          404Not Found
          500Internal Server Error

          スケジュールメッセージ

          スケジュールメッセージのキャンセル

          メッセージ送信スケジュールをキャンセルします。

          DELETE https://sens.apigw.ntruss.com/push/v2/services/{serviceId}/schedules/{scheduleCode}/messages/{messageId}

x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

          Path Variables

          項目MandatoryType説明備考
          serviceIdMandatoryStringサービス IDプロジェクト登録時に発行されたサービス ID
          scheduleCodeMandatoryStringスケジュールコードスケジュールの登録時に使用したコード
          messageIdMandatoryString予約メッセージ IDスケジュール送信リクエストを照会する時に返されるメッセージ識別子(requestId)

          Headers

          API Headerに移動する

          リクエスト Body

          なし

          レスポンス Body

          なし

          レスポンス Status

          HTTP StatusDesc
          204No Content(削除完了)
          400Bad Request
          401Unauthorized
          403Forbidden
          404Not Found
          500Internal Server Error
          この記事は役に立ちましたか?
          What's Next
          Change password!
          Changing your password will log you out immediately. Use the new password to log back in.
          Change profile
          Success!
          First name must have atleast 2 characters. Numbers and special characters are not allowed.
          Last name must have atleast 1 characters. Numbers and special characters are not allowed.
          Enter a valid email
          Enter a valid password
          Your profile has been successfully updated.
          Logout