疑似ライブプロファイル取得API疑似ライブプロファイル取得APIを利用することで、疑似ライブプロファイルの設定情報を取得することができます。
■API呼び出しURI
https://api01-platform.stream.co.jp/apiservice/filetolive/v1/profile/?token=xxxx&各パラメータ
※xxxxはReadAPIのトークンになります。
トークンの確認方法は「■Token情報確認方法について」をご参照ください。
■パラメータ
| 項目名 | 必須 | 説明 | フォーマット | デフォルト値 |
| token | ○ | アカウント（CID）毎に 発行されたトークン |
文字列 | 無し |
| type | --- | 返却形式のタイプを指定 「jsonp」「json」が指定可能 |
文字列 | json |
| callback | --- | JSONPコールバック関数名 ※jsonp時のみ有効 |
文字列 | searchResultEq |
| pageSize | --- | 取得する件数 | 半角数字 （上限100） |
10 |
| pageNumber | --- | 取得を開始するページ番号 | 半角数字 | 1 |
| flpid | --- | 取得する疑似ライブID 「,」区切りで指定することで 複数指定可能 |
半角数字 | 無し |
| liveName | --- | 疑似ライブ設定名 ※部分一致 |
文字列 | 無し |
| status | --- |
疑似ライブのステータス waiting：配信予約中 |
文字列 | 無し |
| p1,p2,p3 | --- | 指定の引数を戻り値として そのまま返却 |
文字列 | 無し |
| resObject | --- |
レスポンスのオブジェクト 下記のレスポンスはリクエスト時にのみ返却
※上記以外の文字列の場合は、エラーコード（1037）を返却 |
文字列 | 無し |
■レスポンス
| 項目名 | 説明 | 備考 | |||
| response_status | APIレスポンスステータス | 「レスポンスステータス」を参照 | |||
| livesum | 疑似ライブプロファイルの全件数 | ||||
| profiles | flpid | 疑似ライブID | |||
| mid | 動画ID | ||||
| start_date | 開始時間 | ||||
| close_date | 終了時間 | ||||
| status | ライブステータス | waiting：配信予約中 ready：配信準備中 streaming：配信中 finished：配信終了 error：エラー |
|||
| live_name | ライブ配信設定名 | ||||
| live_description | ライブ設定説明 | ||||
| max_client | 同時接続数制限 | ||||
| prefiller_mid | プリフィラー動画ID | 0の場合は、システムデフォルト | |||
| postfiller_mid | ポストフィラー動画ID | 0の場合は、システムデフォルト | |||
| media_meta | title | 選択されている動画IDのタイトル | |||
| description | 選択されている動画IDの説明 | ||||
| media_thumbnails |
url | 選択されている動画IDのサムネイルURL | |||
| small_url | 選択されている動画IDの小サムネイルURL | ||||
| 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：メッセージを全て許可する 1：不適切な可能性のあるメッセージを保留して確認する 2：すべてのメッセージを保留して確認する |
|||
| 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ポータルの出演者 | ||||
| permalink | ライブパーマリンク（動画URL） | ||||
| thumbnails | feedout | サムネイル - 配信停止URL | |||
| feedin |
サムネイル - 配信準備URL | ||||
| liveclose | サムネイル - 配信終了URL | ||||
■レスポンス例：正常時
|
{
"response_status": "2000",
"livesum": 1,
"profiles": [
{
"flpid": 2,
"mid": 2,
"start_date": "2020/01/01T00:00:00",
"close_date": "2020/01/01T00:00:00",
"status": "finished",
"live_name": "test",
"live_description": "",
"max_client": 1022,
"prefiller_mid": 0,
"postfiller_mid": 0,
"media_meta": {
"title": "",
"description": ""
},
"media_thumbnails": {
"url": "https://eqa110uelg.eq.webcdn.stream.ne.jp/www50/eqa110uelg/jmc_pub/thumbnail/00024/da55770394f541938d4fd35623117f7b_25.00005.jpg",
"smail_url": "https://eqa110uelg.eq.webcdn.stream.ne.jp/www50/eqa110uelg/jmc_pub/thumbnail/00024/da55770394f541938d4fd35623117f7b_26.00005.jpg",
},
"chat": {
"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": [
"apple",
"orange"
],
"icon_texts": [
{
"id": 1,
"active_flg": 1,
"text": "アイコン"
}
],
"open_timing": 1,
"close_timing": 0
},
"portal_meta": {
"event_name": "イベント名",
"description": "イベント説明",
"performer": "田中"
},
"permalink": "https://api01-platform.stream.co.jp/apiservice/flplt3/Mjk5MA%3d%3d%23MzMw%23280%2317c%230%233E04480FC000%23OzEwOzEw%23%e3%83%95%e3%83%83%e3%82%bf%e2%80%95",
"thumbnails": {
"feedout": "http://eqy005test.eq-test.webcdn.stream.ne.jp/www50/eqy005test/jmc_pub/thumbnail/filetolive/2990_330_1.jpg",
"feedin": "http://eqy005test.eq-test.webcdn.stream.ne.jp/www50/eqy005test/jmc_pub/thumbnail/filetolive/2990_330_2.jpg",
"liveclose": "http://eqy005test.eq-test.webcdn.stream.ne.jp/www50/eqy005test/jmc_pub/thumbnail/filetolive/2990_330_3.jpg"
}
}
]
}
|
■レスポンス例：エラー時
|
{ |