プッシュ通知設定の解除

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

ユーザーに設定したプッシュ通知を解除します。

リクエスト

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

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

リクエストヘッダ

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

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

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

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

リクエスト例

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

curl --location --request DELETE 'https://dashboard-api.ncloudchat.naverncp.com/v1/api/members/39c8de0f-****-****-****-6a1a875df59f/notification' \
--header 'x-api-key: {API Key}' \
--header 'x-project-id: {Project ID}'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`member`	Object	-	ユーザー情報
`member.id`	String	-	ユーザー ID
`member.notifications`	Object	-	プッシュ通知の設定内容設定が解除され、配下の情報に`null`と表示
`member.notifications.token`	String	-	プッシュトークン
`member.notifications.device`	String	-	デバイスプッシュタイプ `FCM` \| `APNS`
`member.notifications.os`	String	-	OSのバージョン
`member.notifications.push`	Boolean	-	プッシュ通知を許可するか `true` \| `false` `true`: 許可 `false`: ブロック
`member.notifications.ad`	Boolean	-	プッシュ型広告通知を許可するか `true` \| `false` `true`: 許可 `false`: ブロック
`member.notifications.night`	Boolean	-	夜間プッシュ通知を許可するか `true` \| `false` `true`: 許可 `false`: ブロック
`member.notifications.timezone`	String	-	タイムゾーン未設定の場合、`null`と表示
`status`	Integer	-	レスポンスの状態 `1`: 成功 `1`でない場合: 失敗

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

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

レスポンス例

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

{
    "member": {
        "id": "39c8de0f-****-****-****-6a1a875df59f",
        "notifications": {
            "token": null,
            "device": null,
            "os": null,
            "push": null,
            "ad": null,
            "night": null,
            "timezone": null
        }
    },
    "status": 1
}