プッシュ通知設定の照会

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

ユーザーのプッシュ通知設定内容を照会します。

リクエスト

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

メソッド	URI
GET	/v1/api/members/{userId}/notification

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`userId`	String	Required	ユーザー ID ユーザーリストの照会を参照

リクエスト例

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

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}'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`id`	String	-	ユーザー ID
`notifications`	Object	-	プッシュ通知設定の内容
`notifications.token`	String	-	プッシュトークン
`notifications.device`	String	-	デバイスプッシュタイプ `FCM` \| `APNS`
`notifications.os`	String	-	OSのバージョン
`notifications.push`	Boolean	-	プッシュ通知を許可するか `true` \| `false` `true`: 許可 `false`: ブロック
`notifications.ad`	Boolean	-	プッシュ型広告通知を許可するか `true` \| `false` `true`: 許可 `false`: ブロック
`notifications.night`	Boolean	-	夜間プッシュ通知を許可するか `true` \| `false` `true`: 許可 `false`: ブロック
`notifications.timezone`	String	-	タイムゾーン未設定の場合、`null`と表示

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

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

レスポンス例

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

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