ライブプロファイルの設定情報を取得できるAPIです。
■メソッドタイプ
GET
■API呼び出しURI
https://api01-platform.stream.co.jp/apiservice/live/v1/profile/?token=xxxx&各パラメータ
※xxxxはReadAPIのトークンになります。
トークンの確認方法は「■Token情報確認方法について」をご参照ください。
■パラメータ
| 項目名 | 必須 | 説明 | フォーマット | デフォルト値 |
| token | ○ | アカウント（CID）毎に 発行されたトークン |
文字列 | 無し |
| type | --- | 返却形式のタイプを指定 「jsonp」「json」が指定可能 |
文字列 | json |
| callback | --- | JSONPコールバック関数名 ※jsonp時のみ有効 |
文字列 | searchResultEq |
| pageSize | --- | 取得するプロファイル件数 | 半角数字 （上限100） |
10 |
| pageNumber | --- | 取得を開始するページ番号 | 半角数字 | 1 |
| lpid | --- | 取得するライブID 「,」区切りで指定することで 複数指定可能 |
半角数字 | 無し |
| liveName | --- | ライブ設定名 ※部分一致 |
文字列 | 無し |
| status | --- |
ライブのステータス creating：作成中 |
文字列 | 無し |
| p1,p2,p3 | --- | 指定の引数を戻り値として そのまま返却 |
文字列 | 無し |
| resObject | --- |
レスポンスのオブジェクト 下記のレスポンスはリクエスト時にのみ返却
※上記以外の文字列の場合は、エラーコード（1037）を返却 |
文字列 | 無し |
■レスポンス
| 項目名 | 名称 | 備考 | |||
| response_status | APIレスポンスステータス | 「レスポンスステータス」を参照 | |||
| livesum ※ | ライブプロファイルの全件数 | ||||
| profiles | lpid | ライブID | |||
| status | ライブステータス | creating：作成中 open：配信中 stop：配信停止中 error：エラー |
|||
| live_name | ライブ配信設定名 | ||||
| live_description | ライブ設定説明 | ||||
| group_id | グループ設定 （録画ファイルアップロード先） |
||||
| mpid | トランスコード設定 | ||||
| max_client | 同時接続数制限 |
0：無制限（unlimited live edtionでのみ利用可能） その他数値：同時接続数 |
|||
| liveapp_flg | EQライブキャスト利用 |
1：利用する 0：利用しない |
|||
| vod_flg | VODの使用可否 | 1：有効 0：無効 |
|||
| exlink ※ | enabled | 関連リンク利用可否 | 1：有効 0：無効 |
||
| settings | index | 関連リンク番号（1～3） | |||
| text | リンクテキスト | ||||
| url | リンクURL | ||||
| vlpid | セキュリティプロファイルID | ||||
| chat ※ | enabled | チャット設定利用可否 | 0:利用しない 1:利用する |
||
| status |
チャットステータス |
streaming：チャット中 stop：チャット停止中 no_setting：チャット使用なし |
|||
| auto_resize_flg | チャット視聴者画面のレスポンシブの有無 |
0:無効 |
|||
| width | 表示サイズ - width | ||||
| height | 表示サイズ - height | ||||
| enter_msg | 投稿されるメッセージ管理 | 0:表示する 1:入室メッセージのみ表示する 2:表示しない |
|||
| good_btn | [いいね]ボタン表示 | 0:無効 1:有効 |
|||
| trouble_btn | [わかりません]ボタン表示 | 0:無効 1:有効 |
|||
| admin_displayname | 管理者表示名 | ||||
| block_type |
投稿されるメッセージ管理 |
0：メッセージを全て許可する |
|||
| block_words | ブロックする文字列（配列） | array | |||
| open_timing | チャット 開始タイミング（分） | -1：手動で開始 0：ライブ開始と同タイミング |
|||
| close_timing | チャット 終了タイミング（分） | -1：手動で終了 0：ライブ終了と同タイミング その他数値：ライブ終了後、○分後に終了 |
|||
| icon_texts | id | リアクションアイコン（複数） | |||
| active_flg |
利用フラグ |
1：有効 0：無効 |
|||
| text |
ボタンの文字 |
||||
|
portal_meta ※ |
event_name |
EQポータルのイベント名 |
|||
| description |
EQポータルのイベント説明 |
||||
| performer |
EQポータルの出演者 |
||||
| desktop_encoder |
デスクトップ配信 |
1：有効 0：無効 |
|||
| lqpid |
ライブ自動画質ID |
||||
| encrypt |
暗号化配信 |
1：有効 0：無効 |
|||
| dvr |
ライブDVR機能利用有無 |
1：有効 0：無効 |
|||
| dvr_close_minutes |
ライブ終了後のDVR配信有効期間（分） |
1：即時無効化 それ以外：任意時間後無効化 |
|||
| dvr_close_date |
ライブDVR終了時刻（分） |
DVRによるライブ映像の巻き戻し機能が使えなくなる時刻 | |||
| permalink ※ | ライブパーマリンク | ||||
| thumbnails ※ | feedout | サムネイル - 配信停止URL | |||
|
feedin |
サムネイル - 配信準備URL | ||||
| liveclose | サムネイル - 配信終了URL | ||||
※リクエスト時に「resObject」で指定した場合のみ返却となります。
■レスポンス例：正常時
|
{
"response_status": "2000",
"livesum": 1,
"profiles": [
{
"lpid": 2,
"status": "stop",
"live_name": "test",
"live_description": "",
"group_id": 0,
"mpid": 1,
"max_client": 1022,
"vod_flg": 1,
"exlink": {
"enabled": 1,
"settings": [
{
"index": 1,
"text": "",
"url": ""
},
{
"index": 2,
"text": "",
"url": ""
},
{
"index": 3,
"text": "",
"url": ""
}
]
},
"vlpid": 0,
"chat": {
"status": "stop",
"enabled": 0,
"auto_resize_flg": 0,
"width": 400,
"height": 600,
"enter_msg": 0,
"good_btn": 1,
"trouble_btn": 1,
"admin_display_name": "管理者",
"block_type": 0,
"block_words": [
""
],
"open_timing": 0,
"close_timing": 0,
"icon_texts": [
{
"id": 1,
"active_flg": 1,
"text": "アイコン"
}
]
},
"portal_meta": {
"event_name": "イベント名",
"description": "イベント説明",
"performer": "田中"
},
"desktop_encoder": 0,
"lqpid": 1,
"encrypt": 1,
"dvr": 1,
"dvr_close_minutes": 1,
"dvr_close_date": "2021/12/07T14:07:50.123",
"live_permalink": "https://apiXX-platform.stream.co.jp/apiservice/lplt3/XXXXXXXXXX",
"thumbnails": {
"feedout": "http://eqXXXXXXXX.eq.webcdn.stream.ne.jp/wwwXX/eqXXXXXXXX/jmc_pub/thumbnail/live/XXXX_X_X.jpg",
"feedin": "http://eqXXXXXXXX.eq.webcdn.stream.ne.jp/wwwXX/eqXXXXXXXX/jmc_pub/thumbnail/live/XXXX_X_X.jpg",
"liveclose": "http://eqXXXXXXXX.eq.webcdn.stream.ne.jp/wwwXX/eqXXXXXXXX/jmc_pub/thumbnail/live/XXXX_X_X.jpg"
}
}
]
}
|
■レスポンス例：エラー時
|
{ |