Member

Article summary

Did you find this summary helpful?

Thank you for your feedback

Description

This section introduces APIs for creating, editing, and deleting member information.

Get member API

You can search all of your member information.

Request URL

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

Request headers

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

Request path parameter

Parameter	Type	Required	Description
channelId	String	O	Channel ID

Request query parameter

Parameter	Type	Required	Description
filter	String	O	Enter {} by default. Filters allow you to search for some fields
sort	String	X	Define the filter for the fields you want to sort
option	String	X	See the below when there are options

Request example

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 example (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

It is returned as an HTTP status code and forwarded as body information.

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 general server errors - While 4XX error codes represent client-side errors - 5xx error codes represent server-side errors

Get individual member information API

You can get specific individual member information.

Request URL

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

Request headers

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

Request path parameter

Parameter	Type	Required	Description
userId	String	Y	Member ID

Request example

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 example (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

It is returned as an HTTP status code and forwarded as body information.

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 general server errors - While 4XX error codes represent client-side errors - 5xx error codes represent server-side errors

Create member API

You can send the Create member API.

Request URL

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

Request headers

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

Request body parameter

Parameter	Type	Required	Description
userId	String	Y	ID to create (4 - 128 characters allowed)
name	String	Y	Nickname or name
customField	String	N	customField

Request example

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 example (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

It is returned as an HTTP status code and forwarded as body information.

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 general server errors - While 4XX error codes represent client-side errors - 5xx error codes represent server-side errors

Delete member API

Delete specific member information.

Request URL

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

Request headers

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

Request path parameter

Parameter	Type	Required	Description
userId	String	Y	Member ID

Request example

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 example (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

It is returned as an HTTP status code and forwarded as body information.

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 general server errors - While 4XX error codes represent client-side errors - 5xx error codes represent server-side errors

Restore member API

Restore information of a deleted member.

Request URL

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

Request headers

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

Request path parameter

Parameter	Type	Required	Description
userId	String	Y	Member ID

Request example

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 example (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

It is returned as an HTTP status code and forwarded as body information.

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 general server errors - While 4XX error codes represent client-side errors - 5xx error codes represent server-side errors

Register user token

Request URL

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

Request headers

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

Request path parameters

Parameter	Type	Required	Description
userId	String	Y	Member ID

Request body parameter

Parameter	Type	Required	Description
token	String	N	Push token
device	String	N	Device push type (`FCM`, `APNS`)
os	String	N	Operating system type
push	Boolean	N	Whether to receive push messages (`true`: receive all messages)
ad	Boolean	N	Whether to receive ad messages (`true`: receive all messages)
night	Boolean	N	Whether to receive night messages
timezone	String	N	Time zone

Request example

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

Response example (normal)

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

Response

It is returned as an HTTP status code and forwarded as body information.

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 general server errors - 4XX error codes used to represent client-side errors - 5xx error codes represent server-side errors

Get user token

Get the user's push token and the push receipt status.

Request URL

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

Request headers

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

Request path parameter

Parameter	Type	Required	Description
userId	String	Y	Member ID

Request example

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'

Response example (normal)

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

Response

It is returned as an HTTP status code and forwarded as body information.

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 general server errors - 4XX error codes 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
Get member API
Response
Get individual member information API
Response
Create member API
Response
Delete member API
Response
Restore member API
Response
Register user token
Response
Get user token
Response