회원

인쇄
공유
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