Get push notification settings

Prev Next

Available in Classic and VPC

Get user's push notification settings.

Request

This section describes the request format. The method and URI are as follows:

Method URI
GET /v1/api/members/{userId}/notification

Request headers

For information about the headers common to all Ncloud Chat APIs, see Ncloud Chat request headers.

Request path parameters

You can use the following path parameters with your request:

Field Type Required Description
userId String Required User ID

Request example

The request example is as follows:

curl --location --request GET 'https://dashboard-api.ncloudchat.naverncp.com/v1/api/members/NCP001/notification' \
--header 'x-api-key: {API Key}' \
--header 'x-project-id: {Project ID}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field Type Required Description
id String - User ID
notifications Object - Push notification settings
notifications.token String - Push token
notifications.device String - Device push type
  • FCM | APNS
notifications.os String - Operating system version
notifications.push Boolean - Whether to allow push notifications
  • true | false
    • true: Allow
    • false: Block
notifications.ad Boolean - Whether to allow ad push notifications
  • true | false
    • true: Allow
    • false: Block
notifications.night Boolean - Whether to allow night push notifications
  • true | false
    • true: Allow
    • false: Block
notifications.timezone String - Time zone
  • null is displayed if not set.

Response status codes

For information about the HTTP status codes common to all Ncloud Chat APIs, see Common Ncloud Chat response status codes.

Response example

The response example is as follows:

{
    "id": "NCP001",
    "notifications": {
        "token": "48b673227f*************************17ac563d712dad",
        "device": "sandbox",
        "os": "17.5.1",
        "push": true,
        "ad": true,
        "night": true,
        "timezone": null
    }
}