ライブプロファイル作成更新APIライブプロファイルの作成および更新を行うAPIです。
■リクエストURI
https://eqapi.stream.co.jp/live/v1/setProfile/[アップロードキー]
※「アップロードキー」の取得方法は「アップロードキー取得API 」をご参照ください。
■メソッドタイプ
POST
■ヘッダー
| HTTPヘッダー | 値 |
| Accept |
multipart/form-data |
| Content-Type | multipart/form-data |
■パラメータ
| パラメータ | 必須 | 名称 | デフォルト値 （新規） | フォーマット | |
| 新規 | 更新 | ||||
| lpid | --- | ○ | ライブID | 自動連番 | 半角数字 |
| name | ○ | --- | ライブ配信設定名 | 無し |
文字列 100文字 |
| description | --- | --- | ライブ設定説明 | 空白 |
文字列 500文字 |
| group_id | --- | --- | グループ設定 （録画ファイルアップロード先） |
無し | 半角数字 |
| transcode_id | --- | --- | トランスコードID | デフォルトに指定した トランスコードID |
半角数字 |
| max_client | --- | --- | 同時接続数制限 |
ライブの同時接続数上限 0:無制限※1 その他の値：その値で制限 |
半角数字 |
| vod_flg | --- | --- | VODの使用可否 | 1:有効 |
半角数字 0:無効 1:有効 |
| exlink_flg | --- | --- | 動画からのリンク | 1:利用する |
半角数字 0:利用しない 1:利用する |
| exlink1_txt | --- | --- | 関連ページリンク(1) リンクテキスト |
空白 |
文字列 100文字 |
| exlink1_url | --- | --- | 関連ページリンク(1) リンクURL |
空白 |
文字列（URL形式） 1000文字 |
| exlink2_txt | --- | --- | 関連ページリンク(2) リンクテキスト |
空白 |
文字列 100文字 |
| exlink2_url | --- | --- | 関連ページリンク(2) リンクURL |
空白 |
文字列（URL形式） 1000文字 |
| exlink3_txt | --- | --- | 関連ページリンク(3) リンクテキスト |
空白 |
文字列 100文字 |
| exlink3_url | --- | --- | 関連ページリンク(3) リンクURL |
空白 |
文字列（URL形式） 1000文字 |
| vlp_id | --- | --- | セキュリティプロファイルID | 「制限なし」で登録 | 半角数字 |
| thumb_feedout | --- | --- | 配信停止サムネイル | デフォルトサムネイル |
フルパス形式 2MB以下 |
| thumb_feedin | --- | --- | 配信準備サムネイル | デフォルトサムネイル |
フルパス形式 2MB以下 |
| thumb_liveclose | --- | --- | 配信終了サムネイル | デフォルトサムネイル |
フルパス形式 2MB以下 |
| 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：利用する ※2 |
| 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文字 |
| desktop_encoder | --- | --- | デスクトップ配信利用 |
0:利用しない |
半角数字 0:利用しない 1:利用する |
| lqpid | --- | --- | ライブ自動画質設定ID | ライブ自動画質設定のデフォルト |
半角数字 |
| dvr | --- | --- | ライブDVR機能 |
0：利用しない |
半角数字 0：利用しない 1：利用する |
| dvr_close_minutes | --- | --- | ライブ終了後のDVR配信有効期間（分） | 1：即時無効化 |
半角数字 0：利用しない 1：即時無効化 その他数値：DVR有効時間（分） |
| encrypt | --- | --- | 暗号配信機能の付与 |
0：利用しない |
0：利用しない 1：利用する※3 |
| potal_meta_event_name | --- | --- | ライブイベント情報 - イベント名 | 空白 | 文字列 |
| potal_meta_event_description | --- | --- | ライブイベント情報 - イベント説明 | 空白 | 文字列 |
| potal_meta_performer | --- | --- | ライブイベント情報 - 出演者 | 空白 | 文字列 |
※1 Unlimited Liveエディションでのみ利用可、
それ以外のエディションでは「0」を指定することは出来ません。
※2 chat_icon_text[]と数が一致しない場合、パラメータエラーとなります。
※3 暗号化配信が利用可能なアカウント（cid）でない場合は「9021:パラメーターエラー」となります。
■レスポンス例：正常時
| { "error_code": 0, "message": "OK", "lpid": 1 } |
■レスポンス例：エラー時
| { "error_code": 9021, "message": "request parameter error" } |
■レスポンスコード
| レスポンスコード | 説明 |
| 0 | 正常 |
| 7000 | 一部のみ更新（ライブ配信準備中時、一部設定登録不可） |
| 9021 | パラメータエラー |
| 9022 | 未対応サムネイル |
| 9502 | サムネイルアップロード中エラー |
| 9503 | 削除済み、または登録されていない |
| 9512 | ライブ中またはライブ準備中更新NGエラー |
| 9513 | プロファイル作成中エラー |
| 9516 | ライブ設定上限超過エラー |
| 9519 | 有効なグループIDなし |
| 9520 | 有効なトランスコードIDなし |
| 9521 | ライブ同時接続数上限超過エラー |
| 9522 | 有効なセキュリティプロファイルIDなし |
| 9525 | ライブ自動画質設定プロファイルIDなし |
| 9999 | その他システムエラー |