ユーザーの退会

Prev Next

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

ユーザーを退会処理します。

リクエスト

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

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

リクエストヘッダ

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

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

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

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

リクエスト例

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

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

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
member Object - ユーザー情報
member.id String - ユーザー ID
member.project_id String - プロジェクト ID
member.member_id String - ユーザー ID
member.name String - ユーザーの名前
member.profile String - ユーザープロファイル画像
member.memo String - ユーザーに関するメモ
member.country String - アクセスした国
member.remoteip String - アクセス IPアドレス
member.adid String - 広告 ID
member.device String - デバイス
member.network String - ネットワーク
member.version String - バージョン
member.model String - モデル
member.deleted Boolean - 退会しているか
  • true | false
    • true: 退会
    • false: 退会していない
member.online Boolean - オンラインかどうか
  • true | false
    • true: オンライン
    • false: オフライン
member.customField String - ユーザー定義フィールド
member.device_type Array - デバイスタイプ
member.push Boolean - プッシュ通知を許可するか
  • true | false
    • true: 許可
    • false: ブロック
member.memberblock_id String - TBD
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 - 時間帯
member.logined_at String - 最終ログイン日時
  • ISO 8601形式
member.created_at String - ユーザー登録日時
  • ISO 8601形式
member.updated_at String - 情報更新日時
  • ISO 8601形式
member.deleted_at String - 退会日時
  • ISO 8601形式
status Integer - レスポンスの状態
  • 1: 成功
  • 1でない場合: 失敗

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

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

レスポンス例

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

{
    "member": {
        "id": "guestID3",
        "project_id": "8be54b8b-****-****-****-84c0d5df2e9c",
        "member_id": "guestID3",
        "name": "guest3",
        "profile": null,
        "memo": null,
        "country": "KR",
        "remoteip": null,
        "adid": null,
        "device": null,
        "network": null,
        "version": null,
        "model": null,
        "deleted": false,
        "online": false,
        "customField": "{ageGroup: 20s}",
        "device_type": [],
        "push": null,
        "memberblock_id": null,
        "notifications": {
            "token": null,
            "device": null,
            "os": null,
            "push": null,
            "ad": null,
            "night": null,
            "timezone": null
        },
        "logined_at": "2025-07-23T11:04:03+09:00",
        "created_at": "2025-07-23T11:04:03+09:00",
        "updated_at": "2025-07-23T11:04:03+09:00",
        "deleted_at": null
    },
    "status": 1
}