Channel

채널 API로 채널 정보 조회, 채널 관리자 조회, 채널 팔로워 조회, 채널 구독자를 조회할 수 있습니다.

채팅 API로 채팅 전송, 채팅 공지 등록, 채팅 설정 조회, 채팅 설정 변경을 할 수 있습니다. 채팅 API 중 채널 관리자 조회, 채널 팔로워 조회, 채널 구독자를 호출하려면 사용자 계정으로 인증하여 얻은 Access Token이 필요합니다. API Scope는 채널 관리자 조회, 채널 팔로워 조회, 채널 구독자 조회입니다.


채널 정보 조회

채널 정보를 조회할 수 있습니다. 채널 정보 조회 API를 호출하려면 애플리케이션 등록 후 Client 인증이 필요합니다. (Client 인증 API 참조)

HTTP Request
Description

GET /open/v1/channels

채널 정보 조회

Request Param

Field
Type
required
Description

channelIds

String[]

*

조회할 채널 ID 목록. 최대 20개까지 요청 가능

Response Body

Field
Type
Description

data

Object[]

요청한 채널 정보 목록. 일치하는 채널을 찾지 못할 경우 결과 미반환

channelId

String

채널 식별자

channelName

String

채널 이름

channelImageUrl

String

채널 이미지 URL

followerCount

Int

채널의 팔로워 수

verifiedMark

Boolean

채널 인증 마크 여부

채널 관리자 조회

채널 관리자를 조회할 수 있습니다.

HTTP Request
Description

GET /open/v1/channels/streaming-roles

채널 관리자 조회

Response Body

Field
Type
Description

data

Object[]

요청한 채널 관리자 목록

managerChannelId

String

관리자 채널 식별자

managerChannelName

String

관리자 채널 이름

userRole

String

관리자 역할

  • STREAMING_CHANNEL_OWNER - 채널 소유자

  • STREAMING_CHANNEL_MANAGER - 채널 관리자

  • STREAMING_CHAT_MANAGER - 채팅 운영자

  • STREAMING_SETTLEMENT_MANAGER - 정산 관리자

createdDate

Date

등록일

채널 팔로워 조회

채널의 팔로워 목록을 조회할 수 있습니다.

HTTP Request
Description

GET /open/v1/channels/followers

채널 팔로워 조회

Request Param

Field
Type
required
Description

page

Int

optional

요청하는 페이지. 0부터 시작

디폴트 값 : 0

size

Int

optional

조회할 카테고리 개수. 최소 1 ~ 최대 50 요청 가능 디폴트 값 : 30

Response Body

Field
Type
Description

data

Object[]

요청한 채널의 팔로워 목록

channelId

String

팔로워 채널 식별자

channelName

String

팔로워 채널 이름

createdDate

Date

팔로우 일자

채널 구독자 조회

채널의 구독자 목록을 조회할 수 있습니다.

HTTP Request
Description

GET /open/v1/channels/subscribers

채널 구독자 조회

Request Param

Field
Type
required
Description

page

Int

optional

요청하는 페이지. 0부터 시작

디폴트 값 : 0

size

Int

optional

조회할 카테고리 개수. 최소 1 ~ 최대 50 요청 가능 디폴트 값 : 30

sort

String

optional

정렬 방식

  • RECENT (최신 구독 순)

  • LONGER (구독 개월 순)

Response Body

Field
Type
Description

data

Object[]

요청한 채널의 구독자 목록

channelId

String

구독자 채널 식별자

channelName

String

구독자 채널 이름

month

Int

구독 개월 수

tierNo

Int

구독 상품

  • 1 (티어1 구독)

  • 2 (티어2 구독)

createdDate

Date

팔로우 일자

Last updated