{ "openapi": "3.0.3", "info": { "title": "Live API リファレンス", "description": "- **API 接続トークン**: Live API ガイド - 認証方式 \n - **識別キー情報**: 認証および主要キー\n - **公式ドキュメント**: Kollus Docs", "contact": { "name": "お問い合わせ", "email": "jp_sales@catenoid.net" }, "license": { "name": "サービス利用規約", "url": "https://catenoid-support.gitbook.io/terms_of_service" }, "version": "1.0" }, "servers": [ { "url": "https://api-live-jp.kollus.com/api" } ], "tags": [ { "name": "サービス契約情報照会" }, { "name": "エンコーディングプロファイル管理" }, { "name": "チャンネル管理" }, { "name": "Creator 管理" }, { "name": "ライブ配信管理" }, { "name": "編成管理" }, { "name": "シンジケーション管理" }, { "name": "チャット管理" }, { "name": "録画ファイル転送先管理" }, { "name": "録画ファイル管理" }, { "name": "統計", "description": "- **基準タイムゾーン**: すべてのデータは UTC 基準です。 \n- **更新タイミング**: すべてのデータはライブ配信終了の 約30分後 から確認できます。" } ], "paths": { "/v1/live/service-accounts/{service_account_key}/contracts": { "get": { "tags": [ "サービス契約情報照会" ], "summary": "サービス契約情報照会", "description": "[ **アクセス可能なロール**: 最高管理者 ]\n\n 契約の詳細情報を照会します。", "operationId": "67ce4976bc74feb04e1e46c84fbc6a57", "parameters": [ { "name": "service_account_key", "in": "path", "description": "サービスアカウントキー", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ApiOpenLiveContract" } }, "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthenticated" }, "404": { "description": "Not found" } }, "security": [ { "kollus_oauth2": [ "live:control" ] } ] } }, "/v1/live/service-accounts/{service_account_key}/chatting-services": { "get": { "tags": [ "サービス契約情報照会" ], "summary": "チャットサービス契約情報照会", "description": "チャットサービス契約の詳細情報を照会します。", "operationId": "d142e2226e243388b38c165d745c62d4", "parameters": [ { "name": "service_account_key", "in": "path", "description": "サービスアカウントキー", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ApiOpenChattingService" } } }, "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthenticated" }, "404": { "description": "Not found" } }, "security": [ { "kollus_oauth2": [ "live:control" ] } ] } }, "/v1/live/service-accounts/{service_account_key}/profile-groups": { "get": { "tags": [ "エンコーディングプロファイル管理" ], "summary": "エンコーディングプロファイルグループリスト照会", "description": "システムに登録された全エンコーディングプロファイルグループのリストを照会します。", "operationId": "fd1e5c0c1208df2b154a64f4d3250e36", "parameters": [ { "name": "service_account_key", "in": "path", "description": "サービスアカウントキー", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ApiOpenLiveMediaProfileGroup" } } }, "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthenticated" }, "404": { "description": "Not found" } }, "security": [ { "kollus_oauth2": [ "live-api:console-control" ] } ] } }, "/v1/live/service-accounts/{service_account_key}/profile-groups/{live_media_profile_group_key}/profiles": { "get": { "tags": [ "エンコーディングプロファイル管理" ], "summary": "エンコーディングプロファイルリスト照会", "description": "特定のプロファイルグループ内に含まれる全エンコーディングプロファイルのリストを照会します。", "operationId": "b665d2e469bccd943dcbb7caedc764dd", "parameters": [ { "name": "service_account_key", "in": "path", "description": "サービスアカウントキー", "required": true, "schema": { "type": "string" } }, { "name": "live_media_profile_group_key", "in": "path", "description": "エンコーディングプロファイルグループキー", "required": true, "schema": { "type": "string" } }, { "name": "video_screen_type", "in": "query", "description": "ビデオ画面の向き (`landscape`: 幅, `portrait`: 高さ)", "schema": { "type": "string", "default": "landscape", "enum": [ "landscape", "portrait" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ApiOpenLiveMediaProfile" } } }, "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthenticated" }, "404": { "description": "Not found" } }, "security": [ { "kollus_oauth2": [ "live:control" ] } ] } }, "/v1/live/service-accounts/{service_account_key}/profile-groups/{live_media_profile_group_key}/profiles/{live_media_profile_id}/attach": { "put": { "tags": [ "エンコーディングプロファイル管理" ], "summary": "エンコーディングプロファイル有効化", "description": "[ **アクセス可能なロール**: 最高管理者 ]\n\n 特定のエンコーディングプロファイルをライブ配信時に使用できるよう有効化します。サービスアカウントあたり最大3つまで同時に有効化できます。", "operationId": "2a51ebe989ca19d215bf7acd63ac6d39", "parameters": [ { "name": "service_account_key", "in": "path", "description": "サービスアカウントキー", "required": true, "schema": { "type": "string" } }, { "name": "live_media_profile_group_key", "in": "path", "description": "エンコーディングプロファイルグループキー", "required": true, "schema": { "type": "string" } }, { "name": "live_media_profile_id", "in": "path", "description": "エンコーディングプロファイルID", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "description": "OK" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthenticated" }, "404": { "description": "Not found" }, "422": { "description": "Unprocessable entity" } }, "security": [ { "kollus_oauth2": [ "live:control" ] } ] } }, "/v1/live/service-accounts/{service_account_key}/profile-groups/{live_media_profile_group_key}/profiles/{live_media_profile_id}/detach": { "put": { "tags": [ "エンコーディングプロファイル管理" ], "summary": "エンコーディングプロファイル無効化", "description": "[ **アクセス可能なロール**: 最高管理者 ]\n\n 有効なエンコーディングプロファイルを無効化します。アカウント内で最低1つのプロファイルはアクティブな状態を維持する必要があります。", "operationId": "f6873b46af6ebf8e8a2151cc9b9ffb1b", "parameters": [ { "name": "service_account_key", "in": "path", "description": "サービスアカウントキー", "required": true, "schema": { "type": "string" } }, { "name": "live_media_profile_group_key", "in": "path", "description": "エンコーディングプロファイルグループキー", "required": true, "schema": { "type": "string" } }, { "name": "live_media_profile_id", "in": "path", "description": "エンコーディングプロファイルID", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "description": "OK" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthenticated" }, "404": { "description": "Not found" }, "422": { "description": "Unprocessable entity" } }, "security": [ { "kollus_oauth2": [ "live:control" ] } ] } }, "/v1/live/service-accounts/{service_account_key}/channels": { "get": { "tags": [ "チャンネル管理" ], "summary": "チャンネルリスト照会", "description": "全チャンネルのリストを照会します。クエリパラメーターを活用して結果をフィルタリングできます。", "operationId": "8b09ca1457b528b823c66d698beba686", "parameters": [ { "name": "service_account_key", "in": "path", "description": "サービスアカウントキー", "required": true, "schema": { "type": "string" } }, { "name": "keyword", "in": "query", "description": "検索キーワードフィルタリング", "schema": { "type": "string" } }, { "name": "order", "in": "query", "description": "データ表示順", "schema": { "type": "string", "default": "id_desc", "enum": [ "id_desc", "id_asc", "customer_code_desc", "customer_code_asc", "title_desc", "title_asc", "hided_at_desc", "hided_at_asc" ] } }, { "name": "page", "in": "query", "description": "取得ページ番号", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "description": "1ページに表示する個数", "schema": { "type": "integer", "default": 10 } }, { "name": "live_status", "in": "query", "description": "チャンネル有効化ステータスフィルタリング", "schema": { "type": "string", "default": "all", "enum": [ "all", "on", "off" ] } }, { "name": "shared_status", "in": "query", "description": "チャンネル公開ステータスフィルタリング\n- `on`: 公開チャンネルのみ照会", "schema": { "type": "string", "default": "all", "enum": [ "all", "on", "off" ] } }, { "name": "trashed", "in": "query", "description": "チャンネル非表示ステータスフィルタリング\n- `1`: 非表示チャンネルのみ照会", "schema": { "type": "integer", "default": 0, "enum": [ 0, 1 ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ApiOpenLiveMediaChannel" } }, "links": { "properties": { "first": { "type": "string" }, "last": { "type": "string" }, "prev": { "type": "string" }, "next": { "type": "string" } }, "type": "object" }, "meta": { "properties": { "current_page": { "type": "integer" }, "from": { "type": "integer" }, "last_page": { "type": "integer" }, "path": { "type": "string" }, "per_page": { "type": "integer" }, "to": { "type": "integer" }, "total": { "type": "integer" } }, "type": "object" } }, "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthenticated" }, "404": { "description": "Not found" } }, "security": [ { "kollus_oauth2": [ "live:control" ] } ] }, "post": { "tags": [ "チャンネル管理" ], "summary": "新規チャンネル登録", "description": "[ **アクセス可能なロール**: 最高管理者 ]\n\n 新しいライブチャンネルを登録します。チャンネル設定に関する詳細は チャンネル詳細設定 ドキュメントを参照してください。", "operationId": "3cb7197bdc6e76c558343e27933dbb01", "parameters": [ { "name": "service_account_key", "in": "path", "description": "サービスアカウントキー", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/x-www-form-urlencoded": { "schema": { "required": [ "title", "customer_code", "concurrently_viewer_limit", "is_shared", "live_media_profile_group_key" ], "properties": { "kind": { "description": "チャンネルタイプ (ライブ種別)\n- `0`: ライブ\n- `1`: 編成ライブ\n- `3`: 低遅延ライブ", "type": "integer", "enum": [ 0, 1, 3 ] }, "title": { "description": "チャンネル名", "type": "string" }, "customer_code": { "description": "顧客内部管理コード / 顧客内部管理識別コード", "type": "string" }, "concurrently_viewer_limit": { "description": "最大同時視聴者数 (`0`: 無制限)", "type": "integer", "default": 0, "enum": [ 0, 100, 200, 300, 400, 500, 600, 700, 800, 900, 1000 ] }, "is_shared": { "description": "チャンネル外部公開ポリシー\n- `0`: 非公開\n- `1`: 公開", "type": "integer", "default": 0, "enum": [ 0, 1 ] }, "live_media_profile_group_key": { "description": "エンコーディングプロファイルグループキー", "type": "string" }, "meta_title_pattern": { "description": "メタ情報タイトル命名規則", "type": "string", "default": "[CHANNEL_TITLE]-[BROADCAST_COUNTING]" }, "meta_description": { "description": "メタ情報内容", "type": "string" }, "recording_file_policy": { "description": "録画ファイル保存方式\n- `0`: 未使用\n- `1`: 自動保存\n- `3`: 自動保存 + 手動保存", "type": "integer", "default": 1, "enum": [ 0, 1, 3 ] }, "recording_file_segment_policy": { "description": "録画ファイル自動保存基準\n- `1`: ファイル容量基準分割保存 (4GB)\n- `2`: 録画時間基準分割保存", "type": "integer", "default": 1, "enum": [ 1, 2 ] }, "recording_file_segment_by_duration": { "description": "時間分割保存時の自動保存間隔 (単位: 分)", "type": "integer", "default": 60, "enum": [ 10, 20, 30, 40, 50, 60, 120 ] }, "recording_file_pattern": { "description": "録画ファイル命名規則", "type": "string", "default": "[CHANNEL_KEY]-[CHANNEL_CUSTOMER_CODE]-[BROADCAST_KEY]-[BROADCAST_CREATING_DATE]-[RECORDING_START_DATETIME]-[RECORDING_TYPE]" }, "idle_screen_kind": { "description": "待機画面タイプ\n- `0`: 事前に登録したポスター画像を表示\n- `1`: 最新スナップショット画像を表示", "type": "integer", "default": 0, "enum": [ 0, 1 ] }, "media_player_policy": { "description": "Kollus セキュリティプレイヤー使用設定\n- `0`: 自動検出\n- `1`: 強制使用", "type": "integer", "default": 0, "enum": [ 0, 1 ] }, "use_chatting_service": { "description": "チャット使用設定\n- `0`: 未使用\n- `1`: 使用", "type": "integer", "default": 0, "enum": [ 0, 1 ] }, "chatting_service_id": { "description": "チャットサービスID", "type": "integer" }, "chatting_info": { "description": "チャット関連設定 (JSON形式)", "type": "string" }, "division_delayed_minutes": { "description": "ネットワーク障害時のセッション維持時間 (単位: 分)", "type": "integer", "default": 3, "enum": [ 0, 1, 2, 3, 4, 5 ] }, "use_duplicate_block": { "description": "同一アカウントの重複視聴制限設定\n- `0`: 非遮断\n- `1`: 遮断", "type": "integer", "default": 0, "enum": [ 0, 1 ] }, "use_capture_block": { "description": "Kollus セキュリティプレイヤー使用時の録画およびキャプチャ遮断設定\n- `0`: 非遮断\n- `1`: 遮断", "type": "integer", "default": 0, "enum": [ 0, 1 ] }, "use_timeshift": { "description": "ライブ配信のタイムシフト機能有効化設定\n- `0`: 無効\n- `1`: 有効化", "type": "integer", "default": 0, "enum": [ 0, 1 ] }, "use_aes128": { "description": "AES-128 暗号化使用設定\n- `0`: 未使用\n- `1`: 使用", "type": "integer", "default": 0, "enum": [ 0, 1 ] }, "use_referer_check": { "description": "リファラーアクセス制御ポリシー\n- `0`: 未使用\n- `1`: 特定ドメイン許可\n- `2`: 特定ドメイン遮断", "type": "integer", "default": 0, "enum": [ 0, 1, 2 ] }, "referer_check_domains": { "description": "再生許可ドメインリスト (区切り文字: カンマ)", "type": "string" }, "referer_reject_domains": { "description": "再生遮断ドメインリスト / 再生拒否ドメインリスト (区切り文字: カンマ)", "type": "string" } }, "type": "object" } } } }, "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" ] } ] } }, "/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" ] } ] }, "put": { "tags": [ "チャンネル管理" ], "summary": "チャンネル情報修正", "description": "[ **アクセス可能なロール**: 最高管理者、管理者 ]\n\n 登録済みのチャンネルの詳細設定を更新します。", "operationId": "19132bacdba0aa98f079c9a24fa729c1", "parameters": [ { "name": "service_account_key", "in": "path", "description": "サービスアカウントキー", "required": true, "schema": { "type": "string" } }, { "name": "channel_key", "in": "path", "description": "チャンネルキー", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { "title": { "description": "チャンネル名", "type": "string" }, "customer_code": { "description": "顧客内部管理コード / 顧客内部管理識別コード", "type": "string" }, "concurrently_viewer_limit": { "description": "最大同時視聴者数 (`0`: 無制限)", "type": "integer", "default": 0, "enum": [ 0, 100, 200, 300, 400, 500, 600, 700, 900, 1000 ] }, "is_shared": { "description": "チャンネル外部公開ポリシー\n- `0`: 非公開\n- `1`: 公開", "type": "integer", "default": 0, "enum": [ 0, 1 ] }, "live_media_profile_group_key": { "description": "エンコーディングプロファイルグループキー", "type": "string" }, "meta_title_pattern": { "description": "メタ情報タイトル命名規則", "type": "string", "default": "[CHANNEL_TITLE]-[BROADCAST_COUNTING]" }, "meta_description": { "description": "メタ情報内容", "type": "string" }, "recording_file_policy": { "description": "録画ファイル保存方式\n- `0`: 未使用\n- `1`: 自動保存\n- `3`: 自動保存 + 手動保存", "type": "integer", "default": 1, "enum": [ 0, 1, 3 ] }, "recording_file_segment_policy": { "description": "録画ファイル自動保存基準\n- `1`: ファイル容量基準分割保存 (4GB)\n- `2`: 録画時間基準分割保存", "type": "integer", "default": 1, "enum": [ 1, 2 ] }, "recording_file_segment_by_duration": { "description": "時間分割保存時の自動保存間隔 (単位: 分)", "type": "integer", "default": 60, "enum": [ 10, 20, 30, 40, 50, 60, 120 ] }, "recording_file_pattern": { "description": "録画ファイル命名規則", "type": "string", "default": "[CHANNEL_KEY]-[CHANNEL_CUSTOMER_CODE]-[BROADCAST_KEY]-[BROADCAST_CREATING_DATE]-[RECORDING_START_DATETIME]-[RECORDING_TYPE]" }, "idle_screen_kind": { "description": "待機画面タイプ\n- `0`: 事前に登録したポスター画像を表示\n- `1`: 最新スナップショット画像を表示", "type": "integer", "default": 0, "enum": [ 0, 1 ] }, "media_player_policy": { "description": "Kollus セキュリティプレイヤー使用設定\n- `0`: 自動検出\n- `1`: 強制使用", "type": "integer", "default": 0, "enum": [ 0, 1 ] }, "use_chatting_service": { "description": "チャット使用設定\n- `0`: 未使用\n- `1`: 使用", "type": "integer", "default": 0, "enum": [ 0, 1 ] }, "division_delayed_minutes": { "description": "ネットワーク障害時にセッションを維持するための有効待機時間（単位：分）", "type": "integer", "default": 3, "enum": [ 0, 1, 2, 3, 4, 5 ] }, "use_duplicate_block": { "description": "同一アカウントベースの重複再生遮断設定\n- `0`: 未遮断\n- `1`: 遮断", "type": "integer", "default": 0, "enum": [ 0, 1 ] }, "use_capture_block": { "description": "Kollus セキュリティプレイヤー使用時の録画およびキャプチャ遮断設定\n- `0`: 未遮断\n- `1`: 遮断", "type": "integer", "default": 0, "enum": [ 0, 1 ] }, "use_timeshift": { "description": "ライブ配信中に過去の時点を視聴する機能（Timeshift）の有効化設定\n- `0`: 無効\n- `1`: 有効化", "type": "integer", "default": 0, "enum": [ 0, 1 ] }, "use_aes128": { "description": "AES-128 暗号化使用設定\n- `0`: 未使用\n- `1`: 使用", "type": "integer", "default": 0, "enum": [ 0, 1 ] }, "use_referer_check": { "description": "リファラーアクセス制御ポリシー\n- `0`: 未使用\n- `1`: 特定ドメイン許可\n- `2`: 特定ドメイン遮断", "type": "integer", "default": 0, "enum": [ 0, 1, 2 ] }, "referer_check_domains": { "description": "再生許可ドメインリスト（区切り文字:カンマ）", "type": "string" }, "referer_reject_domains": { "description": "再生遮断ドメインリスト / 再生拒否ドメインリスト（区切り文字：カンマ）", "type": "string" } }, "type": "object" } } } }, "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" ] } ] }, "delete": { "tags": [ "チャンネル管理" ], "summary": "チャンネル削除", "description": "[ **アクセス可能なロール**: 最高管理者 ]\n\n 特定のチャンネルをシステムから永久に削除します。", "operationId": "9896e28965cd9907818109625c8c2fd3", "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": { "204": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthenticated" }, "404": { "description": "Not found" }, "422": { "description": "Unprocessable entity" } }, "security": [ { "kollus_oauth2": [ "live:control" ] } ] } }, "/v1/live/service-accounts/{service_account_key}/channels/{channel_key}/disable": { "put": { "tags": [ "チャンネル管理" ], "summary": "チャンネル無効", "description": "[ **アクセス可能なロール**: 最高管理者 ]\n\n 有効なチャンネルを無効化します。無効化されたチャンネルは、プレイヤーでの再生が停止されます。", "operationId": "cab64917d80add751849b14526112618", "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" ] } ] } }, "/v1/live/service-accounts/{service_account_key}/channels/{channel_key}/enable": { "put": { "tags": [ "チャンネル管理" ], "summary": "チャンネル有効化", "description": "[ **アクセス可能なロール**: 最高管理者 ]\n\n 無効なチャンネルを有効化します。有効化されたチャンネルは、プレイヤーでの再生が可能になります。", "operationId": "a70389bb80273c24b9071a9c7a8d6dcf", "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" ] } ] } }, "/v1/live/service-accounts/{service_account_key}/channels/{channel_key}/trash": { "put": { "tags": [ "チャンネル管理" ], "summary": "チャンネル非表示処理", "description": "[ **アクセス可能なロール**: 最高管理者 ]\n\n 指定したチャンネルの配信を停止します。停止されたチャンネルは、チャンネルリストで非表示になります。", "operationId": "d60aae97ec2f37a481c5e98b0eb4dc04", "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" ] } ] } }, "/v1/live/service-accounts/{service_account_key}/channels/{channel_key}/restore": { "put": { "tags": [ "チャンネル管理" ], "summary": "非表示チャンネル復元", "description": "[ **アクセス可能なロール**: 最高管理者 ]\n\n 非表示状態のチャンネルを復元し、チャンネルリストに再表示します。", "operationId": "f7d9be7f8d45b6557f151f7ef79589ec", "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" ] } ] } }, "/v1/live/service-accounts/{service_account_key}/channels/{channel_key}/callback": { "put": { "tags": [ "チャンネル管理" ], "summary": "コールバック設定", "description": "[ **アクセス可能なロール**: 最高管理者, 管理者 ]\n\n 特定のイベント発生時にシステムが外部サーバーへ情報を送信できるようエンドポイント（URL）を設定します。各コールバックタイプによって送信されるデータの種類が異なります。", "operationId": "8c593ff66ca5e1808e6ed68657bb825c", "parameters": [ { "name": "service_account_key", "in": "path", "description": "サービスアカウントキー", "required": true, "schema": { "type": "string" } }, { "name": "channel_key", "in": "path", "description": "チャンネルキー", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { "use_broadcast_update_callback": { "description": "ライブコールバック使用設定\n- `0`: 未使用\n- `1`: 使用", "type": "integer", "default": 0, "enum": [ 0, 1 ] }, "broadcast_update_callback_url": { "description": "ライブコールバック URL", "type": "string" }, "use_recording_file_transfer_callback": { "description": "録画ファイル転送コールバック使用設定\n- `0`: 未使用\n- `1`: 使用", "type": "integer", "default": 0, "enum": [ 0, 1 ] }, "recording_file_transfer_callback_url": { "description": "録画ファイル転送コールバック URL", "type": "string" }, "use_lms_callback": { "description": "LMS コールバック使用設定\n- `0`: 未使用\n- `1`: 使用", "type": "integer", "default": 0, "enum": [ 0, 1 ] }, "lms_callback_url": { "description": "LMS コールバック URL", "type": "string" }, "use_play_callback": { "description": "再生コールバック使用設定\n- `0`: 未使用\n- `1`: 使用", "type": "integer", "default": 0, "enum": [ 0, 1 ] }, "play_callback_url": { "description": "再生コールバック URL", "type": "string" } }, "type": "object" } } } }, "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" ] } ] } }, "/v1/live/service-accounts/{service_account_key}/channels/{channel_key}/creators": { "get": { "tags": [ "Creator 管理" ], "summary": "チャンネル別 Creator リスト照会", "description": "特定チャンネルに登録された Creator リストを照会します。クエリパラメーターを活用して結果をフィルタリングできます。", "operationId": "0a9d5248e34e495f9311e7eb95e85bba", "parameters": [ { "name": "service_account_key", "in": "path", "description": "サービスアカウントキー", "required": true, "schema": { "type": "string" } }, { "name": "channel_key", "in": "path", "description": "チャンネルキー", "required": true, "schema": { "type": "string" } }, { "name": "keyword", "in": "query", "description": "検索キーワードフィルタリング", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ApiOpenLiveCreator" } } }, "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthenticated" }, "404": { "description": "Not found" } }, "security": [ { "kollus_oauth2": [ "live:control" ] } ] }, "post": { "tags": [ "Creator 管理" ], "summary": "新規 Creator 生成", "description": "[ **アクセス可能なロール**: 最高管理者, 管理者 ]\n\n 特定チャンネルでライブ配信を行う新しい Creator を登録します。", "operationId": "0a9d5248e34e495f9311e7eb95e85bbb", "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/ApiOpenLiveCreator" } }, "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthenticated" }, "404": { "description": "Not found" } }, "security": [ { "kollus_oauth2": [ "live:control" ] } ] } }, "/v1/live/service-accounts/{service_account_key}/channels/{channel_key}/creators/{creator_code}": { "put": { "tags": [ "Creator 管理" ], "summary": "Creator ニックネーム修正", "description": "[ **アクセス可能なロール**: 最高管理者、管理者 ]\n\n 登録されたCreatorのニックネームを修正します。", "parameters": [ { "name": "service_account_key", "in": "path", "description": "サービスアカウントキー", "required": true, "schema": { "type": "string" } }, { "name": "channel_key", "in": "path", "description": "チャンネルキー", "required": true, "schema": { "type": "string" } }, { "name": "creator_code", "in": "path", "description": "修正対象のCreatorコード", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/x-www-form-urlencoded": { "schema": { "required": [ "nickname" ], "properties": { "nickname": { "description": "修正するCreatorのニックネーム", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ApiOpenLiveCreator" } }, "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthenticated" }, "404": { "description": "Not found" } }, "security": [ { "kollus_oauth2": [ "live:control" ] } ] }, "delete": { "tags": [ "Creator 管理" ], "summary": "Creator削除", "description": "[ **アクセス可能なロール**: 最高管理者、管理者 ]\n\n 特定のチャンネルに所属するCreatorをシステムから永久に削除します。", "parameters": [ { "name": "service_account_key", "in": "path", "description": "サービスアカウントキー", "required": true, "schema": { "type": "string" } }, { "name": "channel_key", "in": "path", "description": "チャンネルキー", "required": true, "schema": { "type": "string" } }, { "name": "creator_code", "in": "path", "description": "削除対象のCreatorコード", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthenticated" }, "404": { "description": "Not found" } }, "security": [ { "kollus_oauth2": [ "live:control" ] } ] } }, "/v1/live/service-accounts/{service_account_key}/broadcasts": { "get": { "tags": [ "ライブ配信管理" ], "summary": "全体配信リスト照会", "description": "特定のサービスアカウントの全体ライブ配信リストを照会します。クエリパラメーターを活用して結果をフィルタリングできます。", "operationId": "959c7a991bd8e6ab4e2f20c10b95676f", "parameters": [ { "name": "service_account_key", "in": "path", "description": "サービスアカウントキー", "required": true, "schema": { "type": "string" } }, { "name": "keyword", "in": "query", "description": "検索キーワードフィルタリング", "schema": { "type": "string" } }, { "name": "order", "in": "query", "description": "データ表示順", "schema": { "type": "string", "default": "id_desc", "enum": [ "id_desc", "id_asc", "title_desc", "title_asc" ] } }, { "name": "page", "in": "query", "description": "取得ページ番号", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "description": "1ページに表示する個数", "schema": { "type": "integer", "default": 10 } }, { "name": "start_date", "in": "query", "description": "照会範囲の開始日", "schema": { "type": "string", "example": "2026-01-01 09:00:00 또는 2026-01-01" } }, { "name": "end_date", "in": "query", "description": "照会範囲の終了日", "schema": { "type": "string", "example": "2026-02-01 11:59:59 또는 2026-02-01" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ApiOpenLiveMediaBroadcast" } }, "links": { "properties": { "first": { "type": "string" }, "last": { "type": "string" }, "prev": { "type": "string" }, "next": { "type": "string" } }, "type": "object" }, "meta": { "properties": { "current_page": { "type": "integer" }, "from": { "type": "integer" }, "last_page": { "type": "integer" }, "path": { "type": "string" }, "per_page": { "type": "integer" }, "to": { "type": "integer" }, "total": { "type": "integer" } }, "type": "object" } }, "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthenticated" }, "404": { "description": "Not found" } }, "security": [ { "kollus_oauth2": [ "live:control" ] } ] } }, "/v1/live/service-accounts/{service_account_key}/channels/{channel_key}/broadcasts": { "get": { "tags": [ "ライブ配信管理" ], "summary": "チャンネル別配信リスト照会", "description": "特定のチャンネルのライブ配信リストを照会します。クエリパラメーターを活用して結果をフィルタリングできます。", "operationId": "8c593ff66ca5e1808e6ed68657bb825d", "parameters": [ { "name": "service_account_key", "in": "path", "description": "サービスアカウントキー", "required": true, "schema": { "type": "string" } }, { "name": "channel_key", "in": "path", "description": "チャンネルキー", "required": true, "schema": { "type": "string" } }, { "name": "keyword", "in": "query", "description": "検索キーワードフィルタリング", "schema": { "type": "string" } }, { "name": "order", "in": "query", "description": "データ表示順", "schema": { "type": "string", "default": "id_desc", "enum": [ "id_desc", "id_asc", "title_desc", "title_asc" ] } }, { "name": "page", "in": "query", "description": "取得ページ番号", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "description": "1ページに表示する個数", "schema": { "type": "integer", "default": 10 } }, { "name": "start_date", "in": "query", "description": "照会範囲の開始日", "schema": { "type": "string", "example": "2026-01-01 09:00:00 또는 2026-01-01" } }, { "name": "end_date", "in": "query", "description": "照会範囲の終了日", "schema": { "type": "string", "example": "2026-02-01 11:59:59 또는 2026-02-01" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ApiOpenLiveMediaBroadcast" } }, "links": { "properties": { "first": { "type": "string" }, "last": { "type": "string" }, "prev": { "type": "string" }, "next": { "type": "string" } }, "type": "object" }, "meta": { "properties": { "current_page": { "type": "integer" }, "from": { "type": "integer" }, "last_page": { "type": "integer" }, "path": { "type": "string" }, "per_page": { "type": "integer" }, "to": { "type": "integer" }, "total": { "type": "integer" } }, "type": "object" } }, "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthenticated" }, "404": { "description": "Not found" } }, "security": [ { "kollus_oauth2": [ "live:control" ] } ] } }, "/v1/live/service-accounts/{service_account_key}/broadcasts/{broadcast_key}": { "get": { "tags": [ "ライブ配信管理" ], "summary": "配信情報照会", "description": "特定のライブ配信の詳細情報を照会します。", "operationId": "48664e18d3f032ac84b842f41e95d85b", "parameters": [ { "name": "service_account_key", "in": "path", "description": "サービスアカウントキー", "required": true, "schema": { "type": "string" } }, { "name": "broadcast_key", "in": "path", "description": "配信キー", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ApiOpenLiveMediaBroadcast" } }, "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthenticated" }, "404": { "description": "Not found" }, "422": { "description": "Unprocessable entity" } }, "security": [ { "kollus_oauth2": [ "live:control" ] } ] }, "put": { "tags": [ "ライブ配信管理" ], "summary": "配信タイトル修正", "description": "既存のライブ配信のタイトルを修正します。", "operationId": "0e2c51ff22e3293700099d27feb7af02", "parameters": [ { "name": "service_account_key", "in": "path", "description": "サービスアカウントキー", "required": true, "schema": { "type": "string" } }, { "name": "broadcast_key", "in": "path", "description": "配信キー", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/x-www-form-urlencoded": { "schema": { "required": [ "title" ], "properties": { "title": { "description": "配信タイトル", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ApiOpenLiveMediaBroadcast" } }, "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthenticated" }, "404": { "description": "Not found" }, "422": { "description": "Unprocessable entity" } }, "security": [ { "kollus_oauth2": [ "live:control" ] } ] } }, "/v1/live/service-accounts/{service_account_key}/broadcasts/{broadcast_key}/duplicate-recording": { "post": { "tags": [ "ライブ配信管理" ], "summary": "手動録画開始", "description": "進行中のライブ配信の手動録画を開始します。", "parameters": [ { "name": "service_account_key", "in": "path", "description": "サービスアカウントキー", "required": true, "schema": { "type": "string" } }, { "name": "broadcast_key", "in": "path", "description": "配信キー", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { "use_cue_sign_timeshift": { "description": "Timeshiftキューサイン有効化\n- `0`: 無効\n- `1`: 有効", "type": "integer", "default": 0, "enum": [ 0, 1 ] } }, "type": "object" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ApiOpenLiveMediaBroadcast" } }, "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthenticated" }, "404": { "description": "Not found" }, "409": { "description": "Conflict" } }, "security": [ { "kollus_oauth2": [ "live:creator" ] } ] }, "delete": { "tags": [ "ライブ配信管理" ], "summary": "手動録画終了", "description": "進行中の手動録画を即時終了します。", "parameters": [ { "name": "service_account_key", "in": "path", "description": "サービスアカウントキー", "required": true, "schema": { "type": "string" } }, { "name": "broadcast_key", "in": "path", "description": "配信キー", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ApiOpenLiveMediaBroadcast" } }, "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthenticated" }, "404": { "description": "Not found" }, "422": { "description": "Unprocessable entity" } }, "security": [ { "kollus_oauth2": [ "live:creator" ] } ] } }, "/v1/live/service-accounts/{service_account_key}/broadcasts/{broadcast_key}/cue-sign-timeshift": { "put": { "tags": [ "ライブ配信管理" ], "summary": "Timeshiftキューサイン修正", "description": "タイムシフト機能が有効な配信の再生開始位置を変更します。これにより、ユーザーが配信を視聴開始した際の初期位置を調整可能です。過去への遡り（タイムシフト視聴）は、指定した `cue_sign_at` 時点までに制限されます。", "operationId": "6bbeb29fdaccd3cca5c6e31ff90719ab", "parameters": [ { "name": "service_account_key", "in": "path", "description": "サービスアカウントキー", "required": true, "schema": { "type": "string" } }, { "name": "broadcast_key", "in": "path", "description": "放送キー / 配信キー", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { "cue_sign_at": { "description": "修正するキューサインの時点", "type": "string", "example": "2026-01-01 09:00:00" } }, "type": "object" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ApiOpenLiveMediaBroadcast" } }, "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthenticated" }, "404": { "description": "Not found" }, "422": { "description": "Unprocessable entity" } }, "security": [ { "kollus_oauth2": [ "live:control" ] } ] } }, "/v1/live/service-accounts/{service_account_key}/broadcasts/{broadcast_key}/like-download": { "get": { "tags": [ "ライブ配信管理" ], "summary": "「いいね」リアクションデータのダウンロード", "description": "特定のライブ配信で発生した「いいね」リアクションデータをファイル形式でダウンロードできるURLを生成します。", "operationId": "8ac0a6f372a7ad57d22de24f8c312645", "parameters": [ { "name": "service_account_key", "in": "path", "description": "サービスアカウントキー", "required": true, "schema": { "type": "string" } }, { "name": "broadcast_key", "in": "path", "description": "放送キー / 配信キー", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ApiOpenKollusFileDownload" } }, "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthenticated" }, "404": { "description": "Not found" }, "422": { "description": "Unprocessable entity" } }, "security": [ { "kollus_oauth2": [ "live:control" ] } ] } }, "/v1/live/service-accounts/{service_account_key}/programs": { "get": { "tags": [ "編成管理" ], "summary": "全体編成リスト照会", "description": "全体編成ライブチャンネルのプログラム編成リストを照会します。", "parameters": [ { "name": "service_account_key", "in": "path", "description": "サービスアカウントキー", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "照会対象のページ番号", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "description": "1ページに表示する個数", "schema": { "type": "integer", "default": 10 } }, { "name": "start_date", "in": "query", "description": "照会範囲の開始日", "schema": { "type": "string", "example": "2026-01-01 09:00:00 또는 2026-01-01" } }, { "name": "end_date", "in": "query", "description": "照会範囲の終了日", "schema": { "type": "string", "example": "2026-02-01 11:59:59 또는 2026-02-01" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ApiOpenProgramSchedule" } }, "links": { "properties": { "first": { "type": "string" }, "last": { "type": "string" }, "prev": { "type": "string" }, "next": { "type": "string" } }, "type": "object" }, "meta": { "properties": { "current_page": { "type": "integer" }, "from": { "type": "integer" }, "last_page": { "type": "integer" }, "path": { "type": "string" }, "per_page": { "type": "integer" }, "to": { "type": "integer" }, "total": { "type": "integer" } }, "type": "object" } }, "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthenticated" }, "404": { "description": "Not found" } }, "security": [ { "kollus_oauth2": [ "live:control" ] } ] } }, "/v1/live/service-accounts/{service_account_key}/channels/{channel_key}/programs": { "get": { "tags": [ "編成管理" ], "summary": "チャンネル別編成リスト照会", "description": "特定の編成ライブチャンネルのプログラム編成リストを照会します。", "parameters": [ { "name": "service_account_key", "in": "path", "description": "サービスアカウントキー", "required": true, "schema": { "type": "string" } }, { "name": "channel_key", "in": "path", "description": "チャンネルキー", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "照会対象のページ番号", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "description": "1ページに表示する個数", "schema": { "type": "integer", "default": 10 } }, { "name": "start_date", "in": "query", "description": "照会範囲の開始日", "schema": { "type": "string", "example": "2026-01-01 09:00:00 또는 2026-01-01" } }, { "name": "end_date", "in": "query", "description": "照会範囲の終了日", "schema": { "type": "string", "example": "2026-02-01 11:59:59 또는 2026-02-01" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ApiOpenProgramSchedule" } }, "links": { "properties": { "first": { "type": "string" }, "last": { "type": "string" }, "prev": { "type": "string" }, "next": { "type": "string" } }, "type": "object" }, "meta": { "properties": { "current_page": { "type": "integer" }, "from": { "type": "integer" }, "last_page": { "type": "integer" }, "path": { "type": "string" }, "per_page": { "type": "integer" }, "to": { "type": "integer" }, "total": { "type": "integer" } }, "type": "object" } }, "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthenticated" }, "404": { "description": "Not found" } }, "security": [ { "kollus_oauth2": [ "live:control" ] } ] }, "post": { "tags": [ "編成管理" ], "summary": "新規プログラム編成", "description": "[ **アクセス可能なロール**: 最高管理者 ]\n\n 編成ライブチャンネルで配信される新規プログラムのスケジュールを登録します。アップロードされたVODコンテンツを特定の時間に順次配信するよう設定できます。", "parameters": [ { "name": "service_account_key", "in": "path", "description": "サービスアカウントキー", "required": true, "schema": { "type": "string" } }, { "name": "channel_key", "in": "path", "description": "チャンネルキー", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/x-www-form-urlencoded": { "schema": { "required": [ "title", "general_file_upload_file_keys[]", "start_date" ], "properties": { "title": { "description": "プログラムタイトル", "type": "string" }, "wait_file_upload_file_key": { "description": "配信開始前に表示する待機画面のファイルキー", "type": "string" }, "wait_file_duration": { "description": "待機画面の表示時間（単位：分）", "type": "integer", "maximum": 360 }, "general_file_upload_file_keys[]": { "description": "順次配信するVODコンテンツのアップロードファイルキー", "type": "array", "items": { "type": "string" } }, "start_date": { "description": "配信開始日時", "type": "string", "example": "2026-01-01 09:00:00" } }, "type": "object" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ApiOpenProgramSchedule" } }, "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthenticated" }, "404": { "description": "Not found" }, "422": { "description": "Unprocessable entity" } }, "security": [ { "kollus_oauth2": [ "live:control" ] } ] } }, "/v1/live/service-accounts/{service_account_key}/channels/{channel_key}/programs/{program_id}": { "put": { "tags": [ "編成管理" ], "summary": "編成情報修正", "description": "[ **アクセス可能なロール**: 最高管理者 ]\n\n 特定のプログラム編成情報を修正します。", "parameters": [ { "name": "service_account_key", "in": "path", "description": "サービスアカウントキー", "required": true, "schema": { "type": "string" } }, { "name": "channel_key", "in": "path", "description": "チャンネルキー", "required": true, "schema": { "type": "string" } }, { "name": "program_id", "in": "path", "description": "プログラムID", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/x-www-form-urlencoded": { "schema": { "required": [ "title", "general_file_upload_file_keys[]", "start_date" ], "properties": { "title": { "description": "プログラムタイトル", "type": "string" }, "wait_file_id": { "description": "待機画面ID", "type": "integer" }, "wait_file_duration": { "description": "待機画面の表示時間（単位：分）", "type": "integer", "maximum": 360 }, "general_file_upload_file_keys[]": { "description": "順次配信するVODコンテンツのアップロードファイルキー", "type": "array", "items": { "type": "string" } }, "start_date": { "description": "配信開始日時", "type": "string", "example": "2026-01-01 09:00:00" } }, "type": "object" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ApiOpenProgramSchedule" } }, "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthenticated" }, "404": { "description": "Not found" }, "422": { "description": "Unprocessable entity" } }, "security": [ { "kollus_oauth2": [ "live:control" ] } ] }, "delete": { "tags": [ "編成管理" ], "summary": "編成情報削除", "description": "[ **アクセス可能なロール**: 最高管理者 ]\n\n 特定のプログラム編成情報を削除します。", "parameters": [ { "name": "service_account_key", "in": "path", "description": "サービスアカウントキー", "required": true, "schema": { "type": "string" } }, { "name": "channel_key", "in": "path", "description": "チャンネルキー", "required": true, "schema": { "type": "string" } }, { "name": "program_id", "in": "path", "description": "プログラムID", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "description": "No content", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthenticated" }, "404": { "description": "Not found" } }, "security": [ { "kollus_oauth2": [ "live:control" ] } ] } }, "/v1/live/service-accounts/{service_account_key}/programs/media-contents": { "get": { "tags": [ "編成管理" ], "summary": "VODコンテンツリスト照会", "description": "[ **アクセス可能なロール**: 最高管理者、管理者 ]\n\n 編成ライブ配信を目的としてシステムにアップロードされた全体VODコンテンツリストを照会します。クエリパラメーターを活用して結果をフィルタリングできます。", "parameters": [ { "name": "service_account_key", "in": "path", "description": "サービスアカウントキー", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "照会対象のページ番号", "schema": { "type": "integer", "default": "1" } }, { "name": "per_page", "in": "query", "description": "1ページに表示する個数", "schema": { "type": "integer", "default": 10 } }, { "name": "order", "in": "query", "description": "データ表示順", "schema": { "type": "string", "default": "created_at_desc", "enum": [ "title_desc", "title_asc", "created_at_desc", "created_at_asc" ] } }, { "name": "keyword", "in": "query", "description": "検索キーワードフィルタリング", "schema": { "type": "string" } }, { "name": "only_selectable", "in": "query", "description": "アップロード完了有無フィルタリング", "schema": { "type": "integer", "default": 0, "enum": [ 0, 1 ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ApiOpenProgramMediaContents" } }, "links": { "properties": { "first": { "type": "string" }, "last": { "type": "string" }, "prev": { "type": "string" }, "next": { "type": "string" } }, "type": "object" }, "meta": { "properties": { "current_page": { "type": "integer" }, "from": { "type": "integer" }, "last_page": { "type": "integer" }, "path": { "type": "string" }, "per_page": { "type": "integer" }, "to": { "type": "integer" }, "total": { "type": "integer" } }, "type": "object" } }, "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthenticated" }, "404": { "description": "Not found" } }, "security": [ { "kollus_oauth2": [ "live:control" ] } ] } }, "/v1/live/service-accounts/{service_account_key}/programs/media-contents/upload-url": { "get": { "tags": [ "編成管理" ], "summary": "VOD コンテンツアップロード", "description": "[ **アクセス可能なロール**: 最高管理者 ]\n\n コンテンツファイルを安全にアップロードするためのワンタイムURLを生成します。", "parameters": [ { "name": "service_account_key", "in": "path", "description": "サービスアカウントキー", "required": true, "schema": { "type": "string" } }, { "name": "general_upload", "in": "query", "description": "トランスコーディング設定（`1`: トランスコーディング実行）", "schema": { "type": "integer", "default": 1, "enum": [ 0, 1 ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ApiOpenMediaContentUploadURL" } } }, "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthenticated" }, "404": { "description": "Not found" } }, "security": [ { "kollus_oauth2": [ "live:control" ] } ] } }, "/v1/live/service-accounts/{service_account_key}/programs/media-contents/{upload_file_key}": { "delete": { "tags": [ "編成管理" ], "summary": "VOD コンテンツ削除", "description": "[ **アクセス可能なロール**: 最高管理者 ]\n\n 編成ライブ配信用にアップロードされたVODコンテンツを完全に削除します。", "parameters": [ { "name": "service_account_key", "in": "path", "description": "サービスアカウントキー", "required": true, "schema": { "type": "string" } }, { "name": "upload_file_key", "in": "path", "description": "アップロードファイルキー", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthenticated" }, "404": { "description": "Not found" }, "422": { "description": "Unprocessable entity" } }, "security": [ { "kollus_oauth2": [ "live:control" ] } ] } }, "/v1/live/service-accounts/{service_account_key}/programs/wait-media-contents": { "get": { "tags": [ "編成管理" ], "summary": "待機画面リスト照会", "description": "[ **アクセス可能なロール**: 最高管理者、管理者 ]\n\n 編成ライブ配信を目的としてシステムにアップロードされた全待機画面リストを照会します。クエリパラメーターを活用して結果をフィルタリングできます。", "parameters": [ { "name": "service_account_key", "in": "path", "description": "サービスアカウントキー", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "取得ページ番号", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "description": "1ページに表示する個数", "schema": { "type": "integer", "default": 10 } }, { "name": "order", "in": "query", "description": "データ表示順", "schema": { "type": "string", "default": "created_at_desc", "enum": [ "title_desc", "title_asc", "created_at_desc", "created_at_asc" ] } }, { "name": "keyword", "in": "query", "description": "検索キーワードフィルタリング", "schema": { "type": "string" } }, { "name": "only_selectable", "in": "query", "description": "アップロード完了有無フィルタリング", "schema": { "type": "integer", "default": 0, "enum": [ 0, 1 ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ApiOpenProgramMediaContents" } }, "links": { "properties": { "first": { "type": "string" }, "last": { "type": "string" }, "prev": { "type": "string" }, "next": { "type": "string" } }, "type": "object" }, "meta": { "properties": { "current_page": { "type": "integer" }, "from": { "type": "integer" }, "last_page": { "type": "integer" }, "path": { "type": "string" }, "per_page": { "type": "integer" }, "to": { "type": "integer" }, "total": { "type": "integer" }, "max_width": { "type": "integer" }, "max_height": { "type": "integer" } }, "type": "object" } }, "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthenticated" }, "404": { "description": "Not found" } }, "security": [ { "kollus_oauth2": [ "live:control" ] } ] } }, "/v1/live/service-accounts/{service_account_key}/programs/media-contents/upload-wait-file": { "post": { "tags": [ "編成管理" ], "summary": "待機画面イメージアップロード", "description": "[ **アクセス可能なロール**: 最高管理者 ]\n\n 編成プログラム開始前に表示する待機画面イメージファイルをアップロードするための一回性エンドポイントURLを生成します。", "parameters": [ { "name": "service_account_key", "in": "path", "description": "サービスアカウントキー", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "properties": { "upload_file": { "description": "イメージファイル（jpeg, jpg, png）", "type": "string", "format": "binary" } }, "type": "object" } } } }, "responses": { "204": { "description": "No content", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthenticated" }, "404": { "description": "Not found" }, "422": { "description": "Unprocessable entity" } }, "security": [ { "kollus_oauth2": [ "live:control" ] } ] } }, "/v1/live/service-accounts/{service_account_key}/channels/{channel_key}/syndications": { "get": { "tags": [ "シンジケーション管理" ], "summary": "チャンネル別シンジケーションリスト照会", "description": "特定チャンネルに登録されたシンジケーション設定リストを照会します。", "operationId": "a54d316907c57f8c35c037aed1666200", "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": { "type": "array", "items": { "$ref": "#/components/schemas/ApiOpenLiveMediaSyndication" } } }, "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthenticated" }, "404": { "description": "Not found" } }, "security": [ { "kollus_oauth2": [ "live:control" ] } ] }, "post": { "tags": [ "シンジケーション管理" ], "summary": "新規シンジケーション追加", "description": "シンジケーション設定を新規登録します。", "operationId": "16c76f5dd6fda9a187dc8bc3a13e25a7", "parameters": [ { "name": "service_account_key", "in": "path", "description": "サービスアカウントキー", "required": true, "schema": { "type": "string" } }, { "name": "channel_key", "in": "path", "description": "チャンネルキー", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/x-www-form-urlencoded": { "schema": { "required": [ "title", "link", "stream_name", "status" ], "properties": { "title": { "description": "シンジケーション設定名", "type": "string" }, "link": { "description": "外部プラットフォームのストリーム受信URL（リンク）", "type": "string" }, "stream_name": { "description": "外部プラットフォームで発行されたストリームキー", "type": "string" }, "status": { "description": "シンジケーション有効化有無\n- `0`: 無効\n- `1`: 有効", "type": "integer", "default": 0, "enum": [ 0, 1 ] } }, "type": "object" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ApiOpenLiveMediaSyndication" } }, "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthenticated" }, "404": { "description": "Not found" }, "422": { "description": "Unprocessable entity" } }, "security": [ { "kollus_oauth2": [ "live:control" ] } ] } }, "/v1/live/service-accounts/{service_account_key}/channels/{channel_key}/syndications/{syndication_id}": { "get": { "tags": [ "シンジケーション管理" ], "summary": "シンジケーション設定情報照会", "description": "特定シンジケーション設定の詳細情報を照会します。", "operationId": "0f1ac67f90905f86bfbd879a77d3365c", "parameters": [ { "name": "service_account_key", "in": "path", "description": "サービスアカウントキー", "required": true, "schema": { "type": "string" } }, { "name": "channel_key", "in": "path", "description": "チャンネルキー", "required": true, "schema": { "type": "string" } }, { "name": "syndication_id", "in": "path", "description": "シンジケーションID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ApiOpenLiveMediaSyndication" } }, "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthenticated" }, "404": { "description": "Not found" } }, "security": [ { "kollus_oauth2": [ "live:control" ] } ] }, "put": { "tags": [ "シンジケーション管理" ], "summary": "シンジケーション設定情報修正", "description": "指定したシンジケーションの詳細設定を更新します。", "operationId": "3617ae67fe4d4ab0b2cd29ca69b6836a", "parameters": [ { "name": "service_account_key", "in": "path", "description": "サービスアカウントキー", "required": true, "schema": { "type": "string" } }, { "name": "channel_key", "in": "path", "description": "チャンネルキー", "required": true, "schema": { "type": "string" } }, { "name": "syndication_id", "in": "path", "description": "シンジケーションID", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/x-www-form-urlencoded": { "schema": { "required": [ "status" ], "properties": { "title": { "description": "シンジケーション設定名", "type": "string" }, "link": { "description": "外部プラットフォームのストリーム受信URL（リンク）", "type": "string" }, "stream_name": { "description": "外部プラットフォームで発行されたストリームキー", "type": "string" }, "status": { "description": "シンジケーション有効化有無\n- `0`: 無効\n- `1`: 有効", "type": "integer", "default": 0, "enum": [ 0, 1 ] } }, "type": "object" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ApiOpenLiveMediaSyndication" } }, "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthenticated" }, "404": { "description": "Not found" }, "422": { "description": "Unprocessable entity" } }, "security": [ { "kollus_oauth2": [ "live:control" ] } ] }, "delete": { "tags": [ "シンジケーション管理" ], "summary": "シンジケーション削除", "description": "特定のシンジケーション設定をシステムから永久に削除します。", "operationId": "d8befcff832d3140d10829704b4d0f6a", "parameters": [ { "name": "service_account_key", "in": "path", "description": "サービスアカウントキー", "required": true, "schema": { "type": "string" } }, { "name": "channel_key", "in": "path", "description": "チャンネルキー", "required": true, "schema": { "type": "string" } }, { "name": "syndication_id", "in": "path", "description": "シンジケーションID", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthenticated" }, "404": { "description": "Not found" }, "422": { "description": "Unprocessable entity" } }, "security": [ { "kollus_oauth2": [ "live:control" ] } ] } }, "/v1/live/service-accounts/{service_account_key}/channels/{channel_key}/kollus-chatting": { "post": { "tags": [ "チャット管理" ], "summary": "チャット設定修正", "description": "[ **アクセス可能なロール**: 最高管理者、管理者 ]\n\n チャット機能の詳細設定を修正します。", "operationId": "8ac0a6f372a7ad57d22de24f8c312642", "parameters": [ { "name": "service_account_key", "in": "path", "description": "サービスアカウントキー", "required": true, "schema": { "type": "string" } }, { "name": "channel_key", "in": "path", "description": "チャンネルキー", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/x-www-form-urlencoded": { "schema": { "required": [ "use_chatting_service" ], "properties": { "use_chatting_service": { "description": "チャット機能の有効化\n- `0`: 無効\n- `1`: 有効", "type": "integer", "default": 1, "enum": [ 0, 1 ] }, "chatting_service_id": { "description": "連携チャットサービスID", "type": "integer" }, "concurrently_chatting_limit": { "description": "チャットルームの最大同時入室人数", "type": "integer", "default": 300 }, "chatting_limit_count": { "description": "1ユーザーが1分間に送信できるメッセージ数の上限", "type": "integer", "default": 30 }, "chatting_join_message": { "description": "チャット入室時に表示されるウェルカムメッセージ", "type": "string" }, "chatting_anonymous_chat": { "description": "匿名チャットの有効化\n- `0`: 無効\n- `1`: 有効", "type": "integer", "default": 0, "enum": [ 0, 1 ] }, "chatting_enable_block": { "description": "チャット管理者用ユーザーブロック（強制退出）機能の有効化\n- `0`: 無効\n- `1`: 有効", "type": "integer", "default": 1, "enum": [ 0, 1 ] }, "chatting_admin_ids": { "description": "チャット管理者ID（区切り文字: 空白）。認証時の `client_user_id` と一致する必要があります。", "type": "string" }, "chatting_send_status": { "description": "'いいね'リアクション機能の有効化\n- `0`: 無効\n- `1`: 有効", "type": "integer", "default": 0, "enum": [ 0, 1 ] }, "chatting_display_profile_photo": { "description": "チャットユーザーのプロフィール画像表示設定\n- `0`: 非表示\n- `1`: 表示", "type": "integer", "default": 0, "enum": [ 0, 1 ] }, "chatting_disable_default_profile_photo": { "description": "デフォルトプロフィール画像の更新", "type": "integer", "default": 0, "enum": [ 0, 1 ] }, "chatting_profile_photo_file": { "description": "デフォルトプロフィール画像ファイル", "type": "string", "format": "binary" } }, "type": "object" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ApiOpenLiveMediaChannelChatting" } }, "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthenticated" }, "404": { "description": "Not found" }, "422": { "description": "Unprocessable entity" } }, "security": [ { "kollus_oauth2": [ "live:control" ] } ] } }, "/v1/live/service-accounts/{service_account_key}/channels/{channel_key}/chatting": { "get": { "tags": [ "チャット管理" ], "summary": "チャットルーム設定情報照会", "description": "チャットルームの詳細設定情報を照会します。", "operationId": "8ac0a6f372a7ad57d22de24f8c312643", "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": { "description": "チャットサービスの種類によって返されるデータオブジェクトの構造が異なります。", "type": "object" } }, "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthenticated" }, "404": { "description": "Not found" }, "422": { "description": "Unprocessable entity" } }, "security": [ { "kollus_oauth2": [ "live:control" ] } ] } }, "/v1/live/service-accounts/{service_account_key}/channels/{channel_key}/chatting-info": { "get": { "tags": [ "チャット管理" ], "summary": "チャットルーム設定情報照会 (チャットSDK専用)", "description": "チャットルームの詳細設定情報を照会します。", "operationId": "8ac0a6f372a7ad57d22de24f8c312640", "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": { "description": "チャットサービスの種類によって返されるデータオブジェクトの構造が異なります。", "type": "object" } }, "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthenticated" }, "404": { "description": "Not found" }, "422": { "description": "Unprocessable entity" } }, "security": [ { "kollus_oauth2": [ "live:control" ] } ] } }, "/v1/live/service-accounts/{service_account_key}/channels/{channel_key}/chatroll-chatting": { "post": { "tags": [ "チャット管理" ], "summary": "Chatroll連携情報修正", "description": "[ **アクセス可能なロール**: 最高管理者、管理者 ]\n\n 外部チャットサービス（Chatroll）の連携情報を更新します。", "operationId": "8ac0a6f372a7ad57d22de24f8c312641", "parameters": [ { "name": "service_account_key", "in": "path", "description": "サービスアカウントキー", "required": true, "schema": { "type": "string" } }, { "name": "channel_key", "in": "path", "description": "チャンネルキー", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/x-www-form-urlencoded": { "schema": { "required": [ "use_chatting_service" ], "properties": { "use_chatting_service": { "description": "チャット機能の有効化\n- `0`: 無効\n- `1`: 有効", "type": "integer", "default": 1, "enum": [ 0, 1 ] }, "chatting_service_id": { "description": "連携ChatrollサービスID", "type": "integer" }, "chatting_position": { "description": "プレイヤー内チャットウィンドウの表示位置", "type": "string", "default": "bottom", "enum": [ "right", "left", "bottom" ] }, "chatting_embed_code": { "description": "Chatrollから発行されたHTMLエンベッドコード", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ApiOpenLiveMediaChannelChatting" } }, "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthenticated" }, "404": { "description": "Not found" }, "422": { "description": "Unprocessable entity" } }, "security": [ { "kollus_oauth2": [ "live:control" ] } ] } }, "/v1/live/service-accounts/{service_account_key}/broadcasts/{broadcast_key}/chatting-joined-users-on-air": { "get": { "tags": [ "チャット管理" ], "summary": "リアルタイムチャット参加者情報照会", "description": "チャットの参加者数とユーザー情報を照会します。", "operationId": "8ac0a6f372a7ad57d22de24f8c312647", "parameters": [ { "name": "service_account_key", "in": "path", "description": "サービスアカウントキー", "required": true, "schema": { "type": "string" } }, { "name": "broadcast_key", "in": "path", "description": "放送キー", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "最大取得件数 (`0`: 全データ照会)", "schema": { "type": "integer", "default": 10 } }, { "name": "page", "in": "query", "description": "取得ページ番号", "schema": { "type": "integer", "default": 1 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ApiOpenLiveChattingJoinedUsersOnAir" } }, "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthenticated" }, "404": { "description": "Not found" }, "422": { "description": "Unprocessable entity" } }, "security": [ { "kollus_oauth2": [ "live:control" ] } ] } }, "/v1/service-accounts/{service_account_key}/chat/stats": { "get": { "tags": [ "チャット管理" ], "summary": "チャット利用統計データ照会", "description": "チャットの利用統計データを照会します。クエリパラメータで集計単位や照会期間を指定できます。", "operationId": "8ac0a6f372a7ad57d22de24f8c312646", "parameters": [ { "name": "service_account_key", "in": "path", "description": "サービスアカウントキー", "required": true, "schema": { "type": "string" } }, { "name": "channel_key", "in": "query", "description": "チャンネルキー", "schema": { "type": "string" } }, { "name": "broadcast_key", "in": "query", "description": "放送キー", "schema": { "type": "string" } }, { "name": "from", "in": "query", "description": "照会範囲開始日", "schema": { "type": "string", "example": "2026-01-01" } }, { "name": "to", "in": "query", "description": "照会範囲の終了日", "schema": { "type": "string", "example": "2026-02-01" } }, { "name": "timegroup", "in": "query", "description": "集計単位 (`5m`: 5分, `10m`: 10分, `1h`: 1時間, `1d`: 1日)", "schema": { "type": "string", "default": "5m", "enum": [ "5m", "10m", "1h", "1d" ] } }, { "name": "order", "in": "query", "description": "データの表示順", "schema": { "type": "string", "default": "desc" } }, { "name": "limit", "in": "query", "description": "最大出力データ個数 (`0`: 全データ照会)", "schema": { "type": "integer", "default": 10 } }, { "name": "page", "in": "query", "description": "取得ページ番号", "schema": { "type": "integer", "default": 1 } }, { "name": "info", "in": "query", "description": "検索情報の含有有無 (`y`: 含む, `n`: 含まない)", "schema": { "type": "string", "default": "y", "enum": [ "y", "n" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "info": { "description": "チャットサービスの種別によって返されるデータオブジェクトの構造が異なります。" } }, "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthenticated" }, "404": { "description": "Not found" }, "422": { "description": "Unprocessable entity" } }, "security": [ { "kollus_oauth2": [ "live:statistics" ] } ] } }, "/v1/live/service-accounts/{service_account_key}/broadcasts/{broadcast_key}/chatting-download": { "get": { "tags": [ "チャット管理" ], "summary": "チャット原本ダウンロード", "description": "特定のライブ配信のチャット原本データをファイル形式でダウンロードできるURLを生成します。", "operationId": "8ac0a6f372a7ad57d22de24f8c312644", "parameters": [ { "name": "service_account_key", "in": "path", "description": "サービスアカウントキー", "required": true, "schema": { "type": "string" } }, { "name": "broadcast_key", "in": "path", "description": "配信キー", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ApiOpenKollusFileDownload" } }, "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthenticated" }, "404": { "description": "Not found" }, "422": { "description": "Unprocessable entity" } }, "security": [ { "kollus_oauth2": [ "live:control" ] } ] } }, "/v1/live/service-accounts/{service_account_key}/channels/{channel_key}/file-transfers": { "get": { "tags": [ "録画ファイル転送先管理" ], "summary": "チャンネル別ファイル転送先リスト照会", "description": "指定したチャンネルの録画ファイル外部転送先（FTP、ストレージなど）のリストを照会します。", "operationId": "77de69ba7be7bf5c1e888e8312d160e5", "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": { "type": "array", "items": { "$ref": "#/components/schemas/ApiOpenLiveMediaFileTransfer" } } }, "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthenticated" }, "404": { "description": "Not found" } }, "security": [ { "kollus_oauth2": [ "live:control" ] } ] } }, "/v1/live/service-accounts/{service_account_key}/channels/{channel_key}/file-transfers/ftp": { "post": { "tags": [ "録画ファイル転送先管理" ], "summary": "ファイル転送先登録 (FTP)", "description": "録画ファイルの転送先となる外部FTPサーバー情報を新規登録します。", "parameters": [ { "name": "service_account_key", "in": "path", "description": "サービスアカウントキー", "required": true, "schema": { "type": "string" } }, { "name": "channel_key", "in": "path", "description": "チャンネルキー", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/x-www-form-urlencoded": { "schema": { "required": [ "title", "host", "port", "username", "password", "remote_path", "status" ], "properties": { "title": { "description": "転送先名 / 転送先設定名", "type": "string" }, "host": { "description": "FTPサーバーホストアドレス", "type": "string" }, "port": { "description": "FTPポート番号", "type": "string" }, "username": { "description": "FTP接続ユーザーアカウント", "type": "string" }, "password": { "description": "FTP接続パスワード", "type": "string" }, "remote_path": { "description": "ファイルが保存されるリモートサーバーパス", "type": "string" }, "status": { "description": "ファイル転送の有効化\n- `0`: 無効\n- `1`: 有効", "type": "integer", "default": 0, "enum": [ 0, 1 ] } }, "type": "object" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ApiOpenLiveMediaFileTransfer" } }, "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthenticated" }, "404": { "description": "Not found" }, "422": { "description": "Unprocessable entity" } }, "security": [ { "kollus_oauth2": [ "live:control" ] } ] } }, "/v1/live/service-accounts/{service_account_key}/channels/{channel_key}/file-transfers/sftp": { "post": { "tags": [ "録画ファイル転送先管理" ], "summary": "ファイル転送先登録 (SFTP)", "description": "録画完了したファイルをセキュア転送する外部SFTPサーバー情報を登録します。", "parameters": [ { "name": "service_account_key", "in": "path", "description": "サービスアカウントキー", "required": true, "schema": { "type": "string" } }, { "name": "channel_key", "in": "path", "description": "チャンネルキー", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/x-www-form-urlencoded": { "schema": { "required": [ "title", "host", "port", "username", "password", "remote_path", "status" ], "properties": { "title": { "description": "転送先名 / 転送先設定名", "type": "string" }, "host": { "description": "SFTPサーバーホストアドレス", "type": "string" }, "port": { "description": "SFTPポート番号", "type": "string" }, "username": { "description": "SFTP接続ユーザーアカウント", "type": "string" }, "password": { "description": "SFTP接続パスワード", "type": "string" }, "remote_path": { "description": "ファイルが保存されるリモートサーバーパス", "type": "string" }, "status": { "description": "ファイル転送の有効化\n- `0`: 無効\n- `1`: 有効", "type": "integer", "default": 0, "enum": [ 0, 1 ] } }, "type": "object" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ApiOpenLiveMediaFileTransfer" } }, "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthenticated" }, "404": { "description": "Not found" }, "422": { "description": "Unprocessable entity" } }, "security": [ { "kollus_oauth2": [ "live:control" ] } ] } }, "/v1/live/service-accounts/{service_account_key}/channels/{channel_key}/file-transfers/kollus": { "post": { "tags": [ "録画ファイル転送先管理" ], "summary": "ファイル転送先登録 (Kollus VOD)", "description": "録画完了したファイルをKollus VODサービスへ転送するためのアカウントおよび連携情報を登録します。パラメーターの詳細情報は 転送先登録手順 (Kollus VOD) ドキュメントをご参照ください。", "parameters": [ { "name": "service_account_key", "in": "path", "description": "サービスアカウントキー", "required": true, "schema": { "type": "string" } }, { "name": "channel_key", "in": "path", "description": "チャンネルキー", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/x-www-form-urlencoded": { "schema": { "required": [ "title", "host", "username", "password", "category_key", "use_encryption", "status" ], "properties": { "title": { "description": "転送先名 / 転送先設定名", "type": "string" }, "host": { "description": "Kollus VOD FTPサーバーアドレス", "type": "string" }, "username": { "description": "Kollus VODサービスアカウントキー", "type": "string" }, "password": { "description": "Kollus VOD FTP接続パスワード", "type": "string" }, "category_key": { "description": "アップロード対象カテゴリキー", "type": "string" }, "use_encryption": { "description": "録画ファイル暗号化設定\n- `0`: 非暗号化\n- `1`: 暗号化", "type": "integer", "default": 0, "enum": [ 0, 1 ] }, "status": { "description": "ファイル転送の有効化\n- `0`: 無効\n- `1`: 有効", "type": "integer", "default": 0, "enum": [ 0, 1 ] } }, "type": "object" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ApiOpenLiveMediaFileTransfer" } }, "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthenticated" }, "404": { "description": "Not found" }, "422": { "description": "Unprocessable entity" } }, "security": [ { "kollus_oauth2": [ "live:control" ] } ] } }, "/v1/live/service-accounts/{service_account_key}/channels/{channel_key}/file-transfers/s3": { "post": { "tags": [ "録画ファイル転送先管理" ], "summary": "ファイル転送先登録 (Amazon S3)", "description": "録画ファイルの転送先となるAmazon S3バケットおよび認証情報を新規登録します。", "operationId": "89385d7adb008bdae8696705cc128200", "parameters": [ { "name": "service_account_key", "in": "path", "description": "サービスアカウントキー", "required": true, "schema": { "type": "string" } }, { "name": "channel_key", "in": "path", "description": "チャンネルキー", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/x-www-form-urlencoded": { "schema": { "required": [ "title", "aws_access_key_id", "aws_secret_access_key", "bucket_name", "aws_region_key", "status" ], "properties": { "title": { "description": "転送先名 / 転送先設定名", "type": "string" }, "aws_access_key_id": { "description": "S3 Access Key", "type": "string" }, "aws_secret_access_key": { "description": "S3 Secret Access Key", "type": "string" }, "bucket_name": { "description": "転送先のS3バケット名", "type": "string" }, "aws_region_key": { "description": "S3 Region Key", "type": "string", "example": "ap-northeast-2" }, "status": { "description": "ファイル転送の有効化\n- `0`: 無効\n- `1`: 有効化", "type": "integer", "default": 0, "enum": [ 0, 1 ] } }, "type": "object" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ApiOpenLiveMediaFileTransfer" } }, "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthenticated" }, "404": { "description": "Not found" }, "422": { "description": "Unprocessable entity" } }, "security": [ { "kollus_oauth2": [ "live:control" ] } ] } }, "/v1/live/service-accounts/{service_account_key}/channels/{channel_key}/file-transfers/{file_transfer_id}": { "get": { "tags": [ "録画ファイル転送先管理" ], "summary": "ファイル転送先情報照会", "description": "登録したファイル転送先の詳細設定を照会します。", "operationId": "774d33cb10a8777e6ddbfd28aca34691", "parameters": [ { "name": "service_account_key", "in": "path", "description": "サービスアカウントキー", "required": true, "schema": { "type": "string" } }, { "name": "channel_key", "in": "path", "description": "チャンネルキー", "required": true, "schema": { "type": "string" } }, { "name": "file_transfer_id", "in": "path", "description": "ファイル転送先ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ApiOpenLiveMediaFileTransfer" } }, "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthenticated" }, "404": { "description": "Not found" } }, "security": [ { "kollus_oauth2": [ "live:control" ] } ] }, "put": { "tags": [ "録画ファイル転送先管理" ], "summary": "ファイル転送先情報修正", "description": "登録済みのファイル転送先の接続情報および運用設定を更新します。転送先タイプ（FTP、SFTP、S3、Kollus）に応じて、必須となるパラメータが異なります。", "operationId": "6eab18cd2235ecb10648bdcb6dffe485", "parameters": [ { "name": "service_account_key", "in": "path", "description": "サービスアカウントキー", "required": true, "schema": { "type": "string" } }, { "name": "channel_key", "in": "path", "description": "チャンネルキー", "required": true, "schema": { "type": "string" } }, { "name": "file_transfer_id", "in": "path", "description": "ファイル転送先ID", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/x-www-form-urlencoded": { "schema": { "required": [ "title", "status" ], "properties": { "title": { "description": "ファイル転送先名 / 転送先設定名", "type": "string" }, "host": { "description": "(FTP、SFTP、Kollus必須) ホストサーバーアドレス", "type": "string" }, "port": { "description": "(FTP、SFTP必須) ポート番号", "type": "string" }, "username": { "description": "(FTP、SFTP、Kollus必須) サーバー接続ユーザーアカウント", "type": "string" }, "password": { "description": "(FTP、SFTP、Kollus必須) サーバー接続パスワード", "type": "string" }, "remote_path": { "description": "(FTP、SFTP必須) ファイルが保存されるリモートサーバーパス", "type": "string" }, "category_key": { "description": "(Kollus必須) アップロード対象カテゴリキー", "type": "string" }, "use_encryption": { "description": "(Kollus必須) 録画ファイル暗号化設定\n- `0`: 非暗号化\n- `1`: 暗号化", "type": "integer", "default": 0, "enum": [ 0, 1 ] }, "aws_access_key_id": { "description": "(S3必須) S3 Access Key", "type": "string" }, "aws_secret_access_key": { "description": "(S3必須) S3 Secret Access Key", "type": "string" }, "bucket_name": { "description": "(S3必須) 転送先のS3バケット名", "type": "string" }, "aws_region_key": { "description": "(S3必須) S3 Region Key", "type": "string", "example": "ap-northeast-2" }, "status": { "description": "ファイル転送の有効化\n- `0`: 無効\n- `1`: 有効化", "type": "integer", "default": 0, "enum": [ 0, 1 ] } }, "type": "object" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ApiOpenLiveMediaFileTransfer" } }, "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthenticated" }, "404": { "description": "Not found" }, "422": { "description": "Unprocessable entity" } }, "security": [ { "kollus_oauth2": [ "live:control" ] } ] }, "delete": { "tags": [ "録画ファイル転送先管理" ], "summary": "ファイル転送先削除", "description": "登録されたファイル転送先設定をシステムから永久に削除します。", "operationId": "b20dedeb4c8baea4ec13fd6795b11535", "parameters": [ { "name": "service_account_key", "in": "path", "description": "サービスアカウントキー", "required": true, "schema": { "type": "string" } }, { "name": "channel_key", "in": "path", "description": "チャンネルキー", "required": true, "schema": { "type": "string" } }, { "name": "file_transfer_id", "in": "path", "description": "削除対象ファイル転送先ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthenticated" }, "404": { "description": "Not found" }, "422": { "description": "Unprocessable entity" } }, "security": [ { "kollus_oauth2": [ "live:control" ] } ] } }, "/v1/live/service-accounts/{service_account_key}/channels/{channel_key}/file-transfers/{file_transfer_id}/status": { "put": { "tags": [ "録画ファイル転送先管理" ], "summary": "ファイル転送有効化/無効", "description": "指定した転送先へのファイル転送を有効化、または無効化します。", "operationId": "16b01651f49114c89e5971b1dee88d22", "parameters": [ { "name": "service_account_key", "in": "path", "description": "サービスアカウントキー", "required": true, "schema": { "type": "string" } }, { "name": "channel_key", "in": "path", "description": "チャンネルキー", "required": true, "schema": { "type": "string" } }, { "name": "file_transfer_id", "in": "path", "description": "ファイル転送先ID", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/x-www-form-urlencoded": { "schema": { "required": [ "status" ], "properties": { "status": { "description": "ファイル転送の有効化\n- `0`: 無効\n- `1`: 有効化", "type": "integer", "default": 0, "enum": [ 0, 1 ] } }, "type": "object" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ApiOpenLiveMediaFileTransfer" } }, "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthenticated" }, "404": { "description": "Not found" }, "422": { "description": "Unprocessable entity" } }, "security": [ { "kollus_oauth2": [ "live:control" ] } ] } }, "/v1/live/service-accounts/{service_account_key}/recording-files": { "get": { "tags": [ "録画ファイル管理" ], "summary": "全録画ファイルリスト照会", "description": "全録画ファイルリストを照会します。クエリパラメーターを活用して結果をフィルタリングすることができます。", "parameters": [ { "name": "service_account_key", "in": "path", "description": "サービスアカウントキー", "required": true, "schema": { "type": "string" } }, { "name": "start_date", "in": "query", "description": "照会範囲開始日付", "schema": { "type": "string", "example": "2026-01-01 09:00:00 또는 2026-01-01" } }, { "name": "end_date", "in": "query", "description": "照会範囲終了日付", "schema": { "type": "string", "example": "2026-02-01 11:59:59 또는 2026-02-01" } }, { "name": "keyword", "in": "query", "description": "検索キーワードフィルタリング", "schema": { "type": "string" } }, { "name": "order", "in": "query", "description": "データ表示順", "schema": { "type": "string", "default": "id_desc", "enum": [ "id_desc", "id_asc", "title_desc", "title_asc" ] } }, { "name": "page", "in": "query", "description": "取得ページ番号", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "description": "1ページに表示する個数", "schema": { "type": "integer", "default": 10 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ApiOpenLiveMediaRecordingFile" } }, "links": { "properties": { "first": { "type": "string" }, "last": { "type": "string" }, "prev": { "type": "string" }, "next": { "type": "string" } }, "type": "object" }, "meta": { "properties": { "current_page": { "type": "integer" }, "from": { "type": "integer" }, "last_page": { "type": "integer" }, "path": { "type": "string" }, "per_page": { "type": "integer" }, "to": { "type": "integer" }, "total": { "type": "integer" } }, "type": "object" } }, "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthenticated" }, "404": { "description": "Not found" } }, "security": [ { "kollus_oauth2": [ "live:control" ] } ] } }, "/v1/live/service-accounts/{service_account_key}/channels/{channel_key}/recording-files": { "get": { "tags": [ "録画ファイル管理" ], "summary": "チャンネル別録画ファイルリスト照会", "description": "指定したチャンネルで実施されたライブ配信の録画ファイル一覧を照会します。クエリパラメータで結果をフィルタリングできます。", "parameters": [ { "name": "service_account_key", "in": "path", "description": "サービスアカウントキー", "required": true, "schema": { "type": "string" } }, { "name": "channel_key", "in": "path", "description": "チャンネルキー", "required": true, "schema": { "type": "string" } }, { "name": "start_date", "in": "query", "description": "照会範囲の開始日", "schema": { "type": "string", "example": "2026-01-01 09:00:00 또는 2026-01-01" } }, { "name": "end_date", "in": "query", "description": "照会範囲の終了日", "schema": { "type": "string", "example": "2026-02-01 11:59:59 또는 2026-02-01" } }, { "name": "keyword", "in": "query", "description": "検索キーワードフィルタリング", "schema": { "type": "string" } }, { "name": "order", "in": "query", "description": "データの表示順", "schema": { "type": "string", "default": "id_desc", "enum": [ "id_desc", "id_asc", "title_desc", "title_asc" ] } }, { "name": "per_page", "in": "query", "description": "1ページに表示する個数", "schema": { "type": "integer", "default": 10 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "data": { "description": "ライブ録画ファイル", "type": "array", "items": { "$ref": "#/components/schemas/ApiOpenLiveMediaRecordingFile" } }, "links": { "properties": { "first": { "type": "string" }, "last": { "type": "string" }, "prev": { "type": "string" }, "next": { "type": "string" } }, "type": "object" }, "meta": { "properties": { "current_page": { "type": "integer" }, "from": { "type": "integer" }, "last_page": { "type": "integer" }, "path": { "type": "string" }, "per_page": { "type": "integer" }, "to": { "type": "integer" }, "total": { "type": "integer" } }, "type": "object" } }, "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthenticated" }, "404": { "description": "Not found" } }, "security": [ { "kollus_oauth2": [ "live:control" ] } ] } }, "/v1/live/service-accounts/{service_account_key}/channels/{channel_key}/broadcasts/{broadcast_key}/recording-files": { "get": { "tags": [ "録画ファイル管理" ], "summary": "配信別録画ファイルリスト照会", "description": "指定したライブ配信の録画ファイル一覧を照会します。クエリパラメータで結果をフィルタリングできます。", "parameters": [ { "name": "service_account_key", "in": "path", "description": "サービスアカウントキー", "required": true, "schema": { "type": "string" } }, { "name": "channel_key", "in": "path", "description": "チャンネルキー", "required": true, "schema": { "type": "string" } }, { "name": "broadcast_key", "in": "path", "description": "配信キー", "required": true, "schema": { "type": "string" } }, { "name": "start_date", "in": "query", "description": "照会範囲の開始日", "schema": { "type": "string", "example": "2026-01-01 09:00:00 또는 2026-01-01" } }, { "name": "end_date", "in": "query", "description": "照会範囲の終了日", "schema": { "type": "string", "example": "2026-02-01 11:59:59 또는 2026-02-01" } }, { "name": "keyword", "in": "query", "description": "検索キーワードフィルタリング", "schema": { "type": "string" } }, { "name": "order", "in": "query", "description": "データの表示順", "schema": { "type": "string", "default": "id_desc", "enum": [ "id_desc", "id_asc", "title_desc", "title_asc" ] } }, { "name": "page", "in": "query", "description": "照会対象のページ番号", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "description": "1ページに表示する個数", "schema": { "type": "integer", "default": 10 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ApiOpenLiveMediaRecordingFile" } }, "links": { "properties": { "first": { "type": "string" }, "last": { "type": "string" }, "prev": { "type": "string" }, "next": { "type": "string" } }, "type": "object" }, "meta": { "properties": { "current_page": { "type": "integer" }, "from": { "type": "integer" }, "last_page": { "type": "integer" }, "path": { "type": "string" }, "per_page": { "type": "integer" }, "to": { "type": "integer" }, "total": { "type": "integer" } }, "type": "object" } }, "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthenticated" }, "404": { "description": "Not found" } }, "security": [ { "kollus_oauth2": [ "live:control" ] } ] } }, "/v1/live/service-accounts/{service_account_key}/channels/{channel_key}/broadcasts/{broadcast_key}/recording-files/{recording_file_id}/download": { "get": { "tags": [ "録画ファイル管理" ], "summary": "録画ファイルダウンロード", "description": "指定した録画ファイルのダウンロードURLを生成します。", "parameters": [ { "name": "service_account_key", "in": "path", "description": "サービスアカウントキー", "required": true, "schema": { "type": "string" } }, { "name": "channel_key", "in": "path", "description": "チャンネルキー", "required": true, "schema": { "type": "string" } }, { "name": "broadcast_key", "in": "path", "description": "配信キー", "required": true, "schema": { "type": "string" } }, { "name": "recording_file_id", "in": "path", "description": "録画ファイルID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ApiOpenKollusFileDownload" } }, "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthenticated" }, "404": { "description": "Not found" }, "422": { "description": "Unprocessable entity" } }, "security": [ { "kollus_oauth2": [ "live:control" ] } ] } }, "/v1/live/service-accounts/{service_account_key}/statistics/viewer/{duration_minute}min-during-a-day": { "get": { "tags": [ "統計" ], "summary": "日別視聴者数照会", "description": "[ **アクセス可能なロール**: 最高管理者、管理者 ]\n\n サービスアカウント内の全ライブ配信の視聴者数データを、指定した時間間隔ごとに照会します。", "parameters": [ { "name": "service_account_key", "in": "path", "description": "サービスアカウントキー", "required": true, "schema": { "type": "string" } }, { "name": "duration_minute", "in": "path", "description": "データ集計の時間間隔（単位：分）", "required": true, "schema": { "type": "string", "default": "5", "enum": [ "5", "10" ] } }, { "name": "start_date", "in": "query", "description": "照会対象の基準日時", "required": true, "schema": { "type": "string", "example": "2026-01-01 09:00:00 또는 2026-01-01" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ApiOpenLiveViewer" } } }, "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthenticated" }, "404": { "description": "Not found" } }, "security": [ { "kollus_oauth2": [ "live:statistics" ] } ] } }, "/v1/live/service-accounts/{service_account_key}/channels/{channel_key}/statistics/viewer/{duration_minute}min-during-a-day": { "get": { "tags": [ "統計" ], "summary": "チャンネル別視聴者数照会", "description": "[ **アクセス可能なロール**: 最高管理者、管理者 ]\n\n 指定したチャンネルのライブ配信における視聴者数データを、時間間隔ごとに照会します。", "parameters": [ { "name": "service_account_key", "in": "path", "description": "サービスアカウントキー", "required": true, "schema": { "type": "string" } }, { "name": "channel_key", "in": "path", "description": "チャンネルキー", "required": true, "schema": { "type": "string" } }, { "name": "duration_minute", "in": "path", "description": "データ集計の時間間隔（単位：分）", "required": true, "schema": { "type": "string", "default": "5", "enum": [ "5", "10" ] } }, { "name": "start_date", "in": "query", "description": "照会対象の基準日時", "required": true, "schema": { "type": "string", "example": "2026-01-01 09:00:00 또는 2026-01-01" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ApiOpenLiveChannelViewer" } } }, "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthenticated" }, "404": { "description": "Not found" } }, "security": [ { "kollus_oauth2": [ "live:statistics" ] } ] } }, "/v1/live/service-accounts/{service_account_key}/broadcasts/{broadcast_key}/statistics/viewer/{duration_minute}min-during-a-day": { "get": { "tags": [ "統計" ], "summary": "配信別視聴者数照会", "description": "[ **アクセス可能なロール**: 最高管理者、管理者 ]\n\n 指定したライブ配信の視聴者数データを、時間間隔ごとに照会します。", "parameters": [ { "name": "service_account_key", "in": "path", "description": "サービスアカウントキー", "required": true, "schema": { "type": "string" } }, { "name": "broadcast_key", "in": "path", "description": "配信キー", "required": true, "schema": { "type": "string" } }, { "name": "duration_minute", "in": "path", "description": "データ集計の時間間隔（単位：分）", "required": true, "schema": { "type": "string", "default": "5", "enum": [ "5", "10" ] } }, { "name": "start_date", "in": "query", "description": "照会対象の基準日時", "required": true, "schema": { "type": "string", "example": "2026-01-01 09:00:00 또는 2026-01-01" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ApiOpenLiveBroadcastViewer" } }, "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthenticated" }, "404": { "description": "Not found" } }, "security": [ { "kollus_oauth2": [ "live:statistics" ] } ] } }, "/v1/live/service-accounts/{service_account_key}/statistics/summary-daily": { "get": { "tags": [ "統計" ], "summary": "日別統計サマリー照会", "description": "[ **アクセス可能なロール**: 最高管理者、管理者 ]\n\n すべてのライブ配信の日別主要統計サマリーを照会します。", "parameters": [ { "name": "service_account_key", "in": "path", "description": "サービスアカウントキー", "required": true, "schema": { "type": "string" } }, { "name": "start_date", "in": "query", "description": "照会範囲の開始日時", "schema": { "type": "string", "example": "2026-01-01 09:00:00 또는 2026-01-01" } }, { "name": "end_date", "in": "query", "description": "照会範囲の終了日時", "schema": { "type": "string", "example": "2026-02-01 11:59:59 또는 2026-02-01" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ApiOpenLiveSummaryDaily" } } }, "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthenticated" }, "404": { "description": "Not found" } }, "security": [ { "kollus_oauth2": [ "live:statistics" ] } ] } }, "/v1/live/service-accounts/{service_account_key}/statistics/summary": { "get": { "tags": [ "統計" ], "summary": "期間別統計サマリー照会", "description": "[ **アクセス可能なロール**: 最高管理者、管理者 ]\n\n 指定した期間中のすべてのライブ配信サマリーを照会します。", "parameters": [ { "name": "service_account_key", "in": "path", "description": "サービスアカウントキー", "required": true, "schema": { "type": "string" } }, { "name": "start_date", "in": "query", "description": "照会範囲の開始日時", "required": true, "schema": { "type": "string", "example": "2026-01-01 09:00:00 또는 2026-01-01" } }, { "name": "end_date", "in": "query", "description": "照会範囲の終了日時", "required": true, "schema": { "type": "string", "example": "2026-02-01 11:59:59 또는 2026-02-01" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ApiOpenLiveStatisticsSummary" } } }, "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthenticated" }, "404": { "description": "Not found" } }, "security": [ { "kollus_oauth2": [ "live:statistics" ] } ] } }, "/v1/live/service-accounts/{service_account_key}/channels/{channel_key}/statistics/summary": { "get": { "tags": [ "統計" ], "summary": "チャンネル別統計要約照会", "description": "[ **アクセス可能なロール**: 最高管理者、管理者 ]\n\n 指定した期間中に特定チャンネルで配信されたすべてのライブ配信に関する要約データを照会します。", "parameters": [ { "name": "service_account_key", "in": "path", "description": "サービスアカウントキー", "required": true, "schema": { "type": "string" } }, { "name": "channel_key", "in": "path", "description": "チャンネルキー", "required": true, "schema": { "type": "string" } }, { "name": "start_date", "in": "query", "description": "照会範囲の開始日時", "required": true, "schema": { "type": "string", "example": "2026-01-01 09:00:00 또는 2026-01-01" } }, { "name": "end_date", "in": "query", "description": "照会範囲の終了日時", "required": true, "schema": { "type": "string", "example": "2026-02-01 11:59:59 또는 2026-02-01" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ApiOpenLiveChannelStatisticsSummary" } } }, "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthenticated" }, "404": { "description": "Not found" } }, "security": [ { "kollus_oauth2": [ "live:statistics" ] } ] } }, "/v1/live/service-accounts/{service_account_key}/broadcasts/{broadcast_key}/statistics/summary": { "get": { "tags": [ "統計" ], "summary": "配信別統計要約照会", "description": "[ **アクセス可能なロール**: 最高管理者、管理者 ]\n\n 指定した期間中に特定ライブ配信に関する要約データを照会します。", "parameters": [ { "name": "service_account_key", "in": "path", "description": "サービスアカウントキー", "required": true, "schema": { "type": "string" } }, { "name": "broadcast_key", "in": "path", "description": "配信キー", "required": true, "schema": { "type": "string" } }, { "name": "start_date", "in": "query", "description": "照会範囲の開始日時", "required": true, "schema": { "type": "string", "example": "2026-01-01 09:00:00 또는 2026-01-01" } }, { "name": "end_date", "in": "query", "description": "照会範囲の終了日時", "required": true, "schema": { "type": "string", "example": "2026-02-01 11:59:59 또는 2026-02-01" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ApiOpenLiveBroadcastStatisticsSummary" } } }, "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthenticated" }, "404": { "description": "Not found" } }, "security": [ { "kollus_oauth2": [ "live:statistics" ] } ] } }, "/v1/vod/service-accounts/{service_account_key}/statistics/summary-daily": { "get": { "tags": [ "統計" ], "summary": "日別VOD統計要約照会", "description": "[ **アクセス可能なロール**: 最高管理者、管理者 ]\n\n すべての編成ライブ配信の日別VOD統計サマリーデータを照会します。", "parameters": [ { "name": "service_account_key", "in": "path", "description": "サービスアカウントキー", "required": true, "schema": { "type": "string" } }, { "name": "start_date", "in": "query", "description": "照会範囲の開始日付", "required": true, "schema": { "type": "string", "example": "2026-01-01" } }, { "name": "end_date", "in": "query", "description": "照会範囲の終了日付", "required": true, "schema": { "type": "string", "example": "2026-02-01" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ApiOpenVodSummaryDaily" } } }, "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthenticated" }, "404": { "description": "Not found" } }, "security": [ { "kollus_oauth2": [ "live:statistics" ] } ] } } }, "components": { "schemas": { "ApiOpenKollusFileDownload": { "properties": { "download_uri": { "description": "ダウンロードURI", "type": "string" }, "expires": { "description": "URIの有効期限", "type": "string" } }, "type": "object" }, "ApiOpenLiveChattingJoinedUsersOnAir": { "properties": { "total": { "description": "チャット参加者数", "type": "integer" }, "users": { "type": "array", "items": { "properties": { "UserId": { "description": "チャット参加者ID", "type": "string" }, "Nickname": { "description": "ニックネーム", "type": "string" } }, "type": "object" } } }, "type": "object" }, "ApiOpenChattingService": { "description": "チャットサービス契約情報", "properties": { "id": { "description": "チャット契約ID", "type": "integer" }, "kind": { "description": "チャットサービス種別", "properties": { "type": { "description": "チャットサービス種別", "type": "string", "enum": [ "chatroll", "kollus" ] }, "value": { "description": "チャットサービス種別コード (`1`: Chatroll, `2`: Kollus)", "type": "integer" } }, "type": "object" }, "info": { "description": "チャットサービス種別によって返されるデータオブジェクトの構造が異なります。" } }, "type": "object" }, "ApiOpenLiveCreator": { "description": "Creator情報", "properties": { "id": { "description": "Creator ID", "type": "integer" }, "nickname": { "description": "Creatorネーム", "type": "string" }, "code": { "description": "Creatorコード", "type": "string" }, "stream_key": { "description": "Creatorストリームキー", "type": "string" }, "created_at": { "description": "Creator生成日時", "type": "string" }, "updated_at": { "description": "Creator情報修正日時", "type": "string" } }, "type": "object" }, "ApiOpenLiveMediaBroadcastItem": { "description": "ライブ配信情報", "properties": { "id": { "description": "配信ID", "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": "手動録画ステータス", "type": "string", "enum": [ "duplicate_recording_stopped", "duplicate_recording_started" ] }, "value": { "description": "手動録画ステータスコード\n- `0`: 手動録画終了\n- `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" }, "ApiOpenLiveMediaBroadcast": { "properties": { "id": { "description": "配信ID", "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" }, "channel": { "$ref": "#/components/schemas/ApiOpenLiveMediaChannelItem" }, "creator": { "$ref": "#/components/schemas/ApiOpenLiveCreator" }, "duplicate_recording_state": { "properties": { "type": { "description": "手動録画ステータス", "type": "string", "enum": [ "duplicate_recording_stopped", "duplicate_recording_started" ] }, "value": { "description": "手動録画ステータスコード\n- `0`: 手動録画終了\n- `1`: 手動録画開始", "type": "integer" } }, "type": "object" }, "streaming_server_type": { "description": "ストリーミングサーバー種別", "type": "string" }, "streaming_server_host": { "description": "ストリーミングサーバーホスト", "type": "string" }, "streaming_server_ip": { "description": "ストリーミングサーバーIP", "type": "string" }, "timeshift_cue_sign_at": { "description": "Timeshift キューサイン時点", "type": "string" }, "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" }, "ApiOpenLiveMediaChannelChatting": { "properties": { "use_chatting_service": { "description": "チャット使用有無", "type": "boolean" }, "chatting_service": { "$ref": "#/components/schemas/ApiOpenChattingService" }, "chatting_position": { "description": "プレイヤー内チャットウィンドウの表示位置", "type": "string", "enum": [ "right", "left", "bottom" ] }, "chatting_embed_code": { "description": "チャットHTMLエンベッドコード", "type": "string" }, "concurrently_chatting_limit": { "description": "チャットルーム同時入場最大人数制限", "type": "integer" }, "chatting_limit_count": { "description": "1ユーザーが1分間に送信できるメッセージ数の上限", "type": "integer" }, "chatting_join_message": { "description": "チャット入室時に表示されるウェルカムメッセージ", "type": "string" }, "chatting_anonymous_chat": { "description": "匿名チャット有効化有無", "type": "boolean" }, "chatting_display_profile_photo": { "description": "チャット参加者プロフィール画像表示有無", "type": "boolean" }, "chatting_disable_default_profile_photo": { "description": "デフォルトプロフィール画像更新", "type": "boolean" }, "chatting_profile_photo_url": { "description": "プロフィール画像URL", "type": "string" }, "chatting_enable_block": { "description": "チャット管理者専用ユーザーブロック(強制退場)機能有効化有無", "type": "boolean" }, "chatting_admin_ids": { "description": "チャット管理者ID (区切り文字: スペース)", "type": "string" }, "chatting_send_status": { "description": "「いいね」リアクション機能有効化有無", "type": "boolean" } }, "type": "object" }, "ApiOpenLiveMediaChannelItem": { "properties": { "id": { "description": "チャンネルID", "type": "integer" }, "key": { "description": "チャンネルキー", "type": "string" }, "title": { "description": "チャンネル名", "type": "string" }, "customer_code": { "description": "顧客内部管理コード / 顧客内部管理識別コード", "type": "string" }, "concurrently_viewer_limit": { "description": "最大同時視聴者数 (`0`: 無制限)", "type": "integer" }, "kind": { "description": "チャンネルタイプ (ライブ種別)\n- `0`: ライブ\n- `1`: 編成ライブ\n- `3`: 低遅延ライブ", "type": "integer" }, "is_shared": { "description": "チャンネル公開有無 (`true`: 公開, `false`: 非公開)", "type": "boolean" }, "profile_group": { "$ref": "#/components/schemas/ApiOpenLiveMediaProfileGroup" }, "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", "enum": [ "poster", "snapshot" ] }, "value": { "description": "待機画面タイプコード\n- `0`: 事前に登録したポスター画像を表示\n- `1`: 最新スナップショット画像を表示", "type": "integer" } }, "type": "object" }, "publish_url": { "description": "アプリケーションリンク (OBS、vMixなどの外部エンコーダー接続時に使用する配信送出アドレスおよび送出接続情報)", "type": "string" }, "video_gateway_url": { "description": "ビデオゲートウェイリンク (ライブ配信視聴URL)", "type": "string" }, "recording_file_policy": { "description": "録画ファイル保存方式", "properties": { "type": { "description": "録画ファイル保存方式 (`segment`: 自動保存, `duplicate`: 手動保存)", "type": "string", "enum": [ "not_used", "segment_recording", "segment_and_duplicate_recording" ] }, "value": { "description": "録画ファイル保存方式コード\n- `0`: 未使用\n- `1`: 自動保存\n- `3`: 自動保存 + 手動保存", "type": "integer" } }, "type": "object" }, "recording_file_pattern": { "description": "録画ファイル命名規則", "type": "string" }, "recording_file_segment_policy": { "description": "録画ファイル自動保存基準", "properties": { "type": { "description": "録画ファイル自動保存基準 (`by_size`: 録画ファイル容量(4G)基準で分割保存, `by_duration`: 録画時間基準で分割保存)", "type": "string", "enum": [ "by_size", "by_duration" ] }, "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": "Kollus セキュリティプレイヤー使用設定", "properties": { "type": { "description": "Kollus セキュリティプレイヤー使用設定 (`auto_detect`: 自動検知, `force_exclusive_player`: 強制使用)", "type": "string", "enum": [ "auto_detect", "force_exclusive_player" ] }, "value": { "description": "Kollus セキュリティプレイヤー使用設定コード\n- `0`: 自動検知\n- `1`: 強制使用", "type": "integer" } }, "type": "object" }, "use_chatting_service": { "description": "チャットサービス有効化有無", "type": "boolean" }, "chatting_service": { "$ref": "#/components/schemas/ApiOpenChattingService" }, "use_duplicate_block": { "description": "重複再生遮断使用有無", "type": "boolean" }, "use_capture_block": { "description": "録画およびキャプチャ遮断使用有無 (セキュリティプレイヤー専用)", "type": "boolean" }, "use_timeshift": { "description": "ライブ配信中の過去時点視聴(Timeshift)機能有効化有無", "type": "boolean" }, "use_aes128": { "description": "AES-128 暗号化使用有無", "type": "boolean" }, "hided_at": { "description": "チャンネル非表示日時", "type": "string" }, "created_at": { "description": "チャンネル登録日時", "type": "string" }, "updated_at": { "description": "チャンネル情報修正日時", "type": "string" } }, "type": "object" }, "ApiOpenLiveMediaChannel": { "properties": { "id": { "description": "チャンネルID", "type": "integer" }, "key": { "description": "チャンネルキー", "type": "string" }, "title": { "description": "チャンネル名", "type": "string" }, "customer_code": { "description": "顧客内部管理コード / 顧客内部管理識別コード", "type": "string" }, "concurrently_viewer_limit": { "description": "最大同時視聴者数 (`0`: 無制限)", "type": "integer" }, "kind": { "description": "チャンネルタイプ", "properties": { "type": { "description": "チャンネルタイプ (`general`: 一般ライブチャンネル, `programming`: 編成ライブチャンネル)", "type": "string", "enum": [ "general", "programming" ] }, "value": { "description": "チャンネルタイプコード\n- `0`: 一般ライブチャンネル\n- `1`: 編成ライブチャンネル", "type": "integer" } } }, "is_shared": { "description": "チャンネル公開有無 (`true`: 公開, `false`: 非公開)", "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", "enum": [ "poster", "snapshot" ] }, "value": { "description": "待機画面タイプコード\n- `0`: 事前に登録したポスター画像を表示\n- `1`: 最新スナップショット画像を表示", "type": "integer" } }, "type": "object" }, "publish_url": { "description": "アプリケーションリンク (OBS、vMixなどの外部エンコーダー接続時に使用する配信送出アドレスおよび送出接続情報)", "type": "string" }, "video_gateway_url": { "description": "ビデオゲートウェイリンク (ライブ配信視聴URL)", "type": "string" }, "recording_file_policy": { "description": "録画ファイル保存方式", "properties": { "type": { "description": "録画ファイル保存方式 (`segment`: 自動保存, `duplicate`: 手動保存)", "type": "string", "enum": [ "not_used", "segment_recording", "segment_and_duplicate_recording" ] }, "value": { "description": "録画ファイル保存方式コード\n- `0`: 未使用\n- `1`: 自動保存\n- `3`: 自動保存 + 手動保存", "type": "integer" } }, "type": "object" }, "recording_file_pattern": { "description": "録画ファイル命名規則", "type": "string" }, "recording_file_segment_policy": { "description": "録画ファイル自動保存基準", "properties": { "type": { "description": "録画ファイル自動保存基準 (`by_size`: 録画ファイル容量(4G)基準で分割保存, `by_duration`: 録画時間基準で分割保存)", "type": "string", "enum": [ "by_size", "by_duration" ] }, "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": "Kollus セキュリティプレイヤー使用設定", "properties": { "type": { "description": "Kollus セキュリティプレイヤー使用設定 (`auto_detect`: 自動検知, `force_exclusive_player`: 強制使用)", "type": "string", "enum": [ "auto_detect", "force_exclusive_player" ] }, "value": { "description": "Kollus セキュリティプレイヤー使用設定コード\n- `0`: 自動検知\n- `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": "ライブ配信中の過去時点視聴(Timeshift)機能有効化有無", "type": "boolean" }, "use_aes128": { "description": "AES-128暗号化使用有無", "type": "boolean" }, "use_broadcast_update_callback": { "description": "ライブCallback機能有効化有無", "type": "boolean" }, "broadcast_update_callback_url": { "description": "ライブCallbackURL", "type": "string" }, "use_recording_file_transfer_callback": { "description": "録画ファイル転送Callback機能有効化有無", "type": "boolean" }, "recording_file_transfer_callback_url": { "description": "録画ファイル転送CallbackURL", "type": "string" }, "use_lms_callback": { "description": "LMS Callback機能有効化有無", "type": "boolean" }, "lms_callback_url": { "description": "LMS Callback URL", "type": "string" }, "use_play_callback": { "description": "再生Callback機能有効化有無", "type": "boolean" }, "play_callback_url": { "description": "再生Callback URL", "type": "string" }, "use_referer_check": { "description": "リファラーアクセス制御ポリシー\n- `0`: 未使用\n- `1`: 特定ドメイン許可\n- `2`: 特定ドメイン遮断", "type": "integer", "enum": [ 0, 1, 2 ] }, "referer_check_domains": { "description": "再生許可ドメインリスト (区切り文字: カンマ)", "type": "string" }, "referer_reject_domains": { "description": "再生遮断ドメインリスト / 再生拒否ドメインリスト (区切り文字: カンマ)", "type": "string" }, "status": { "description": "チャンネルステータス (`true`: 有効, `false`: 無効)", "type": "boolean" }, "hided_at": { "description": "チャンネル非表示日時", "type": "string" }, "created_at": { "description": "チャンネル登録日時", "type": "string" }, "updated_at": { "description": "チャンネル情報修正日時", "type": "string" } }, "type": "object" }, "ApiOpenLiveMediaFileTransfer": { "description": "ファイル転送先情報", "properties": { "id": { "description": "転送先ID", "type": "integer" }, "title": { "description": "転送先名 / 転送先設定名", "type": "string" }, "host": { "description": "(FTP, SFTP, Kollus 必須) ホストサーバーアドレス", "type": "string" }, "port": { "description": "(FTP, SFTP 必須) ポート番号", "type": "string" }, "username": { "description": "(FTP, SFTP, Kollus 必須) サーバー接続ユーザーアカウント", "type": "string" }, "password": { "description": "(FTP, SFTP, Kollus 必須) サーバー接続パスワード", "type": "string" }, "remote_path": { "description": "(FTP, SFTP 必須) ファイルが保存されるリモートサーバーパス", "type": "string" }, "category_key": { "description": "(Kollus 必須) アップロード対象カテゴリキー", "type": "string" }, "use_encryption": { "description": "(Kollus 必須) 録画ファイル暗号化使用有無", "type": "boolean" }, "aws_access_key_id": { "description": "(S3 必須) S3 Access Key", "type": "string" }, "aws_secret_access_key": { "description": "(S3 必須) S3 Secret Access Key", "type": "string" }, "bucket_name": { "description": "(S3 必須) 転送先のS3バケット名", "type": "string" }, "aws_region_key": { "description": "(S3 必須) S3 Region Key", "type": "string" }, "status": { "description": "ファイル転送の有効化", "type": "boolean" }, "created_at": { "description": "転送先登録日時", "type": "string" }, "updated_at": { "description": "転送先情報修正日時", "type": "string" } }, "type": "object" }, "ApiOpenLiveMediaProfileGroup": { "description": "エンコーディングプロファイルグループ情報", "properties": { "id": { "description": "エンコーディングプロファイルグループID", "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": "ビデオ画面方向 (`landscape`: 幅, `portrait`: 高さ)", "type": "string" }, "created_at": { "description": "エンコーディングプロファイルグループ生成日時", "type": "string" }, "updated_at": { "description": "エンコーディングプロファイルグループ修正日時", "type": "string" } }, "type": "object" }, "ApiOpenLiveMediaRecordingFile": { "properties": { "id": { "description": "録画ファイルID", "type": "integer" }, "channel_key": { "description": "チャンネルキー", "type": "string" }, "broadcast_key": { "description": "放送キー", "type": "string" }, "kind": { "description": "録画ファイル保存方式 (`segment`: 自動保存, `duplicate`: 手動保存)", "type": "string" }, "filesize": { "description": "録画ファイル容量 (bytes)", "type": "integer" }, "started_at": { "description": "放送開始時刻", "type": "string" }, "ended_at": { "description": "放送終了時刻", "type": "string" }, "created_at": { "description": "録画ファイル生成日時", "type": "string" }, "updated_at": { "description": "録画ファイル修正日時", "type": "string" } }, "type": "object" }, "ApiOpenLiveMediaSyndication": { "properties": { "id": { "description": "シンジケーションID", "type": "integer" }, "title": { "description": "シンジケーション設定名", "type": "string" }, "application_link": { "description": "外部プラットフォームのストリーム受信URL (リンク)", "type": "string" }, "stream_key": { "description": "外部プラットフォームが提供する放送識別キー (ストリームキー)", "type": "string" }, "status": { "description": "シンジケーション有効化有無\n- `0`: 無効\n- `1`: 有効", "type": "integer" }, "created_at": { "description": "シンジケーション追加日時", "type": "string" }, "updated_at": { "description": "シンジケーション情報修正日時", "type": "string" } }, "type": "object" }, "ApiOpenLiveMediaGeneralFile": { "properties": { "id": { "description": "VOD コンテンツID", "type": "integer" }, "title": { "description": "VOD コンテンツタイトル", "type": "string" }, "upload_file_key": { "description": "アップロードファイルキー", "type": "string" }, "raw_duration": { "description": "待機画面表示時間 (単位: ミリ秒)", "type": "integer" }, "created_at": { "description": "編成登録日時", "type": "string" }, "updated_at": { "description": "編成修正日時", "type": "string" } }, "type": "object" }, "ApiOpenProgramSchedule": { "properties": { "id": { "description": "ID", "type": "integer" }, "live_program_id": { "description": "プログラムID", "type": "integer" }, "live_media_channel_key": { "description": "チャンネルキー", "type": "string" }, "title": { "description": "プログラムタイトル", "type": "string" }, "wait_file": { "$ref": "#/components/schemas/ApiOpenLiveMediaWaitFile" }, "files": { "$ref": "#/components/schemas/ApiOpenLiveMediaGeneralFile" }, "ongoing": { "description": "放送進行中有無 (`1`: 進行中)", "type": "integer" }, "finished": { "description": "放送終了有無 (`1`: 終了)", "type": "integer" }, "started_at": { "description": "放送開始時間", "type": "string" }, "ended_at": { "description": "放送終了時間", "type": "string" }, "created_at": { "description": "編成登録日時", "type": "string" }, "updated_at": { "description": "編成修正日時", "type": "string" } }, "type": "object" }, "ApiOpenMediaContentUploadURL": { "properties": { "upload_url": { "description": "アップロードURL", "type": "string" }, "progress_url": { "description": "アップロード進捗確認URL", "type": "string" }, "upload_file_key": { "description": "アップロードファイルキー", "type": "string" }, "will_be_expired_at": { "description": "URL満了時刻", "type": "string" } }, "type": "object" }, "ApiOpenLiveMediaProfile": { "description": "ライブエンコーディングプロファイル情報", "properties": { "id": { "description": "エンコーディングプロファイルID", "type": "integer" }, "name": { "description": "エンコーディングプロファイル名", "type": "string" }, "key": { "description": "エンコーディングプロファイルキー", "type": "string" }, "profile_type": { "description": "エンコーディングプロファイル種別", "type": "integer" }, "device_type": { "description": "デバイス種別", "type": "string" }, "video_codec": { "description": "ビデオコーデック", "type": "string" }, "video_profile": { "description": "ビデオプロファイル", "type": "string" }, "video_bitrate": { "description": "ビデオビットレート", "type": "integer" }, "video_framerate": { "description": "ビデオフレームレート", "type": "integer" }, "video_width": { "description": "映像の幅（または 映像の横幅）", "type": "integer" }, "video_height": { "description": "ビデオ縦解像度", "type": "integer" }, "video_fitmode": { "description": "画面アスペクト比調整方式", "type": "string" }, "video_screen_type": { "description": "ビデオ画面方向 (`landscape`: 幅, `portrait`: 高さ)", "type": "string" }, "audio_codec": { "description": "オーディオコーデック", "type": "string" }, "audio_bitrate": { "description": "オーディオビットレート", "type": "integer" }, "audio_sample_rate": { "description": "オーディオサンプルレート", "type": "integer" }, "status": { "description": "エンコーディングプロファイル選択可能有無", "type": "boolean" }, "is_default_preset": { "description": "デフォルトプリセット設定有無", "type": "boolean" }, "is_used": { "description": "エンコーディングプロファイル有効化有無", "type": "boolean" }, "created_at": { "description": "エンコーディングプロファイル生成日時", "type": "string" }, "updated_at": { "description": "エンコーディングプロファイル修正日時", "type": "string" } }, "type": "object" }, "ApiOpenLiveContract": { "properties": { "start_date": { "description": "サービス契約開始日時", "type": "string" }, "end_date": { "description": "サービス契約終了日時", "type": "string" }, "live_service_type": { "description": "サービス提供タイプ", "type": "string" }, "live_max_channels": { "description": "最大チャンネル数", "type": "integer" }, "live_max_fps": { "description": "最大フレームレート (FPS)", "type": "integer" }, "live_max_bitrate": { "description": "最大ビットレート (Kbps)", "type": "integer" }, "live_use_concurrently_viewer_limit": { "description": "同時視聴者数制限適用有無", "type": "boolean" }, "live_use_exclusive_player": { "description": "Kollus セキュリティプレイヤー使用有無", "type": "boolean" }, "live_duplicate_block": { "description": "重複再生遮断使用有無\n- `0`: 未遮断\n- `1`: 遮断", "type": "integer" }, "live_max_player_id_count": { "description": "登録可能な最大デバイス数", "type": "integer" }, "live_capture_block_policy": { "description": "録画およびキャプチャ遮断使用有無", "type": "boolean" }, "live_capture_period": { "description": "録画およびキャプチャ遮断ロジック実行周期", "type": "integer" }, "live_use_time_shift": { "description": "ライブ配信中の過去時点視聴(Timeshift)機能有効化有無", "type": "boolean" }, "live_use_recording_file": { "description": "録画ファイル自動転送機能使用有無", "type": "boolean" }, "live_max_recording_files_per_channel": { "description": "チャンネル別登録可能な録画ファイル転送先数", "type": "integer" }, "live_use_syndication": { "description": "シンジケーション(外部プラットフォーム同時配信)機能使用有無", "type": "boolean" }, "live_max_syndication_per_channel": { "description": "チャンネル別登録可能なシンジケーション設定数", "type": "integer" }, "live_use_snapshot": { "description": "スナップショット生成機能使用有無", "type": "boolean" }, "live_use_mobile_encoder_sdk": { "description": "モバイルエンコーダーSDK使用有無", "type": "boolean" }, "live_use_lms_callback": { "description": "LMS コールバック機能有効化有無", "type": "boolean" }, "live_use_play_callback": { "description": "再生コールバック機能有効化有無", "type": "boolean" }, "live_use_chatting_service": { "description": "チャットサービス使用有無", "type": "boolean" }, "chatting_service": { "description": "チャットサービス契約情報", "properties": { "kind": { "description": "チャットサービスタイプコード (`1`: Chatroll, `2`: Kollus)", "type": "integer" }, "info": { "description": "チャット関連設定 (JSON形式)", "type": "object" }, "use_scalable": { "description": "大規模チャットサービス適用有無", "type": "boolean" } }, "type": "object" }, "live_use_file_to_live": { "description": "編成ライブ機能使用有無", "type": "boolean" }, "user_id": { "description": "サービスユーザー識別番号", "type": "integer" } }, "type": "object" }, "ApiOpenProgramMediaContents": { "properties": { "id": { "description": "VOD コンテンツID", "type": "integer" }, "title": { "description": "VOD コンテンツタイトル", "type": "string" }, "upload_file_key": { "description": "アップロードファイルキー", "type": "string" }, "duration": { "description": "コンテンツ総時間 (単位: 秒)", "type": "string" }, "raw_duration": { "description": "コンテンツ総時間 (単位: ミリ秒)", "type": "integer" }, "is_passthru": { "description": "パススルー(原本映像情報維持)適用有無\n- `0`: 未適用\n- `1`: 適用", "type": "boolean" }, "transcoding_state": { "description": "トランスコーディング進行ステータス", "type": "string" }, "transcoding_percent": { "description": "トランスコーディング進行率 (%)", "type": "integer" }, "created_at": { "description": "コンテンツ登録日時", "type": "string" }, "updated_at": { "description": "コンテンツ情報修正日時", "type": "string" }, "snapshot_url": { "description": "スナップショット URL", "type": "string" }, "status": { "description": "コンテンツ有効化および編成可能有無", "type": "integer" }, "programs_ready_schedules": { "$ref": "#/components/schemas/ApiOpenProgramScheduleResourceSummary" }, "transcoding_file": { "$ref": "#/components/schemas/ApiTranscodingFile" }, "transcoding_file_size": { "description": "トランスコーディングファイル容量", "type": "integer" }, "original_file_size": { "description": "原本ファイル容量", "type": "integer" }, "sum_original_file_and_transcoding_file": { "description": "トランスコーディングおよび原本ファイル容量合計", "type": "integer" } }, "type": "object" }, "ApiTranscodingFile": { "description": "トランスコーディングファイル情報", "properties": { "id": { "description": "トランスコーディングファイルID", "type": "integer" }, "profile_name": { "description": "エンコーディングプロファイル名", "type": "string" }, "profile_key": { "description": "エンコーディングプロファイルキー", "type": "string" }, "media_information": { "description": "メディア情報", "type": "object" }, "raw_duration": { "description": "コンテンツ総時間（単位：ミリ秒）", "type": "integer" }, "created_at": { "description": "コンテンツ登録日時", "type": "string" }, "updated_at": { "description": "コンテンツ情報修正日時", "type": "string" } }, "type": "object" }, "ApiOpenProgramScheduleResourceSummary": { "properties": { "id": { "description": "プログラムID", "type": "integer" }, "start_at": { "description": "配信開始時刻", "type": "string" }, "end_at": { "description": "配信終了時刻", "type": "string" } }, "type": "object" }, "ApiOpenLiveMediaWaitFile": { "properties": { "id": { "description": "待機画面ID", "type": "integer" }, "title": { "description": "待機画面名", "type": "string" }, "upload_file_key": { "description": "アップロードファイルキー", "type": "string" }, "raw_duration": { "description": "待機画面表示時間（単位：ミリ秒）", "type": "integer" }, "created_at": { "description": "待機画面画像アップロード日時", "type": "string" }, "updated_at": { "description": "待機画面情報修正日時", "type": "string" } }, "type": "object" }, "ApiOpenLiveBroadcastStatisticsSummary": { "description": "配信別統計要約", "properties": { "startdate": { "description": "照会範囲の開始日付", "type": "string" }, "enddate": { "description": "照会範囲の終了日付", "type": "string" }, "max_cur_user": { "description": "最大同時視聴者数", "type": "integer" }, "max_sum_user": { "description": "累計視聴者数", "type": "integer" }, "total_acc_user": { "description": "純視聴者数", "type": "integer" }, "total_count": { "description": "照会数", "type": "integer" }, "total_broadcast_interval": { "description": "総配信時間", "type": "string" }, "total_watch_time": { "description": "総視聴時間", "type": "string" }, "average_broadcast_interval": { "description": "平均配信時間", "type": "string" }, "average_watch_time": { "description": "平均視聴時間", "type": "string" }, "live_count": { "description": "配信回数", "type": "integer" } }, "type": "object" }, "ApiOpenLiveChannelStatisticsSummary": { "description": "チャンネル別統計要約", "properties": { "startdate": { "description": "照会範囲の開始日付", "type": "string" }, "enddate": { "description": "照会範囲の終了日付", "type": "string" }, "max_cur_user": { "description": "最大同時視聴者数", "type": "integer" }, "max_sum_user": { "description": "累計視聴者数", "type": "integer" }, "total_acc_user": { "description": "純視聴者数", "type": "integer" }, "total_count": { "description": "照会数", "type": "integer" }, "total_broadcast_interval": { "description": "総配信時間", "type": "string" }, "total_watch_time": { "description": "総視聴時間", "type": "string" }, "average_broadcast_interval": { "description": "平均配信時間", "type": "string" }, "average_watch_time": { "description": "平均視聴時間", "type": "string" }, "live_count": { "description": "配信回数", "type": "integer" } }, "type": "object" }, "ApiOpenLiveStatisticsSummary": { "description": "統計要約", "properties": { "startdate": { "description": "照会範囲の開始日付", "type": "string" }, "enddate": { "description": "照会範囲の終了日付", "type": "string" }, "max_cur_user": { "description": "最大同時視聴者数", "type": "integer" }, "max_sum_user": { "description": "累計視聴者数", "type": "integer" }, "total_acc_user": { "description": "純視聴者数", "type": "integer" }, "total_count": { "description": "照会数", "type": "integer" }, "total_broadcast_interval": { "description": "総配信時間", "type": "string" }, "total_watch_time": { "description": "総視聴時間", "type": "string" }, "average_broadcast_interval": { "description": "平均配信時間", "type": "string" }, "average_watch_time": { "description": "平均視聴時間", "type": "string" }, "live_count": { "description": "配信回数", "type": "integer" } }, "type": "object" }, "ApiOpenLiveSummaryDaily": { "description": "日別統計要約", "properties": { "startdate": { "description": "照会範囲開始日付", "type": "string" }, "enddate": { "description": "照会範囲終了日付", "type": "string" }, "total_transfer": { "description": "総転送量 (bytes)", "type": "integer" }, "max_traffic": { "description": "最大トラフィック (bps)", "type": "integer" }, "total_watch_time": { "description": "総視聴時間 (単位: 分)", "type": "integer" }, "total_broadcast_time": { "description": "総配信時間 (単位: 分)", "type": "integer" }, "daily_data": { "type": "array", "items": { "properties": { "datetime": { "description": "照会対象基準日付", "type": "string" }, "transfer": { "description": "転送量 (bytes)", "type": "integer" }, "traffic": { "description": "トラフィック (bps)", "type": "integer" }, "watch_time": { "description": "視聴時間 (単位: 分)", "type": "integer" }, "broadcast_time": { "description": "配信時間 (単位: 分)", "type": "integer" } }, "type": "object" } } }, "type": "object" }, "ApiOpenLiveBroadcastViewer": { "description": "配信別視聴者数統計", "properties": { "startdate": { "description": "照会範囲開始日付", "type": "string" }, "enddate": { "description": "照会範囲終了日付", "type": "string" }, "max_cur_user": { "description": "最大同時視聴者数", "type": "integer" }, "max_acc_user": { "description": "累積視聴者数", "type": "integer" }, "daily_data": { "type": "array", "items": { "properties": { "datetime": { "description": "照会対象基準日付", "type": "string" }, "cur_user": { "description": "同時視聴者数", "type": "integer" }, "acc_user": { "description": "純視聴者数", "type": "integer" } }, "type": "object" } } }, "type": "object" }, "ApiOpenLiveChannelViewer": { "description": "チャンネル別視聴者数統計", "properties": { "startdate": { "description": "照会範囲開始日付", "type": "string" }, "enddate": { "description": "照会範囲終了日付", "type": "string" }, "max_cur_user": { "description": "最大同時視聴者数", "type": "integer" }, "max_acc_user": { "description": "累積視聴者数", "type": "integer" }, "user_data": { "type": "array", "items": { "properties": { "datetime": { "description": "照会対象基準日付", "type": "string" }, "cur_user": { "description": "同時視聴者数", "type": "integer" }, "acc_user": { "description": "純視聴者数", "type": "integer" } }, "type": "object" } } }, "type": "object" }, "ApiOpenLiveViewer": { "description": "視聴者数統計", "properties": { "startdate": { "description": "照会範囲開始日付", "type": "string" }, "enddate": { "description": "照会範囲終了日付", "type": "string" }, "max_cur_user": { "description": "最大同時視聴者数", "type": "integer" }, "max_acc_user": { "description": "累積視聴者数", "type": "integer" }, "user_data": { "type": "array", "items": { "properties": { "datetime": { "description": "照会対象基準日付", "type": "string" }, "cur_user": { "description": "同時視聴者数", "type": "integer" }, "acc_user": { "description": "純視聴者数", "type": "integer" } }, "type": "object" } } }, "type": "object" }, "ApiOpenVodSummaryDaily": { "description": "日別VOD統計要約", "properties": { "startdate": { "description": "照会範囲開始日付", "type": "string" }, "enddate": { "description": "照会範囲終了日付", "type": "string" }, "total_transfer": { "description": "総転送量 (bytes)", "type": "integer" }, "max_traffic": { "description": "最大トラフィック (bps)", "type": "integer" }, "total_storage": { "description": "総ストレージ (bytes)", "type": "integer" }, "total_transcoding_size": { "description": "総トランスコーディングファイル容量 (bytes)", "type": "integer" }, "total_transcoding_count": { "description": "総トランスコーディング数", "type": "integer" }, "total_visitor": { "description": "総訪問者数", "type": "integer" }, "daily_data": { "type": "array", "items": { "properties": { "datetime": { "description": "照会対象基準日付", "type": "string" }, "transfer": { "description": "転送量 (bytes)", "type": "integer" }, "traffic": { "description": "トラフィック (bps)", "type": "integer" }, "storage": { "description": "ストレージ (bytes)", "type": "integer" }, "transcoding_size": { "description": "トランスコーディングファイル容量 (bytes)", "type": "integer" }, "transcoding_count": { "description": "トランスコーディング数", "type": "integer" }, "visitor": { "description": "訪問者数", "type": "integer" } }, "type": "object" } } }, "type": "object" } }, "securitySchemes": { "kollus_oauth2": { "type": "oauth2", "description": "Kollus oauth2 security.", "flows": { "authorizationCode": { "authorizationURL": "https://live-jp.kollus.com/oauth/authorize", "tokenURL": "https://live-jp.kollus.com/oauth/token", "refreshURL": "https://live-jp.kollus.com/token/refresh", "scopes": { "live:control": "Live Control", "live:statistics": "Live Statistics" } }, "clientCredentials": { "tokenURL": "https://live-jp.kollus.com/oauth/token", "refreshURL": "https://live-jp.kollus.com/token/refresh", "scopes": { "live:creator": "Live Creator App", "platform-app": "Platform Api Actions" } } } } } } }