{
"openapi": "3.0.0",
"info": {
"title": "VOD API リファレンス",
"description": "- **API アクセストークン**: Kollus VOD コンソール > サービスアカウント > [API] \n - **識別キー情報**: 認証および主要キー\n - **公式ドキュメント**: Kollus Docs",
"contact": {
"name": "お問い合わせ",
"email": "jp_sales@catenoid.net"
},
"license": {
"name": "サービス利用規約",
"url": "https://catenoid-support.gitbook.io/terms_of_service"
},
"version": "3.0"
},
"servers": [
{
"url": "https://c-api-jp.kollus.com/api"
}
],
"tags": [
{
"name": "공통",
"x-displayName": "共通"
},
{
"name": "카테고리 관리",
"x-displayName": "カテゴリ管理"
},
{
"name": "채널 관리",
"x-displayName": "チャンネル管理"
},
{
"name": "미디어 콘텐츠 키 관리",
"x-displayName": "コンテンツキー管理"
},
{
"name": "미디어 인증 관리",
"x-displayName": "メディア認証管理"
},
{
"name": "콘텐츠 관리",
"x-displayName": "コンテンツ管理"
},
{
"name": "트랜스코딩 관리",
"x-displayName": "トランスコーディング管理"
},
{
"name": "AI 서비스",
"x-displayName": "AIサービス"
},
{
"name": "자막 관리",
"x-displayName": "字幕管理"
},
{
"name": "북마크 관리",
"x-displayName": "ブックマーク管理"
},
{
"name": "인코딩 프로파일 관리",
"x-displayName": "エンコーディングプロファイル管理"
},
{
"name": "중복 재생 차단 관리",
"x-displayName": "重複再生遮断管理"
},
{
"name": "플레이어 관리",
"x-displayName": "プレイヤー管理"
},
{
"name": "통계",
"x-displayName": "統計",
"description": "- **基準タイムゾーン**: すべてのデータは **UTC** 基準です。 \n- **照会範囲**: 直近1年以内のデータを対象とし、1回あたりの最大検索期間は3ヶ月です。 \n- **更新タイミング**: データはリアルタイムで反映されず、最大 **36時間** の遅延が発生する場合があります。"
}
],
"paths": {
"/countries": {
"get": {
"tags": [
"공통"
],
"summary": "国リストを提供",
"description": "システムでサポートされているすべての国の一覧と、国コードを提供します。",
"operationId": "getCountries",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiCommonCountry"
}
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
}
},
"/languages": {
"get": {
"tags": [
"공통"
],
"summary": "言語リスト照会",
"description": "システムで利用可能な全言語リストを照会します。字幕対応言語のみ別途フィルタリングできます。",
"operationId": "getLanguages",
"parameters": [
{
"name": "use_subtitle",
"in": "query",
"description": "字幕対応言語のフィルタリング\n- `false`: 全言語リスト照会\n- `true`: 字幕対応言語リスト照会",
"schema": {
"type": "string",
"default": "false",
"enum": [
"false",
"true"
]
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiCommonLanguage"
}
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
}
},
"/timezones": {
"get": {
"tags": [
"공통"
],
"summary": "タイムゾーンリスト照会",
"description": "コンテンツ管理およびサービス設定に適用できる標準タイムゾーンリストを照会します。",
"operationId": "getTimezones",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {}
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
}
},
"/categories": {
"get": {
"tags": [
"카테고리 관리"
],
"summary": "カテゴリリスト照会",
"description": "全カテゴリリストを照会します。`parent_category_key`を指定すると、指定された上位カテゴリのすべての下位カテゴリリストを返します。",
"operationId": "getCategories",
"parameters": [
{
"name": "order",
"in": "query",
"description": "データ表示順",
"schema": {
"type": "string",
"default": "name_asc",
"enum": [
"created_at_asc",
"created_at_desc",
"position_asc",
"position_desc",
"name_asc",
"name_desc"
]
}
},
{
"name": "parent_category_key",
"in": "query",
"description": "上位カテゴリキー",
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "取得ページ番号",
"schema": {
"type": "integer"
}
},
{
"name": "per_page",
"in": "query",
"description": "1ページに表示する個数",
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 1
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiVodCategory"
}
},
"pagination": {
"properties": {
"current_page": {
"description": "現在のページ",
"type": "integer"
},
"per_page": {
"description": "1ページに表示する個数",
"type": "integer"
},
"total": {
"description": "総件数",
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
},
"post": {
"tags": [
"카테고리 관리"
],
"summary": "新規カテゴリ生成",
"description": "新しいカテゴリを生成します。`parent_category_key`を指定すると、生成されたカテゴリは指定された上位カテゴリの下位カテゴリとして登録されます。",
"operationId": "createCategory",
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"name"
],
"properties": {
"name": {
"description": "カテゴリ名",
"type": "string"
},
"parent_category_key": {
"description": "上位カテゴリキー",
"type": "integer"
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/ApiVodCategory"
},
"status": {
"description": "処理結果\n- `ok`: 成功\n- `fail`: 失敗",
"type": "string"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
},
"422": {
"description": "Unprocessable entity"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
}
},
"/categories/{category_key}": {
"get": {
"tags": [
"카테고리 관리"
],
"summary": "カテゴリ情報照会",
"description": "特定カテゴリの詳細情報および該当カテゴリに紐づけられたチャンネルリストを照会します。",
"operationId": "getCategory",
"parameters": [
{
"name": "category_key",
"in": "path",
"description": "カテゴリキー",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/ApiVodCategory"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
},
"put": {
"tags": [
"카테고리 관리"
],
"summary": "カテゴリ名修正",
"description": "既存カテゴリの名前を変更します。",
"operationId": "updateCategory",
"parameters": [
{
"name": "category_key",
"in": "path",
"description": "カテゴリキー",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"name"
],
"properties": {
"name": {
"description": "修正するカテゴリ名",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/ApiVodCategory"
},
"status": {
"description": "処理結果\n- `ok`: 成功\n- `fail`: 失敗",
"type": "string"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
},
"422": {
"description": "Unprocessable entity"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
},
"delete": {
"tags": [
"카테고리 관리"
],
"summary": "カテゴリ削除",
"description": "特定カテゴリをシステムから永久に削除します。削除されたカテゴリに所属するコンテンツファイルはシステムに維持されます。下位カテゴリの位置は階層構造に従って自動的に再調整されます。(関連ドキュメント: カテゴリ削除)",
"operationId": "deleteCategory",
"parameters": [
{
"name": "category_key",
"in": "path",
"description": "カテゴリキー",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {},
"default": "[]"
},
"status": {
"description": "処理結果\n- `ok`: 成功\n- `fail`: 失敗",
"type": "string"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
}
},
"/categories/{category_key}/channels/{channel_key}/attach": {
"post": {
"tags": [
"카테고리 관리"
],
"summary": "カテゴリ-チャンネル紐づけ",
"description": "特定のカテゴリと特定のチャンネルを紐づけます。",
"operationId": "attachChannelToCategory",
"parameters": [
{
"name": "category_key",
"in": "path",
"description": "カテゴリキー",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "channel_key",
"in": "path",
"description": "チャンネルキー",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"201": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/ApiVodCategory"
},
"status": {
"description": "処理結果\n- `ok`: 成功\n- `fail`: 失敗",
"type": "string"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
}
},
"/categories/{category_key}/channels/{channel_key}/detach": {
"delete": {
"tags": [
"카테고리 관리"
],
"summary": "カテゴリ-チャンネル紐づけ解除",
"description": "カテゴリとチャンネルの紐づけを解除します。",
"operationId": "detachChannelFromCategory",
"parameters": [
{
"name": "category_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": {},
"default": "[]"
},
"status": {
"description": "処理結果\n- `ok`: 成功\n- `fail`: 失敗",
"type": "string"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
}
},
"/channels": {
"get": {
"tags": [
"채널 관리"
],
"summary": "チャンネルリスト照会",
"description": "全チャンネルのリストを照会します。チャンネル種別(`kind`)または有効化ステータス(`status`)を基準にフィルタリングできます。",
"operationId": "getChannels",
"parameters": [
{
"name": "kind",
"in": "query",
"description": "チャンネル種別フィルタリング",
"schema": {
"type": "string",
"default": "package"
}
},
{
"name": "status",
"in": "query",
"description": "チャンネル有効化ステータスフィルタリング\n- `0`: 無効\n- `1`: 有効",
"schema": {
"type": "integer",
"enum": [
0,
1
]
}
},
{
"name": "order",
"in": "query",
"description": "データ表示順",
"schema": {
"type": "string",
"default": "position_asc",
"enum": [
"created_at_asc",
"created_at_desc",
"position_asc",
"position_desc"
]
}
},
{
"name": "page",
"in": "query",
"description": "取得ページ番号",
"schema": {
"type": "integer"
}
},
{
"name": "per_page",
"in": "query",
"description": "1ページに表示する個数",
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 1
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiVodChannel"
}
},
"pagination": {
"properties": {
"current_page": {
"description": "現在のページ",
"type": "integer"
},
"per_page": {
"description": "1ページに表示する個数",
"type": "integer"
},
"total": {
"description": "総件数",
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
},
"post": {
"tags": [
"채널 관리"
],
"summary": "新規チャンネル生成",
"description": "新しいチャンネルを生成します。共有およびセキュリティポリシーの設定は生成後に変更できません。",
"operationId": "createChannel",
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"name"
],
"properties": {
"name": {
"description": "チャンネル名",
"type": "string",
"maximum": 50
},
"description": {
"description": "チャンネル説明",
"type": "string"
},
"is_shared": {
"description": "共有ポリシー設定\n- `0`: 非共有チャンネル\n- `1`: 共有チャンネル",
"type": "integer",
"enum": [
0,
1
]
},
"is_encrypted": {
"description": "セキュリティポリシー設定\n- `0`: 非暗号化通常チャンネル\n- `1`: 暗号化コンテンツ専用チャンネル",
"type": "integer",
"enum": [
0,
1
]
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/ApiVodChannel"
},
"status": {
"description": "処理結果\n- `ok`: 成功\n- `fail`: 失敗",
"type": "string"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
},
"422": {
"description": "Unprocessable entity"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
}
},
"/channels/{channel_key}": {
"get": {
"tags": [
"채널 관리"
],
"summary": "チャンネル情報照会",
"description": "指定したチャンネルの詳細情報を照会します。",
"operationId": "getChannel",
"parameters": [
{
"name": "channel_key",
"in": "path",
"description": "チャンネルキー",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/ApiVodChannel"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
},
"put": {
"tags": [
"채널 관리"
],
"summary": "チャンネル情報修正",
"description": "既存チャンネルの名前、説明、ストリーミング規格設定を修正します。",
"operationId": "updateChannel",
"parameters": [
{
"name": "channel_key",
"in": "path",
"description": "チャンネルキー",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"name"
],
"properties": {
"name": {
"description": "チャンネル名",
"type": "string"
},
"description": {
"description": "チャンネル説明",
"type": "string"
},
"use_realtime": {
"description": "リアルタイムストリーミング(HLS)使用有無\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
]
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/ApiVodChannel"
},
"status": {
"description": "処理結果\n- `ok`: 成功\n- `fail`: 失敗",
"type": "string"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
},
"422": {
"description": "Unprocessable entity"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
},
"delete": {
"tags": [
"채널 관리"
],
"summary": "チャンネル削除",
"description": "特定チャンネルをシステムから永久に削除します。この操作は紐づけられたコンテンツのアクセスに技術的な影響を与える場合があります。(関連ドキュメント: チャンネル削除)",
"operationId": "deleteChannel",
"parameters": [
{
"name": "channel_key",
"in": "path",
"description": "チャンネルキー",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {},
"default": "[]"
},
"status": {
"description": "処理結果\n- `ok`: 成功\n- `fail`: 失敗",
"type": "string"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
}
},
"/channels/{channel_key}/media-contents/{upload_file_key}/attach": {
"post": {
"tags": [
"채널 관리"
],
"summary": "チャンネル-コンテンツ紐づけ",
"description": "コンテンツを特定チャンネルに紐づけます。",
"operationId": "attachMediaContentToChannel",
"parameters": [
{
"name": "channel_key",
"in": "path",
"description": "チャンネルキー",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "upload_file_key",
"in": "path",
"description": "アップロードファイルキー",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"201": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/ApiVodMediaContentKey"
},
"status": {
"description": "処理結果\n- `ok`: 成功\n- `fail`: 失敗",
"type": "string"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
}
},
"/channels/{channel_key}/media-contents/{upload_file_key}/detach": {
"delete": {
"tags": [
"채널 관리"
],
"summary": "チャンネル-コンテンツ紐づけ解除",
"description": "チャンネルとコンテンツの紐づけを解除します。",
"operationId": "detachMediaContentFromChannel",
"parameters": [
{
"name": "channel_key",
"in": "path",
"description": "チャンネルキー",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "upload_file_key",
"in": "path",
"description": "アップロードファイルキー",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {},
"default": "[]"
},
"status": {
"description": "処理結果\n- `ok`: 成功\n- `fail`: 失敗",
"type": "string"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
}
},
"/channels/{channel_key}/player-skins/{skin_id}/attach": {
"post": {
"tags": [
"채널 관리",
"플레이어 관리"
],
"summary": "チャンネル-プレイヤースキン紐づけ",
"description": "プレイヤースキンを特定のチャンネルに紐づけます。チャンネルにすでに紐づけられたスキンがある場合、システムは既存のスキンを解除し、新しいスキンに置き換えます。",
"operationId": "attachPlayerSkinToChannel",
"parameters": [
{
"name": "channel_key",
"in": "path",
"description": "チャンネルキー",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "skin_id",
"in": "path",
"description": "スキンID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/ApiVodPlayerSkin"
},
"status": {
"description": "処理結果\n- `ok`: 成功\n- `fail`: 失敗",
"type": "string"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
}
},
"/channels/{channel_key}/player-skins": {
"delete": {
"tags": [
"채널 관리",
"플레이어 관리"
],
"summary": "チャンネル-プレイヤースキン紐づけ解除",
"description": "チャンネルとプレイヤースキンの紐づけを解除します。",
"operationId": "detachPlayerSkinFromChannel",
"parameters": [
{
"name": "channel_key",
"in": "path",
"description": "チャンネルキー",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {},
"default": "[]"
},
"status": {
"description": "処理結果\n- `ok`: 成功\n- `fail`: 失敗",
"type": "string"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
}
},
"/channels/{channel_key}/callback": {
"put": {
"tags": [
"채널 관리"
],
"summary": "コールバックURL設定 (コンテンツ追加/削除、再生)",
"description": "コンテンツの追加/削除または再生リクエストイベント発生時に外部サーバーへ情報を送信するためのエンドポイント(URL)を設定します。",
"operationId": "updateChannelCallback",
"parameters": [
{
"name": "channel_key",
"in": "path",
"description": "チャンネルキー",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"use_pingback"
],
"properties": {
"use_pingback": {
"description": "コールバック機能有効化の有無",
"type": "integer",
"enum": [
0,
1
]
},
"pingback_url": {
"description": "コンテンツのチャンネル追加コールバックURL",
"type": "string"
},
"leave_pingback_url": {
"description": "コンテンツのチャンネル削除コールバックURL",
"type": "string"
},
"play_callback_url": {
"description": "再生コールバックURL",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/ApiVodChannel"
},
"status": {
"description": "処理結果\n- `ok`: 成功\n- `fail`: 失敗",
"type": "string"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
},
"422": {
"description": "Unprocessable entity"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
}
},
"/channels/{channel_key}/download-callback": {
"put": {
"tags": [
"채널 관리"
],
"summary": "コールバックURL設定 (ダウンロード)",
"description": "PCおよびモバイル環境でコンテンツのダウンロードが発生した際にサーバー間連携のためのコールバックURLを設定します。",
"operationId": "updateChannelDownloadCallback",
"parameters": [
{
"name": "channel_key",
"in": "path",
"description": "チャンネルキー",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"use_pc_download",
"use_mobile_download"
],
"properties": {
"use_pc_download": {
"description": "PCダウンロード機能の有効化\n- `0`: 未使用\n- `1`: 使用",
"type": "integer",
"enum": [
0,
1
]
},
"pc_download_callback_url": {
"description": "PCダウンロードコールバックURL",
"type": "string"
},
"use_mobile_download": {
"description": "モバイルダウンロード機能の有効化\n- `0`: 未使用\n- `1`: 使用",
"type": "integer",
"default": 0,
"enum": [
0,
1
]
},
"mobile_download_callback_url": {
"description": "モバイルダウンロードコールバックURL",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/ApiVodChannel"
},
"status": {
"description": "処理結果\n- `ok`: 成功\n- `fail`: 失敗",
"type": "string"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
},
"422": {
"description": "Unprocessable entity"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
}
},
"/channels/{channel_key}/security": {
"put": {
"tags": [
"채널 관리"
],
"summary": "外部ディスプレイ出力遮断",
"description": "チャンネルに属するコンテンツ再生時にHDMIやミラーリング等による外部出力(TV-OUT)の遮断有無を設定します。",
"operationId": "updateChannelSecurity",
"parameters": [
{
"name": "channel_key",
"in": "path",
"description": "チャンネルキー",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"disable_tvout"
],
"properties": {
"disable_tvout": {
"description": "外部ディスプレイ出力遮断設定\n- `0`: 未遮断\n- `1`: 遮断",
"type": "integer",
"enum": [
0,
1
]
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/ApiVodChannel"
},
"status": {
"description": "処理結果\n- `ok`: 成功\n- `fail`: 失敗",
"type": "string"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
},
"422": {
"description": "Unprocessable entity"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
}
},
"/channels/{channel_key}/referer": {
"put": {
"tags": [
"채널 관리"
],
"summary": "リファラーベースのアクセス制御",
"description": "特定のドメインからの再生のみ許可または遮断するようにリファラー(Referer)ベースのアクセス制御ポリシーを適用します。",
"operationId": "updateChannelReferer",
"parameters": [
{
"name": "channel_key",
"in": "path",
"description": "チャンネルキー",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"use_referer_check"
],
"properties": {
"use_referer_check": {
"description": "リファラーアクセス制御ポリシー設定\n- `1`: 特定ドメイン許可\n- `2`: 特定ドメイン遮断",
"type": "integer",
"enum": [
1,
2
]
},
"referer_check_domains[]": {
"description": "再生を許可するドメインアドレスのリスト",
"type": "array",
"items": {
"type": "string"
}
},
"referer_reject_domains[]": {
"description": "再生を遮断するドメインアドレスのリスト",
"type": "array",
"items": {
"type": "string"
}
},
"referer_empty_allow": {
"description": "リファラー情報がないリクエストの遮断有無",
"type": "boolean"
}
},
"type": "object"
},
"encoding": {
"referer_check_domains[]": {
"style": "deepObject",
"explode": true
},
"referer_reject_domains[]": {
"style": "deepObject",
"explode": true
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/ApiVodChannel"
},
"status": {
"description": "処理結果\n- `ok`: 成功\n- `fail`: 失敗",
"type": "string"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
},
"422": {
"description": "Unprocessable entity"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
}
},
"/media-content-keys/{media_content_key}": {
"get": {
"tags": [
"미디어 콘텐츠 키 관리"
],
"summary": "コンテンツキー情報照会",
"description": "コンテンツキーの詳細情報を照会します。",
"operationId": "getMediaContentKey",
"parameters": [
{
"name": "media_content_key",
"in": "path",
"description": "コンテンツキー",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/ApiVodMediaContentKey"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
}
},
"/media-content-keys/validate": {
"get": {
"tags": [
"미디어 콘텐츠 키 관리"
],
"summary": "コンテンツキー有効検査",
"description": "コンテンツキーが有効化されていて使用中有無を確認します。",
"operationId": "validateMediaContentKey",
"parameters": [
{
"name": "media_content_keys[]",
"in": "query",
"description": "コンテンツキー配列",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "object"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
}
},
"/media-contents/{upload_file_key}/media-content-keys/{media_content_key}/assign": {
"put": {
"tags": [
"미디어 콘텐츠 키 관리"
],
"summary": "コンテンツキー割り当て",
"description": "アップロードされたコンテンツにコンテンツキーを割り当てます。暗号化コンテンツには暗号化専用チャンネルに属するキーのみ割り当てることができます。他のコンテンツにすでに紐づけられたキーは重複して割り当てることができません。",
"operationId": "assignMediaContentKeyToMediaContent",
"parameters": [
{
"name": "upload_file_key",
"in": "path",
"description": "アップロードファイルキー",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "media_content_key",
"in": "path",
"description": "割り当てるコンテンツキー",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"201": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/ApiVodMediaContent"
},
"status": {
"description": "処理結果\n- `ok`: 成功\n- `fail`: 失敗",
"type": "string"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
},
"422": {
"description": "Unprocessable entity"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
}
},
"/media/kollus-encrypt": {
"post": {
"tags": [
"미디어 인증 관리"
],
"summary": "Kollus 暗号化適用",
"description": "プレイヤーとサーバー間の安全な通信のために、Kollus サービス内部の暗号化アルゴリズムを使用して平文の文字列を暗号化します。",
"operationId": "encryptMediaData",
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"source_string"
],
"properties": {
"source_string": {
"description": "平文の文字列",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"properties": {
"encoded": {
"description": "暗号化された文字列",
"type": "string"
}
},
"type": "object"
},
"status": {
"description": "処理結果\n- `ok`: 成功\n- `fail`: 失敗",
"type": "string"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
},
"422": {
"description": "Unprocessable entity"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
}
},
"/media/user-key": {
"post": {
"tags": [
"미디어 인증 관리"
],
"summary": "ユーザーキー生成",
"description": "ユーザー識別およびセキュリティ認証に使用するユーザーキーを生成します。",
"operationId": "createMediaUserKey",
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"client_user_id",
"remote_addr",
"user_agent"
],
"properties": {
"client_user_id": {
"description": "ユーザーID",
"type": "string"
},
"remote_addr": {
"description": "ユーザーの接続IPアドレス",
"type": "string"
},
"user_agent": {
"description": "ユーザーブラウザまたはデバイスのUser-Agent情報",
"type": "string"
},
"user_key_timeout": {
"description": "キーの有効期間 / キー有効期間 (単位: 秒)",
"type": "integer"
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"properties": {
"user_key": {
"description": "ユーザーキー",
"type": "string"
}
},
"type": "object"
},
"status": {
"description": "処理結果\n- `ok`: 成功\n- `fail`: 失敗",
"type": "string"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
},
"422": {
"description": "Unprocessable entity"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
}
},
"/media/user-key/{user_key}": {
"put": {
"tags": [
"미디어 인증 관리"
],
"summary": "ユーザーキー再発行",
"description": "有効期限切れ、またはセキュリティ上の理由から、現在のユーザーキーを無効化して新しいキーを再発行します。",
"operationId": "renewMediaUserKey",
"parameters": [
{
"name": "user_key",
"in": "path",
"description": "既存のユーザーキー",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"properties": {
"user_key": {
"description": "ユーザーキー",
"type": "string"
}
},
"type": "object"
},
"status": {
"description": "処理結果\n- `ok`: 成功\n- `fail`: 失敗",
"type": "string"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
},
"422": {
"description": "Unprocessable entity"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
},
"delete": {
"tags": [
"미디어 인증 관리"
],
"summary": "ユーザーキー削除",
"description": "ユーザーキーを即時無効化し、システムから永久に削除します。",
"operationId": "deleteMediaUserKey",
"parameters": [
{
"name": "user_key",
"in": "path",
"description": "ユーザーキー",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {},
"default": "[]"
},
"status": {
"description": "処理結果\n- `ok`: 成功\n- `fail`: 失敗",
"type": "string"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
},
"422": {
"description": "Unprocessable entity"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
}
},
"/media/watermarking-code": {
"get": {
"tags": [
"미디어 인증 관리"
],
"summary": "ウォーターマーキング識別コード照会",
"description": "不正流出防止のために、プレイヤー画面上にテキスト形式で表示するウォーターマーキングコードを照会します。",
"operationId": "getMediaWatermarkingCode",
"parameters": [
{
"name": "client_user_id",
"in": "query",
"description": "ユーザーID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"properties": {
"code": {
"description": "ウォーターマーキング識別コード",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
}
},
"/media-contents": {
"get": {
"tags": [
"콘텐츠 관리"
],
"summary": "全コンテンツリスト照会",
"description": "全コンテンツのリストを照会します。クエリパラメーターを活用して結果をフィルタリングできます。",
"operationId": "getMediaContents",
"parameters": [
{
"name": "order",
"in": "query",
"description": "データ表示順",
"schema": {
"type": "string",
"default": "created_at|desc",
"enum": [
"id|desc",
"id|asc",
"title|desc",
"title|asc",
"created_at|desc",
"created_at|asc",
"updated_at|desc",
"updated_at|asc"
]
}
},
{
"name": "page",
"in": "query",
"description": "取得ページ番号",
"schema": {
"type": "integer"
}
},
{
"name": "per_page",
"in": "query",
"description": "1ページに表示する個数",
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 1
}
},
{
"name": "keyword",
"in": "query",
"description": "検索キーワードフィルタリング",
"schema": {
"type": "string"
}
},
{
"name": "state",
"in": "query",
"description": "トランスコーディング進行ステータスフィルタリング",
"schema": {
"type": "string",
"enum": [
"completed",
"transcoding",
"error",
""
]
}
},
{
"name": "encryption",
"in": "query",
"description": "コンテンツ暗号化適用ステータスフィルタリング",
"schema": {
"type": "string",
"enum": [
"encrypted",
"not_encrypted",
""
]
}
},
{
"name": "publish",
"in": "query",
"description": "コンテンツ有効化ステータスフィルタリング",
"schema": {
"type": "string",
"enum": [
"published",
"not_published",
""
]
}
},
{
"name": "content_type",
"in": "query",
"description": "コンテンツタイプフィルタリング",
"schema": {
"type": "string",
"enum": [
"audio",
"video",
""
]
}
},
{
"name": "exist_original",
"in": "query",
"description": "原本ファイル保有ステータスフィルタリング\n- `0`: 原本ファイルなし\n- `1`: 原本ファイル保存済み",
"schema": {
"type": "integer",
"enum": [
0,
1
]
}
},
{
"name": "exist_subtitle",
"in": "query",
"description": "字幕ファイル登録ステータスフィルタリング\n- `0`: 未登録\n- `1`: 登録",
"schema": {
"type": "integer",
"enum": [
0,
1
]
}
},
{
"name": "start_date",
"in": "query",
"description": "照会範囲の開始日",
"schema": {
"type": "string",
"example": "2026-01-01"
}
},
{
"name": "end_date",
"in": "query",
"description": "照会範囲の終了日",
"schema": {
"type": "string",
"example": "2026-02-01"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiVodMediaContent"
}
},
"pagination": {
"properties": {
"current_page": {
"description": "現在のページ",
"type": "integer"
},
"per_page": {
"description": "1ページに表示する個数",
"type": "integer"
},
"total": {
"description": "総件数",
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
}
},
"/channels/{channel_key}/media-contents": {
"get": {
"tags": [
"채널 관리",
"콘텐츠 관리"
],
"summary": "チャンネル別コンテンツリスト照会",
"description": "特定のチャンネルに登録されたコンテンツリストを照会します。クエリパラメーターを活用して結果をフィルタリングできます。",
"operationId": "getChannelMediaContents",
"parameters": [
{
"name": "channel_key",
"in": "path",
"description": "チャンネルキー",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "order",
"in": "query",
"description": "データ表示順",
"schema": {
"type": "string",
"default": "created_at|desc",
"enum": [
"id|desc",
"id|asc",
"title|desc",
"title|asc",
"created_at|desc",
"created_at|asc",
"updated_at|desc",
"updated_at|asc"
]
}
},
{
"name": "page",
"in": "query",
"description": "取得ページ番号",
"schema": {
"type": "integer"
}
},
{
"name": "per_page",
"in": "query",
"description": "1ページに表示する個数",
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 1
}
},
{
"name": "keyword",
"in": "query",
"description": "検索キーワードフィルタリング",
"schema": {
"type": "string"
}
},
{
"name": "state",
"in": "query",
"description": "トランスコーディング進行ステータスフィルタリング",
"schema": {
"type": "string",
"enum": [
"completed",
"transcoding",
"error",
""
]
}
},
{
"name": "encryption",
"in": "query",
"description": "コンテンツ暗号化適用ステータスフィルタリング",
"schema": {
"type": "string",
"enum": [
"encrypted",
"not_encrypted",
""
]
}
},
{
"name": "publish",
"in": "query",
"description": "コンテンツ有効化ステータスフィルタリング",
"schema": {
"type": "string",
"enum": [
"published",
"not_published",
""
]
}
},
{
"name": "content_type",
"in": "query",
"description": "コンテンツタイプフィルタリング",
"schema": {
"type": "string",
"enum": [
"audio",
"video",
""
]
}
},
{
"name": "exist_original",
"in": "query",
"description": "原本ファイル保有ステータスフィルタリング\n- `0`: 原本ファイルなし\n- `1`: 原本ファイル保存済み",
"schema": {
"type": "integer",
"enum": [
0,
1
]
}
},
{
"name": "exist_subtitle",
"in": "query",
"description": "字幕ファイル登録ステータスフィルタリング\n- `0`: 未登録\n- `1`: 登録",
"schema": {
"type": "integer",
"enum": [
0,
1
]
}
},
{
"name": "start_date",
"in": "query",
"description": "照会範囲の開始日",
"schema": {
"type": "string",
"example": "2026-01-01"
}
},
{
"name": "end_date",
"in": "query",
"description": "照会範囲の終了日",
"schema": {
"type": "string",
"example": "2026-02-01"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiVodMediaContent"
}
},
"pagination": {
"properties": {
"current_page": {
"description": "現在のページ",
"type": "integer"
},
"per_page": {
"description": "1ページに表示する個数",
"type": "integer"
},
"total": {
"description": "総件数",
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
}
},
"/categories/{category_key}/media-contents": {
"get": {
"tags": [
"콘텐츠 관리"
],
"summary": "カテゴリ別コンテンツリスト照会",
"description": "特定のカテゴリに分類されたコンテンツリストを照会します。クエリパラメーターを活用して結果をフィルタリングできます。",
"operationId": "getCategoryMediaContents",
"parameters": [
{
"name": "category_key",
"in": "path",
"description": "カテゴリキー",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "order",
"in": "query",
"description": "データ表示順",
"schema": {
"type": "string",
"default": "created_at|desc",
"enum": [
"id|desc",
"id|asc",
"title|desc",
"title|asc",
"created_at|desc",
"created_at|asc",
"updated_at|desc",
"updated_at|asc"
]
}
},
{
"name": "page",
"in": "query",
"description": "取得ページ番号",
"schema": {
"type": "integer"
}
},
{
"name": "per_page",
"in": "query",
"description": "1ページに表示する個数",
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 1
}
},
{
"name": "keyword",
"in": "query",
"description": "検索キーワードフィルタリング",
"schema": {
"type": "string"
}
},
{
"name": "state",
"in": "query",
"description": "トランスコーディング進行ステータスフィルタリング",
"schema": {
"type": "string",
"enum": [
"completed",
"transcoding",
"error",
""
]
}
},
{
"name": "encryption",
"in": "query",
"description": "コンテンツ暗号化適用ステータスフィルタリング",
"schema": {
"type": "string",
"enum": [
"encrypted",
"not_encrypted",
""
]
}
},
{
"name": "publish",
"in": "query",
"description": "コンテンツ有効化ステータスフィルタリング",
"schema": {
"type": "string",
"enum": [
"published",
"not_published",
""
]
}
},
{
"name": "content_type",
"in": "query",
"description": "コンテンツタイプフィルタリング",
"schema": {
"type": "string",
"enum": [
"audio",
"video",
""
]
}
},
{
"name": "exist_original",
"in": "query",
"description": "原本ファイル保有ステータスフィルタリング\n- `0`: 原本ファイルなし\n- `1`: 原本ファイル保存済み",
"schema": {
"type": "integer",
"enum": [
0,
1
]
}
},
{
"name": "exist_subtitle",
"in": "query",
"description": "字幕ファイル登録ステータスフィルタリング\n- `0`: 未登録\n- `1`: 登録",
"schema": {
"type": "integer",
"enum": [
0,
1
]
}
},
{
"name": "start_date",
"in": "query",
"description": "照会範囲の開始日",
"schema": {
"type": "string",
"example": "2026-01-01"
}
},
{
"name": "end_date",
"in": "query",
"description": "照会範囲の終了日",
"schema": {
"type": "string",
"example": "2026-02-01"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiVodMediaContent"
}
},
"pagination": {
"properties": {
"current_page": {
"description": "現在のページ",
"type": "integer"
},
"per_page": {
"description": "1ページに表示する個数",
"type": "integer"
},
"total": {
"description": "総件数",
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
}
},
"/upload/create-url": {
"post": {
"tags": [
"콘텐츠 관리"
],
"summary": "コンテンツアップロードURL生成",
"description": "コンテンツファイルを安全にアップロードするためのワンタイムURLを生成します。",
"operationId": "createUploadUrl",
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"expire_time": {
"description": "URLの有効期限（単位: 秒）",
"type": "integer",
"default": 600,
"maximum": 21600
},
"title": {
"description": "コンテンツタイトル",
"type": "string"
},
"category_key": {
"description": "カテゴリキー",
"type": "string"
},
"is_encryption_upload": {
"description": "暗号化設定（`0`: 非暗号化（一般）コンテンツ、`1`: 暗号化コンテンツ）",
"type": "integer",
"default": 0,
"enum": [
0,
1
]
},
"is_audio_upload": {
"description": "オーディオ専用コンテンツ設定\n- `0`: ビデオを含む\n- `1`: オーディオ専用",
"type": "integer",
"default": 0,
"enum": [
0,
1
]
},
"use_ai_script": {
"description": "AI倍速適用有無\n- `0`: 未適用\n- `1`: 適用",
"type": "integer",
"enum": [
0,
1
]
},
"use_ai_subtitle": {
"description": "AI字幕生成有無\n- `0`: 未生成\n- `1`: 生成",
"type": "integer",
"enum": [
0,
1
]
},
"use_ai_outline": {
"description": "AI要約·チャプター生成有無\n- `0`: 未生成\n- `1`: 生成",
"type": "integer",
"enum": [
0,
1
]
},
"ai_subtitle_language": {
"description": "AI字幕言語設定（映像・音声の主要言語）",
"type": "string",
"enum": [
"ja"
]
},
"ai_subtitle_status": {
"description": "AI字幕公開設定\n- `0`: 非公開\n- `1`: 公開",
"type": "integer",
"enum": [
0,
1
]
},
"ai_subtitle_kind": {
"description": "AI字幕タイプ設定\n- `0`: メイン字幕\n- `1`: サブ字幕",
"type": "integer",
"enum": [
0,
1
]
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"properties": {
"upload_url": {
"description": "コンテンツアップロードURL",
"type": "string"
},
"progress_url": {
"description": "アップロード進行ステータス照会URL",
"type": "string"
},
"upload_file_key": {
"description": "アップロードファイルキー",
"type": "string"
},
"expired_at": {
"description": "URL満了日時",
"type": "integer"
}
},
"type": "object"
},
"status": {
"description": "処理結果\n- `ok`: 成功\n- `fail`: 失敗",
"type": "string"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
},
"422": {
"description": "Unprocessable entity"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
}
},
"/media-contents/{upload_file_key}": {
"get": {
"tags": [
"콘텐츠 관리"
],
"summary": "コンテンツ情報照会",
"description": "特定コンテンツの詳細情報を照会します。",
"operationId": "getMediaContent",
"parameters": [
{
"name": "upload_file_key",
"in": "path",
"description": "アップロードファイルキー",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/ApiVodMediaContent"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
},
"put": {
"tags": [
"콘텐츠 관리"
],
"summary": "コンテンツ情報修正",
"description": "既存コンテンツのタイトル、VRコンテンツ投影方式およびサウンドモード設定を修正します。",
"operationId": "updateMediaContent",
"parameters": [
{
"name": "upload_file_key",
"in": "path",
"description": "アップロードファイルキー",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"title": {
"description": "コンテンツタイトル",
"type": "string"
},
"vr": {
"description": "VRコンテンツ設定",
"properties": {
"projection_type": {
"description": "VR投影方式\n- `rectangular`: 一般2D映像\n- `equirectangular`: 360度球面映像投影方式",
"type": "string",
"default": "rectangular",
"enum": [
"rectangular",
"equirectangular"
]
},
"stereo_mode": {
"description": "サウンドモード（`mono`: 方向性のない一般オーディオ）",
"type": "string",
"default": "mono",
"enum": [
"mono"
]
}
},
"type": "object"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/ApiVodMediaContent"
},
"status": {
"description": "処理結果\n- `ok`: 成功\n- `fail`: 失敗",
"type": "string"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
},
"422": {
"description": "Unprocessable entity"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
},
"delete": {
"tags": [
"콘텐츠 관리"
],
"summary": "コンテンツ削除",
"description": "特定コンテンツをシステムから永久に削除します。",
"operationId": "deleteMediaContent",
"parameters": [
{
"name": "upload_file_key",
"in": "path",
"description": "アップロードファイルキー",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {},
"default": "[]"
},
"status": {
"description": "処理結果\n- `ok`: 成功\n- `fail`: 失敗",
"type": "string"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
}
},
"/media-contents/{upload_file_key}/categories/{category_key}": {
"put": {
"tags": [
"콘텐츠 관리"
],
"summary": "コンテンツカテゴリ変更",
"description": "コンテンツのカテゴリ分類を別のカテゴリに変更します。",
"operationId": "updateMediaContentCategory",
"parameters": [
{
"name": "upload_file_key",
"in": "path",
"description": "アップロードファイルキー",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "category_key",
"in": "path",
"description": "変更するカテゴリキー",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/ApiVodMediaContentCategory"
},
"status": {
"description": "処理結果\n- `ok`: 成功\n- `fail`: 失敗",
"type": "string"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
},
"422": {
"description": "Unprocessable entity"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
}
},
"/media-contents/{upload_file_key}/disable": {
"put": {
"tags": [
"콘텐츠 관리"
],
"summary": "コンテンツ無効化",
"description": "有効状態のコンテンツを無効化して、プレイヤーでの再生を一時的に遮断します。",
"operationId": "disableMediaContent",
"parameters": [
{
"name": "upload_file_key",
"in": "path",
"description": "アップロードファイルキー",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/ApiVodMediaContentStatus"
},
"status": {
"description": "処理結果\n- `ok`: 成功\n- `fail`: 失敗",
"type": "string"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
},
"422": {
"description": "Unprocessable entity"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
}
},
"/media-contents/{upload_file_key}/enable": {
"put": {
"tags": [
"콘텐츠 관리"
],
"summary": "コンテンツ有効化",
"description": "無効状態のコンテンツを有効化して、プレイヤーで再生可能な状態に変更します。",
"operationId": "enableMediaContent",
"parameters": [
{
"name": "upload_file_key",
"in": "path",
"description": "アップロードファイルキー",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/ApiVodMediaContentStatus"
},
"status": {
"description": "処理結果\n- `ok`: 成功\n- `fail`: 失敗",
"type": "string"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
},
"422": {
"description": "Unprocessable entity"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
}
},
"/media-contents/{upload_file_key}/poster": {
"post": {
"tags": [
"콘텐츠 관리"
],
"summary": "ポスター画像アップロード",
"description": "プレイヤー画面に表示するポスター画像ファイルをアップロードします。",
"operationId": "createMediaContentPoster",
"parameters": [
{
"name": "upload_file_key",
"in": "path",
"description": "アップロードファイルキー",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"multipart/form-data": {
"schema": {
"required": [
"file"
],
"properties": {
"file": {
"description": "画像ファイル",
"type": "string",
"format": "binary"
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {},
"default": "[]"
},
"status": {
"description": "処理結果\n- `ok`: 成功\n- `fail`: 失敗",
"type": "string"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
},
"422": {
"description": "Unprocessable entity"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
}
},
"/media-contents/{upload_file_key}/poster/download": {
"get": {
"tags": [
"콘텐츠 관리"
],
"summary": "ポスター画像ダウンロード",
"description": "登録されたポスター画像ファイルをローカル環境にダウンロードできるURLを生成します。",
"operationId": "downloadMediaContentPoster",
"parameters": [
{
"name": "upload_file_key",
"in": "path",
"description": "アップロードファイルキー",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/ApiVodMediaContentDownloadPoster"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
}
},
"/media-contents/{upload_file_key}/original-file/download": {
"get": {
"tags": [
"콘텐츠 관리"
],
"summary": "原本ファイルダウンロードURL生成",
"description": "トランスコーディング前の原本メディアファイルをダウンロードできるURLを生成します。原本ファイル保存機能が有効化されている場合のみ利用可能です。",
"operationId": "downloadMediaContentOriginalFile",
"parameters": [
{
"name": "upload_file_key",
"in": "path",
"description": "アップロードファイルキー",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"properties": {
"expires": {
"description": "URL満了日時",
"type": "string"
},
"download_url": {
"description": "ダウンロードURL",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
}
},
"/media-contents/{upload_file_key}/progress": {
"get": {
"tags": [
"트랜스코딩 관리"
],
"summary": "トランスコーディング進行状況を照会",
"description": "アップロードされたコンテンツのトランスコーディング進行ステータスを照会します。進行ステータスデータは10秒周期で更新されます。",
"operationId": "getMediaContentProgress",
"parameters": [
{
"name": "upload_file_key",
"in": "path",
"description": "アップロードファイルキー",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/ApiVodMediaContentProgress"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
}
},
"/media-contents/{upload_file_key}/transcoding-files": {
"get": {
"tags": [
"트랜스코딩 관리"
],
"summary": "トランスコーディングファイルリスト照会",
"description": "特定コンテンツで生成されたすべてのトランスコーディングファイルリストを照会します。",
"operationId": "getMediaContentTranscodingFiles",
"parameters": [
{
"name": "upload_file_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/ApiVodTranscodingFile"
}
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
}
},
"/media-contents/{upload_file_key}/transcoding-files/{transcoding_file_id}/download": {
"get": {
"tags": [
"트랜스코딩 관리"
],
"summary": "トランスコーディングファイルダウンロードURL生成",
"description": "トランスコーディングファイルIDを指定して、指定されたファイルをローカル環境にダウンロードできるURLを生成します。",
"operationId": "downloadMediaContentTranscodingFile",
"parameters": [
{
"name": "upload_file_key",
"in": "path",
"description": "アップロードファイルキー",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "transcoding_file_id",
"in": "path",
"description": "トランスコーディングファイルID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"properties": {
"expires": {
"description": "URL満了日時",
"type": "string"
},
"download_url": {
"description": "ダウンロードURL",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
}
},
"/media-contents/{upload_file_key}/media-profiles/{media_profile_key}/transcoding-jobs": {
"post": {
"tags": [
"트랜스코딩 관리"
],
"summary": "追加トランスコーディングジョブ生成",
"description": "既存コンテンツに新しいエンコーディングプロファイルを適用して追加のトランスコーディングジョブをリクエストします。ただし、すでにトランスコーディングが進行中のファイルは対象から除外されます。",
"operationId": "createMediaContentTranscodingJob",
"parameters": [
{
"name": "upload_file_key",
"in": "path",
"description": "アップロードファイルキー",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "media_profile_key",
"in": "path",
"description": "エンコーディングプロファイルキー",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"201": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiVodMediaContentTranscodingJob"
}
},
"status": {
"description": "処理結果\n- `ok`: 成功\n- `fail`: 失敗",
"type": "string"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
},
"422": {
"description": "Unprocessable entity"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
}
},
"/media-contents/{upload_file_key}/transcoding-files/{transcoding_file_id}/enable": {
"put": {
"tags": [
"트랜스코딩 관리"
],
"summary": "トランスコーディングファイル有効化（ファイルID基準）",
"description": "特定のトランスコーディングファイルを有効化して、指定された品質の映像がプレイヤーで再生できるように設定します。",
"operationId": "enableMediaContentTranscodingFile",
"parameters": [
{
"name": "upload_file_key",
"in": "path",
"description": "アップロードファイルキー",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "transcoding_file_id",
"in": "path",
"description": "トランスコーディングファイルID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/ApiVodTranscodingFile"
},
"status": {
"description": "処理結果\n- `ok`: 成功\n- `fail`: 失敗",
"type": "string"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
}
},
"/media-contents/{upload_file_key}/media-profiles/{profile_key}/enable": {
"put": {
"tags": [
"트랜스코딩 관리"
],
"summary": "トランスコーディングファイル有効化（プロファイルキー基準）",
"description": "特定のエンコーディングプロファイルキーを基準に生成されたトランスコーディングファイルを有効ステータスに変更して、指定された品質の映像がプレイヤーで再生できるように設定します。",
"operationId": "enableMediaContentMediaProfile",
"parameters": [
{
"name": "upload_file_key",
"in": "path",
"description": "アップロードファイルキー",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "profile_key",
"in": "path",
"description": "エンコーディングプロファイルキー",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/ApiVodTranscodingFile"
},
"status": {
"description": "処理結果\n- `ok`: 成功\n- `fail`: 失敗",
"type": "string"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
}
},
"/media-contents/{upload_file_key}/transcoding-files/{transcoding_file_id}/disable": {
"put": {
"tags": [
"트랜스코딩 관리"
],
"summary": "トランスコーディングファイル無効（ファイルID基準）",
"description": "特定のトランスコーディングファイルを無効ステータスに変更して、指定された品質の映像再生を一時的に制限します。",
"operationId": "disableMediaContentTranscodingFile",
"parameters": [
{
"name": "upload_file_key",
"in": "path",
"description": "アップロードファイルキー",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "transcoding_file_id",
"in": "path",
"description": "トランスコーディングファイルID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/ApiVodTranscodingFile"
},
"status": {
"description": "処理結果\n- `ok`: 成功\n- `fail`: 失敗",
"type": "string"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
}
},
"/media-contents/{upload_file_key}/media-profiles/{profile_key}/disable": {
"put": {
"tags": [
"트랜스코딩 관리"
],
"summary": "トランスコーディングファイル無効（プロファイルキー基準）",
"description": "特定のエンコーディングプロファイルキーを基準に生成されたトランスコーディングファイルを無効ステータスに変更して、指定された品質の映像再生を一時的に制限します。",
"operationId": "disableMediaContentMediaProfile",
"parameters": [
{
"name": "upload_file_key",
"in": "path",
"description": "アップロードファイルキー",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "profile_key",
"in": "path",
"description": "エンコーディングプロファイルキー",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/ApiVodTranscodingFile"
},
"status": {
"description": "処理結果\n- `ok`: 成功\n- `fail`: 失敗",
"type": "string"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
}
},
"/media-contents/{upload_file_key}/transcoding-files/{transcoding_file_id}": {
"delete": {
"tags": [
"트랜스코딩 관리"
],
"summary": "トランスコーディングファイル削除（ファイルID基準）",
"description": "特定のトランスコーディングファイルをシステムから永久に削除します。",
"operationId": "deleteMediaContentTranscodingFile",
"parameters": [
{
"name": "upload_file_key",
"in": "path",
"description": "アップロードファイルキー",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "transcoding_file_id",
"in": "path",
"description": "トランスコーディングファイルID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {},
"default": "[]"
},
"status": {
"description": "処理結果\n- `ok`: 成功\n- `fail`: 失敗",
"type": "string"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
}
},
"/media-contents/{upload_file_key}/media-profiles/{profile_key}": {
"delete": {
"tags": [
"트랜스코딩 관리"
],
"summary": "トランスコーディングファイル削除（プロファイルキー基準）",
"description": "特定のエンコーディングプロファイルキーを基に生成されたトランスコーディングファイルをシステムから永久に削除します。",
"operationId": "deleteMediaContentMediaProfile",
"parameters": [
{
"name": "upload_file_key",
"in": "path",
"description": "アップロードファイルキー",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "profile_key",
"in": "path",
"description": "エンコーディングプロファイルキー",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {},
"default": "[]"
},
"status": {
"description": "処理結果\n- `ok`: 成功\n- `fail`: 失敗",
"type": "string"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
}
},
"/media-contents/{upload_file_key}/ai-subtitles": {
"post": {
"tags": [
"AI 서비스",
"자막 관리"
],
"summary": "AI字幕生成",
"description": "AIベースの音声認識(STT)技術を活用してコンテンツの音声データをリアルタイムで分析し、テキスト形式の字幕ファイルに自動変換して登録します。",
"operationId": "createMediaContentAiSubtitle",
"parameters": [
{
"name": "upload_file_key",
"in": "path",
"description": "アップロードファイルキー",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"language_code",
"status",
"kind"
],
"properties": {
"language_code": {
"description": "映像・音声の主要言語",
"type": "string",
"enum": [
"ja"
]
},
"kind": {
"description": "AI字幕タイプ設定\n- `0`: メイン字幕\n- `1`: サブ字幕",
"type": "integer",
"enum": [
0,
1
]
},
"status": {
"description": "AI字幕公開設定\n- `0`: 非公開\n- `1`: 公開",
"type": "integer",
"enum": [
0,
1
]
}
},
"type": "object"
}
}
}
},
"responses": {
"204": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "object"
},
"status": {
"description": "処理結果\n- `ok`: 成功\n- `fail`: 失敗",
"type": "string"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
},
"422": {
"description": "Unprocessable entity"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
}
},
"/media-contents/{upload_file_key}/ai-outlines": {
"get": {
"tags": [
"AI 서비스"
],
"summary": "AI要約·チャプターデータ照会",
"description": "特定のコンテンツに対して生成されたAIベースの要約情報、チャプター区分および主要キーワードデータを照会します。字幕言語コード(`language_code`)を基準にフィルタリングできます。",
"operationId": "getMediaContentAiOutlines",
"parameters": [
{
"name": "upload_file_key",
"in": "path",
"description": "アップロードファイルキー",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "language_code",
"in": "query",
"description": "字幕言語コード",
"schema": {
"type": "string",
"enum": [
"ko",
"en"
]
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiVodMediaContentOutline"
}
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
},
"post": {
"tags": [
"AI 서비스"
],
"summary": "AI要約·チャプターデータ生成",
"description": "特定のコンテンツに対してAIベースの要約情報、チャプター区分および主要キーワードデータを生成します。",
"operationId": "createMediaContentAiOutline",
"parameters": [
{
"name": "upload_file_key",
"in": "path",
"description": "アップロードファイルキー",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"language_code"
],
"properties": {
"language_code": {
"description": "映像・音声の主要言語",
"type": "string",
"enum": [
"ko",
"en"
]
},
"ai_subtitle_kind": {
"description": "AI字幕タイプ設定\n- `0`: メイン字幕\n- `1`: サブ字幕",
"type": "integer",
"enum": [
0,
1
]
},
"ai_subtitle_status": {
"description": "AI字幕公開設定\n- `0`: 非公開\n- `1`: 公開",
"type": "integer",
"enum": [
0,
1
]
}
},
"type": "object"
}
}
}
},
"responses": {
"204": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "object"
},
"status": {
"description": "処理結果\n- `ok`: 成功\n- `fail`: 失敗",
"type": "string"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not found"
},
"409": {
"description": "Conflict"
},
"422": {
"description": "Unprocessable entity"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
}
},
"/media-contents/{upload_file_key}/ai-scripts": {
"post": {
"tags": [
"AI 서비스"
],
"summary": "コンテンツAI倍速変換",
"description": "特定のコンテンツをAI倍速機能が適用されたコンテンツに変換します。すべてのトランスコーディングファイルが変換されます。変換作業完了時にメールまたはコールバック通知を送信します。",
"operationId": "createMediaContentAiScript",
"parameters": [
{
"name": "upload_file_key",
"in": "path",
"description": "アップロードファイルキー",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "object"
},
"status": {
"description": "処理結果\n- `ok`: 成功\n- `fail`: 失敗",
"type": "string"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
},
"422": {
"description": "Unprocessable entity"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
}
},
"/media-contents/{upload_file_key}/subtitles": {
"get": {
"tags": [
"자막 관리"
],
"summary": "字幕リスト照会",
"description": "特定のコンテンツに登録された全字幕リストを照会します。字幕名(`name`)または字幕言語コード(`language_code`)を基準にフィルタリングできます。",
"operationId": "getMediaContentSubtitles",
"parameters": [
{
"name": "upload_file_key",
"in": "path",
"description": "アップロードファイルキー",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "name",
"in": "query",
"description": "字幕名",
"schema": {
"type": "string"
}
},
{
"name": "language_code",
"in": "query",
"description": "字幕言語コード",
"schema": {
"type": "string",
"enum": [
"ja"
]
}
},
{
"name": "status",
"in": "query",
"description": "字幕公開設定フィルタリング\n- `0`: 非公開\n- `1`: 公開",
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiVodMediaContentSubtitle"
}
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
},
"post": {
"tags": [
"자막 관리"
],
"summary": "字幕登録",
"description": "字幕テキスト内容を直接入力して特定のコンテンツの字幕を生成します。",
"operationId": "createMediaContentSubtitle",
"parameters": [
{
"name": "upload_file_key",
"in": "path",
"description": "アップロードファイルキー",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"body",
"type",
"kind",
"name",
"language_code"
],
"properties": {
"body": {
"description": "実際の字幕テキスト",
"type": "string"
},
"type": {
"description": "字幕ファイル規格",
"type": "string",
"enum": [
"vtt",
"srt"
]
},
"kind": {
"description": "字幕タイプ\n- `main`: メイン字幕\n- `sub`: サブ字幕",
"type": "string",
"enum": [
"main",
"sub"
]
},
"status": {
"description": "字幕公開設定\n- `0`: 非公開\n- `1`: 公開",
"type": "integer",
"default": 1,
"enum": [
0,
1
]
},
"name": {
"description": "プレイヤー字幕リストに表示する字幕名",
"type": "string"
},
"language_code": {
"description": "字幕言語コード",
"type": "string",
"enum": [
"ja"
]
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/ApiVodMediaContentSubtitle"
},
"status": {
"description": "処理結果\n- `ok`: 成功\n- `fail`: 失敗",
"type": "string"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
},
"422": {
"description": "Unprocessable entity"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
}
},
"/media-contents/{upload_file_key}/subtitles/upload": {
"post": {
"tags": [
"자막 관리"
],
"summary": "字幕ファイル新規アップロード",
"description": "字幕ファイルをアップロードして指定されたコンテンツの字幕情報を生成します。",
"operationId": "uploadMediaContentSubtitle",
"parameters": [
{
"name": "upload_file_key",
"in": "path",
"description": "アップロードファイルキー",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"multipart/form-data": {
"schema": {
"required": [
"file",
"language_code",
"kind"
],
"properties": {
"file": {
"description": "字幕ファイル (VTT または SRT)",
"type": "string",
"format": "binary"
},
"name": {
"description": "プレイヤー字幕リストに表示する字幕名",
"type": "string"
},
"language_code": {
"description": "字幕言語コード",
"type": "string",
"enum": [
"ja"
]
},
"kind": {
"description": "字幕タイプ\n- `main`: メイン字幕\n- `sub`: サブ字幕",
"type": "string",
"enum": [
"main",
"sub"
]
},
"status": {
"description": "字幕公開設定\n- `0`: 非公開\n- `1`: 公開",
"type": "integer",
"default": 1,
"enum": [
0,
1
]
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/ApiVodMediaContentSubtitle"
},
"status": {
"description": "処理結果\n- `ok`: 成功\n- `fail`: 失敗",
"type": "string"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
},
"422": {
"description": "Unprocessable entity"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
}
},
"/media-contents/{upload_file_key}/subtitles/{subtitle_id}/upload": {
"post": {
"tags": [
"자막 관리"
],
"summary": "字幕ファイル更新",
"description": "既存の字幕データを新しい字幕ファイルに置き換えます。",
"operationId": "updateMediaContentSubtitleFile",
"parameters": [
{
"name": "upload_file_key",
"in": "path",
"description": "アップロードファイルキー",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "subtitle_id",
"in": "path",
"description": "更新対象の字幕ID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"multipart/form-data": {
"schema": {
"required": [
"file",
"language_code",
"kind"
],
"properties": {
"file": {
"description": "新しい字幕ファイル（VTTまたはSRT）",
"type": "string",
"format": "binary"
},
"name": {
"description": "プレイヤーの字幕リストに表示する字幕名",
"type": "string"
},
"language_code": {
"description": "字幕言語コード",
"type": "string",
"enum": [
"ja"
]
},
"kind": {
"description": "字幕タイプ\n- `main`: メイン字幕\n- `sub`: サブ字幕",
"type": "string",
"enum": [
"main",
"sub"
]
},
"status": {
"description": "字幕公開設定\n- `0`: 非公開\n- `1`: 公開\n\n値を入力しない場合、既存の設定が維持されます。",
"type": "integer",
"enum": [
0,
1
]
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/ApiVodMediaContentSubtitle"
},
"status": {
"description": "処理結果\n- `ok`: 成功\n- `fail`: 失敗",
"type": "string"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
},
"422": {
"description": "Unprocessable entity"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
}
},
"/media-contents/{upload_file_key}/subtitles/{subtitle_id}": {
"get": {
"tags": [
"자막 관리"
],
"summary": "字幕情報照会",
"description": "特定の字幕の詳細情報を照会します。",
"operationId": "getMediaContentSubtitle",
"parameters": [
{
"name": "upload_file_key",
"in": "path",
"description": "アップロードファイルキー",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "subtitle_id",
"in": "path",
"description": "字幕ID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/ApiVodMediaContentSubtitle"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
},
"put": {
"tags": [
"자막 관리"
],
"summary": "字幕情報修正",
"description": "既存に登録された字幕の内容や言語設定などの情報を修正します。",
"operationId": "updateMediaContentSubtitle",
"parameters": [
{
"name": "upload_file_key",
"in": "path",
"description": "アップロードファイルキー",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "subtitle_id",
"in": "path",
"description": "修正対象の字幕ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"body",
"type",
"kind",
"name",
"language_code"
],
"properties": {
"body": {
"description": "実際の字幕テキスト",
"type": "string"
},
"type": {
"description": "字幕ファイル規格",
"type": "string",
"enum": [
"vtt",
"srt"
]
},
"kind": {
"description": "字幕タイプ\n- `main`: メイン字幕\n- `sub`: サブ字幕",
"type": "string",
"enum": [
"main",
"sub"
]
},
"status": {
"description": "字幕公開設定\n- `0`: 非公開\n- `1`: 公開\n\n値を入力しない場合、既存の設定が維持されます。",
"type": "integer",
"enum": [
0,
1
]
},
"name": {
"description": "プレイヤーの字幕リストに表示する字幕名",
"type": "string"
},
"language_code": {
"description": "字幕言語コード",
"type": "string",
"enum": [
"ja"
]
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/ApiVodMediaContentSubtitle"
},
"status": {
"description": "処理結果\n- `ok`: 成功\n- `fail`: 失敗",
"type": "string"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
},
"422": {
"description": "Unprocessable entity"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
},
"delete": {
"tags": [
"자막 관리"
],
"summary": "字幕削除",
"description": "特定の字幕をシステムから永久に削除します。",
"operationId": "deleteMediaContentSubtitle",
"parameters": [
{
"name": "upload_file_key",
"in": "path",
"description": "アップロードファイルキー",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "subtitle_id",
"in": "path",
"description": "削除対象の字幕ID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {},
"default": "[]"
},
"status": {
"description": "処理結果\n- `ok`: 成功\n- `fail`: 失敗",
"type": "string"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
},
"422": {
"description": "Unprocessable entity"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
}
},
"/media-contents/{upload_file_key}/subtitles/{subtitle_id}/move": {
"put": {
"tags": [
"자막 관리"
],
"summary": "字幕表示順序変更（特定位置）",
"description": "プレイヤーの字幕選択リストで、指定された字幕の表示順序を`id`パラメーターで指定された字幕の位置に変更します。",
"operationId": "moveMediaContentSubtitle",
"parameters": [
{
"name": "upload_file_key",
"in": "path",
"description": "アップロードファイルキー",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "subtitle_id",
"in": "path",
"description": "順序変更対象の字幕ID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"id"
],
"properties": {
"id": {
"description": "目標位置の字幕ID",
"type": "integer"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/ApiVodMediaContentSubtitle"
},
"status": {
"description": "処理結果\n- `ok`: 成功\n- `fail`: 失敗",
"type": "string"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
},
"422": {
"description": "Unprocessable entity"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
}
},
"/media-contents/{upload_file_key}/subtitles/{subtitle_id}/move-first": {
"put": {
"tags": [
"자막 관리"
],
"summary": "字幕の表示順変更（リストの先頭）",
"description": "プレイヤーの字幕選択リストで、指定した字幕を一番上に表示します。",
"operationId": "moveMediaContentSubtitleToFirst",
"parameters": [
{
"name": "upload_file_key",
"in": "path",
"description": "アップロードファイルキー",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "subtitle_id",
"in": "path",
"description": "順序変更対象の字幕ID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/ApiVodMediaContentSubtitle"
},
"status": {
"description": "処理結果\n- `ok`: 成功\n- `fail`: 失敗",
"type": "string"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
},
"422": {
"description": "Unprocessable entity"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
}
},
"/media-contents/{upload_file_key}/subtitles/{subtitle_id}/move-last": {
"put": {
"tags": [
"자막 관리"
],
"summary": "字幕の表示順変更（リストの最後）",
"description": "プレイヤーの字幕選択リストで、指定した字幕を一番下に表示します。",
"operationId": "moveMediaContentSubtitleToLast",
"parameters": [
{
"name": "upload_file_key",
"in": "path",
"description": "アップロードファイルキー",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "subtitle_id",
"in": "path",
"description": "順序変更対象の字幕ID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/ApiVodMediaContentSubtitle"
},
"status": {
"description": "処理結果\n- `ok`: 成功\n- `fail`: 失敗",
"type": "string"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
},
"422": {
"description": "Unprocessable entity"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
}
},
"/media-content-keys/{media_content_key}/bookmarks": {
"get": {
"tags": [
"북마크 관리"
],
"summary": "ブックマークリスト照会（コンテンツキー基準）",
"description": "特定のユーザーが特定のコンテンツに追加したブックマークのリストを照会します。",
"operationId": "getMediaContentKeyBookmarks",
"parameters": [
{
"name": "media_content_key",
"in": "path",
"description": "コンテンツキー",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "client_user_id",
"in": "query",
"description": "ユーザーID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiVodBookmark"
}
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
}
},
"/media-contents/{upload_file_key}/bookmarks": {
"get": {
"tags": [
"북마크 관리"
],
"summary": "ブックマークリスト照会 (アップロードファイルキー基準)",
"description": "特定コンテンツに追加されたブックマークリストを照会します。`client_user_id` パラメーターを指定すると、指定されたユーザーが追加したブックマークリストのみ照会します。",
"operationId": "getMediaContentBookmarks",
"parameters": [
{
"name": "upload_file_key",
"in": "path",
"description": "アップロードファイルキー",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "client_user_id",
"in": "query",
"description": "ユーザーID",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiVodBookmark"
}
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
},
"post": {
"tags": [
"북마크 관리"
],
"summary": "ブックマーク追加",
"description": "コンテンツの特定の時点にブックマークを追加します。",
"operationId": "createMediaContentBookmark",
"parameters": [
{
"name": "upload_file_key",
"in": "path",
"description": "アップロードファイルキー",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"position"
],
"properties": {
"position": {
"description": "ブックマーク位置 (単位: 秒)",
"type": "string"
},
"value": {
"description": "ブックマーク内容",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/ApiVodBookmark"
},
"status": {
"description": "処理結果\n- `ok`: 成功\n- `fail`: 失敗",
"type": "string"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
},
"422": {
"description": "Unprocessable entity"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
}
},
"/media-contents/{upload_file_key}/bookmarks/{bookmark_id}": {
"put": {
"tags": [
"북마크 관리"
],
"summary": "ブックマーク修正",
"description": "既存ブックマークの内容を修正します。",
"operationId": "updateMediaContentBookmark",
"parameters": [
{
"name": "upload_file_key",
"in": "path",
"description": "アップロードファイルキー",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "bookmark_id",
"in": "path",
"description": "ブックマークID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"value": {
"description": "修正するブックマーク内容",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/ApiVodBookmark"
},
"status": {
"description": "処理結果\n- `ok`: 成功\n- `fail`: 失敗",
"type": "string"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
},
"422": {
"description": "Unprocessable entity"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
},
"delete": {
"tags": [
"북마크 관리"
],
"summary": "ブックマーク削除",
"description": "ブックマークIDを使用して保存されたブックマークを削除します。",
"operationId": "deleteMediaContentBookmark",
"parameters": [
{
"name": "upload_file_key",
"in": "path",
"description": "アップロードファイルキー",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "bookmark_id",
"in": "path",
"description": "ブックマークID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {},
"default": "[]"
},
"status": {
"description": "処理結果\n- `ok`: 成功\n- `fail`: 失敗",
"type": "string"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
},
"422": {
"description": "Unprocessable entity"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
}
},
"/media-profiles/format": {
"get": {
"tags": [
"인코딩 프로파일 관리"
],
"summary": "サポート規格全体照会",
"description": "システムでサポートするビデオおよびオーディオエンコーディングプロファイルの標準フォーマット情報を照会します。",
"operationId": "getMediaProfileFormats",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiProfileFormat"
}
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
}
},
"/media-profiles/preset": {
"get": {
"tags": [
"인코딩 프로파일 관리"
],
"summary": "エンコーディングプロファイルプリセットリスト照会",
"description": "エンコーディングプロファイル生成時にテンプレートとして活用可能な標準プリセットリストを照会します。",
"operationId": "getMediaProfilePresets",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiVodMediaProfilePreset"
}
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
}
},
"/media-profile-groups": {
"get": {
"tags": [
"인코딩 프로파일 관리"
],
"summary": "エンコーディングプロファイルグループリスト照会",
"description": "システムに登録された全エンコーディングプロファイルグループリストを照会します。",
"operationId": "getMediaProfileGroups",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiVodMediaProfileGroup"
}
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
}
},
"/media-profiles": {
"get": {
"tags": [
"인코딩 프로파일 관리"
],
"summary": "エンコーディングプロファイルリスト照会",
"description": "全エンコーディングプロファイルリストを照会します。",
"operationId": "getMediaProfiles",
"parameters": [
{
"name": "order",
"in": "query",
"description": "データ表示順",
"schema": {
"type": "string",
"default": "id_asc",
"enum": [
"id_asc",
"id_desc",
"name_asc",
"name_desc"
]
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiVodMediaProfile"
}
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
},
"post": {
"tags": [
"인코딩 프로파일 관리"
],
"summary": "新規エンコーディングプロファイル生成",
"description": "プリセットIDを基に新しいエンコーディングプロファイルを生成します。",
"operationId": "createMediaProfile",
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"media_profile_preset_id"
],
"properties": {
"media_profile_preset_id": {
"description": "エンコーディングプロファイルプリセットID",
"type": "integer"
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/ApiVodMediaProfile"
},
"status": {
"description": "処理結果\n- `ok`: 成功\n- `fail`: 失敗",
"type": "string"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
},
"422": {
"description": "Unprocessable entity"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
}
},
"/media-profiles/{media_profile_key}": {
"get": {
"tags": [
"인코딩 프로파일 관리"
],
"summary": "エンコーディングプロファイル詳細規格照会",
"description": "特定エンコーディングプロファイルの詳細技術規格を照会します。",
"operationId": "getMediaProfile",
"parameters": [
{
"name": "media_profile_key",
"in": "path",
"description": "エンコーディングプロファイルキー",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/ApiVodMediaProfile"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
},
"put": {
"tags": [
"인코딩 프로파일 관리"
],
"summary": "エンコーディングプロファイル詳細規格修正",
"description": "エンコーディングプロファイルのコーデック、解像度、ビットレートなどの詳細規格を修正します。ハードウェアエンコーディングの使用有無により、一部の最新コーデック(H.265、AV1)の設定が制限される場合があります。",
"operationId": "updateMediaProfile",
"parameters": [
{
"name": "media_profile_key",
"in": "path",
"description": "エンコーディングプロファイルキー",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"name": {
"description": "エンコーディングプロファイル名",
"type": "string"
},
"video_codec": {
"description": "ビデオコーデック (H.265/AV1はハードウェアエンコーディング時のみサポート可能)",
"type": "string",
"enum": [
"H.264/MPEG-4 AVC",
"H.264/MPEG-4 AVC (Baseline@L1.3 Mobile)",
"H.264/MPEG-4 AVC (Baseline@L3.0)",
"H.264/MPEG-4 AVC (Main@L3.0)",
"H.264/MPEG-4 AVC (High@L3.0)",
"H.264/MPEG-4 AVC (High@L4.1)",
"MPEG-4 Video (MP4V)",
"H.265 (Main)",
"H.265 (Baseline)",
"H.265 (High)",
"AV1 (Main)",
"AV1 (Main10)"
]
},
"video_ratio": {
"description": "映像比率 (トランスコーダー2.0使用時に `Auto` 設定可能、比率が合わない場合はwidth基準に合わせる)",
"type": "string",
"enum": [
"16:9",
"16:10",
"4:3",
"21:9",
"Custom",
"Auto (Width)",
"Auto (Height)"
]
},
"video_width": {
"description": "映像の幅（または 映像の横幅） (px)",
"type": "integer",
"maximum": 4096,
"minimum": 0
},
"video_height": {
"description": "ビデオ縦解像度 (px)",
"type": "integer",
"maximum": 2160,
"minimum": 0
},
"container_format": {
"description": "コンテナフォーマット",
"type": "string",
"enum": [
"mp4",
"MP4"
]
},
"bitrate_mode": {
"description": "ビットレートモード",
"type": "string",
"enum": [
"cbr",
"vbr"
]
},
"video_bitrate": {
"description": "ビデオビットレート (kbps)",
"type": "integer",
"maximum": 100000,
"minimum": 0
},
"video_framerate": {
"description": "ビデオフレームレート (fps)",
"type": "number"
},
"audio_codec": {
"description": "オーディオコーデック",
"type": "string",
"enum": [
"AAC",
"MP3"
]
},
"audio_bitrate": {
"description": "オーディオビットレート (Kbps)",
"type": "integer",
"enum": [
48,
56,
64,
96,
128,
192,
256,
320
]
},
"audio_samplerate": {
"description": "オーディオサンプルレート (Hz)",
"type": "integer",
"enum": [
11025,
22050,
44100,
48000
]
},
"status": {
"description": "エンコーディングプロファイル有効化設定\n- `0`: 無効\n- `1`: 有効",
"type": "integer",
"enum": [
0,
1
]
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/ApiVodMediaProfile"
},
"status": {
"description": "処理結果\n- `ok`: 成功\n- `fail`: 失敗",
"type": "string"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
},
"422": {
"description": "Unprocessable entity"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
}
},
"/media-profiles/{media_profile_key}/categories/{category_key}/attach": {
"post": {
"tags": [
"인코딩 프로파일 관리"
],
"summary": "プロファイル-カテゴリ紐づけ",
"description": "カテゴリに特定のエンコーディングプロファイルを紐づけします。",
"operationId": "attachCategoryToMediaProfile",
"parameters": [
{
"name": "media_profile_key",
"in": "path",
"description": "エンコーディングプロファイルキー",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "category_key",
"in": "path",
"description": "カテゴリキー",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"201": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/ApiVodMediaProfile"
},
"status": {
"description": "処理結果\n- `ok`: 成功\n- `fail`: 失敗",
"type": "string"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
},
"422": {
"description": "Unprocessable entity"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
}
},
"/media-profiles/{media_profile_key}/categories/{category_key}/detach": {
"delete": {
"tags": [
"인코딩 프로파일 관리"
],
"summary": "プロファイル-カテゴリ紐づけ解除",
"description": "エンコーディングプロファイルとカテゴリの紐づけ状態を解除します。",
"operationId": "detachCategoryFromMediaProfile",
"parameters": [
{
"name": "media_profile_key",
"in": "path",
"description": "エンコーディングプロファイルキー",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "category_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/ApiVodMediaProfile"
}
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
},
"422": {
"description": "Unprocessable entity"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
}
},
"/service-accounts/{service_account_key}/duplicate-blocks/logs": {
"get": {
"tags": [
"중복 재생 차단 관리"
],
"summary": "重複再生遮断記録照会",
"description": "特定のサービスアカウントで発生した重複再生遮断ログを照会します。",
"operationId": "getDuplicateBlockLogs",
"parameters": [
{
"name": "service_account_key",
"in": "path",
"description": "サービスアカウントキー",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "client_user_id",
"in": "query",
"description": "ユーザーID",
"schema": {
"type": "string"
}
},
{
"name": "player_id",
"in": "query",
"description": "プレイヤー(デバイス)ID",
"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": "page",
"in": "query",
"description": "取得ページ番号",
"schema": {
"type": "integer"
}
},
{
"name": "per_page",
"in": "query",
"description": "1ページに表示する個数",
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 1
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiVodDuplicateBlockLog"
}
},
"pagination": {
"properties": {
"current_page": {
"description": "現在のページ",
"type": "integer"
},
"per_page": {
"description": "1ページに表示する個数",
"type": "integer"
},
"total": {
"description": "総件数",
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
}
},
"/service-accounts/{service_account_key}/duplicate-blocks/players": {
"get": {
"tags": [
"중복 재생 차단 관리"
],
"summary": "重複再生許可デバイス照会",
"description": "特定のユーザー(`client_user_id`)に登録された重複再生許可デバイスのリストを照会します。",
"operationId": "getDuplicateBlockPlayers",
"parameters": [
{
"name": "service_account_key",
"in": "path",
"description": "サービスアカウントキー",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "client_user_id",
"in": "query",
"description": "ユーザーID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiVodDuplicateBlockPlayerList"
}
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
},
"delete": {
"tags": [
"중복 재생 차단 관리"
],
"summary": "重複再生許可デバイス削除",
"description": "特定のユーザー(`client_user_id`)に登録された許可デバイスの中から特定のデバイス(`player_id`)を削除します。",
"operationId": "deleteDuplicateBlockPlayers",
"parameters": [
{
"name": "service_account_key",
"in": "path",
"description": "サービスアカウントキー",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "client_user_id",
"in": "query",
"description": "ユーザーID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "player_id",
"in": "query",
"description": "プレイヤー(デバイス)ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"201": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {},
"default": "[]"
},
"status": {
"description": "処理結果\n- `ok`: 成功\n- `fail`: 失敗",
"type": "string"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
},
"422": {
"description": "Unprocessable entity"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
}
},
"/service-accounts/{service_account_key}/duplicate-blocks/players/reset": {
"post": {
"tags": [
"중복 재생 차단 관리"
],
"summary": "重複再生許可デバイス全体初期化",
"description": "特定のユーザー(`client_user_id`)に登録されたすべての重複再生許可デバイスを一括削除します。",
"operationId": "resetDuplicateBlockPlayers",
"parameters": [
{
"name": "service_account_key",
"in": "path",
"description": "サービスアカウントキー",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"client_user_id"
],
"properties": {
"client_user_id": {
"description": "ユーザーID",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {},
"default": "[]"
},
"status": {
"description": "処理結果\n- `ok`: 成功\n- `fail`: 失敗",
"type": "string"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
},
"422": {
"description": "Unprocessable entity"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
}
},
"/player-skins": {
"get": {
"tags": [
"플레이어 관리"
],
"summary": "プレイヤースキンリスト照会",
"description": "全プレイヤースキンのリストを照会します。",
"operationId": "getPlayerSkins",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiVodPlayerSkin"
}
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
}
},
"/player-skins/{player_skin_id}": {
"delete": {
"tags": [
"플레이어 관리"
],
"summary": "プレイヤースキン削除",
"description": "特定のプレイヤースキンをシステムから永久に削除します。",
"operationId": "deletePlayerSkin",
"parameters": [
{
"name": "player_skin_id",
"in": "path",
"description": "プレイヤースキンID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {},
"default": "[]"
},
"status": {
"description": "処理結果\n- `ok`: 成功\n- `fail`: 失敗",
"type": "string"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
}
},
"/player-events": {
"get": {
"tags": [
"플레이어 관리"
],
"summary": "プレイヤーイベントリスト照会",
"description": "全プレイヤーイベント(広告)のリストを照会します。",
"operationId": "getPlayerEvents",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiVodPlayerEvent"
}
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
}
},
"/player-events/{player_event_id}": {
"delete": {
"tags": [
"플레이어 관리"
],
"summary": "プレイヤーイベント削除",
"description": "特定のプレイヤーイベントをシステムから永久に削除します。",
"operationId": "deletePlayerEvent",
"parameters": [
{
"name": "player_event_id",
"in": "path",
"description": "プレイヤーイベントID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {},
"default": "[]"
},
"status": {
"description": "処理結果\n- `ok`: 成功\n- `fail`: 失敗",
"type": "string"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
}
},
"/statistics/content-rank": {
"get": {
"tags": [
"통계"
],
"summary": "全コンテンツ視聴ランキング照会",
"description": "サービスアカウント内のすべてのチャンネルのコンテンツを統合し、指定された期間中の照会数ベースのランキングリストを照会します。",
"operationId": "getContentRankStatistics",
"parameters": [
{
"name": "start_date",
"in": "query",
"description": "照会範囲の開始日",
"required": true,
"schema": {
"type": "string",
"example": "20260101"
}
},
{
"name": "end_date",
"in": "query",
"description": "照会範囲の終了日",
"required": true,
"schema": {
"type": "string",
"example": "20260201"
}
},
{
"name": "keyword",
"in": "query",
"description": "検索キーワードフィルタリング",
"schema": {
"type": "string"
}
},
{
"name": "start_index",
"in": "query",
"description": "結果リストの開始番号",
"schema": {
"type": "integer",
"default": 0
}
},
{
"name": "limit",
"in": "query",
"description": "最大取得件数(`0`: 全データ照会)",
"schema": {
"type": "integer",
"default": 10
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"result_data": {
"type": "array",
"items": {}
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
}
},
"/channels/{channel_key}/statistics/content-rank": {
"get": {
"tags": [
"통계"
],
"summary": "チャンネル別コンテンツ視聴ランキング照会",
"description": "特定のチャンネルに所属するコンテンツを対象に、指定された期間内の照会数ベースのランキングリストを照会します。",
"operationId": "getChannelContentRankStatistics",
"parameters": [
{
"name": "channel_key",
"in": "path",
"description": "チャンネルキー",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "start_date",
"in": "query",
"description": "照会範囲の開始日",
"required": true,
"schema": {
"type": "string",
"example": "20260101"
}
},
{
"name": "end_date",
"in": "query",
"description": "照会範囲の終了日",
"required": true,
"schema": {
"type": "string",
"example": "20260201"
}
},
{
"name": "keyword",
"in": "query",
"description": "検索キーワードフィルタリング",
"schema": {
"type": "string"
}
},
{
"name": "start_index",
"in": "query",
"description": "結果リストの開始番号",
"schema": {
"type": "integer",
"default": 0
}
},
{
"name": "limit",
"in": "query",
"description": "最大取得件数(`0`: 全データ照会)",
"schema": {
"type": "integer",
"default": 10
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"result_data": {
"type": "array",
"items": {}
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
}
},
"/statistics/channels": {
"get": {
"tags": [
"통계"
],
"summary": "チャンネル別統計照会",
"description": "すべてのチャンネルを対象に、指定した期間の統計サマリーデータを照会します。",
"operationId": "getChannelStatistics",
"parameters": [
{
"name": "start_date",
"in": "query",
"description": "照会範囲の開始日",
"required": true,
"schema": {
"type": "string",
"example": "20260101"
}
},
{
"name": "end_date",
"in": "query",
"description": "照会範囲の終了日",
"required": true,
"schema": {
"type": "string",
"example": "20260201"
}
},
{
"name": "start_index",
"in": "query",
"description": "結果リストの開始番号",
"schema": {
"type": "integer",
"default": 0
}
},
{
"name": "limit",
"in": "query",
"description": "最大取得件数(`0`: 全データ照会)",
"schema": {
"type": "integer",
"default": 10
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {}
},
"status": {
"description": "処理結果\n- `ok`: 成功\n- `fail`: 失敗",
"type": "string"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
}
},
"/statistics/summary-daily": {
"get": {
"tags": [
"통계"
],
"summary": "日別統計サマリー照会",
"description": "全コンテンツに対して発生した日付別の主要統計指標のサマリーデータを照会します。",
"operationId": "getDailySummaryStatistics",
"parameters": [
{
"name": "start_date",
"in": "query",
"description": "照会範囲の開始日",
"required": true,
"schema": {
"type": "string",
"example": "20260101"
}
},
{
"name": "end_date",
"in": "query",
"description": "照会範囲の終了日",
"required": true,
"schema": {
"type": "string",
"example": "20260201"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {}
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
}
},
"/statistics/countries": {
"get": {
"tags": [
"통계"
],
"summary": "国別統計の取得",
"description": "指定された期間の国別統計データを取得します。",
"operationId": "getCountriesStatistics",
"parameters": [
{
"name": "start_date",
"in": "query",
"description": "照会範囲の開始日",
"required": true,
"schema": {
"type": "string",
"example": "20260101"
}
},
{
"name": "end_date",
"in": "query",
"description": "照会範囲の終了日",
"required": true,
"schema": {
"type": "string",
"example": "20260201"
}
},
{
"name": "start_index",
"in": "query",
"description": "結果リストの開始番号",
"schema": {
"type": "integer",
"default": 0
}
},
{
"name": "limit",
"in": "query",
"description": "最大取得件数(`0`: 全データ照会)",
"schema": {
"type": "integer",
"default": 0
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {}
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthenticated"
},
"404": {
"description": "Not found"
}
},
"security": [
{
"kollus_api_access_token": []
}
]
}
}
},
"components": {
"schemas": {
"ApiVodMediaContentDownloadPoster": {
"properties": {
"expires": {
"description": "URL満了日時",
"type": "string"
},
"download_url": {
"description": "ダウンロードURL",
"type": "string"
}
},
"type": "object"
},
"ApiProfileFormat": {
"properties": {
"video_bitrate": {
"description": "ビデオビットレート"
},
"video_framerate": {
"description": "ビデオフレームレート"
},
"audio_bitrate": {
"description": "オーディオビットレート"
},
"audio_samplerate": {
"description": "オーディオサンプルレート"
}
},
"type": "object"
},
"ApiVodBookmark": {
"properties": {
"id": {
"description": "ブックマークID",
"type": "integer"
},
"kind": {
"description": "ブックマーク種類\n- `0`: マイブックマーク（視聴者が直接追加）\n- `1`: 公式ブックマーク（お客様が指定）",
"type": "integer"
},
"label": {
"description": "ブックマークラベル",
"type": "string"
},
"position": {
"description": "ブックマーク位置（単位：秒）",
"type": "integer"
},
"value": {
"description": "ブックマーク内容",
"type": "string"
},
"created_at": {
"description": "ブックマーク生成日時",
"type": "string"
},
"updated_at": {
"description": "ブックマーク修正日時",
"type": "string"
}
},
"type": "object"
},
"ApiVodCategory": {
"properties": {
"id": {
"description": "カテゴリID",
"type": "integer"
},
"key": {
"description": "カテゴリキー",
"type": "string"
},
"name": {
"description": "カテゴリ名",
"type": "string"
},
"parent_id": {
"description": "上位カテゴリID（`null`: 最上位カテゴリ）",
"type": "integer"
},
"parent_key": {
"description": "上位カテゴリキー（`null`: 最上位カテゴリ）",
"type": "string"
},
"level": {
"description": "カテゴリ階層レベル（`0`: 最上位カテゴリ）",
"type": "integer"
},
"default": {
"description": "「デフォルト」カテゴリ有無",
"type": "boolean"
},
"position": {
"description": "カテゴリ表示順序",
"type": "integer"
},
"created_at": {
"description": "カテゴリ生成日時",
"type": "string"
},
"updated_at": {
"description": "カテゴリ情報修正日時",
"type": "string"
},
"children_exist": {
"description": "下位カテゴリ保有有無",
"type": "boolean"
},
"channels": {
"description": "指定されたカテゴリに紐づけられたチャンネルリスト",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiVodChannelSummary"
}
}
},
"type": "object"
},
"ApiVodChannel": {
"properties": {
"key": {
"description": "チャンネルキー",
"type": "string"
},
"name": {
"description": "チャンネル名",
"type": "string"
},
"description": {
"description": "チャンネル説明",
"type": "string"
},
"use_pingback": {
"description": "コールバック機能の有効化有無",
"type": "boolean"
},
"pingback_url": {
"description": "コンテンツのチャンネル追加コールバックURL",
"type": "string"
},
"leave_pingback_url": {
"description": "コンテンツのチャンネル削除コールバックURL",
"type": "string"
},
"play_callback_url": {
"description": "再生コールバックURL",
"type": "string"
},
"use_referer_check": {
"description": "リファラーアクセス制御設定ポリシー\n- `0`: 未設定\n- `1`: 特定ドメイン許可\n- `2`: 特定ドメイン遮断",
"type": "integer"
},
"referer_check_domains": {
"description": "再生を許可するドメインアドレス",
"type": "string"
},
"referer_reject_domains": {
"description": "再生を遮断するドメインアドレス",
"type": "string"
},
"referer_empty_allow": {
"description": "リファラー情報がないリクエストの遮断有無",
"type": "boolean"
},
"use_pc_download": {
"description": "PCダウンロード使用有無",
"type": "boolean"
},
"pc_download_callback_url": {
"description": "PCダウンロードコールバックURL",
"type": "string"
},
"use_mobile_download": {
"description": "モバイルダウンロード利用の有無",
"type": "boolean"
},
"mobile_download_callback_url": {
"description": "モバイルダウンロードコールバックURL",
"type": "string"
},
"default": {
"description": "デフォルトチャンネル有無",
"type": "boolean"
},
"is_shared": {
"description": "共有ポリシー設定\n- `false`: 非共有チャンネル\n- `true`: 共有チャンネル",
"type": "boolean"
},
"is_encrypted": {
"description": "セキュリティポリシー設定 (`false`: 非暗号化(一般)チャンネル、`true`: 暗号化コンテンツ専用チャンネル)",
"type": "boolean"
},
"disable_tvout": {
"description": "外部ディスプレイ出力遮断設定",
"type": "boolean"
},
"count_of_contents": {
"description": "チャンネル内の全コンテンツ個数",
"type": "integer"
},
"position": {
"description": "チャンネル表示順序",
"type": "integer"
},
"status": {
"description": "チャンネル有効化ステータス",
"type": "boolean"
},
"use_realtime": {
"description": "リアルタイムストリーミング(HLS)使用有無",
"type": "boolean"
},
"use_aes128": {
"description": "AES-128暗号化使用有無",
"type": "boolean"
},
"video_watermarking_enable_block": {
"description": "ビデオウォーターマーキング使用有無",
"type": "boolean"
},
"created_at": {
"description": "チャンネル生成日時",
"type": "string"
},
"updated_at": {
"description": "チャンネル情報修正日時",
"type": "string"
}
},
"type": "object"
},
"ApiVodChannelSummary": {
"properties": {
"key": {
"description": "チャンネルキー",
"type": "string"
},
"name": {
"description": "チャンネル名",
"type": "string"
},
"status": {
"description": "チャンネル有効化ステータス",
"type": "boolean"
}
},
"type": "object"
},
"ApiCommonCountry": {
"properties": {
"id": {
"description": "国家ID",
"type": "integer"
},
"english_name": {
"description": "国家名称（英語表記）",
"type": "string"
},
"native_name": {
"description": "国家名称（現地言語表記）",
"type": "string"
},
"code_2char": {
"description": "国家コード（2桁）",
"type": "string"
},
"code_3char": {
"description": "国家コード（3桁）",
"type": "string"
},
"short_name": {
"description": "国家略称",
"type": "string"
}
},
"type": "object"
},
"ApiVodDuplicateBlockLog": {
"properties": {
"id": {
"description": "遮断ログID",
"type": "string"
},
"media_content_title": {
"description": "対象コンテンツのタイトル",
"type": "string"
},
"upload_file_key": {
"description": "アップロードファイルキー",
"type": "string"
},
"player_id": {
"description": "プレイヤー(デバイス)ID",
"type": "string"
},
"key": {
"description": "重複再生遮断キー",
"type": "string"
},
"client_user_id": {
"description": "ユーザーID",
"type": "string"
},
"hardware_id": {
"description": "ハードウェアID",
"type": "string"
},
"created_at": {
"description": "遮断日時",
"type": "string"
}
},
"type": "object"
},
"ApiVodDuplicateBlockPlayerList": {
"properties": {
"total_count": {
"description": "全データ個数",
"type": "integer"
},
"player_id": {
"description": "プレイヤー(デバイス)IDリスト",
"type": "array",
"items": {
"type": "string"
}
}
},
"type": "object"
},
"ApiCommonLanguage": {
"properties": {
"id": {
"description": "言語ID",
"type": "integer"
},
"english_name": {
"description": "言語名称（英語表記）",
"type": "string"
},
"native_name": {
"description": "言語名称（現地言語表記）",
"type": "string"
},
"code_2char": {
"description": "言語コード（2桁）",
"type": "string"
},
"use_subtitle": {
"description": "字幕サポート有無",
"type": "boolean"
},
"key": {
"description": "言語キー",
"type": "string"
}
},
"type": "object"
},
"ApiVodMediaContentCategory": {
"properties": {
"id": {
"description": "コンテンツID",
"type": "integer"
},
"title": {
"description": "コンテンツタイトル",
"type": "string"
},
"upload_file_key": {
"description": "アップロードファイルキー",
"type": "string"
},
"category_name": {
"description": "カテゴリ名",
"type": "string"
},
"category_key": {
"description": "カテゴリキー",
"type": "string"
}
},
"type": "object"
},
"ApiVodMediaContentKey": {
"properties": {
"id": {
"description": "ID",
"type": "integer"
},
"media_content_key": {
"description": "コンテンツキー",
"type": "string"
},
"upload_file_key": {
"description": "アップロードファイルキー",
"type": "string"
},
"channel_key": {
"description": "チャンネルキー",
"type": "string"
},
"status": {
"description": "キー有効化ステータス",
"type": "boolean"
},
"created_at": {
"description": "キー生成日時",
"type": "string"
},
"updated_at": {
"description": "キー情報修正日時",
"type": "string"
}
},
"type": "object"
},
"ApiVodMediaContentProgress": {
"properties": {
"id": {
"description": "コンテンツID",
"type": "integer"
},
"title": {
"description": "コンテンツタイトル",
"type": "string"
},
"upload_file_key": {
"description": "アップロードファイルキー",
"type": "string"
},
"transcoding_stage": {
"description": "トランスコーディング進行ステータスコード\n- `0`: 待機中\n- `11`: トランスコーディング準備中\n- `1`: トランスコーディング開始\n- `12`: トランスコーディング中\n- `21`: トランスコーディング完了\n- `51`: トランスコーディングエラー\n- `52`: 初期化失敗",
"type": "integer"
},
"transcoding_stage_name": {
"description": "トランスコーディング進行ステータス",
"type": "string"
},
"transcoding_progress": {
"description": "トランスコーディング進行率 (%)",
"type": "integer"
}
},
"type": "object"
},
"ApiVodMediaContent": {
"properties": {
"id": {
"description": "コンテンツID",
"type": "integer"
},
"kind": {
"description": "コンテンツタイプ分類コード\n- `1`: ビデオ\n- `2`: オーディオ",
"type": "integer"
},
"kind_name": {
"description": "コンテンツタイプ",
"type": "string"
},
"title": {
"description": "コンテンツタイトル",
"type": "string"
},
"upload_file_key": {
"description": "アップロードファイルキー",
"type": "string"
},
"duration": {
"description": "コンテンツ総時間",
"type": "string"
},
"category_name": {
"description": "カテゴリ名",
"type": "string"
},
"category_key": {
"description": "カテゴリキー",
"type": "string"
},
"use_encryption": {
"description": "暗号化適用有無",
"type": "boolean"
},
"poster_url": {
"description": "ポスター画像URL",
"type": "string"
},
"snapshot_url": {
"description": "スナップショット画像URL",
"type": "string"
},
"original_file_name": {
"description": "原本ファイル名",
"type": "string"
},
"original_file_size": {
"description": "原本ファイル容量",
"type": "integer"
},
"media_information": {
"description": "コンテンツ詳細情報",
"properties": {
"file": {
"description": "ファイル属性情報",
"properties": {
"filesize": {
"description": "ファイル容量",
"type": "string"
},
"format": {
"description": "コンテナフォーマット",
"type": "string"
},
"duration": {
"description": "コンテンツ総時間",
"type": "string"
},
"raw_duration": {
"description": "コンテンツ総時間 (単位: ミリ秒)",
"type": "integer"
}
}
},
"video": {
"description": "ビデオトラック情報",
"properties": {
"video_codec": {
"description": "ビデオコーデック",
"type": "string"
},
"video_bitrate": {
"description": "ビデオビットレート",
"type": "string"
},
"video_framerate": {
"description": "ビデオフレームレート",
"type": "string"
},
"video_screen_size": {
"description": "ビデオ解像度",
"type": "string"
},
"video_framecount": {
"description": "ビデオフレーム数",
"type": "boolean"
},
"video_raw_duration": {
"description": "ビデオトラック再生時間 (単位: ミリ秒)",
"type": "integer"
}
}
},
"audio": {
"description": "オーディオトラック情報",
"properties": {
"audio_codec": {
"description": "オーディオコーデック",
"type": "string"
},
"audio_bitrate": {
"description": "オーディオビットレート",
"type": "string"
},
"audio_samplerate": {
"description": "オーディオサンプルレート",
"type": "string"
},
"audio_channel": {
"description": "オーディオチャンネル数",
"type": "integer"
},
"audio_raw_duration": {
"description": "オーディオトラック再生時間 (単位: ミリ秒)",
"type": "integer"
}
}
}
}
},
"human_readable_original_file_size": {
"description": "原本ファイル容量 (単位: K, M, G, T)",
"type": "string"
},
"transcoding_stage": {
"description": "トランスコーディング進行ステータスコード\n- `0`: 待機中\n- `11`: トランスコーディング準備中\n- `1`: トランスコーディング開始\n- `12`: トランスコーディング中\n- `21`: トランスコーディング完了\n- `51`: トランスコーディングエラー\n- `52`: 初期化失敗",
"type": "integer"
},
"transcoding_stage_name": {
"description": "トランスコーディング進行ステータス",
"type": "string"
},
"status": {
"description": "コンテンツ有効化ステータス",
"type": "boolean"
},
"vr_info": {
"description": "VR設定情報",
"properties": {
"projection_type": {
"description": "投影方式",
"type": "string"
},
"stereo_mode": {
"description": "サウンドモード",
"type": "string"
}
},
"type": "object"
},
"is_passthrough": {
"description": "パススルー処理の有無",
"type": "boolean"
},
"media_content_keys": {
"description": "コンテンツキーリスト",
"type": "array",
"items": {
"type": "string"
}
},
"transcoded_at": {
"description": "トランスコーディング完了日時",
"type": "string"
},
"created_at": {
"description": "コンテンツ登録日時",
"type": "string"
},
"updated_at": {
"description": "コンテンツ情報修正日時",
"type": "string"
}
},
"type": "object"
},
"ApiVodMediaContentStatus": {
"properties": {
"id": {
"description": "コンテンツID",
"type": "integer"
},
"title": {
"description": "コンテンツタイトル",
"type": "string"
},
"status": {
"description": "コンテンツ有効化ステータス",
"type": "boolean"
}
},
"type": "object"
},
"ApiVodMediaContentSubtitle": {
"properties": {
"id": {
"description": "字幕ID",
"type": "integer"
},
"name": {
"description": "字幕名",
"type": "string"
},
"kind": {
"description": "字幕タイプ\n- `main`: メイン字幕\n- `sub`: サブ字幕",
"type": "string"
},
"status": {
"description": "字幕公開の有無\n- `false`: 非公開\n- `true`: 公開",
"type": "boolean"
},
"language_code": {
"description": "字幕言語コード",
"type": "string"
},
"vtt_url": {
"description": "VTTファイルパス",
"type": "string"
},
"srt_url": {
"description": "SRTファイルパス",
"type": "string"
},
"position": {
"description": "字幕表示順序",
"type": "integer"
}
},
"type": "object"
},
"ApiVodMediaContentOutline": {
"properties": {
"language_code": {
"description": "基準字幕の言語コード",
"type": "string"
},
"summary": {
"description": "区間別要約の一覧",
"type": "array",
"items": {
"properties": {
"start_position": {
"description": "区間開始地点（単位：秒）",
"type": "integer"
},
"end_position": {
"description": "区間終了地点（単位：秒）",
"type": "integer"
},
"value": {
"description": "該当時間区間の要約内容",
"type": "string"
}
}
}
},
"chapter": {
"description": "チャプター一覧",
"type": "array",
"items": {
"properties": {
"position": {
"description": "チャプター開始地点（単位：秒）",
"type": "integer"
},
"value": {
"description": "チャプタータイトル",
"type": "string"
}
}
}
},
"keyword": {
"description": "コンテンツ分析キーワードの一覧",
"type": "array",
"items": {
"type": "string"
}
}
},
"type": "object"
},
"ApiVodMediaProfileGroup": {
"properties": {
"key": {
"description": "エンコーディングプロファイルグループキー",
"type": "string"
},
"name": {
"description": "エンコーディングプロファイルグループ名",
"type": "string"
}
},
"type": "object"
},
"ApiVodMediaProfilePreset": {
"properties": {
"id": {
"description": "プリセットID",
"type": "integer"
},
"key": {
"description": "プリセットキー",
"type": "string"
},
"name": {
"description": "プリセット名",
"type": "string"
},
"is_audio_file": {
"description": "オーディオ専用ファイルの有無",
"type": "boolean"
},
"is_default_preset": {
"description": "デフォルトプリセット設定の有無",
"type": "boolean"
},
"is_optional": {
"description": "追加トランスコーディング設定の有無",
"type": "boolean"
},
"container_format": {
"description": "コンテナフォーマット",
"type": "string"
},
"bitrate_mode": {
"description": "ビットレートモード",
"type": "string"
},
"video_codec": {
"description": "ビデオコーデック",
"type": "string"
},
"video_bitrate": {
"description": "ビデオビットレート",
"type": "integer"
},
"video_width": {
"description": "映像の幅（または 映像の横幅）",
"type": "integer"
},
"video_height": {
"description": "ビデオ縦解像度",
"type": "integer"
},
"video_framerate": {
"description": "ビデオフレームレート",
"type": "integer"
},
"video_rotate_degree": {
"description": "ビデオ回転角度",
"type": "integer"
},
"video_overlay_position": {
"description": "ビデオオーバーレイ位置",
"type": "string"
},
"video_overlay_path": {
"description": "ビデオオーバーレイファイルパス",
"type": "string"
},
"is_video_ratio": {
"description": "ビデオ画面比率維持の有無",
"type": "boolean"
},
"is_video_vertical_flip": {
"description": "ビデオ垂直反転処理の有無",
"type": "boolean"
},
"is_video_horizontal_flip": {
"description": "ビデオ水平反転処理の有無",
"type": "boolean"
},
"audio_codec": {
"description": "オーディオコーデック",
"type": "string"
},
"audio_bitrate": {
"description": "オーディオビットレート",
"type": "integer"
},
"audio_samplerate": {
"description": "オーディオサンプルレート",
"type": "integer"
},
"audio_channel": {
"description": "オーディオチャンネル",
"type": "integer"
},
"audio_volume_control": {
"description": "オーディオボリューム制御設定",
"type": "integer"
},
"group": {
"description": "エンコーディングプロファイルグループ",
"properties": {
"key": {
"description": "エンコーディングプロファイルグループキー",
"type": "string"
},
"name": {
"description": "エンコーディングプロファイルグループ名",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"ApiVodMediaProfile": {
"properties": {
"id": {
"description": "エンコーディングプロファイルID",
"type": "integer"
},
"key": {
"description": "エンコーディングプロファイルキー",
"type": "string"
},
"name": {
"description": "エンコーディングプロファイル名",
"type": "string"
},
"is_audio_file": {
"description": "オーディオ専用ファイルの有無",
"type": "boolean"
},
"is_default_preset": {
"description": "デフォルトプリセット設定の有無",
"type": "boolean"
},
"is_optional": {
"description": "追加トランスコーディング設定の有無",
"type": "boolean"
},
"container_format": {
"description": "コンテナフォーマット",
"type": "string"
},
"bitrate_mode": {
"description": "ビットレートモード",
"type": "string"
},
"video_codec": {
"description": "ビデオコーデック",
"type": "string"
},
"video_bitrate": {
"description": "ビデオビットレート",
"type": "integer"
},
"video_width": {
"description": "映像の幅（または 映像の横幅）",
"type": "integer"
},
"video_height": {
"description": "ビデオ縦解像度",
"type": "integer"
},
"video_framerate": {
"description": "ビデオフレームレート",
"type": "number"
},
"video_rotate_degree": {
"description": "ビデオ回転角度",
"type": "integer"
},
"video_overlay_position": {
"description": "ビデオオーバーレイ位置",
"type": "string"
},
"video_overlay_path": {
"description": "ビデオオーバーレイファイルパス",
"type": "string"
},
"is_video_ratio": {
"description": "ビデオ画面比率維持の有無",
"type": "boolean"
},
"is_video_vertical_flip": {
"description": "ビデオ垂直反転処理の有無",
"type": "boolean"
},
"is_video_horizontal_flip": {
"description": "ビデオ水平反転処理の有無",
"type": "boolean"
},
"audio_codec": {
"description": "オーディオコーデック",
"type": "string"
},
"audio_bitrate": {
"description": "オーディオビットレート",
"type": "integer"
},
"audio_samplerate": {
"description": "オーディオサンプルレート",
"type": "integer"
},
"audio_channel": {
"description": "オーディオチャンネル",
"type": "integer"
},
"audio_volume_control": {
"description": "オーディオボリューム制御設定",
"type": "integer"
},
"status": {
"description": "エンコーディングプロファイル有効化ステータス",
"type": "boolean"
},
"group": {
"description": "エンコーディングプロファイルグループ",
"properties": {
"key": {
"description": "エンコーディングプロファイルグループキー",
"type": "string"
},
"name": {
"description": "エンコーディングプロファイルグループ名",
"type": "string"
}
},
"type": "object"
},
"categories": {
"description": "エンコーディングプロファイルに紐づけられたカテゴリリスト",
"type": "array",
"items": {
"properties": {
"key": {
"description": "カテゴリキー",
"type": "string"
},
"name": {
"description": "カテゴリ名",
"type": "string"
}
},
"type": "object"
}
}
},
"type": "object"
},
"ApiVodPlayerEvent": {
"properties": {
"id": {
"description": "イベントID",
"type": "integer"
},
"title": {
"description": "イベント名",
"type": "string"
},
"value": {
"description": "イベント詳細情報",
"type": "object"
},
"channels": {
"description": "イベントが適用されたチャンネルリスト",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiVodChannelSummary"
}
}
},
"type": "object"
},
"ApiVodPlayerSkin": {
"properties": {
"id": {
"description": "スキンID",
"type": "integer"
},
"title": {
"description": "スキン名",
"type": "string"
},
"value": {
"description": "スキン詳細情報",
"type": "object"
},
"channels": {
"description": "スキンが適用されたチャンネルリスト",
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiVodChannelSummary"
}
}
},
"type": "object"
},
"ApiStatisticsSummaryDaily": {
"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"
},
"max_storage": {
"description": "最大ストレージ割り当て量 (bytes)",
"type": "integer"
},
"total_transcoding_size": {
"description": "累積トランスコーディング処理容量 (bytes)",
"type": "integer"
},
"total_transcoding_count": {
"description": "累積トランスコーディング処理回数",
"type": "integer"
},
"total_visitor": {
"description": "累積訪問者数 (Unique Visitor)",
"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": "訪問者数 (Unique Visitor)",
"type": "integer"
}
},
"type": "object"
}
}
},
"type": "object"
},
"ApiVodStat": {
"properties": {
"avg_play_rate": {
"description": "コンテンツ総時間に対する平均再生比率",
"type": "integer"
},
"avg_uplay_rate": {
"description": "コンテンツ総時間に対する平均再生比率 (Unique User)",
"type": "integer"
},
"category_id": {
"description": "カテゴリID",
"type": "integer"
},
"channel_key": {
"description": "チャンネルキー",
"type": "string"
},
"content_id": {
"description": "コンテンツID",
"type": "integer"
},
"title": {
"description": "コンテンツタイトル",
"type": "string"
},
"upload_time": {
"description": "コンテンツアップロード日時",
"type": "string"
},
"upload_key": {
"description": "アップロードファイルキー",
"type": "string"
},
"duration": {
"description": "コンテンツ総時間",
"type": "integer"
},
"count": {
"description": "照会数",
"type": "integer"
},
"play_count": {
"description": "再生回数",
"type": "integer"
}
},
"type": "object"
},
"ApiChannelStat": {
"properties": {
"startdate": {
"description": "統計集計開始日",
"type": "string"
},
"enddate": {
"description": "統計集計終了日",
"type": "string"
},
"row_count": {
"description": "全体データ件数",
"type": "integer"
},
"startindex": {
"description": "統計データ開始インデックス",
"type": "integer"
},
"limit": {
"description": "最大取得件数",
"type": "integer"
},
"result_data": {
"type": "array",
"items": {
"properties": {
"channel_key": {
"description": "チャンネルキー",
"type": "string"
},
"count": {
"description": "ヒット(Hit)数",
"type": "integer"
},
"content_count": {
"description": "ヒット(Hit)コンテンツ数",
"type": "integer"
},
"play_count": {
"description": "再生回数",
"type": "integer"
},
"play_content_count": {
"description": "再生されたコンテンツ数",
"type": "integer"
},
"transfer": {
"description": "データ転送量",
"type": "integer"
},
"origin_size": {
"description": "原本ファイルのストレージ使用量",
"type": "integer"
},
"transcoding_size": {
"description": "トランスコーディングファイルのストレージ使用",
"type": "integer"
},
"total_size": {
"description": "全体（原本＋トランスコーディングファイル）のストレージ使用量",
"type": "integer"
}
},
"type": "object"
}
}
},
"type": "object"
},
"ApiVodTranscodingFile": {
"properties": {
"id": {
"description": "トランスコーディングファイルID",
"type": "integer"
},
"media_profile_group_name": {
"description": "エンコーディングプロファイルグループ名",
"type": "string"
},
"media_profile_group_key": {
"description": "エンコーディングプロファイルグループキー",
"type": "string"
},
"profile_name": {
"description": "エンコーディングプロファイル名",
"type": "string"
},
"profile_key": {
"description": "エンコーディングプロファイルキー",
"type": "string"
},
"filesize_bytes": {
"description": "ファイル容量 (bytes)",
"type": "integer"
},
"media_information": {
"description": "コンテンツ詳細情報",
"properties": {
"file": {
"description": "ファイル属性情報",
"properties": {
"filesize": {
"description": "ファイル容量",
"type": "string"
},
"format": {
"description": "コンテナフォーマット",
"type": "string"
},
"duration": {
"description": "コンテンツ総時間",
"type": "string"
},
"raw_duration": {
"description": "コンテンツ総時間 (単位: ミリ秒)",
"type": "integer"
}
}
},
"video": {
"description": "ビデオトラック情報",
"properties": {
"video_codec": {
"description": "ビデオコーデック",
"type": "string"
},
"video_bitrate": {
"description": "ビデオビットレート",
"type": "string"
},
"video_framerate": {
"description": "ビデオフレームレート",
"type": "string"
},
"video_screen_size": {
"description": "ビデオ解像度",
"type": "string"
},
"video_framecount": {
"description": "ビデオフレーム数",
"type": "boolean"
},
"video_raw_duration": {
"description": "ビデオトラック再生時間 (単位: ミリ秒)",
"type": "integer"
}
}
},
"audio": {
"description": "オーディオトラック情報",
"properties": {
"audio_codec": {
"description": "オーディオコーデック",
"type": "string"
},
"audio_bitrate": {
"description": "オーディオビットレート",
"type": "string"
},
"audio_samplerate": {
"description": "オーディオサンプルレート",
"type": "string"
},
"audio_channel": {
"description": "オーディオチャンネル数",
"type": "integer"
},
"audio_raw_duration": {
"description": "オーディオトラック再生時間 (単位: ミリ秒)",
"type": "integer"
}
}
}
}
},
"thumbnail_urls": {
"properties": {
"big": {
"description": "高画質サムネイルURL",
"type": "string"
},
"small": {
"description": "低画質サムネイルURL",
"type": "string"
}
}
},
"created_at": {
"description": "トランスコーディングファイル生成日時",
"type": "string"
},
"updated_at": {
"description": "トランスコーディングファイル修正日時",
"type": "string"
}
},
"type": "object"
},
"ApiVodMediaContentTranscodingJob": {
"properties": {
"key": {
"description": "トランスコーディング作業キー",
"type": "string"
}
},
"type": "object"
}
},
"securitySchemes": {
"kollus_api_access_token": {
"type": "apiKey",
"description": "Kollus API アクセストークン",
"name": "access_token",
"in": "query"
}
}
}
}