会員

印刷する
共有
PDF

会員

印刷する
共有
PDF

記事の要約

この要約は役に立ちましたか?

ご意見ありがとうございます

説明

会員情報の作成/変更/削除用 APIを説明します。

会員照会 API

会員情報をすべて検索できます。

リクエスト URL

GET https://dashboard-api.ncloudchat.naverncp.com/v1/api/members

リクエストヘッダ

Header	Description
x-project-id	- ダッシュボード > 設定 > 一般 > プロジェクト ID
x-api-key	- ダッシュボード > 設定 > 一般 > APIキー

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

パラメータ	タイプ	必須の有無	説明
channelId	String	O	チャンネル ID

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

パラメータ	タイプ	必須の有無	説明
filter	String	O	基本的には{}を入力してご使用ください。フィルタは、一部のフィールドに対して検索を行えます。
sort	String	X	ソートしようとするフィールドのフィルタを定義します。
option	String	X	オプションが存在する場合、以下をご参照ください。

リクエスト例

curl -X 'GET' \
  'https://dashboard-api.ncloudchat.naverncp.com/v1/api/members?filter=%7B%7D&sort=%7B%22created_at%22%3A%22-1%22%7D&option=%7B%22offset%22%3A0%2C%22per_page%22%3A1%7D' \
  -H 'accept: application/json' \
  -H 'x-project-id: 339c2b1c-d35b-47f2-828d-5f0xxxxxxxxxx' \
  -H 'x-api-key: 4302925661f70ce7c1406c59543f2546d26xxxxxxxxxx'

レスポンス例(正常)

[
  {
    "id": "750610c9-3fb9-42b0-8355-XXXXXXXXX",
    "project_id": "339c2b1c-d35b-47f2-828d-5f0xxxxxxxxxx",
    "member_id": "750610c9-3fb9-42b0-8355-XXXXXXXXX",
    "name": "Nickname",
    "profile": "http://XXXXXX",
    "memo": null,
    "country": "KR",
    "remoteip": "116.124.XX.XXX",
    "adid": null,
    "device": null,
    "network": null,
    "version": null,
    "model": null,
    "deleted": false,
    "online": false,
    "customField": null,
    "device_type": [],
    "push": true,
    "memberblock_id": null,
    "logined_at": "2022-06-15T09:30:28+09:00",
    "created_at": "2021-12-06T19:36:59+09:00",
    "updated_at": "2022-06-27T15:17:31+09:00",
    "deleted_at": null
  }
]

レスポンス

HTTPステータスコードで返され、ボディ情報として伝達します。

HTTPステータスコード	レスポンスメッセージ	説明
200	OK	一般的なリクエスト成功
400	Bad Request	一般的なリクエスト失敗に使用(ほとんど場合、サーバが理解できない形式のリクエストがあった時のレスポンスとして使用)
500	Internal Server Error	- 一般的なサーバエラーに対するレスポンスコード - 4XX番台のエラーコードはクライアント側のエラーを表すために使用 - 5XX番台のエラーコードはサーバ側のエラーを表すために使用

個別会員情報照会 API

特定の個別会員情報を取得できます。

リクエスト URL

GET https://dashboard-api.ncloudchat.naverncp.com/v1/api/members/{userId}

リクエストヘッダ

Header	Description
x-project-id	- ダッシュボード > 設定 > 一般 > プロジェクト ID
x-api-key	- ダッシュボード > 設定 > 一般 > APIキー

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

パラメータ	タイプ	必須の有無	説明
userId	String	Y	会員 ID

リクエスト例

curl -X 'GET' \
  'https://dashboard-api.ncloudchat.naverncp.com/v1/api/members/f8002d46-3064-4d42-XXXX-XXXXXXXXX' \
  -H 'accept: application/json' \
  -H 'x-project-id: 339c2b1c-d35b-47f2-XXXX-XXXXXXXXX' \
  -H 'x-api-key: 4302925661f70ce7c1406c59543f2546dXXXXXXXX'

レスポンス例(正常)

  {
  "id": "f8002d46-3064-4d42-XXXX-XXXXXXXXX",
  "project_id": "339c2b1c-d35b-47f2-828d-xxxxxxxxxx",
  "member_id": "f8002d46-3064-4d42-XXXX-XXXXXXXXX",
  "name": "Nickname222",
  "profile": "image_url",
  "memo": null,
  "country": "KR",
  "remoteip": "116.124.XXX.XXX",
  "adid": null,
  "device": null,
  "network": null,
  "version": null,
  "model": null,
  "deleted": false,
  "online": false,
  "customField": null,
  "device_type": [],
  "push": true,
  "memberblock_id": null,
  "logined_at": "2022-06-15T09:30:28+09:00",
  "created_at": "2021-12-06T19:36:59+09:00",
  "updated_at": "2023-04-26T13:16:37+09:00",
  "deleted_at": null
}

レスポンス

HTTPステータスコードで返され、ボディ情報として伝達します。

HTTPステータスコード	レスポンスメッセージ	説明
200	OK	一般的なリクエスト成功
400	Bad Request	一般的なリクエスト失敗に使用(ほとんど場合、サーバが理解できない形式のリクエストがあった時のレスポンスとして使用)
500	Internal Server Error	- 一般的なサーバエラーに対するレスポンスコード - 4XX番台のエラーコードはクライアント側のエラーを表すために使用 - 5XX番台のエラーコードはサーバ側のエラーを表すために使用

会員作成 API

会員作成 APIを送信できます。

リクエスト URL

POST https://dashboard-api.ncloudchat.naverncp.com/v1/api/members

リクエストヘッダ

Header	Description
x-project-id	- ダッシュボード > 設定 > 一般 > プロジェクト ID
x-api-key	- ダッシュボード > 設定 > 一般 > APIキー

リクエストボディパラメータ

パラメータ	タイプ	必須の有無	説明
userId	String	Y	作成する ID (4~128文字以内で入力可能)
name	String	Y	ハンドルネームまたは名前
customField	String	N	customField

リクエスト例

curl -X 'POST' \
  'https://dashboard-api.ncloudchat.naverncp.com/v1/api/members' \
  -H 'accept: application/json' \
  -H 'x-project-id: 339c2b1c-d35b-47f2-XXXX-XXXXXXXX' \
  -H 'x-api-key: 4302925661f70ce7c1406c59543f254XXXXXXXX' \
  -H 'Content-Type: application/json' \
  -d '{
  "userId": "guestId",
  "name": "111222333444",
  "customField": "customField"
}'

レスポンス例(正常)

 {
  "member": {
    "id": "guestId",
    "project_id": "339c2b1c-d35b-47f2-XXXX-XXXXXXXX",
    "member_id": "guestId",
    "name": "111222333444",
    "profile": null,
    "memo": null,
    "country": "NO",
    "remoteip": null,
    "adid": null,
    "device": null,
    "network": null,
    "version": null,
    "model": null,
    "deleted": false,
    "online": false,
    "customField": "customField",
    "device_type": [],
    "push": true,
    "memberblock_id": null,
    "logined_at": "2023-04-26T13:10:25+09:00",
    "created_at": "2023-04-26T13:10:25+09:00",
    "updated_at": "2023-04-26T13:10:25+09:00",
    "deleted_at": null
  },
  "status": 1
}

レスポンス

HTTPステータスコードで返され、ボディ情報として伝達します。

HTTPステータスコード	レスポンスメッセージ	説明
200	OK	一般的なリクエスト成功
400	Bad Request	一般的なリクエスト失敗に使用(ほとんど場合、サーバが理解できない形式のリクエストがあった時のレスポンスとして使用)
500	Internal Server Error	- 一般的なサーバエラーに対するレスポンスコード - 4XX番台のエラーコードはクライアント側のエラーを表すために使用 - 5XX番台のエラーコードはサーバ側のエラーを表すために使用

会員削除 API

特定の会員情報を削除処理します。

リクエスト URL

DELETE https://dashboard-api.ncloudchat.naverncp.com/v1/api/members/:userId

リクエストヘッダ

Header	Description
x-project-id	- ダッシュボード > 設定 > 一般 > プロジェクト ID
x-api-key	- ダッシュボード > 設定 > 一般 > APIキー

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

パラメータ	タイプ	必須の有無	説明
userId	String	Y	会員 ID

リクエスト例

curl -X 'DELETE' \
  https://dashboard-api.ncloudchat.naverncp.com/v1/api/members/guestId2' \
  -H 'accept: */*' \
  -H 'x-project-id: 339c2b1c-d35b-47f2-XXXX-XXXXXXXXX' \
  -H 'x-api-key: 4302925661f70ce7c1406c59543f2546dXXXXXXXXXXX'

レスポンス例(正常)

 {
  "member": {
    "id": "guestId2",
    "project_id": "339c2b1c-d35b-47f2-XXXX-XXXXXXXXX",
    "member_id": "guestId2",
    "name": "111222333444",
    "profile": null,
    "memo": null,
    "country": "NO",
    "remoteip": null,
    "adid": null,
    "device": null,
    "network": null,
    "version": null,
    "model": null,
    "deleted": false,
    "online": false,
    "customField": "customField",
    "device_type": [],
    "push": true,
    "memberblock_id": null,
    "logined_at": "2023-04-26T13:42:04+09:00",
    "created_at": "2023-04-26T13:42:04+09:00",
    "updated_at": "2023-04-26T13:42:04+09:00",
    "deleted_at": null
  },
  "status": 1
}

レスポンス

HTTPステータスコードで返され、ボディ情報として伝達します。

HTTPステータスコード	レスポンスメッセージ	説明
200	OK	一般的なリクエスト成功
400	Bad Request	一般的なリクエスト失敗に使用(ほとんど場合、サーバが理解できない形式のリクエストがあった時のレスポンスとして使用)
500	Internal Server Error	- 一般的なサーバエラーに対するレスポンスコード - 4XX番台のエラーコードはクライアント側のエラーを表すために使用 - 5XX番台のエラーコードはサーバ側のエラーを表すために使用

会員復元 API

削除された会員の情報を復元します。

リクエスト URL

DELETE https://dashboard-api.ncloudchat.naverncp.com/v1/api/members/:userId/restore

リクエストヘッダ

Header	Description
x-project-id	- ダッシュボード > 設定 > 一般 > プロジェクト ID
x-api-key	- ダッシュボード > 設定 > 一般 > APIキー

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

パラメータ	タイプ	必須の有無	説明
userId	String	Y	会員 ID

リクエスト例

curl -X 'DELETE' \
  https://dashboard-api.ncloudchat.naverncp.com/v1/api/members/guestId2/restore' \
  -H 'accept: */*' \
  -H 'x-project-id: 339c2b1c-d35b-47f2-XXXX-XXXXXXXXX' \
  -H 'x-api-key: 4302925661f70ce7c1406c59543f2546dXXXXXXXXXXX'

レスポンス例(正常)

 {
  "member": {
    "id": "guestId2",
    "project_id": "339c2b1c-d35b-47f2-XXXX-XXXXXXXXX",
    "member_id": "guestId2",
    "name": "111222333444",
    "profile": null,
    "memo": null,
    "country": "NO",
    "remoteip": null,
    "adid": null,
    "device": null,
    "network": null,
    "version": null,
    "model": null,
    "deleted": false,
    "online": false,
    "customField": "customField",
    "device_type": [],
    "push": true,
    "memberblock_id": null,
    "logined_at": "2023-04-26T13:42:04+09:00",
    "created_at": "2023-04-26T13:42:04+09:00",
    "updated_at": "2023-04-26T13:42:04+09:00",
    "deleted_at": null
  },
  "status": 1
}

レスポンス

HTTPステータスコードで返され、ボディ情報として伝達します。

HTTPステータスコード	レスポンスメッセージ	説明
200	OK	一般的なリクエスト成功
400	Bad Request	一般的なリクエスト失敗に使用(ほとんど場合、サーバが理解できない形式のリクエストがあった時のレスポンスとして使用)
500	Internal Server Error	- 一般的なサーバエラーに対するレスポンスコード - 4XX番台のエラーコードはクライアント側のエラーを表すために使用 - 5XX番台のエラーコードはサーバ側のエラーを表すために使用

ユーザートークンの登録

ユーザーのプッシュトークンを登録し、受信状態を変更します。

リクエスト URL

POST https://dashboard-api.ncloudchat.naverncp.com/v1/api/members/:userId/notification

リクエストヘッダ

Header	Description
x-project-id	ダッシュボード > 設定 > 一般 > プロジェクト ID
x-api-key	ダッシュボード > 設定 > 一般 > APIキー

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

パラメータ	タイプ	必須の有無	説明
userId	String	Y	会員 ID

リクエストボディパラメータ

パラメータ	タイプ	必須の有無	説明
token	String	N	プッシュトークン
device	String	N	デバイスプッシュタイプ(`FCM`, `APNS`)
os	String	N	OSタイプ
push	Boolean	N	プッシュメッセージを受信するかどうか(`true`: すべてのメッセージを受信)
ad	Boolean	N	メッセージ型広告を受信するかどうか(`true`: メッセージを受信)
night	Boolean	N	夜間メッセージを受信するかどうか
timezone	String	N	タイムゾーン

リクエスト例

curl -X 'POST' \
  'https://dashboard-api.ncloudchat.naverncp.com/v1/api/members/guestId1/notification' \
  -H 'accept: */*' \
  -H 'x-project-id: 339c2b1c-d35b-47f2-XXXX-XXXXXXXXX' \
  -H 'x-api-key: 4302925661f70ce7c1406c59543f2546dXXXXXXXXXXX'
  -H 'Content-Type: application/json' \
  -d '{
  "token": "eSs_u-CVRXSAaZNZe6E47B:APA91bGE-99GKBWXFV2EUO_N__VJtRlyw_fbbj5bIxzslCRn3exMuW9z9lSYEYAKjQUd0OHa0yIL4bEh31iQ9T09OXEqC4nwUCt-C_GS44luMbofSEjCEluhCDQW3luduAAALMf3VC4s",
  "device": "FCM",
  "os": "",
  "push": true,
  "ad": true,
  "night": true
}'

レスポンス例(正常)

{
  "member": {
    "id": "guestId1",
    "notifications": {
      "token": "eSs_u-CVRXSAaZNZe6E47B:APA91bGE-99GKBWXFV2EUO_N__VJtRlyw_fbbj5bIxzslCRn3exMuW9z9lSYEYAKjQUd0OHa0yIL4bEh31iQ9T09OXEqC4nwUCt-C_GS44luMbofSEjCEluhCDQW3luduAAALMf3VC4s",
      "device": "FCM",
      "os": "",
      "push": false,
      "ad": true,
      "night": true,
      "timezone": null
    }
  },
  "status": 1
}

レスポンス

HTTPステータスコードで返され、ボディ情報として伝達します。

HTTPステータスコード	レスポンスメッセージ	説明
200	OK	一般的なリクエスト成功
400	Bad Request	一般的なリクエスト失敗に使用(ほとんど場合、サーバが理解できない形式のリクエストがあった時のレスポンスとして使用)
500	Internal Server Error	- 一般的なサーバエラーに対するレスポンスコード - 4XX番台のエラーコードは、クライアント側のエラーを示すために使用 - 5XX番台のエラーコードはサーバ側のエラーを表すために使用

ユーザートークンの照会

ユーザーのプッシュトークンとプッシュの受信状態を照会します。

リクエスト URL

GET https://dashboard-api.ncloudchat.naverncp.com/v1/api/members/:userId/notification

リクエストヘッダ

Header	Description
x-project-id	- ダッシュボード > 設定 > 一般 > プロジェクト ID
x-api-key	- ダッシュボード > 設定 > 一般 > APIキー

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

パラメータ	タイプ	必須の有無	説明
userId	String	Y	会員 ID

リクエスト例

curl -X 'POST' \
  'https://dashboard-api.ncloudchat.naverncp.com/v1/api/members/guestId1/notification' \
  -H 'accept: */*' \
  -H 'x-project-id: 339c2b1c-d35b-47f2-XXXX-XXXXXXXXX' \
  -H 'x-api-key: 4302925661f70ce7c1406c59543f2546dXXXXXXXXXXX'

レスポンス例(正常)

{
  "member": {
    "id": "guestId1",
    "notifications": {
      "token": "eSs_u-CVRXSAaZNZe6E47B:APA91bGE-99GKBWXFV2EUO_N__VJtRlyw_fbbj5bIxzslCRn3exMuW9z9lSYEYAKjQUd0OHa0yIL4bEh31iQ9T09OXEqC4nwUCt-C_GS44luMbofSEjCEluhCDQW3luduAAALMf3VC4s",
      "device": "FCM",
      "os": "",
      "push": false,
      "ad": true,
      "night": true,
      "timezone": null
      }
    }
}

レスポンス

HTTPステータスコードで返され、ボディ情報として伝達します。

HTTPステータスコード	レスポンスメッセージ	説明
200	OK	一般的なリクエスト成功
400	Bad Request	一般的なリクエスト失敗に使用(ほとんど場合、サーバが理解できない形式のリクエストがあった時のレスポンスとして使用)
500	Internal Server Error	- 一般的なサーバエラーに対するレスポンスコード - 4XX番台のエラーコードは、クライアント側のエラーを示すために使用 - 5XX番台のエラーコードはサーバ側のエラーを表すために使用

この記事は役に立ちましたか?

What's Next

チャンネル

説明
会員照会 API
レスポンス
個別会員情報照会 API
レスポンス
会員作成 API
レスポンス
会員削除 API
レスポンス
会員復元 API
レスポンス
ユーザートークンの登録
レスポンス
ユーザートークンの照会
レスポンス

タグ

Ncloud Chat