ライブプロファイルの作成および更新を行うAPIです。
■リクエストURI
https://eqapi.stream.co.jp/filetolive/v1/setProfile/[アップロードキー]
※「アップロードキー」の取得方法は「アップロードキー取得API」をご参照ください。
■メソッドタイプ
POST
■ヘッダー
| HTTPヘッダー | 値 |
| Accept |
multipart/form-data |
| Content-Type | multipart/form-data |
■パラメータ
| パラメータ | 必須 | 説明 | デフォルト値 （新規） | フォーマット | |
| 新規 | 更新 | ||||
| flpid | --- | ○ | 疑似ライブID | 自動連番 | 半角数 |
| mid | ○ | --- | 疑似ライブする動画ID | 無し | 半角数 |
| start_date | ○ | --- | 公開開始日時 | 無し |
date型 yyyy/MM/dd hh:mm:ss yyyy-MM-dd hh:mm:ss |
| name | ○ | --- | 疑似ライブ配信設定名 | 無し | 全角半角 100文字 |
| description | --- | --- | 疑似ライブ設定説明 | 空白 | 全角半角 500文字 |
| max_client | --- | --- | 同時接続数制限 |
ライブの同時接続数上限 0:無制限※1 その他の値：その値で制限 |
半角数 |
| prefiller_mid | --- | --- | 開始前フィラー映像にする動画ID |
0:システムデフォルトのフィラー映像を利用する 1以上の数値:任意の動画を指定する |
|
| postfiller_mid | --- | --- | 終了後フィラー映像にする動画ID |
0:システムデフォルトのフィラー映像を利用する 1以上の数値:任意の動画を指定する |
|
| thumb_feedout | --- | --- | 配信停止サムネイル | デフォルトサムネイル | フルパス形式 2MB以下 *.gif; *.jpeg; *.jpg; *.png |
| thumb_feedin | --- | --- | 配信準備サムネイル | デフォルトサムネイル | フルパス形式 2MB以下 *.gif; *.jpeg; *.jpg; *.png |
| thumb_liveclose | --- | --- | 配信終了サムネイル | デフォルトサムネイル | フルパス形式 2MB以下 *.gif; *.jpeg; *.jpg; *.png |
| chat_flg | --- | --- | チャット設定利用可否 | 0:利用しない | 0:利用しない 1:利用する |
| chat_auto_resize | --- | --- | チャットの自動リサイズ | 0:無効 | 0:無効 1:有効 |
| chat_width | --- | --- | チャットのwidth | 600 | 300 ～ 1920 |
| chat_height | --- | --- | チャットのheight | 400 | 320 ～ 1080 |
| chat_block_type | --- | --- | 投稿されるメッセージ管理 | 0:メッセージを全て許可する |
0:メッセージを全て許可する 1:不適切な可能性のあるメッセージを保留して確認する 2:表示しない |
| chat_enter_msg | --- | --- | 入退室メッセージの表示 | 0:表示する | 0:表示する 1:入室メッセージのみ表示する 2:表示しない |
| chat_open_timing | --- | --- | チャット 開始タイミング（分） | 0：ライブ開始と同タイミング |
-1：手動で開始 0：ライブ開始と同タイミング |
| chat_close_timing | --- | --- | チャット 終了タイミング（分） | 0：ライブ終了と同タイミング |
-1：手動で終了 0：ライブ終了と同タイミング その他数値：ライブ終了後、○分後に終了 |
| chat_icon_text_flg[] | --- | --- | チャット任意のリアクションボタンテキストの利用有無 | 空白 |
0：利用しない 1：利用する ※chat_icon_text[]と数が一致しない場合、パラメータエラーとなります。 |
| chat_icon_text[] | --- | --- | チャット 任意のリアクションボタンテキスト | 空白 |
文字列 |
| chat_good_btn | --- | --- | いいねボタン表示 | 1:有効 | 0:無効 1:有効 |
| chat_trouble_btn | --- | --- | わかりませんボタン表示 | 1:有効 | 0:無効 1:有効 |
| chat_display_name | --- | --- | 管理者表示名 | "admin":管理者 | "admin":管理者 "operator":運営 "secretariat":事務局 "任意の15文字以内" |
| chat_block_words | --- | --- | ブロックする文字列 （カンマ区切り） |
空白 | 全角半角 1000文字 |
| potal_meta_event_name | --- | --- | ライブイベント情報 - イベント名 | 空白 | 文字列 |
| potal_meta_event_description | --- | --- | ライブイベント情報 - イベント説明 | 空白 | 文字列 |
| potal_meta_performer | --- | --- | ライブイベント情報 - 出演者 | 空白 | 文字列 |
※1 Unlimited Liveエディションでのみ利用可、
それ以外のエディションでは「0」を指定することは出来ません。
■レスポンス例：正常時
| { "error_code": 0, "message": "OK", "flpid": 1 } |
error_code：レスポンスコード message：メッセージ flpid：疑似ライブID |
■レスポンス例：エラー時
|
{ } |
■レスポンスコード
| レスポンスコード | 説明 |
| 0 | 正常 |
| 7000 | 一部のみ更新（ライブ配信準備中時、一部設定登録不可） |
| 9021 | パラメータエラー |
| 9022 | 未対応サムネイル |
| 9502 | サムネイルアップロード中エラー |
| 9503 | 削除済み、または登録されていない |
| 9512 | ライブ中またはライブ準備中更新NGエラー |
| 9516 | 疑似ライブ設定上限超過エラー |
| 9521 | ライブ同時接続数上限超過エラー |
| 9999 | その他システムエラー |