プッシュ通知の設定

Prev Next

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

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

リクエスト

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

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

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
userId String Required ユーザー ID

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
token String Optional プッシュトークン
device String Optional デバイスプッシュタイプ
  • FCM | APNS
os String Optional OSのバージョン
push Boolean Optional プッシュ通知を許可するか
  • true | false
    • true: 許可
    • false: ブロック
ad Boolean Optional プッシュ型広告通知を許可するか
  • true | false
    • true: 許可
    • false: ブロック
night Boolean Optional 夜間プッシュ通知を許可するか
  • true | false
    • true: 許可
    • false: ブロック
timezone String Optional 時間帯

リクエスト例

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

curl --location --request POST 'https://dashboard-api.ncloudchat.naverncp.com/v1/api/members/39c8de0f-****-****-****-6a1a875df59f/notification' \
--header 'x-api-key: {API Key}' \
--header 'x-project-id: {Project ID}' \
--header 'Content-Type: application/json' \
--data '{
    "token": "dXNhZ2******************************YWJjZGVm",
    "device": "APNS",
    "os": "iOS 18",
    "push": true,
    "ad": true,
    "night": true,
    "timezone": "Asia/Seoul"
}'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
member Object - ユーザー情報
member.id String - ユーザー ID
member.notifications Object - プッシュ通知設定の内容
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": "dXNhZ2******************************YWJjZGVm",
            "device": "APNS",
            "os": "iOS 18",
            "push": true,
            "ad": true,
            "night": true,
            "timezone": null
        }
    },
    "status": 1
}