채널 구독 목록 조회

Classic/VPC 환경에서 이용 가능합니다.

사용자의 채널 구독 정보를 조회합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드	URI
GET	/v1/api/subscriptions

요청 헤더

Ncloud Chat API에서 공통으로 사용하는 헤더에 대한 정보는 Ncloud Chat 요청 헤더를 참조해 주십시오.

요청 쿼리 파라미터

요청 쿼리 파라미터에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`filter`	String	Required	필터링 조건 응답 바디의 일부 필드를 기준으로 필터링 전체 일치하는 값만 필터링 조건이 없는 경우, 빈 값`{}` 입력 <예시> `{"channel_id":"{채널아이디}"}`, `{"user_id":"{사용자아이디}"}`, `{"online":true}`
`sort`	String	Optional	정렬 기준 `{기준:방식}` 형태로 입력 기준: 응답 바디의 String 타입 필드 방식: `-1` \| `1` `-1`: 내림차순 `1`: 오름차순 <예시> `{"created_at":"-1"}`: 생성 일시 기준 내림차순
`option`	String	Optional	추가 옵션: Option <예시> `{"offset":0,"per_page":20}`: 첫 번째 항목부터 20개 표시

Option

Option에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`offset`	Number	Optional	조회 시작 오프셋 0~N
`per_page`	Number	Optional	페이지당 항목 수 1~100
`count`	Boolean	Optional	목록 대신 응답 결과 수 표시 여부 `true` \| `false` `true`: 응답 결과 수 표시 `false`: 목록 표시

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request GET 'https://dashboard-api.ncloudchat.naverncp.com/v1/api/subscriptions
?filter=%7B%22user_id%22%3A%22NCP001%22%7D
&sort=%7B%22created_at%22%3A%22-1%22%7D
&option=%7B%22offset%22%3A0%2C%22per_page%22%3A20%7D' \
--header 'x-api-key: {API Key}' \
--header 'x-project-id: {Project ID}'

응답

응답 형식을 설명합니다.

응답 바디

응답 바디에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`id`	String	-	구독 고유 아이디
`project_id`	String	-	프로젝트 아이디
`channel_id`	String	-	채널 아이디
`user_id`	String	-	사용자 아이디
`online`	Boolean	-	온라인 여부 `true` \| `false` `true`: 온라인 `false`: 오프라인
`language`	String	-	접속 언어
`push`	Boolean	-	푸시 알림 허용 여부 `true` \| `false` `true`: 허용 `false`: 차단
`mute`	Boolean	-	채널 음소거 여부 `true` \| `false` `true`: 음소거 `false`: 음소거 안 함
`user`	Object	-	사용자 정보
`user.name`	String	-	사용자 이름
`user.profile`	String	-	사용자 프로필 이미지
`mark`	Object	-	마지막 메시지 정보
`mark.user_id`	String	-	발신자 아이디
`mark.message_id`	String	-	메시지 아이디
`mark.sort_id`	String	-	발신 일시 Unix Timestamp 형식
`mark.unread`	String	-	이후 읽지 않은 메시지 수

응답 상태 코드

Ncloud Chat API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Ncloud Chat 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.

[
    {
        "id": "78e6d8ca-****-****-****-6ebe51af5906",
        "project_id": "8be54b8b-****-****-****-84c0d5df2e9c",
        "channel_id": "17563b23-****-****-****-de11ce1ff34a",
        "user_id": "NCP001",
        "online": false,
        "language": "",
        "push": true,
        "mute": false,
        "user": {
            "name": "아기나무",
            "profile": ""
        },
        "mark": {
            "user_id": "NCP001",
            "message_id": "66a04**********b5b4d9e10",
            "sort_id": "1721780063170",
            "unread": 117
        }
    },
    {
        "id": "4fed04e9-****-****-****-dcd4c180079c",
        "project_id": "8be54b8b-****-****-****-84c0d5df2e9c",
        "channel_id": "a7adab41-****-****-****-961f661dcefd",
        "user_id": "NCP001",
        "online": false,
        "language": "",
        "push": true,
        "mute": false,
        "user": {
            "name": "아기나무",
            "profile": ""
        },
        "mark": {
            "user_id": "NCP001",
            "message_id": "",
            "sort_id": "",
            "unread": 24
        }
    }
]