ライブ配信の開始および停止を行うAPIです。
■リクエストURL
https://file-platform.stream.co.jp/writeapi/live/setStatus/[アップロードキー]
※「アップロードキー」の取得方法は「認証API」をご参照ください。
- contentType:multipart/form-data
■パラメータ
パラメータ | 必須 | 説明 | デフォルト値 | フォーマット |
lpid | ○ | ライブID | 無し | 半角数 |
enable | ○ | ライブ配信開始/停止 | 無し | 0:ライブ停止 1:ライブ開始 |
event_name | --- | ライブイベント名 | yyyyMMdd hh:mm:ss ※ライブ配信開始時の日時 |
全角半角 200文字 ※ライブ配信開始時のみ指定可能 |
■レスポンス情報
- 出力タイプ:JSON
- Content-Type:application/json
- 文字コード:UTF-8(BOMなし)
■レスポンス例:正常時
{ "error_code": 0, "message": "OK" } |
error_code:レスポンスコード message:メッセージ |
■レスポンス例:エラー時
{ "error_code": 9021, "message": "request parameter error" } |
■レスポンスコード
レスポンスコード | 説明 |
0 | 正常 |
9021 | パラメータエラー |
9503 | 削除済み、または登録されていない |
9506 | ライブ開始エラー |
9509 | ライブ停止エラー |
9514 | ライブ配信中エラー |
9515 | ライブ配信中でない |
9999 | その他システムエラー |