Live
Last updated
Last updated
๋ผ์ด๋ธ API๋ก ์ ์ฒด ๋ผ์ด๋ธ ๋ชฉ๋ก ์กฐํ, ๋ฐฉ์ก ์คํธ๋ฆผํค ์กฐํ, ๋ฐฉ์ก ์ค์ ์กฐํ, ๋ฐฉ์ก ์ค์ ์ ๋ณ๊ฒฝํ ์ ์์ต๋๋ค.
๋ผ์ด๋ธ API ์ค ์๋ API Scope๋ฅผ ํธ์ถํ๋ ค๋ฉด ์ฌ์ฉ์ ๊ณ์ ์ผ๋ก ์ธ์ฆํ์ฌ ์ป์ Access Token์ด ํ์ํฉ๋๋ค.
API Scope๋ ๋ฐฉ์ก ์คํธ๋ฆผํค ์กฐํ
, ๋ฐฉ์ก ์ค์ ์กฐํ
, ๋ฐฉ์ก ์ค์ ๋ณ๊ฒฝ
์
๋๋ค.
ํ์ฌ ์งํ ์ค์ธ ๋ผ์ด๋ธ์ ์ ์ฒด ๋ชฉ๋ก์ ์กฐํํ ์ ์์ต๋๋ค. ๋ผ์ด๋ธ ๋ชฉ๋ก ์กฐํ API๋ฅผ ํธ์ถํ๋ ค๋ฉด ์ ํ๋ฆฌ์ผ์ด์ ๋ฑ๋ก ํ Client ์ธ์ฆ์ด ํ์ํฉ๋๋ค. ()
GET /open/v1/lives
๋ผ์ด๋ธ ๋ชฉ๋ก ์กฐํ
Request Param
size
Int
Optional
์กฐํํ ๋ผ์ด๋ธ ๊ฐ์. ์ต์ 1 ~ ์ต๋ 20 ์์ฒญ ๊ฐ๋ฅ ๋ํดํธ ๊ฐ : 20
next
String
Optional
๋ค์ ๋ชฉ๋ก์ ํธ์ถํ๊ธฐ ์ํ ๊ฐ์ ๋๋ค. api ์๋ต ์ค page.next ๊ฐ์ ํตํด ํธ์ถ ๊ฐ๋ฅ
Response Body
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
๋ค์ ๋ชฉ๋ก ํธ์ถ์ ์ํ ๊ฐ
์คํธ๋ฆฌ๋ฐ ์ฑ๋์ ์คํธ๋ฆผํค๋ฅผ ์กฐํํ ์ ์์ต๋๋ค.
GET /open/v1/streams/key
๋ฐฉ์ก ์คํธ๋ฆผํค ์กฐํ
Response Body
streamKey
String
์คํธ๋ฆผํค ๊ฐ
์คํธ๋ฆฌ๋ฐ ์ฑ๋์ ๋ฐฉ์ก ์ค์ ์ ์กฐํํ ์ ์์ต๋๋ค.
GET /open/v1/lives/setting
๋ฐฉ์ก ์ค์ ์กฐํ
Response Body
defaultLiveTitle
String
๋ผ์ด๋ธ ์ ๋ชฉ
category
Object
๋ผ์ด๋ธ ์นดํ ๊ณ ๋ฆฌ
categoryType
String
์นดํ ๊ณ ๋ฆฌ ์ข ๋ฅ
GAME
SPORTS
ETC
categoryId
String
์นดํ ๊ณ ๋ฆฌ ์๋ณ์
categoryValue
String
์นดํ ๊ณ ๋ฆฌ ์ด๋ฆ
posterImageUrl
String
์นดํ ๊ณ ๋ฆฌ ์ด๋ฏธ์ง URL
tags
String[]
๋ผ์ด๋ธ ํ๊ทธ ๋ชฉ๋ก
์คํธ๋ฆฌ๋ฐ ์ฑ๋์ ๋ฐฉ์ก ์ค์ ์ ๋ณ๊ฒฝํ ์ ์์ต๋๋ค. ์ค์ ๋ณ๊ฒฝ ์ API ์์ฒญ์ ํตํด ํ์ํ ํน์ ๊ฐ๋ง ๋ณ๊ฒฝํ๋ ๊ฒ๋ ๊ฐ๋ฅํฉ๋๋ค.
PATCH /open/v1/lives/setting
๋ฐฉ์ก ์ค์ ๋ณ๊ฒฝ
Request Body
defaultLiveTitle
String
optional
๋ผ์ด๋ธ ์ ๋ชฉ. ๋น ๊ฐ์ผ๋ก ์ค์ ๋ถ๊ฐ
categoryType
String
optional
์นดํ ๊ณ ๋ฆฌ ์ข ๋ฅ. ์ ํจํ ์นดํ ๊ณ ๋ฆฌ ์ข ๋ฅ๋ก๋ง ์ค์ ๊ฐ๋ฅ
GAME
SPORTS
ETC
categoryId
String
optional
์นดํ ๊ณ ๋ฆฌ ์๋ณ์. ์ ํจํ ์นดํ ๊ณ ๋ฆฌ ์ข ๋ฅ๋ก๋ง ์ค์ ๊ฐ๋ฅ. ""์ผ๋ก ์ ์กํ ๊ฒฝ์ฐ ์นดํ ๊ณ ๋ฆฌ ์ค์ ์ ๊ฑฐ
tags
String[]
optional
๋ผ์ด๋ธ ํ๊ทธ ๋ชฉ๋ก. empty list๋ก ์ ์กํ ๊ฒฝ์ฐ ํ๊ทธ ์ค์ ์ ๊ฑฐ. ๊ณต๋ฐฑ ๋ฐ ํน์๋ฌธ์ ๋นํ์ฉ