Login
      Contents x
      PUSH API
        • Print
        • PDF
        Contents

        PUSH API

          • Print
          • PDF
          Article Summary

          Basic information

          API URL

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

          Go to SENS Push API Swagger

          API Header

          ItemMandatoryDescription
          Content-TypeMandatorySpecify the request body content type as application/json (POST)
          x-ncp-apigw-timestampMandatoryThis is the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 (UTC).
          If the time difference compared to the API Gateway server is more than 5 minutes, the request is considered invalid
          x-ncp-iam-access-keyMandatoryAccess Key ID issued by the portal or Sub Account
          x-ncp-apigw-signature-v2MandatorySignature of the body in the above example encrypted with a SecretKey mapped to Access Key ID
          HmacSHA256 is used as the HMAC encryption algorithm

          Go to NAVER Cloud Platform authentication key and signature creation guide

          Note

          The services for FCM (GCM) types will end on June 20, 2024. For more information on how to switch to FCMv1, see FCMv1 Transition Guide.

          Device

          Register device tokens

          This registers a device token and binds it to a user.

          Request 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

          ItemMandatoryTypeDescriptionNote
          serviceIdMandatoryStringService IDService ID issued when registering the project

          Headers

          Go to API Header

          Request Body

          {
    "userId":"string",
    "country":"string",
    "language":"string",
    "timezone":"integer",
    "channelName":"string",
    "deviceType":"(GCM|FCMv1|APNS)",
    "deviceToken":"string",
    "isNotificationAgreement":"boolean",
    "isAdAgreement":"boolean",
    "isNightAdAgreement":"boolean"
}
          ItemMandatoryTypeDescriptionNote
          userIdMandatoryStringUser ID- ID to identify the user
          - Up to 128 characters
          countryOptionalStringCountry code- Device country setting (default: KR)
          - ISO-3166-1 alpha-2
          - English uppercase only
          languageOptionalStringLanguage code- Device language setting (default: ko)
          - ISO-639-1
          - English lowercase only
          timezoneOptionalIntegerTime zone- Number of seconds away from UTC (default: 32400)
          - Example: 28800 (UTC+8)
          channelNameOptionalStringChannel name to be registeredEnter the registered channel name to add to the channel
          deviceTypeMandatoryStringDevice type- FCMv1: Android
          - APNS: iOS
          - GCM: Android (deprecated 2024.6.19.)
          deviceTokenMandatoryStringDevice token
          isNotificationAgreementMandatoryBooleanPush notification message subscription statusWhen false, no message is received
          isAdAgreementMandatoryBooleanAd message subscription statusWhen false, no ad message is received
          (messageType: AD)
          isNightAdAgreementMandatoryBooleanNight ad message subscription statusWhen false, no night ad message is received
          (messageType: AD)
          (Nighttime - 21:00 - 08:00)

          Response bodies

          N/A

          Response status

          HTTP StatusDesc
          201Created (successfully registered)
          400Bad Request
          401Unauthorized
          403Forbidden
          404Not Found
          500Internal Server Error

          View device tokens

          Views the registered device/user.

          Request 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

          ItemMandatoryTypeDescriptionNote
          serviceIdMandatoryStringService IDService ID issued when registering the project
          userIdMandatoryStringUser IDUser ID bound when a device token is registered

          Headers

          Go to API Header

          Request Body

          N/A

          Response bodies

          {
    "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"
        }
    ]
}
          ItemMandatoryTypeDescriptionNote
          userIdMandatoryStringUser ID
          countryMandatoryStringCountry code- Device country setting (default: KR)
          - ISO-3166-1 alpha-2
          - English uppercase only
          languageMandatoryStringLanguage code- Device language setting (default: ko)
          - ISO-639-1
          - English lowercase only
          - zh-Hant / zh-Hans can be used exceptionally (case sensitive)
          timezoneMandatoryIntegerTime zone- Number of seconds away from UTC (default: 32400)
          - Example: 28800 (UTC+8)
          channelNameOptionalStringName of the registered channel
          notificationAgreementMandatoryBooleanPush notification message subscription statusWhen false, no message is received
          adAgreementMandatoryBooleanAd message subscription statusWhen false, no ad message is received
          (messageType: AD)
          nightAdAgreementMandatoryBooleanNight ad message subscription statusWhen false, no night ad message is received
          (messageType: AD)
          (Nighttime - 21:00 - 08:00)
          notificationAgreementTimeMandatoryDateTimeDate and time when the user consented to receive push notification messagesThe most recent date and time when the user consented to receive
          adAgreementTimeMandatoryDateTimeDate and time when the user consented to receive ad messagesThe most recent date and time when the user consented to receive
          nightAdAgreementTimeMandatoryDateTimeDate and time when the user consented to receive night ad messagesThe most recent date and time when the user consented to receive
          createTimeMandatoryDateTimeToken registration time
          updateTimeMandatoryDateTimeToken edit time
          devices.deviceTypeMandatoryStringDevice type- FCMv1: Android
          - APNS: iOS
          - GCM: Android (deprecated 2024.6.19.)
          devices.deviceTokenMandatoryStringDevice token

          Response status

          HTTP StatusDesc
          200OK (successfully searched)
          400Bad Request
          401Unauthorized
          403Forbidden
          404Not Found
          500Internal Server Error

          Delete device tokens

          This deletes all the devices bound to a user (userId). The user is also deleted.

          Request 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

          ItemMandatoryTypeDescriptionNote
          serviceIdMandatoryStringService IDService ID issued when registering the project
          userIdMandatoryStringUser IDUser ID bound when a device token is registered

          Headers

          Go to API Header

          Request Body

          N/A

          Response bodies

          N/A

          Response status

          HTTP StatusDesc
          204No Content (successfully deleted)
          400Bad Request
          401Unauthorized
          403Forbidden
          404Not Found
          500Internal Server Error

          Channel

          Create channel

          It creates a channel.

          Request 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

          ItemMandatoryTypeDescriptionNote
          serviceIdMandatoryStringService IDService ID issued when registering the project
          channelNameMandatoryStringChannel nameName of the channel to be created

          Headers

          Go to API Header

          Request Body

          {
    "channelName":"string",
    "channelDesc":"string"
}
          ItemMandatoryTypeDescriptionNote
          channelNameMandatoryStringChannel nameName of the channel to be created
          channelDescOptionalStringChannel descriptionDescription of the channel to be created

          Response bodies

          N/A

          Response status

          HTTP StatusDesc
          201Created (successfully added)
          400Bad Request
          401Unauthorized
          403Forbidden
          404Not Found
          409Conflict (duplicate channel name)
          500Internal Server Error

          Edit channel

          This edits the channel.

          Request 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

          ItemMandatoryTypeDescriptionNote
          serviceIdMandatoryStringService IDService ID issued when registering the project

          Headers

          Go to API Header

          Request Body

          [
    {
        "channelName":"string",
        "channelDesc":"string"
    }
]
          ItemMandatoryTypeDescriptionNote
          channelNameMandatoryStringChannel name- Up to 1000 requests available at a time (list)
          - The description corresponding to the channel name is updated
          - Name of the channel to be edited
          channelDescOptionalStringChannel descriptionDescription of the edited channel

          Response bodies

          [
    {
        "channelName": "string",
        "channelDesc": "string",
        "createTime": "localDateTime",
        "updateTime": "localDateTime"
    }
]
          ItemMandatoryTypeDescriptionNote
          channelNameMandatoryStringChannel nameName of the channel to be created
          channelDescOptionalStringChannel descriptionDescription of the edited channel
          createTimeMandatoryStringCreated timeformat: LocalDateTime
          updateTimeOptionalStringEdited timeformat: LocalDateTime

          Response status

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

          Search Channel

          This searches channels.

          Request 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

          ItemMandatoryTypeDescriptionNote
          serviceIdMandatoryStringService IDService ID issued when registering the project

          Parameters

          ItemMandatoryTypeDescriptionNote
          channelNameOptionalStringChannel name- Return search results of like
          - Name of the created channel
          pageSizeOptionalIntegerPage size- default: 100
          - Only numbers between 0 and 100 can be entered
          pageIndexOptionalIntegerPage indexdefault: 0

          Headers

          Go to API Header

          Request Body

          N/A

          Response bodies

          [
    {
        "channelName": "string",
        "channelDesc": "string",
        "createTime": "localDateTime",
        "updateTime": "localDateTime"
    }
]
          ItemMandatoryTypeDescriptionNote
          channelNameMandatoryStringChannel nameName of the created channel
          channelDescOptionalStringChannel descriptionDescription of the created channel
          createTimeMandatoryStringCreated timeformat: LocalDateTime
          updateTimeOptionalStringEdited timeformat: LocalDateTime

          Response status

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

          Delete channel

          The channel is deleted.

          Request 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

          ItemMandatoryTypeDescriptionNote
          serviceIdMandatoryStringService IDService ID issued when registering the project

          Headers

          Go to API Header

          Request Body

          [
    {
        "channelName":"string"
    }
]
          ItemMandatoryTypeDescriptionNote
          channelNameMandatoryStringChannel name- Up to 1000 requests available at a time (list)
          - Channel name to be deleted

          Response bodies

          N/A

          Response status

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

          Add a user to the channel

          This adds a user to the channel.

          Request 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

          ItemMandatoryTypeDescriptionNote
          serviceIdMandatoryStringService IDService ID issued when registering the project
          channelNameMandatoryStringChannel nameName of the channel to add a user
          userIdMandatoryStringUser IDUser ID bound when a device token is registered

          Headers

          Go to API Header

          Request Body

          N/A

          Response bodies

          N/A

          Response status

          HTTP StatusDesc
          201Created (successfully added)
          400Bad Request
          401Unauthorized
          403Forbidden
          404Not Found
          500Internal Server Error

          Delete a user from the channel

          This deletes a user from the channel.

          Request 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

          ItemMandatoryTypeDescriptionNote
          serviceIdMandatoryStringService IDService ID issued when registering the project
          channelNameMandatoryStringChannel nameName of the channel to delete a user
          userIdMandatoryStringUser IDUser ID bound when a device token is registered

          Headers

          Go to API Header

          Request Body

          N/A

          Response bodies

          N/A

          Response status

          HTTP StatusDesc
          204No Content (successfully deleted)
          400Bad Request
          401Unauthorized
          403Forbidden
          404Not Found
          500Internal Server Error

          Messages

          Send message

          Sends a message.

          Request 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

          ItemMandatoryTypeDescriptionNote
          serviceIdMandatoryStringService IDService ID issued when registering the project

          Headers

          Go to API Header

          Request 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"
}
          ItemMandatoryTypeDescriptionNote
          messageTypeOptionalStringMessage type- NOTIF: notification message
          - AD: ad message
          - (default: NOTIF)
          target.typeMandatoryStringRecipient type- ALL: all devices registered to the service
          - CHANNEL: all devices registered to the channel
          - USER: all devices bound to the user
          target.deviceTypeOptionalStringRecipient's device type- FCMv1: Android
          - APNS: iOS
          - GCM: Android (deprecated 2024.6.19.)
          - If null, all devices
          target.toOptionalArray of StringRecipient identifier- ALL: no need to input
          - CHANNEL: channel name
          - USER: user ID
          - Up to 100
          target.countryOptionalArray of StringRecipient country code- Country code of receiving target device
          - ISO-3166-1 alpha-2
          - Uppercase letters only
          messageMandatoryObjectCommon message to sendFor the message size, see the following common message specification
          message.i18nOptionalObjectObject for processing multilingual message by device languageFor the message size, see the following multilingual message specifications
          reserveTimeOptionalStringReserved date and timeReserved date and time for message delivery (yyyy-MM-dd HH:mm)
          reserveTimeZoneOptionalStringTime zone of reserved date and time- Time zone of reserved date and time (default: Asia/Seoul)
          - List of supported time zones
          - Use the TZ database name value
          scheduleCodeOptionalStringSchedule codeSchedule code to be registered
          Note
          • Both GCM/FCM are supported for sending Android device messages. NAVER Cloud Platform SENS uses GCM as the Type.
          • If you specifies target.deviceType as GCM or FCMv1, a message will not be sent to all Android device, but only to the user with device tokens registered as the type.
          • If the same device token is registered as both GCM and FCMv1, target.deviceType: ALL, or without specifying it, duplicate messages may be sent.

          Common message

          • The message item of the message delivery requestBody is the specifications for common messages.
          • It can be divided into message.default.XXX, message.gcm.XXX, message.fcmv1.XXX, and message.apns.XXX, and you must fill in message.default as required.
          • If you create a default message only, the same message is sent to all push types; if you create gcm, fcmv1, and apns messages as well, you can separate messages for each push type.
          • Apply priority: gcm = fcmv1 = apns > default
          • If a message is composed in message as the following table the messages for each push type are created and sent.
          Message subsectionMandatoryTypeGCM/FCMv1APNS
          contentOptionalStringdata.contentalert or alert.body
          customOptionalObjectDesignate as the date.KEY
          * FCMv1: customKey:customValue format = string:string          		Designate as the KEY of the same level as aps
          optionOptionalObjectSee the available options for each push type below
          i18nOptionalObject
          Note

          If you don't configure message.fcmv1 separately when sending a message, the message will be used as the following order: message.gcm > message.default. The section changed in FCMv1 can affect sending a message.

          Multilingual message

          • This is a specification for processing multilingual messages according to the language set in the device.
          • It can be separated with message.default.XXX and message.[language].XXX, and `language follows the ISO-639-1 standard and only lowercase letters are available. However, as an exception, zh-Hant and zh-Hans can be used to support Simplified/Traditional Chinese.
            • ISO-639-1
            • Lowercase letters only
            • zh-Hant, zh-Hans can be used (case sensitive)
          • language is based on the language code set during device registration.
          • Applied priority is higher than message.content and message.custom.
          i18n subsectionMandatoryTypeGCM/FCMv1APNS
          contentMandatoryStringdata.contentalert or alert.body
          customOptionalObjectDesignate as the date.KEY
          * FCMv1: customKey:customValue format = string:string          		Designate as the KEY of the same level as aps

          Available options for each push type

          Note

          For FCMv1 types, the message information guide will be changed as follows:

          • Delete delay_while_idle options
          • Change the option name of time_to_live to ttl

          Response bodies

          {
    "requestId":"string",
    "requestTime":"string",
    "statusCode":"string",
    "statusName":"string"
}
          ItemMandatoryTypeDescriptionNote
          requestIdMandatoryStringRequest ID
          requestTimeMandatoryDateTimeRequest time
          statusCodeMandatoryStringRequest status codeSee the following response code
          statusNameMandatoryStringRequest status name- Success: success
          - reserved: being reserved
          - scheduled: being scheduled
          - Fail: failed

          Response status

          HTTP StatusDesc
          202Accepted (delivery request completed)
          400Bad Request
          401Unauthorized
          403Forbidden
          404Not Found
          500Internal Server Error

          Search for message delivery result

          Searches for the message delivery result.

          Request 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

          ItemMandatoryTypeDescriptionNote
          serviceIdMandatoryStringService IDService ID issued when registering the project
          requestIdMandatoryStringMessage request IDRequest identifier that is returned when sending the message

          Headers

          Go to API Header

          Request Body

          N/A

          Response bodies

          {
    "requestId":"string",
    "requestTime":"string",
    "statusCode":"string",
    "statusName":"string",
    "messageStatusCode":"string",
    "messageStatusName":"string",
    "completeTime":"string",
    "targetCount":"integer",
    "sentCount":"integer",
    "messageType":"string",
    "target":{
        ...
    },
    "message":{
        ...
    }
}
          ItemMandatoryTypeDescriptionNote
          requestIdMandatoryStringRequest ID
          requestTimeMandatoryDateTimeRequest time
          statusCodeMandatoryStringRequest status code- 202: success
          - Others: failed
          statusNameMandatoryStringRequest status name- Success: success
          - Fail: failed
          messageStatusCodeMandatoryStringDelivery status code- 200: success
          - Others: failed
          messageStatusNameMandatoryStringName of the delivery status- Success: success
          - Processing: being processed
          - Fail: failed
          completeTimeMandatoryDateTimeDelivery completion time
          targetCountMandatoryIntegerNo. of requested devices
          sentCountMandatoryIntegerNo. of successfully delivered devices
          messageTypeMandatoryStringMessage type- NOTIF: notification message
          - AD: ad message
          targetMandatoryObjectInformation of requested target
          messageMandatoryObjectInformation of requested message

          Response status

          HTTP StatusDesc
          200OK (successfully searched)
          400Bad Request
          401Unauthorized
          403Forbidden
          404Not Found
          500Internal Server Error

          Reserved message

          View reserved message status

          View the reservation status of message delivery.

          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

          ItemMandatoryTypeDescriptionNote
          serviceIdMandatoryStringService IDService ID issued when registering the project
          reserveIdMandatoryStringReserved message IDMessage identifier that is returned when searching for the reserved delivery requests (requestId)

          Headers

          Go to API Header

          Request Body

          N/A

          Response bodies

          {
  "reserveId": "string",
  "reserveTimeZone": "string",
  "reserveTime": "string",
  "reserveStatus": "string"
}
          ItemMandatoryTypeDescriptionNote
          reserveIdMandatoryStringReserved message IDMessage identifier that is returned when searching for the reserved delivery requests (requestId)
          reserveTimeMandatoryStringReserved date and timeReserved date and time for message delivery (yyyy-MM-dd HH:mm)
          reserveTimeZoneMandatoryStringTime zone of reserved date and time- Time zone of reserved date and time (default: Asia/Seoul)
          - List of supported time zones
          - Use the TZ database name value
          reserveStatusMandatoryStringReserved status- READY: waiting to be sent
          - PROCESSING: requesting delivery
          - CANCELED: delivery canceled
          - FAIL: delivery request failed
          - DONE: successful delivery request
          - STALE: delivery request failed (timeout)

          Response status

          HTTP StatusDesc
          200OK (successfully searched)
          400Bad Request
          401Unauthorized
          403Forbidden
          404Not Found
          500Internal Server Error

          Cancel reserved message

          Cancel the reserved message delivery.

          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

          ItemMandatoryTypeDescriptionNote
          serviceIdMandatoryStringService IDService ID issued when registering the project
          reserveIdMandatoryStringReserved message IDMessage identifier that is returned when searching for the reserved delivery requests (requestId)

          Headers

          Go to API Header

          Request Body

          N/A

          Response bodies

          N/A

          Response status

          HTTP StatusDesc
          204No Content (successfully deleted)
          400Bad Request
          401Unauthorized
          403Forbidden
          404Not Found
          500Internal Server Error

          Scheduled message

          Cancel scheduled message

          Cancel the message delivery schedule.

          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

          ItemMandatoryTypeDescriptionNote
          serviceIdMandatoryStringService IDService ID issued when registering the project
          scheduleCodeMandatoryStringSchedule codeThe code used for schedule registration
          messageIdMandatoryStringReserved message IDMessage identifier that is returned when searching for the scheduled delivery requests (requestId)

          Headers

          Go to API Header

          Request Body

          N/A

          Response bodies

          N/A

          Response status

          HTTP StatusDesc
          204No Content (successfully deleted)
          400Bad Request
          401Unauthorized
          403Forbidden
          404Not Found
          500Internal Server Error
          Was this article helpful?
          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