チャンネル登録

post https://api-live-jp.kollus.com/api/v1/live/service-accounts/{service_account_key}/channels

チャンネルを登録します。

アクセス可能な権限:最高管理

Path Params

service_account_key

string

required

サービスアカウントキー

Form Data

kind

integer

チャンネルタイプ 0: ライブ放送, 1: 録画放送

title

string

required

チャンネル名

customer_code

string

required

顧客コード

concurrently_viewer_limit

integer

required

Defaults to 0

同時視聴者数制限

is_shared

integer

required

Defaults to 0

公開有無

live_media_profile_group_key

string

required

プロファイルグループキー

meta_title_pattern

string

Defaults to [CHANNEL_TITLE]-[BROADCAST_COUNTING]

メタ情報タイトル

meta_description

string

メタ情報の内容

recording_file_policy

integer

Defaults to 1

録画ファイルの保存方式
0: 使用しない, 1: 自動保存を使用する, 3: 自動保存 + 手動保存を使用する

recording_file_pattern

string

Defaults to [CHANNEL_KEY]-[CHANNEL_CUSTOMER_CODE]-[BROADCAST_KEY]-[BROADCAST_CREATING_DATE]-[RECORDING_START_DATE]

録画ファイル保存規則

recording_file_segment_policy

integer

Defaults to 1

録画ファイルの種類
1: 最大容量保存(4G), 2: インターバルタイム保存

recording_file_segment_by_duration

integer

Defaults to 60

インターバル保存時間(分)

idle_screen_kind

integer

Defaults to 0

待ち受け画面 0: ポスター, 1: スナップショット

media_player_policy

integer

Defaults to 0

専用プレイヤー 0: なし, 1: 専用プレイヤー

use_chatting_service

integer

Defaults to 0

チャットを使用有無

chatting_service_id

integer

チャットサービスID

chatting_info

string

チャットに関する設定(json)

division_delayed_minutes

integer

Defaults to 3

ストリーミングを切断時間

use_duplicate_block

integer

Defaults to 0

重複再生ブロック

use_capture_block

integer

Defaults to 0

録画/キャプチャーブロック(専用プレイヤー)

use_timeshift

integer

Defaults to 0

タイムシフトの使用

use_referer_check

integer

Defaults to 0

リファラ設定 0: 無効化, 1: 特定ドメインでのみ再生可能, 2: 特定ドメインでの再生遮断

referer_check_domains

string

許可するドメインのリスト ( , で区分)

referer_reject_domains

string

ブロックするドメインのリスト ( , で区分)

Responses

Response body

object

data

object

ライブチャンネル(ライブ放送を含む)

integer

key

string

チャンネルキー

title

string

チャンネル名

customer_code

string

顧客コード

concurrently_viewer_limit

integer

同時視聴者数制限

kind

object

チャンネルの種類

is_shared

boolean

公開有無

profile_group

object

ライブエンコーディングプロファイルグループ

creators

array of objects

ライブ Creator

creators

object

integer

nickname

string

ニックネーム

code

string

コード

stream_key

string

ストリームキー

created_at

string

生成日

updated_at

string

修正日

latest_broadcast

object

ライブ放送

meta_title_pattern

string

メタ情報タイトル

meta_description

string

メタ情報の内容

logo_url

string

ロゴURL

idle_screen_url

string

待機画面 URL

idle_screen_kind

object

待機画面

publish_url

string

アプリケーション

video_gateway_url

string

ビデオゲートウェイリンク

recording_file_policy

object

録画ファイルの保存方式

recording_file_pattern

string

録画ファイル保存規則

recording_file_segment_policy

object

録画ファイルの種類

recording_file_segment_by_size

integer

最大容量保存(Mib)

recording_file_segment_by_duration

integer

インターバル保存時間(分)

media_player_policy

object

専用プレイヤー

use_chatting_service

boolean

チャットを使用有無

chatting_service

object

チャット契約

division_delayed_minutes

integer

ストリーミング断絶時間

use_duplicate_block

boolean

重複再生ブロック

use_capture_block

boolean

録画/キャプチャーブロック(専用プレイヤー)

use_timeshift

boolean

タイムシフトの使用

use_broadcast_update_callback

boolean

ライブコールバックを使用有無

broadcast_update_callback_url

string

ライブコールバック URL

use_recording_file_transfer_callback

boolean

録画ファイル転送コールバックを使用有無

recording_file_transfer_callback_url

string

録画ファイル転送コールバック URL

use_lms_callback

boolean

Lmsコールバックを使用有無

lms_callback_url

string

Lmsコールバック URL

use_play_callback

boolean

Playコールバックを使用有無

play_callback_url

string

Play コールバック URL

use_referer_check

integer

リファラ設定 0: 無効化, 1: 特定のドメインでのみ再生可能, 2: 特定のドメインでの再生ブロック

1 2

referer_check_domains

string

許可するドメインのリスト ( , で区分)

referer_reject_domains

string

ブロックするドメインのリスト ( , で区分)

status

boolean

チャンネル状態 - true: enable, false: disable

hided_at

string

隠した時間

created_at

string

生成日

updated_at

string

修正日

400

Bad request

401

Unauthenticated

404

Not found

422

Unprocessable entity

Language

Credentials

OAuth2


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api-live-jp.kollus.com/api/v1/live/service-accounts/service_account_key/channels \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/x-www-form-urlencoded' \
5
     --data concurrently_viewer_limit=0 \
6
     --data is_shared=0

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK