会員

印刷する
共有
PDF

会員

印刷する
共有
PDF

Article Summary

Share feedback

Thanks for sharing your feedback!

説明

会員情報に対して作成/修正/削除をするための APIを説明します。

会員の照会 API

会員情報をすべて検索することができます。

リクエスト URL

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

リクエストヘッダ

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

リクエスト Pathパラメータ

パラメータ	タイプ	要否	説明
channelId	String	O	チャンネル ID

リクエスト Queryパラメータ

パラメータ	タイプ	要否	説明
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状態コードでリターンされ、Body情報として転送します。

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 Key

リクエスト Pathパラメータ

パラメータ	タイプ	要否	説明
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状態コードでリターンされ、Body情報として転送します。

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 Key

リクエスト Bodyパラメータ

パラメータ	タイプ	要否	説明
userId	String	Y	作成する ID(4~128文字まで許容)
name	String	Y	ニックネーム or名前
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状態コードでリターンされ、Body情報として転送します。

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 Key

リクエスト Pathパラメータ

パラメータ	タイプ	要否	説明
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状態コードでリターンされ、Body情報として転送します。

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 Key

リクエスト Pathパラメータ

パラメータ	タイプ	要否	説明
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状態コードでリターンされ、Body情報として転送します。

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

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

What's Next

チャンネル

説明
会員の照会 API
レスポンス
個別会員情報の照会 API
レスポンス
会員作成 API
レスポンス
会員削除 API
レスポンス
会員復元 API
レスポンス

タグ

Ncloud Chat