Members

Article Summary

Share feedback

Thanks for sharing your feedback!

Description

Provides information on API for creation, revision and deletion of member information.

Member-view API

You can search for all member information.

Request URL

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

Request header

Header	Description
x-project-id	- Dashboard > Settings > Project settings > Project ID
x-api-key	- Dashboard > Settings > Project settings > API Key

Request path parameters

Parameters	Type	Requirement status	Description
channelId	String	O	Channel ID

Request query parameters

Parameters	Type	Requirement status	Description
filter	String	O	Please use {} as the default method of entry. The filter can be used to search some of the fields.
sort	String	X	Define the filter for the fields you want to sort.
option	String	X	Refer to the following when there are options.

Request examples

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'

Response examples (normal)

[
  {
    "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
  }
]

Response

Returned as HTTP status codes in the response body.

HTTP status code	Response message	Description
200	OK	General successful request
400	Bad Request	Used for general request failure (usually used to respond to a request format that the server can't understand)
500	Internal Server Error	- Response code for common server errors. - 4XX error codes are used to represent client-side errors. - 5XX error codes represent server-side errors.

API for viewing individual member information

Information on specific individual members can be extracted.

Request URL

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

Request header

Header	Description
x-project-id	- Dashboard > Settings > Project settings > Project ID
x-api-key	- Dashboard > Settings > Project settings > API Key

Request path parameters

Parameters	Type	Requirement status	Description
userId	String	Y	Member ID

Request examples

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'

Response examples (normal)

  {
  "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
}

Response

Returned as HTTP status codes in the response body.

HTTP status code	Response message	Description
200	OK	General successful request
400	Bad Request	Used for general request failure (usually used to respond to a request format that the server can't understand)
500	Internal Server Error	- Response code for common server errors. - 4XX error codes are used to represent client-side errors. - 5XX error codes represent server-side errors.

Member creation API

Member creation API can be sent.

Request URL

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

Request header

Header	Description
x-project-id	- Dashboard > Settings > Project settings > Project ID
x-api-key	- Dashboard > Settings > Project settings > API Key

Request body parameters

Parameters	Type	Requirement status	Description
userId	String	Y	ID to be created (4–128 characters allowed)
name	String	Y	Nickname or name
customField	String	N	customField

Request examples

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"
}'

Response examples (normal)

 {
  "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
}

Response

Returned as HTTP status codes in the response body.

HTTP status code	Response message	Description
200	OK	General successful request
400	Bad Request	Used for general request failure (usually used to respond to a request format that the server can't understand)
500	Internal Server Error	- Response code for common server errors. - 4XX error codes are used to represent client-side errors. - 5XX error codes represent server-side errors.

Member deletion API

Information of specific members can be deleted.

Request URL

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

Request header

Header	Description
x-project-id	- Dashboard > Settings > Project settings > Project ID
x-api-key	- Dashboard > Settings > Project settings > API Key

Request path parameters

Parameters	Type	Requirement status	Description
userId	String	Y	Member ID

Request examples

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'

Response examples (normal)

 {
  "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
}

Response

Returned as HTTP status codes in the response body.

HTTP status code	Response message	Description
200	OK	General successful request
400	Bad Request	Used for general request failure (usually used to respond to a request format that the server can't understand)
500	Internal Server Error	- Response code for common server errors. - 4XX error codes are used to represent client-side errors. - 5XX error codes represent server-side errors.

Member restoration API

Restores the information of a deleted member.

Request URL

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

Request header

Header	Description
x-project-id	- Dashboard > Settings > Project settings > Project ID
x-api-key	- Dashboard > Settings > Project settings > API Key

Request path parameters

Parameters	Type	Requirement status	Description
userId	String	Y	Member ID

Request examples

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'

Response examples (normal)

 {
  "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
}

Response

Returned as HTTP status codes in the response body.

HTTP status code	Response message	Description
200	OK	General successful request
400	Bad Request	Used for general request failure (usually used to respond to a request format that the server can't understand)
500	Internal Server Error	- Response code for common server errors. - 4XX error codes are used to represent client-side errors. - 5XX error codes represent server-side errors.

Was this article helpful?

What's Next

Channel

Table of contents

Description
Member-view API
Response
API for viewing individual member information
Response
Member creation API
Response
Member deletion API
Response
Member restoration API
Response