認証API以外の各 WriteAPI を利用する際に必要となる、
アップロードキーを取得するための API です。
本 API を実行することで、一時的に有効なアップロードキーが発行されます。
本 API は契約会社IDおよび API トークンを用いた認証を行い、
発行されたアップロードキーは指定された WriteAPI の呼び出しに利用されます。
利用上の注意事項:
| cid required | integer 契約会社ID |
| API required | string WriteAPIトークン |
curl 'https://file-platform.stream.co.jp/WriteApiLocation.aspx?cid=&API='
ライブ配信に関するプロファイル設定情報を取得する API です。
登録されているライブプロファイルを対象に、
配信状態や基本設定などの情報を一覧で取得することができます。
本 API は ReadAPI トークンによる認証が必要となり、
条件指定により特定のライブプロファイルのみを取得することも可能です。
また、レスポンス内容には、指定条件に応じて
関連リンクやチャット設定、サムネイル情報などの付加情報が含まれる場合があります。
利用上の注意事項:
| token required | string ReadAPIトークン |
| type | string Enum: "json" "jsonp" レスポンス形式。 |
| callback | string JSONP コールバック関数名(type=jsonp 時のみ有効) |
| pageSize | integer 取得件数(最大 100) |
| pageNumber | integer ページ番号(開始位置) |
| lpid | string ライブ設定 ID(複数指定はカンマ区切り) |
| liveName | string ライブ設定名(部分一致) |
| status | string ライブステータスでの絞り込み(例: creating, open, stop, error) |
| p1 | string 指定の引数を戻り値としてそのまま返却 |
| p2 | string 指定の引数を戻り値としてそのまま返却 |
| p3 | string 指定の引数を戻り値としてそのまま返却 |
| resObject | string レスポンスのオブジェクト(複数指定はカンマ区切り)
|
curl 'https://api01-platform.stream.co.jp/apiservice/live/v1/profile/?token='
{- "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",
- "thumbnails": {
}
}
]
}ライブ配信に使用するプロファイル設定を新規作成、
または既存プロファイルを更新するためのAPIです。
ライブ配信に関する基本設定に加え、
同時接続数制限、チャット設定、関連リンク、
サムネイル設定などの各種ライブ配信設定を登録・変更できます。
本 API はアップロードキーを用いて実行され、
指定内容に応じて新規のライブプロファイルが作成されるか、
既存のライブプロファイルが更新されます。
利用上の注意事項:
| uploadKey required | string WriteAPI 用 アップロードキー(認証API で取得) |
| lpid | integer ライブ設定 ID(更新時のみ指定、作成は空) |
| name | string ライブ設定名(新規作成時のみ必須。100文字まで) |
| description | string ライブ説明文(500文字まで) |
| group_id | integer 録画ファイルアップロード先のグループID |
| transcode_id | integer トランスコード設定ID |
| max_client | integer 同時接続上限(0:無制限、その他の値:その値で制限) |
| liveapp_flg | integer Enum: 0 1 ライブキャスト利用フラグ(0:利用しない、1:利用する) |
| vod_flg | integer Enum: 0 1 VOD利用フラグ(0:無効、1:有効) |
| exlink_flg | integer Enum: 0 1 関連リンク利用フラグ(0:利用しない、1:利用する) |
| exlink1_txt | string 関連リンク1 テキスト(100文字) |
| exlink1_url | string 関連リンク1 URL(100文字) |
| exlink2_txt | string 関連リンク2 テキスト(100文字) |
| exlink2_url | string 関連リンク2 URL(100文字) |
| exlink3_txt | string 関連リンク3 テキスト(100文字) |
| exlink3_url | string 関連リンク3 URL(100文字) |
| vlp_id | integer セキュリティプロファイル ID(デフォルト値:制限なし) |
| thumb_feedout | string <binary> 配信停止時サムネイル画像ファイル(2MB以下 *.gif; *.jpeg; *.jpg; *.png) |
| thumb_feedin | string <binary> 配信前サムネイル画像ファイル(2MB以下 *.gif; *.jpeg; *.jpg; *.png) |
| thumb_liveclose | string <binary> 配信終了時サムネイル画像ファイル(2MB以下 *.gif; *.jpeg; *.jpg; *.png) |
| chat_flg | integer Enum: 0 1 チャット機能使用フラグ(0:利用しない、1:利用する) |
| chat_auto_resize | integer Enum: 0 1 チャット自動リサイズフラグ(0:無効、1:有効) |
| chat_width | integer チャットウィンドウ幅(300 ~ 1920) |
| chat_height | integer チャットウィンドウ高さ(320 ~ 1080) |
| chat_block_type | integer Enum: 0 1 2 チャットブロックタイプ(デフォルト値:0)
|
| chat_enter_msg | integer Enum: 0 1 2 入退室メッセージ表示設定(デフォルト値:0)
|
| chat_open_timing | integer チャット開始タイミング(分)(デフォルト値:0)
|
| chat_close_timing | integer チャット終了タイミング(分)(デフォルト値:0)
|
| chat_icon_text_flg | Array of integers リアクションボタンテキストフラグ配列(0:利用しない、1:利用する) |
| chat_icon_text | Array of strings リアクションボタンテキスト配列 |
| chat_good_btn | integer Enum: 0 1 「いいね」ボタン表示フラグ(0:無効、1:有効) |
| chat_trouble_btn | integer Enum: 0 1 「わかりません」ボタン表示フラグ(0:無効、1:有効) |
| chat_display_name | string 管理者表示名(デフォルト値:"admin")
|
| chat_block_words | string ブロックする文字列(カンマ区切り)(1000文字) |
| desktop_encoder | integer Enum: 0 1 デスクトップ配信利用設定(0:利用しない、1:利用する) |
| lqpid | integer ライブ自動画質設定ID(デフォルト値:ライブ自動画質設定のデフォルト) |
| dvr | integer Enum: 0 1 DVR 機能設定(0:利用しない、1:利用する) |
| dvr_close_minutes | integer DVR 有効期間(分)(デフォルト値:1)
|
| encrypt | integer Enum: 0 1 暗号配信設定(0:利用しない、1:利用する) |
| potal_meta_event_name | string ポータル用イベント名 |
| potal_meta_event_description | string ポータルイベント説明 |
| potal_meta_performer | string ポータル出演者名 |
curl 'https://eqapi.stream.co.jp/live/v1/setProfile/{uploadKey}' \ --request POST \ --header 'Content-Type: multipart/form-data' \ --form 'lpid=' \ --form 'name=' \ --form 'description=' \ --form 'group_id=' \ --form 'transcode_id=' \ --form 'max_client=' \ --form 'exlink1_txt=' \ --form 'exlink1_url=' \ --form 'exlink2_txt=' \ --form 'exlink2_url=' \ --form 'exlink3_txt=' \ --form 'exlink3_url=' \ --form 'vlp_id=' \ --form 'thumb_feedout=' \ --form 'thumb_feedin=' \ --form 'thumb_liveclose=' \ --form 'chat_width=' \ --form 'chat_height=' \ --form 'chat_open_timing=' \ --form 'chat_close_timing=' \ --form 'chat_display_name=' \ --form 'chat_block_words=' \ --form 'lqpid=' \ --form 'dvr_close_minutes=' \ --form 'potal_meta_event_name=' \ --form 'potal_meta_event_description=' \ --form 'potal_meta_performer='
{- "error_code": 0,
- "message": "OK",
- "lpid": 1
}登録されているライブプロファイルを削除するための API です。
指定されたライブプロファイルを対象に、
配信設定および関連するプロファイル情報を削除します。
本 API はアップロードキーを用いて実行され、
指定されたライブプロファイルIDに基づいて削除処理が行われます。
利用上の注意事項:
| uploadKey required | string WriteAPI 用 アップロードキー(認証API で取得) |
| lpid required | integer ライブ設定ID(必須) |
{- "lpid": 0
}{- "error_code": 0,
- "message": "OK"
}ライブ配信に使用するエンコーダー設定情報を取得するための API です。
指定されたライブプロファイルに紐づく配信先情報および、
ライブ配信時に利用するエンコーダー設定内容を取得できます。
本 API はアップロードキーを用いて実行され、
指定内容に応じて JSON 形式、または特定のライブエンコーダー向け形式で
設定情報が返却されます。
利用上の注意事項:
| uploadKey required | string WriteAPI 用 アップロードキー(認証API で取得) |
| lpid required | integer ライブ設定ID(半角数字)(必須) |
| type | string 取得するライブエンコーダー設定のフォーマット
|
curl 'https://eqapi.stream.co.jp/live/v1/getEncoder/{uploadKey}' \ --request POST \ --header 'Content-Type: multipart/form-data' \ --form 'lpid=0' \ --form 'type='
{- "error_code": 0,
- "message": "OK",
- "lpid": 1,
- "encoder_setting": {
- "server_mainurl": "rtmp://XXXXXXXXXXX-org1.wlive.cloud.stream.co.jp:XXXX/XXXXXXXXXXXXXX?key=XXXXXXX",
- "server_suburl": "rtmp://XXXXXXXXXXX-org2.wlive.cloud.stream.co.jp:XXXX/XXXXXXXXXXXXXX?key=XXXXXXX",
- "qualities": [
- {
- "name": "fhd",
- "jpname": "フルHD画質",
- "stream_name": "XXXXXXXXXXXXX",
- "keyframe": 30,
- "video_bitrate": 6000,
- "audio_bitrate": 128,
- "width": 1920,
- "height": 1080,
- "audio_sampling_frequency": 44
}
]
}
}ライブ配信を有効化するための API です。
指定されたライブ設定に対して配信を再度有効な状態にし、
ライブエンコーダーからの映像入力を受け付けられる状態にします。
同一のライブ設定を継続して利用する場合、
エンコーダーからのフィードが正しく接続されないことがあります。
その際は、本 API を実行した後に
改めてエンコーダーからフィードを送出してください。
利用上の注意事項:
| uploadKey required | string WriteAPI 用 アップロードキー(認証API で取得) |
| lpid required | integer ライブ設定ID(半角数字)(必須) |
curl 'https://eqapi.stream.co.jp/live/v1/activateLive/{uploadKey}' \ --request POST \ --header 'Content-Type: multipart/form-data' \ --form 'lpid=0'
{- "error_code": 0,
- "message": "OK"
}ライブ配信における m3u8 形式のプレイリスト情報を取得するための API です。
指定されたライブIDに紐づくストリーム情報をもとに、
配信および監視用の各種URLを取得することができます。
本 API はアップロードキーを用いて実行され、
ライブ配信に利用されるフィードURLおよびプレイヤー用の配信URLなどが返却されます。
また、指定に応じて配信URLに含まれるドメイン情報の置換を行うことが可能です。
利用上の注意事項:
| uploadKey required | string WriteAPI 用 アップロードキー(認証API で取得) |
| lpid required | integer ライブ設定 ID |
| replacement_fqdn | string 置換する FQDN 文字列(253文字、半角英数字、ハイフン(-)、ドット(.)のみ) |
curl 'https://eqapi.stream.co.jp/live/v1/getPlaylist/{uploadKey}' \ --request POST \ --header 'Content-Type: multipart/form-data' \ --form 'lpid=1' \ --form 'replacement_fqdn='
{- "error_code": 0,
- "message": "OK",
- "lpid": 1,
- "streams": [
- {
- "feed_url": {
- "main": "rtmp://XXXXXXXXXXX-org1.wlive.cloud.stream.co.jp:XXXX/XXXXXXXXXXXXXX?key=XXXXXXX",
- "backup": "rtmp://XXXXXXXXXXX-org2.wlive.cloud.stream.co.jp:XXXX/XXXXXXXXXXXXXX?key=XXXXXXX"
}, - "player_url": {
}
}
]
}ライブ配信を開始するための API です。
指定されたライブ設定に基づき、
ライブストリームの配信開始処理を実行します。
本 API はアップロードキーを用いて実行され、
ライブ配信の状態を「配信中」に遷移させるために使用されます。
必要に応じて、配信開始時にライブイベント名を設定することができます。
利用上の注意事項:
| uploadKey required | string WriteAPI 用 アップロードキー(認証API で取得) |
| lpid required | integer ライブ設定ID(半角数字)(必須) |
| event_name | string ライブイベント名 |
curl 'https://eqapi.stream.co.jp/filetolive/v1/startLive/{uploadKey}' \ --request POST \ --header 'Content-Type: multipart/form-data' \ --form 'lpid=1' \ --form 'event_name='
{- "error_code": 0,
- "message": "OK"
}ライブ配信を停止するための API です。
指定されたライブ設定に基づき、
配信中のライブストリームを停止します。
本 API はアップロードキーを用いて実行され、
ライブ配信の状態を「停止」に遷移させるために使用されます。
利用上の注意事項:
| uploadKey required | string WriteAPI 用 アップロードキー(認証API で取得) |
| lpid required | integer ライブ設定ID(半角数字)(必須) |
curl 'https://eqapi.stream.co.jp/filetolive/v1/stopLive/{uploadKey}' \ --request POST \ --header 'Content-Type: multipart/form-data' \ --form 'lpid=1'
{- "error_code": 0,
- "message": "OK"
}ライブ配信におけるチャット機能を開始するための API です。
指定されたライブ設定に紐づくチャット機能の状態を、
手動操作により開始状態へ遷移させます。
本 API はアップロードキーを用いて実行され、
チャットの開始タイミングが手動に設定されている場合にのみ利用可能です。
利用上の注意事項:
| uploadKey required | string WriteAPI 用 アップロードキー(認証API で取得) |
| lpid required | integer ライブ設定ID(半角数字)(必須) |
curl 'https://eqapi.stream.co.jp/filetolive/v1/startChat/{uploadKey}' \ --request POST \ --header 'Content-Type: multipart/form-data' \ --form 'lpid=1'
{- "error_code": 0,
- "message": "OK"
}ライブ配信におけるチャット機能を停止するための API です。
指定されたライブ設定に紐づくチャット機能の状態を、
手動操作により停止状態へ遷移させます。
本 API はアップロードキーを用いて実行され、
チャットの停止タイミングが手動に設定されている場合にのみ利用可能です。
利用上の注意事項:
| uploadKey required | string WriteAPI 用 アップロードキー(認証API で取得) |
| lpid required | integer ライブ設定ID(半角数字)(必須) |
curl 'https://eqapi.stream.co.jp/filetolive/v1/stopChat/{uploadKey}' \ --request POST \ --header 'Content-Type: multipart/form-data' \ --form 'lpid=1'
{- "error_code": 0,
- "message": "OK"
}ライブ配信中のイベント情報および配信状態を取得するための API です。
指定されたライブ設定に紐づく現在の配信状況や、
視聴者数、チャット状態などのリアルタイム情報を取得することができます。
本 API はアップロードキーを用いて実行され、
ライブ配信中または配信終了後の状態に応じた情報が返却されます。
利用上の注意事項:
| uploadKey required | string WriteAPI 用 アップロードキー(認証API で取得) |
| lpid required | integer ライブ設定ID(半角数字)(必須) |
curl 'https://eqapi.stream.co.jp/filetolive/v1/getNowInfo/{uploadKey}' \ --request POST \ --header 'Content-Type: multipart/form-data' \ --form 'lpid=1'
{- "error_code": 0,
- "message": "OK",
- "lpid": 1,
- "live_name": "テスト用ライブ配信設定",
- "status": "open",
- "chat_room_status": "stop",
- "event_name": "テスト配信",
- "recfile_cnt": 1,
- "recfile_cnt_limit": 9,
- "current_viewing_cnt": 0,
- "max_viewing_cnt": 0,
- "cumulative_cnt": 0,
- "dvr_close_date": "2021-12-08T19:41:30.2930",
- "onair_time": "2020/01/01 00:00:00"
}ライブ配信中のライブイベント名を変更するための API です。
指定されたライブ設定に紐づくイベント情報を更新し、
配信中の表示内容に反映させることができます。
本 API はアップロードキーを用いて実行され、
ライブ配信中にイベント名を動的に変更する用途で使用されます。
利用上の注意事項:
| uploadKey required | string WriteAPI 用 アップロードキー(認証API で取得) |
| lpid required | integer ライブ設定ID(半角数字)(必須) |
| event_name required | string ライブイベント名(200文字まで) |
curl 'https://eqapi.stream.co.jp/filetolive/v1/setEventName/{uploadKey}' \ --request POST \ --header 'Content-Type: multipart/form-data' \ --form 'lpid=1' \ --form 'event_name='
{- "error_code": 0,
- "message": "OK"
}ライブ配信中に録画ファイルを分割するための API です。
指定されたライブ設定に紐づく録画データを、
任意のタイミングで区切り、新たな録画ファイルとして保存します。
本 API はアップロードキーを用いて実行され、
ライブ配信中の録画ファイル管理や、
録画データの分割運用を行う際に利用されます。
利用上の注意事項:
| uploadKey required | string WriteAPI 用 アップロードキー(認証API で取得) |
| lpid required | integer ライブ設定ID(半角数字)(必須) |
curl 'https://eqapi.stream.co.jp/filetolive/v1/setExtension/{uploadKey}' \ --request POST \ --header 'Content-Type: multipart/form-data' \ --form 'lpid=1'
{- "error_code": 0,
- "message": "OK"
}ライブDVRの停止を行うAPIです。
ライブ配信中または配信終了後のDVR配信を停止することができます。
利用上の注意事項:
| uploadKey required | string WriteAPI 用 アップロードキー(認証API で取得) |
| lpid required | integer ライブ設定ID(半角数字)(必須) |
{ "lpid": 1 }
{- "error_code": 0,
- "message": "OK"
}過去に実施されたライブ配信の履歴情報を取得するための API です。
指定された条件に基づき、ライブイベントの開催日時や設定情報、
配信状態および関連設定の履歴データを一覧形式で取得することができます。
本 API は ReadAPI トークンによる認証を必要とし、
ページングや検索条件の指定により対象のライブ履歴を絞り込んで取得することが可能です。
また、指定に応じてチャット設定や関連リンク、ポータル情報などの付加情報を含めることができます。
利用上の注意事項:
| token required | string ReadAPIトークン |
| type | string Enum: "jsonp" "json" 返却形式のタイプを指定。「jsonp」「json」が指定可能 |
| callback | string JSONP コールバック関数名(jsonp 時のみ) |
| pageSize | integer <= 100 Default: 10 1ページあたりの取得件数(最大100件) |
| pageNumber | integer Default: 1 取得するページ番号(1開始) |
| lpid | string ライブプロファイルID。複数指定する場合はカンマ区切りで指定。 |
| eventDateFrom | string <date> 取得対象の開始日。26ヶ月以前の日付は指定不可。 |
| eventDateTo | string <date> 取得するライブの開催日期間:終了 |
| liveName | string ライブ設定名(部分一致検索) |
| eventName | string ライブイベント名(部分一致検索) |
| p1 | string 任意パラメータ1(検索条件として利用可能) |
| p2 | string 任意パラメータ2(検索条件として利用可能) |
| p3 | string 任意パラメータ3(検索条件として利用可能) |
| resObject | string レスポンスのオブジェクト(複数指定はカンマ区切り)
|
curl 'https://api01-platform.stream.co.jp/apiservice/live/v1/profile/arch/?token='
{- "response_status": "2000",
- "livesum": 1,
- "events": [
- {
- "lplid": "XXX-1",
- "rec_mids": [
- "XXXX"
], - "status": "TranscodeComp",
- "live_name": "~部分一致~",
- "event_name": "test",
- "event_onair": "2020/05/12 11:00:00",
- "event_offair": "2020/05/12 12:00:00",
- "live_description": "",
- "group_id": 0,
- "mpid": 16,
- "max_client": 2022,
- "liveapp_flg": 0,
- "vod_flg": 1,
- "exlink": {
- "enabled": 1,
- "settings": [
- {
- "index": 1,
- "text": "",
- "url": ""
}, - {
- "index": 2,
- "text": "",
- "url": ""
}, - {
- "index": 3,
- "text": "",
- "url": ""
}
]
}, - "vlpid": 0,
- "chat": {
- "enabled": 0,
- "auto_resize_flg": 0,
- "width": 600,
- "height": 400,
- "enter_msg": 0,
- "good_btn": 0,
- "trouble_btn": 0,
- "admin_display_name": "管理者",
- "block_type": 0,
- "block_words": [
- "ngword"
], - "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"
}
]
}過去に実施されたライブ配信の同時接続数の履歴情報を取得するための API です。
指定されたライブイベントIDに紐づく接続数の推移を時系列データとして取得することができ、
ライブ配信時の視聴傾向やピーク接続数の分析に利用可能です。
本 API は ReadAPI トークンによる認証を必要とし、
取得形式の指定に応じてテキスト形式またはファイル形式でデータが返却されます。
利用上の注意事項:
| token required | string ReadAPIトークン |
| lplid required | string Example: lplid=12-3 ライブイベントID。 半角数-半角数形式で指定(例:12-3)。 |
| type | string Default: "file" Enum: "text" "file" ダウンロードタイプ。 text または file を指定可能。未指定時は file。 |
curl 'https://api01-platform.stream.co.jp/apiservice/getLiveConnectionArch/?token=&lplid=12-3'
"2022-07-01 17:20:00",0 "2022-07-01 17:20:30",0 "2022-07-01 17:21:00",0 "2022-07-01 17:21:30",1 "2022-07-01 17:22:00",1 "2022-07-01 17:22:30",1 "2022-07-01 17:23:00",1 "2022-07-01 17:23:30",1 "2022-07-01 17:24:00",1 累計視聴者数,1
過去に実施されたライブ配信におけるチャット投稿履歴を取得するための API です。
指定されたライブイベントIDに紐づくチャットメッセージの履歴を、
時系列データとして一覧形式で取得することができます。
本 API は ReadAPI トークンによる認証を必要とし、
取得形式の指定に応じてテキスト形式またはファイル形式で履歴データが返却されます。
利用上の注意事項:
| token required | string ReadAPIトークン |
| lplid required | string Example: lplid=12-3 ライブイベントID。 半角数-半角数形式で指定(例:12-3)。 |
| type | string Default: "file" Enum: "text" "file" ダウンロードタイプ。 text または file を指定可能。未指定時は file。 |
curl 'https://api01-platform.stream.co.jp/apiservice/getLiveChatMsgArch/?token=&lplid=12-3'
number,delete,time,soket_id,name,message 1,false,2019/06/17 15:48:54,master,システム,【○○】さんが入室しました 2,false,2019/06/17 15:49:05,master,システム,【aaa】さんが入室しました 3,true,2019/06/17 15:49:27,HUHHi_dXv0MbyMBBAAAC,○○,△△部の○○開いてます。 4,false,2019/06/17 15:49:47,master,システム,【○○】さんが退室しました 5,false,2019/06/17 15:51:15,master,システム,【テストです】さんが入室しました 6,true,2019/06/17 15:51:28,ZF_b0ZXgHScWrAUIAAAE,テストです,テストです 7,true,2019/06/17 15:51:32,ZF_b0ZXgHScWrAUIAAAE,テストです,:trouble:よくわかりません。 8,true,2019/06/17 15:52:09,W8iS8tD8piUyaur4AAAF,aaa,EQライブプレイヤーのサイズをレスポンシブ設定にしておくと、チャットを含んだ画面が使いやすくなりますよ。 9,true,2019/06/17 15:52:28,ZF_b0ZXgHScWrAUIAAAE,テストです,:nice:いいね!しました。 10,false,2019/06/17 15:52:33,master,システム,【aaa】さんが退室しました
疑似ライブ配信で利用可能なフィラー動画の一覧を取得するための API です。
指定された本編動画に紐づき、合間に挿入可能なフィラー映像の情報を一覧形式で取得することができます。
本 API はアップロードキーを用いて実行され、
ページングや検索条件を指定することで対象のフィラー動画を絞り込んで取得することが可能です。
利用上の注意事項:
| uploadKey required | string WriteAPI 用 アップロードキー(認証API で取得) |
フォームデータとして送信するパラメータ
| mid required | integer 本編動画ID(必須) |
| pageSize | integer 取得件数(デフォルト値:100) |
| pageNumber | integer 取得開始ページ番号(デフォルト値:1) |
| search_filler_mid | integer 検索条件としての動画ID(任意) |
curl 'https://eqapi.stream.co.jp/filetolive/v1/getFillerList/{uploadKey}' \ --request POST \ --header 'Content-Type: multipart/form-data' \ --form 'mid=1' \ --form 'pageSize=' \ --form 'pageNumber=' \ --form 'search_filler_mid='
{- "error_code": 0,
- "message": "OK",
- "sum": 1,
- "movies": [
- {
- "mid": 2,
- "title": ""
}
]
}疑似ライブ配信で利用可能な動画の一覧を取得するための API です。
疑似ライブ配信に登録可能な動画を対象に、
動画IDやタイトル、動画尺などの基本情報を一覧形式で取得することができます。
本 API はアップロードキーを用いて実行され、
ページングや検索条件の指定により、対象の動画を絞り込んで取得することが可能です。
利用上の注意事項:
| uploadKey required | string WriteAPI 用 アップロードキー(認証API で取得) |
| pageSize | integer Default: 100 取得件数(最大1000)。 未指定時は100。 |
| pageNumber | integer Default: 1 取得開始ページ番号(1開始)。 |
| mid | integer 検索対象の動画ID。 |
curl 'https://eqapi.stream.co.jp/filetolive/v1/getMediaList/{uploadKey}' \ --request POST \ --header 'Content-Type: multipart/form-data' \ --form 'pageSize=100' \ --form 'pageNumber=1' \ --form 'mid='
{- "error_code": 0,
- "message": "OK",
- "sum": 1,
- "movies": [
- {
- "mid": 2,
- "title": "",
- "duration": 60
}
]
}疑似ライブ配信のプロファイル設定情報を取得するための API です。
指定された条件に基づき、疑似ライブの配信設定や状態、関連するメタ情報を
一覧形式で取得することができます。
本 API は ReadAPI トークンによる認証を必要とし、
ページングや検索条件の指定により対象の疑似ライブ設定を絞り込んで取得することが可能です。
また、指定に応じてチャット設定やポータル情報、サムネイル情報などの付加情報を
含めて取得することができます。
利用上の注意事項:
| token required | string ReadAPIトークン |
| type | string Default: "json" Enum: "jsonp" "json" 返却形式(jsonp / json) |
| callback | string Default: "searchResultEq" JSONP コールバック関数名(jsonp 時のみ有効) |
| pageSize | integer <= 100 Default: 10 取得件数(最大100) |
| pageNumber | integer Default: 1 取得開始ページ番号 |
| flpid | string 取得する疑似ライブ設定ID。 |
| liveName | string 疑似ライブ設定名(部分一致) |
| status | string Enum: "waiting" "ready" "streaming" "finished" "error" 疑似ライブステータス
|
| p1 | string 任意パラメータ1(そのまま返却) |
| p2 | string 任意パラメータ2(そのまま返却) |
| p3 | string 任意パラメータ3(そのまま返却) |
| resObject | string レスポンスのオブジェクト(複数指定はカンマ区切り)
|
curl 'https://api01-platform.stream.co.jp/apiservice/filetolive/v1/profile?token='
{- "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": {
}, - "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": "田中"
}, - "thumbnails": {
}
}
]
}疑似ライブ配信のプロファイルを作成、および更新するための API です。
指定された配信設定に基づき、疑似ライブの配信スケジュールや
動画、チャット設定、サムネイルなどの各種情報を登録・変更することができます。
本 API はアップロードキーを用いて実行され、
新規作成時には疑似ライブプロファイルを生成し、
既存の設定IDを指定した場合は対象の設定内容が更新されます。
利用上の注意事項:
| uploadKey required | string WriteAPI 用 アップロードキー(認証API で取得) |
| flpid | integer 疑似ライブ設定ID |
| mid | integer 疑似ライブする動画ID(新規時必須) |
| start_date | string 公開開始日時(新規時必須) |
| name | string 疑似ライブ設定名(新規時必須)(100文字以内) |
| description | string 疑似ライブ設定説明(500文字以内) |
| max_client | integer 同時接続数制限 |
| prefiller_mid | integer Default: 0 開始前フィラー動画ID |
| postfiller_mid | integer Default: 0 終了後フィラー動画ID |
| thumb_feedout | string <binary> 配信停止サムネイル(2MB以下、gif/jpeg/jpg/png) |
| thumb_feedin | string <binary> 配信準備サムネイル(2MB以下、gif/jpeg/jpg/png) |
| thumb_liveclose | string <binary> 配信終了サムネイル(2MB以下、gif/jpeg/jpg/png) |
| chat_flg | integer Default: 0 Enum: 0 1 チャット利用可否(0:利用しない / 1:利用する) |
| chat_auto_resize | integer Default: 0 Enum: 0 1 チャット自動リサイズ(0:無効 / 1:有効) |
| chat_width | integer Default: 600 チャット幅(300〜1920) |
| chat_height | integer Default: 400 チャット高さ(320〜1080) |
| chat_block_type | integer Default: 0 Enum: 0 1 2 投稿メッセージ管理 |
| chat_enter_msg | integer Default: 0 Enum: 0 1 2 入退室メッセージ表示 |
| chat_open_timing | integer Default: 0 チャット開始タイミング(分) |
| chat_close_timing | integer Default: 0 チャット終了タイミング(分) |
| chat_icon_text_flg | Array of integers 任意リアクションボタン利用有無 |
| chat_icon_text | Array of strings 任意リアクションボタンテキスト |
| chat_good_btn | integer Default: 1 Enum: 0 1 いいねボタン(0:無効 / 1:有効) |
| chat_trouble_btn | integer Default: 1 Enum: 0 1 わかりませんボタン(0:無効 / 1:有効) |
| chat_display_name | string Default: "admin" 管理者表示名 |
| chat_block_words | string ブロックワード(カンマ区切り、1000文字以内) |
| potal_meta_event_name | string ポータルイベント名 |
| potal_meta_event_description | string ポータルイベント説明 |
| potal_meta_performer | string ポータル出演者 |
curl 'https://eqapi.stream.co.jp/filetolive/v1/setProfile/{uploadKey}' \ --request POST \ --header 'Content-Type: multipart/form-data' \ --form 'flpid=' \ --form 'mid=' \ --form 'start_date=' \ --form 'name=' \ --form 'description=' \ --form 'max_client=' \ --form 'prefiller_mid=0' \ --form 'postfiller_mid=0' \ --form 'thumb_feedout=' \ --form 'thumb_feedin=' \ --form 'thumb_liveclose=' \ --form 'chat_flg=0' \ --form 'chat_auto_resize=0' \ --form 'chat_width=600' \ --form 'chat_height=400' \ --form 'chat_block_type=0' \ --form 'chat_enter_msg=0' \ --form 'chat_open_timing=0' \ --form 'chat_close_timing=0' \ --form 'chat_good_btn=1' \ --form 'chat_trouble_btn=1' \ --form 'chat_display_name=admin' \ --form 'chat_block_words=' \ --form 'potal_meta_event_name=' \ --form 'potal_meta_event_description=' \ --form 'potal_meta_performer='
{- "error_code": 0,
- "message": "OK",
- "flpid": 1
}疑似ライブ配信のプロファイル設定を削除するための API です。
指定された疑似ライブ設定IDに紐づくプロファイル情報を削除し、
対象の疑似ライブ配信設定を無効化します。
本 API はアップロードキーを用いて実行され、
該当する疑似ライブプロファイルの削除処理を行います。
利用上の注意事項:
| uploadKey required | string WriteAPI 用 アップロードキー(認証API で取得) |
| flpid required | integer 疑似ライブ設定ID(必須) |
{- "flpid": 0
}{- "error_code": 0,
- "message": "OK"
}疑似ライブ配信を強制的に停止するための API です。
指定された疑似ライブ設定に紐づく配信を、
配信状態に関わらず停止状態へ遷移させます。
本 API はアップロードキーを用いて実行され、
配信中の疑似ライブを即時停止する用途で利用されます。
利用上の注意事項:
| uploadKey required | string WriteAPI 用 アップロードキー(認証API で取得) |
| flpid required | integer 疑似ライブ設定ID(必須) |
curl 'https://eqapi.stream.co.jp/filetolive/v1/stopLive/{uploadKey}' \ --request POST \ --header 'Content-Type: multipart/form-data' \ --form 'flpid=1'
{- "error_code": 0,
- "message": "OK"
}疑似ライブ配信におけるチャット機能を開始するための API です。
指定された疑似ライブ設定に紐づくチャット機能を、
手動操作により開始状態へ遷移させます。
本 API はアップロードキーを用いて実行され、
疑似ライブプロファイルにおいてチャットの開始タイミングが手動設定の場合にのみ利用可能です。
利用上の注意事項:
| uploadKey required | string WriteAPI 用 アップロードキー(認証API で取得) |
| flpid required | integer 疑似ライブ設定ID(必須) |
curl 'https://eqapi.stream.co.jp/filetolive/v1/startChat/{uploadKey}' \ --request POST \ --header 'Content-Type: multipart/form-data' \ --form 'flpid=1'
{- "error_code": 0,
- "message": "OK"
}疑似ライブ配信におけるチャット機能を停止するための API です。
指定された疑似ライブ設定に紐づくチャット機能を、
手動操作により停止状態へ遷移させます。
本 API はアップロードキーを用いて実行され、
疑似ライブプロファイルにおいてチャットの停止タイミングが手動設定の場合にのみ利用可能です。
利用上の注意事項:
| uploadKey required | string WriteAPI 用 アップロードキー(認証API で取得) |
| flpid required | integer 疑似ライブ設定ID(必須) |
curl 'https://eqapi.stream.co.jp/filetolive/v1/stopChat/{uploadKey}' \ --request POST \ --header 'Content-Type: multipart/form-data' \ --form 'flpid=1'
{- "error_code": 0,
- "message": "OK"
}疑似ライブ配信における同時接続数の履歴情報を取得するための API です。
指定された疑似ライブ設定IDに紐づく接続数の推移を時系列データとして取得でき、
配信中の視聴者数の変動やピーク値の分析に利用することができます。
本 API は ReadAPI トークンによる認証を必要とし、
取得形式の指定に応じてテキスト形式またはファイル形式で履歴データが返却されます。
利用上の注意事項:
| token required | string ReadAPIトークン |
| flpid required | integer 疑似ライブ設定ID |
| type | string Default: "file" Enum: "text" "file" ダウンロードタイプ |
curl 'https://api01-platform.stream.co.jp/apiservice/filetolive/v1/connection/?token=&flpid=1'
"2022-03-25 15:51:30",171 "2022-03-25 15:52:00",170 "2022-03-25 15:52:30",168 "2022-03-25 15:53:00",168 "2022-03-25 15:53:30",164 "2022-03-25 15:54:00",169 "2022-03-25 15:54:30",162 "2022-03-25 15:55:00",162 累計視聴者数,317
疑似ライブ配信におけるチャット投稿履歴を取得するための API です。
指定された疑似ライブ設定IDに紐づくチャットメッセージの履歴を、
時系列データとして一覧形式で取得することができます。
本 API は ReadAPI トークンによる認証を必要とし、
取得形式の指定に応じてテキスト形式またはファイル形式で履歴データが返却されます。
利用上の注意事項:
| token required | string ReadAPIトークン |
| flpid required | integer 疑似ライブ設定ID |
| type | string Default: "file" Enum: "text" "file" ダウンロードタイプ |
curl 'https://api01-platform.stream.co.jp/apiservice/filetolive/v1/chatmsg/?token=&flpid=1'
number,delete,time,soket_id,name,message 1,false,2019/06/17 15:48:54,master,システム,【竹田】さんが入室しました 2,false,2019/06/17 15:49:05,master,システム,【aaa】さんが入室しました 3,true,2019/06/17 15:49:27,HUHHi_dXv0MbyMBBAAAC,竹田,ライブ業務推進課の竹田開いてます。 4,false,2019/06/17 15:49:47,master,システム,【竹田】さんが退室しました 5,false,2019/06/17 15:51:15,master,システム,【テストです】さんが入室しました 6,true,2019/06/17 15:51:28,ZF_b0ZXgHScWrAUIAAAE,テストです,テストです 7,true,2019/06/17 15:51:32,ZF_b0ZXgHScWrAUIAAAE,テストです,:trouble:よくわかりません。 8,true,2019/06/17 15:52:09,W8iS8tD8piUyaur4AAAF,aaa,EQライブプレイヤーのサイズをレスポンシブ設定にしておくと、チャットを含んだ画面が使いやすくなりますよ。 9,true,2019/06/17 15:52:28,ZF_b0ZXgHScWrAUIAAAE,テストです,:nice:いいね!しました。 10,false,2019/06/17 15:52:33,master,システム,【aaa】さんが退室しました