ユーザーの照会

Prev Next

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

ユーザーの詳細情報を照会します。

リクエスト

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

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

リクエストヘッダ

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

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

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

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

リクエスト例

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

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

レスポンス

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

レスポンスボディ

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

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

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

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

レスポンス例

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

{
    "id": "39c8de0f-****-****-****-6a1a875df59f",
    "project_id": "8be54b8b-****-****-****-84c0d5df2e9c",
    "member_id": "39c8de0f-****-****-****-6a1a875df59f",
    "name": "apitester",
    "profile": "",
    "memo": null,
    "country": "KR",
    "remoteip": "***.***.***.***",
    "adid": null,
    "device": null,
    "network": null,
    "version": null,
    "model": null,
    "deleted": false,
    "online": false,
    "customField": "",
    "device_type": [],
    "push": null,
    "memberblock_id": null,
    "notifications": {
        "token": "*********************************",
        "device": "APNS",
        "os": "iOS 18",
        "push": true,
        "ad": true,
        "night": true,
        "timezone": null
    },
    "logined_at": "2025-07-22T17:48:04+09:00",
    "created_at": "2025-07-22T11:11:05+09:00",
    "updated_at": "2025-07-22T17:48:04+09:00",
    "deleted_at": null
}