Header	Description
x-project-id	- 대시보드 > 설정 > 일반 > 프로젝트 ID
x-api-key	- 대시보드 > 설정 > 일반 > API 키

파라미터	타입	필수 여부	설명
filter	String	O	필터링할 조건을 JSON 문자열로 전달합니다. 기본값은 `{}`입니다. 필터는 특정 필드에 대한 검색이 가능합니다.
sort	String	X	정렬 기준을 JSON 문자열로 정의합니다. 예를 들어, `{"createdAt":"-1"}`은 내림차순, `{"createdAt":"1"}`은 오름차순입니다.
option	String	X	추가 옵션을 JSON 문자열로 제공합니다.

Option 안내

파라미터	타입	필수 여부	설명
offset	Number	X	목록의 시작점
per_page	Number	X	페이지 당 보여줄 항목 수
count	Boolean	X	목록 대신 전체 수를 반환

요청 예시

curl -X 'GET' \
  'https://dashboard-api.ncloudchat.naverncp.com/v1/api/subscriptions?filter=%7B%22online%22%3Atrue%7D' \
  -H 'accept: application/json' \
  -H 'x-project-id: 339c2b1c-d35b-47f2-828d-xxxxxxxxx' \
  -H 'x-api-key: 4302925661f70ce7c14xxxxxxxxxxxxxxxxxxxx'

응답 예시 (정상)

응답은 구독 정보 목록을 JSON 배열 형태로 반환합니다.

[
  {
    "id": "5dd63a13-dad6-4a22-8a6c-xxxxxx",
    "project_id": "339c2b1c-d35b-47f2-828d-xxxxxx",
    "channel_id": "45ee8860-fa76-4861-9dc0-xxxxxx",
    "user_id": "userId",
    "online": true,
    "language": "en",
    "push": true,
    "mute": false,
    "user": {
      "name": "nickname_576976",
      "profile": "https://www.gravatar.com/avatar/2c7d99fe281ecd3bcd65ab915bac6dd5?s=25"
    },
    "mark": {
      "user_id": null,
      "message_id": null,
      "sort_id": null,
      "unread": null
    }
  },
  ...
]

응답

HTTP 상태 코드와 함께 응답이 반환됩니다.

HTTP 상태 코드	응답 메시지	설명
200	OK	요청이 성공적으로 처리됨
400	Bad Request	요청이 잘못되었을 경우 반환
500	Internal Server Error	서버 내부 오류가 발생했을 경우 반환

이 문서가 도움이 되었습니까?

What's Next

친구

구독 조회 API

구독

구독 조회 API

요청 URL

요청 헤더

요청 Path 파라미터

Option 안내

요청 예시

응답 예시 (정상)

응답

What's Next