Developers
로그인

라이브 API

라이브 목록 조회

현재 진행 중인 라이브 방송 목록을 조회합니다. 커서 기반 페이지네이션을 사용합니다.

GET /api/openapi/open/v1/lives

  • 인증: Client ID/Secret

Query 파라미터

파라미터 타입 기본값 설명
size number 20 페이지 크기 (1~20)
next string - 다음 페이지 커서 값.

응답 (content.data 배열 항목)

필드 타입 설명
liveId string 라이브 ID
liveTitle string 라이브 제목
liveThumbnailImageUrl string | null 라이브 썸네일 이미지 URL
concurrentUserCount number 동시 시청자 수
openedDate string | null 라이브 시작 시간 (ISO 8601)
adult boolean 연령 제한 설정 여부
tags string[] 태그 목록
categoryType string | null 카테고리 타입.
liveCategory string | null 카테고리 식별자.
liveCategoryValue string | null 카테고리 이름
channelId string 채널 ID
channelName string 채널 이름
channelHandle string 채널 핸들 (슬러그)
channelImageUrl string | null 채널 이미지 URL

content.page.next가 null이면 마지막 페이지입니다.

라이브 설정 조회

인증된 사용자 채널의 라이브 설정을 조회합니다.

GET /api/openapi/open/v1/lives/setting

  • 인증: Access Token (Bearer)
  • 필요 Scope: READ:LIVE_STREAM_SETTINGS

응답

필드 타입 설명
defaultLiveTitle string 라이브 제목
category object | null 카테고리 정보.
tags string[] 태그 목록

category 객체 필드

필드 타입 설명
categoryId string 카테고리 ID (카테고리 코드)
categoryType string 카테고리 타입. categoryId와 동일한 값(카테고리 코드)입니다.
categoryValue string 카테고리 이름
posterImageUrl string | null 카테고리 이미지 URL

라이브 설정 변경

인증된 사용자 채널의 라이브 설정을 변경합니다. 전달된 필드만 업데이트됩니다.

PATCH /api/openapi/open/v1/lives/setting

  • 인증: Access Token (Bearer)
  • 필요 Scope: WRITE:LIVE_STREAM_SETTINGS

요청 본문

전달된 필드만 업데이트됩니다. 모든 필드는 선택사항입니다.

파라미터 타입 필수 설명
defaultLiveTitle string - 라이브 제목 (1~100자)
tags string[] - 태그 목록 (최대 6개)
categoryId string | null - 카테고리 ID. null로 설정 시 카테고리 제거

응답

변경이 반영된 후의 라이브 설정을 반환합니다.

필드 타입 설명
defaultLiveTitle string 라이브 제목
categoryType string | null 카테고리 타입. categoryId와 동일한 값(카테고리 코드)이며, 카테고리가 없으면 null
categoryId string | null 카테고리 식별자(카테고리 코드). 카테고리가 없으면 null
tags string[] 태그 목록

스트림 키 조회

인증된 사용자 채널의 스트림 키를 조회합니다. OBS 등 방송 도구 연동 시 사용합니다.

GET /api/openapi/open/v1/streams/key

  • 인증: Access Token (Bearer)
  • 필요 Scope: READ:LIVE_STREAM_KEY

응답

필드 타입 설명
streamKey string 스트림 키

라이브 상태 조회

특정 채널의 라이브 방송 여부를 확인합니다. 인증이 필요 없는 공개 API입니다.

GET /api/openapi/v1/{channelId}/live-status

  • 인증: 불필요

응답

필드 타입 설명
isLive boolean 라이브 방송 여부
title string | null 라이브 제목
openedAt string | null 라이브 시작 시간 (ISO 8601)

에러 응답

성공 응답은 { code, message, content } 래퍼 형식이지만, 에러 응답 { statusCode, message, error }로 내려갑니다.

상황 상태 코드
인증 실패 또는 Scope 부족 401
라이브 등 리소스 미존재 404
잘못된 커서(next) 등 잘못된 요청 400 
{
  "statusCode": 404,
  "message": "Live not found",
  "error": "Not Found"
}