--- updatedAt: 2025-02-13T23:29:34.000Z agentTools: projectIndex: https://kollus-live.readme.io/llms.txt --- # 채널 정보 채널 키를 사용하여 채널 정보를 조회합니다.

접근 가능한 권한: 최고관리자, 관리자, 운영자 # OpenAPI definition ```json { "openapi": "3.0.3", "info": { "title": "Kollus Live API (KR)", "description": "\n

Usage

\n
    \n
  1. 일반적인 Oauth2 API Spec 을 준수합니다.
    2. \n
  2. API 인증을 위해 Client_ID, Client_Secret 등이 필요합니다. Kollus Live Console 에서 발급 하실수 있습니다.
    3. \n
  3. 이 API 문서페이지(Swagger UI) 테스트하려면 Kollus Live Console 에서 Client 생성시 Redirect URL 에\n'https://live-kr.kollus.com/api/oauth2-callback' 를 등록해야 합니다.
    4. \n
  4. Kollus Live Console 에서 Client 생성/수정시 Redirect URL 가 복수개일 경우 ',' 를 구분자로 복수개를 입력할 수 있습니다.
    5. \n
  5. Update 관련 API 는 수정하려는 필드만 반영됩니다.\n이 API 문서페이지(Swagger UI)에서는 테스트 할 경우 자칫 수정하려는 필드대신 다른필드가 수정될 수 있습니다.
    \nUpdate Api 는 되도록이면 이 API 문서페이지(Swagger UI)에서는 테스트를 삼가하시길 바랍니다.
    6. \n
  6. API 호출은 1분당 60번만 가능합니다. 연속적으로 API 호출을 할때에는 최소 1초의 인터벌을 주시길 바랍니다.
    7. \n
\n

Supported Credentials

\n\n

Scope List

\n

Access Token 요청시 Scope 를 명시해야 합니다. 복수의 Scope 는 ' '(공백)으로 구분자로 문자열을 만듭니다. ex) 'live:control live:statistics'

\n\n

Role List

\n

API 를 사용하는 유저의 role 에 따라 API 접근도 제한됩니다. API 문서 설명부분에 허가되는 role 에 대해 설명이 있습니다.

\n\n", "contact": {}, "version": "1.0" }, "servers": [ { "url": "https://api-live-kr.kollus.com/api", "description": "Kollus Live API" } ], "paths": { "/v1/live/service-accounts/{service_account_key}/channels/{channel_key}": { "get": { "tags": [ "채널 관리" ], "summary": "채널 정보", "description": "채널 키를 사용하여 채널 정보를 조회합니다.

접근 가능한 권한: 최고관리자, 관리자, 운영자", "operationId": "5acdb8ad22b5f1588fb659df5b739365", "parameters": [ { "name": "service_account_key", "in": "path", "description": "서비스 계정 키", "required": true, "schema": { "type": "string" } }, { "name": "channel_key", "in": "path", "description": "채널 키", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ApiOpenLiveMediaChannel" } }, "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthenticated" }, "404": { "description": "Not found" }, "422": { "description": "Unprocessable entity" } }, "security": [ { "kollus_oauth2": [ "live:control" ] } ] } } }, "components": { "schemas": { "ApiOpenChattingService": { "description": "채팅 계약", "properties": { "id": { "description": "아이디", "type": "integer" }, "kind": { "description": "정책", "properties": { "type": { "description": "종류 - chatroll, kollus", "type": "string" }, "value": { "description": "값 - 1: chatroll, 2: 콜러스", "type": "integer" } }, "type": "object" }, "info": { "description": "채팅 서비스 정보, 서비스 종류마다 데이터 구조가 다릅니다." } }, "type": "object" }, "ApiOpenLiveCreator": { "description": "라이브 Creator", "properties": { "id": { "description": "아이디", "type": "integer" }, "nickname": { "description": "닉네임", "type": "string" }, "code": { "description": "코드", "type": "string" }, "stream_key": { "description": "스트림키", "type": "string" }, "created_at": { "description": "생성일", "type": "string" }, "updated_at": { "description": "수정일", "type": "string" } }, "type": "object" }, "ApiOpenLiveMediaBroadcastItem": { "description": "라이브 방송", "properties": { "id": { "description": "아이디", "type": "integer" }, "key": { "description": "방송키", "type": "string" }, "title": { "description": "제목", "type": "string" }, "is_onair": { "description": "방송 상태", "type": "boolean" }, "subscribe_url": { "description": "구독 URL", "type": "string" }, "duration": { "description": "방송 시간", "type": "string" }, "counting_number": { "description": "방송 회차", "type": "integer" }, "creator": { "$ref": "#/components/schemas/ApiOpenLiveCreator" }, "duplicate_recording_state": { "description": "수동 녹화 상태", "properties": { "type": { "description": "종류 - duplicate_recording_stopped, duplicate_recording_started", "type": "string" }, "value": { "description": "값 - 0: 수동 녹화 종료, 1: 수동 녹화 시작", "type": "integer" } }, "type": "object" }, "started_at": { "description": "시작 시간", "type": "string" }, "paused_at": { "description": "중지 시간", "type": "string" }, "ended_at": { "description": "종료 시간", "type": "string" }, "created_at": { "description": "생성일", "type": "string" }, "updated_at": { "description": "수정일", "type": "string" } }, "type": "object" }, "ApiOpenLiveMediaChannel": { "description": "라이브 채널 (라이브 방송 포함)", "properties": { "id": { "description": "아이디", "type": "integer" }, "key": { "description": "채널키", "type": "string" }, "title": { "description": "채널명", "type": "string" }, "customer_code": { "description": "고객 코드", "type": "string" }, "concurrently_viewer_limit": { "description": "동시 시청자 수 제한", "type": "integer" }, "kind": { "description": "채널 종류", "properties": { "type": { "description": "종류 - general, programming", "type": "string" }, "value": { "description": "값 - 0: 실시간 방송 1: 녹화 방송", "type": "integer" } } }, "is_shared": { "description": "공개 여부", "type": "boolean" }, "profile_group": { "$ref": "#/components/schemas/ApiOpenLiveMediaProfileGroup" }, "creators": { "description": "라이브 Creator", "type": "array", "items": { "$ref": "#/components/schemas/ApiOpenLiveCreator" } }, "latest_broadcast": { "$ref": "#/components/schemas/ApiOpenLiveMediaBroadcastItem" }, "meta_title_pattern": { "description": "메타 정보 제목", "type": "string" }, "meta_description": { "description": "메타 정보 내용", "type": "string" }, "logo_url": { "description": "로고 URL", "type": "string" }, "idle_screen_url": { "description": "대기화면 URL", "type": "string" }, "idle_screen_kind": { "description": "대기 화면", "properties": { "type": { "description": "종류 - poster, snapshot", "type": "string" }, "value": { "description": "값 - 0: 포스터 1: 스냅샷", "type": "integer" } }, "type": "object" }, "publish_url": { "description": "어플리케이션", "type": "string" }, "video_gateway_url": { "description": "비디오 게이트웨이 링크", "type": "string" }, "recording_file_policy": { "description": "녹화 파일 저장 방식", "properties": { "type": { "description": "종류 - not_used, segment_recording, segment_and_duplicate_recording", "type": "string" }, "value": { "description": "값 - 0: 사용 안함 1: 자동 저장 사용함 3: 자동 저장 + 수동 저장 사용함", "type": "integer" } }, "type": "object" }, "recording_file_pattern": { "description": "녹화 파일 저장 규칙", "type": "string" }, "recording_file_segment_policy": { "description": "녹화 파일 종류", "properties": { "type": { "description": "종류- by_size, by_duration", "type": "string" }, "value": { "description": "값 - 1: 맥시멈 용량 저장(4G), 2: 인터벌 타임 저장", "type": "integer" } }, "type": "object" }, "recording_file_segment_by_size": { "description": "맥시멈 용량 저장(Mib)", "type": "integer" }, "recording_file_segment_by_duration": { "description": "인터벌 저장 시간(분)", "type": "integer" }, "media_player_policy": { "description": "전용 플레이어", "properties": { "type": { "description": "종류 - auto_detect, force_exclusive_player", "type": "string" }, "value": { "description": "값 - 0: 없음 1: 전용 플레이어", "type": "integer" } }, "type": "object" }, "use_chatting_service": { "description": "채팅 사용 여부", "type": "boolean" }, "chatting_service": { "$ref": "#/components/schemas/ApiOpenChattingService" }, "division_delayed_minutes": { "description": "스트리밍 단절 시간", "type": "integer" }, "use_duplicate_block": { "description": "중복 재생 차단", "type": "boolean" }, "use_capture_block": { "description": "녹화/캡쳐 차단(전용 플레이어)", "type": "boolean" }, "use_timeshift": { "description": "타임시프트 사용", "type": "boolean" }, "use_broadcast_update_callback": { "description": "라이브 콜백 사용 여부", "type": "boolean" }, "broadcast_update_callback_url": { "description": "라이브 콜백 URL", "type": "string" }, "use_recording_file_transfer_callback": { "description": "녹화 파일 전송 콜백 사용 여부", "type": "boolean" }, "recording_file_transfer_callback_url": { "description": "녹화 파일 전송 콜백 URL", "type": "string" }, "use_lms_callback": { "description": "Lms 콜백 사용 여부", "type": "boolean" }, "lms_callback_url": { "description": "Lms 콜백 URL", "type": "string" }, "use_play_callback": { "description": "Play 콜백 사용 여부", "type": "boolean" }, "play_callback_url": { "description": "Play 콜백 URL", "type": "string" }, "use_referer_check": { "description": "레퍼러 설정 0: 비활성화, 1: 특정 도메인에서만 재생 허용, 2: 특정 도메인에서의 재생 차단", "type": "integer", "enum": [ 0, 1, 2 ] }, "referer_check_domains": { "description": "허용할 도메인 목록 (, 로 구분)", "type": "string" }, "referer_reject_domains": { "description": "차단할 도메인 목록 (, 로 구분)", "type": "string" }, "status": { "description": "채널 상태 - true: enable, false: disable", "type": "boolean" }, "hided_at": { "description": "숨긴 시간", "type": "string" }, "created_at": { "description": "생성일", "type": "string" }, "updated_at": { "description": "수정일", "type": "string" } }, "type": "object" }, "ApiOpenLiveMediaProfileGroup": { "description": "라이브 인코딩 프로파일 그룹", "properties": { "id": { "description": "아이디", "type": "integer" }, "name": { "description": "그룹명", "type": "string" }, "key": { "description": "그룹 키", "type": "string" }, "group_type": { "description": "그룹 타입", "properties": { "type": { "description": "타입명", "type": "string" }, "value": { "description": "타입값", "type": "integer" } } }, "screen_type": { "description": "형태 - 세로, 가로", "type": "string" }, "created_at": { "description": "생성일", "type": "string" }, "updated_at": { "description": "수정일", "type": "string" } }, "type": "object" } }, "securitySchemes": { "kollus_oauth2": { "type": "oauth2", "description": "Kollus oauth2 security.", "flows": { "authorizationCode": { "authorizationUrl": "https://live-kr.kollus.com/oauth/authorize", "tokenUrl": "https://live-kr.kollus.com/oauth/token", "refreshUrl": "https://live-kr.kollus.com/token/refresh", "scopes": { "live:control": "Live Control", "live:statistics": "Live Statistics" } }, "clientCredentials": { "tokenUrl": "https://live-kr.kollus.com/oauth/token", "refreshUrl": "https://live-kr.kollus.com/token/refresh", "scopes": { "live:creator": "Live Creator App", "platform-app": "Platform Api Actions" } } } } } }, "x-readme": { "explorer-enabled": true, "proxy-enabled": true } } ```