Live

라이브 API로 전체 라이브 목록 조회, 방송 스트림키 조회, 방송 설정 조회, 방송 설정을 변경할 수 있습니다. 라이브 API 중 아래 API Scope를 호출하려면 사용자 계정으로 인증하여 얻은 Access Token이 필요합니다. API Scope는 방송 스트림키 조회, 방송 설정 조회, 방송 설정 변경입니다.


라이브 목록 조회

현재 진행 중인 라이브의 전체 목록을 조회할 수 있습니다. 라이브 목록 조회 API를 호출하려면 애플리케이션 등록 후 Client 인증이 필요합니다. (Client 인증 API 참조)

HTTP Request
Description

GET /open/v1/lives

라이브 목록 조회

Request Param

Field
Type
Required
Description

size

Int

Optional

조회할 라이브 개수. 최소 1 ~ 최대 20 요청 가능 디폴트 값 : 20

next

String

Optional

다음 목록을 호출하기 위한 값입니다. api 응답 중 page.next 값을 통해 호출 가능

Response Body

Field
Type
Description

data

Object[]

라이브 목록 결과. 시청자 수 높은 순 정렬

liveId

Int

라이브 식별자

liveTitle

String

라이브 제목

liveThumbnailImageUrl

String

라이브 썸네일로 사용되는 이미지 URL

concurrentUserCount

Int

라이브 현재 시청자 수

openDate

String

라이브 시작 시간

adult

boolean

연령 제한 설정 여부

tags

String[]

라이브에 설정된 태그 목록

categoryType

String

카테고리 종류

  • GAME

  • SPORTS

  • ETC

liveCategory

String

라이브 카테고리 식별자

liveCategoryValue

String

라이브 카테고리 이름

channelId

String

채널 ID(채널 식별자)

channelName

String

채널명

channelImageUrl

String

채널 이미지 URL

page

Object

next

String

다음 목록 호출을 위한 값

방송 스트림키 조회

스트리밍 채널의 스트림키를 조회할 수 있습니다.

HTTP Request
Description

GET /open/v1/streams/key

방송 스트림키 조회

Response Body

Field
Type
Description

streamKey

String

스트림키 값

방송 설정 조회

스트리밍 채널의 방송 설정을 조회할 수 있습니다.

HTTP Request
Description

GET /open/v1/lives/setting

방송 설정 조회

Response Body

Field
Type
Description

defaultLiveTitle

String

라이브 제목

category

Object

라이브 카테고리

categoryType

String

카테고리 종류

  • GAME

  • SPORTS

  • ETC

categoryId

String

카테고리 식별자

categoryValue

String

카테고리 이름

posterImageUrl

String

카테고리 이미지 URL

tags

String[]

라이브 태그 목록

방송 설정 변경

스트리밍 채널의 방송 설정을 변경할 수 있습니다. 설정 변경 시 API 요청을 통해 필요한 특정 값만 변경하는 것도 가능합니다.

HTTP Request
Description

PATCH /open/v1/lives/setting

방송 설정 변경

Request Body

Field
Type
Required
Description

defaultLiveTitle

String

optional

라이브 제목. 빈 값으로 설정 불가

categoryType

String

optional

카테고리 종류. 유효한 카테고리 종류로만 설정 가능

  • GAME

  • SPORTS

  • ETC

categoryId

String

optional

카테고리 식별자. 유효한 카테고리 종류로만 설정 가능. ""으로 전송할 경우 카테고리 설정 제거

tags

String[]

optional

라이브 태그 목록. empty list로 전송할 경우 태그 설정 제거. 공백 및 특수문자 비허용

Last updated