CHZZK
  • ์‹œ์ž‘ํ•˜๊ธฐ
    • About CHZZK Developers
    • ๐Ÿ†•Updates
  • CHZZK API
    • Authorization
    • ์ฐธ๊ณ ์‚ฌํ•ญ
    • Session
    • User
    • Channel
    • Category
    • Live
    • Chat
    • Drops
  • DROPS
    • ๋“œ๋กญ์Šค ๊ฐœ์š”
    • ๋“œ๋กญ์Šค ์—ฐ๋™ ๋ฐ ์ ˆ์ฐจ
    • Webhook Event
    • ๋“œ๋กญ์Šค ์บ ํŽ˜์ธ ์ƒ์„ฑ ๋ฐ ๊ด€๋ฆฌ ๊ฐ€์ด๋“œ
  • Resources
    • Brand Guides
    • Chzzk AD
Powered by GitBook
On this page
  • ๋ผ์ด๋ธŒ ๋ชฉ๋ก ์กฐํšŒ
  • ๋ฐฉ์†ก ์ŠคํŠธ๋ฆผํ‚ค ์กฐํšŒ
  • ๋ฐฉ์†ก ์„ค์ • ์กฐํšŒ
  • ๋ฐฉ์†ก ์„ค์ • ๋ณ€๊ฒฝ
  1. CHZZK API

Live

PreviousCategoryNextChat

Last updated 4 months ago

๋ผ์ด๋ธŒ API๋กœ ์ „์ฒด ๋ผ์ด๋ธŒ ๋ชฉ๋ก ์กฐํšŒ, ๋ฐฉ์†ก ์ŠคํŠธ๋ฆผํ‚ค ์กฐํšŒ, ๋ฐฉ์†ก ์„ค์ • ์กฐํšŒ, ๋ฐฉ์†ก ์„ค์ •์„ ๋ณ€๊ฒฝํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. ๋ผ์ด๋ธŒ API ์ค‘ ์•„๋ž˜ API Scope๋ฅผ ํ˜ธ์ถœํ•˜๋ ค๋ฉด ์‚ฌ์šฉ์ž ๊ณ„์ •์œผ๋กœ ์ธ์ฆํ•˜์—ฌ ์–ป์€ Access Token์ด ํ•„์š”ํ•ฉ๋‹ˆ๋‹ค. API Scope๋Š” ๋ฐฉ์†ก ์ŠคํŠธ๋ฆผํ‚ค ์กฐํšŒ, ๋ฐฉ์†ก ์„ค์ • ์กฐํšŒ, ๋ฐฉ์†ก ์„ค์ • ๋ณ€๊ฒฝ์ž…๋‹ˆ๋‹ค.


๋ผ์ด๋ธŒ ๋ชฉ๋ก ์กฐํšŒ

ํ˜„์žฌ ์ง„ํ–‰ ์ค‘์ธ ๋ผ์ด๋ธŒ์˜ ์ „์ฒด ๋ชฉ๋ก์„ ์กฐํšŒํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. ๋ผ์ด๋ธŒ ๋ชฉ๋ก ์กฐํšŒ API๋ฅผ ํ˜ธ์ถœํ•˜๋ ค๋ฉด ์• ํ”Œ๋ฆฌ์ผ€์ด์…˜ ๋“ฑ๋ก ํ›„ Client ์ธ์ฆ์ด ํ•„์š”ํ•ฉ๋‹ˆ๋‹ค. ()

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๋กœ ์ „์†กํ•  ๊ฒฝ์šฐ ํƒœ๊ทธ ์„ค์ • ์ œ๊ฑฐ. ๊ณต๋ฐฑ ๋ฐ ํŠน์ˆ˜๋ฌธ์ž ๋น„ํ—ˆ์šฉ

Client ์ธ์ฆ API ์ฐธ์กฐ