APIsRoom管理 APIgetRoom情報の取得delRoom強制終了delConnection強制退室API docs by RedoclyRICOH Live Streaming REST API: Room管理 API (v1)Download OpenAPI specification:DownloadRICOH Live Streaming REST API は Live Streaming サービスの公開 REST API です。本ページは Room 管理 API の仕様について記載します。共通仕様API の認証/認可に失敗した場合、ステータスコード 401 のレスポンスが返却されますRoom管理 APIRoom情報の取得 パラメータで指定したclient_idとroom_idに一致するRoom情報を返しますroom_specのβ機能やリコー内専用機能になっているフィールドは、Connectメッセージでデフォルト値指定だった場合、本APIのレスポンスでは省略されますAuthorizations:ClientBasicpath Parametersclient_idrequiredstring Client IDroom_idrequiredstring Room IDquery Parametersenvstring (LSEnv) Enum: "prod" "dev" 操作対象の環境。複数指定不可Responses200 RoomInfoオブジェクトclient_idとroom_idで指定されたRoom及び、そのRoom内のConnectionの情報を返します404 指定したclient_idとroom_idに対応するRoomが存在しませんget/clients/{client_id}/rooms/{room_id}v1 Endpointhttps://api.livestreaming.mw.smart-integration.ricoh.com/v1/clients/{client_id}/rooms/{room_id} Response samples 200404Content typeapplication/jsonCopy Expand all Collapse all {"client_id": "string","room_id": "string","room_spec": {"type": "sfu","max_connections": 1,"media_control": {"bitrate_reservation_mbps": 10},"classification_label": "default"},"connections": [{"connection_id": "string","meta": { }}]}Room強制終了 Roomに入室していたConnectionを全て切断させてRoomを強制的に終了しますRoomに入室していたConnectionのClientSDKは53002 ConnectionClosedByApplicationでクローズしますAuthorizations:ClientBasicpath Parametersclient_idrequiredstring Client IDroom_idrequiredstring Room IDquery Parametersenvstring (LSEnv) Enum: "prod" "dev" 操作対象の環境。複数指定不可Responses204 強制終了の受付け成功ボディは空です404 対象Roomに1Connectionも入室していませんdelete/clients/{client_id}/rooms/{room_id}v1 Endpointhttps://api.livestreaming.mw.smart-integration.ricoh.com/v1/clients/{client_id}/rooms/{room_id} Response samples 404Content typeapplication/jsonCopy Expand all Collapse all {"error_id": "not_found","message": "string","options": { }}Connection強制退室 ConnectionをRoomから退室させます対象ConnectionのClientSDKは53002 ConnectionClosedByApplicationでクローズしますAuthorizations:ClientBasicpath Parametersclient_idrequiredstring Client IDroom_idrequiredstring Room IDconnection_idrequiredstring Connection IDquery Parametersenvstring (LSEnv) Enum: "prod" "dev" 操作対象の環境。複数指定不可Responses204 強制退室の受付け成功ボディは空です404 対象Roomに対象Connectionが入室していませんdelete/clients/{client_id}/rooms/{room_id}/connections/{connection_id}v1 Endpointhttps://api.livestreaming.mw.smart-integration.ricoh.com/v1/clients/{client_id}/rooms/{room_id}/connections/{connection_id} Response samples 404Content typeapplication/jsonCopy Expand all Collapse all {"error_id": "not_found","message": "string","options": { }} const __redoc_state = {"menu":{"activeItemIdx":-1},"spec":{"data":{"openapi":"3.0.2","info":{"title":"RICOH Live Streaming REST API: Room管理 API","version":"v1","description":"RICOH Live Streaming REST API は Live Streaming サービスの公開 REST API です。\n\n本ページは Room 管理 API の仕様について記載します。\n\n### 共通仕様\n- API の認証/認可に失敗した場合、ステータスコード 401 のレスポンスが返却されます\n"},"servers":[{"url":"https://api.livestreaming.mw.smart-integration.ricoh.com/v1","description":"v1 Endpoint"}],"x-tagGroups":[{"name":"APIs","tags":["Room管理 API"]}],"paths":{"/clients/{client_id}/rooms/{room_id}":{"get":{"summary":"Room情報の取得","description":"- パラメータで指定したclient_idとroom_idに一致するRoom情報を返します\n- room_specのβ機能やリコー内専用機能になっているフィールドは、Connectメッセージでデフォルト値指定だった場合、本APIのレスポンスでは省略されます\n","tags":["Room管理 API"],"security":[{"ClientBasic":[]}],"parameters":[{"$ref":"#/components/parameters/client_id"},{"$ref":"#/components/parameters/room_id"},{"$ref":"#/components/parameters/env"}],"responses":{"200":{"description":"RoomInfoオブジェクト\n- client_idとroom_idで指定されたRoom及び、そのRoom内のConnectionの情報を返します\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoomInfo"}}}},"404":{"description":"指定したclient_idとroom_idに対応するRoomが存在しません","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Error"},{"type":"object","properties":{"error_id":{"type":"string","enum":["not_found"]}}}]}}}}}},"delete":{"summary":"Room強制終了","description":"- Roomに入室していたConnectionを全て切断させてRoomを強制的に終了します\n- Roomに入室していたConnectionのClientSDKは53002 ConnectionClosedByApplicationでクローズします\n","tags":["Room管理 API"],"security":[{"ClientBasic":[]}],"parameters":[{"$ref":"#/components/parameters/client_id"},{"$ref":"#/components/parameters/room_id"},{"$ref":"#/components/parameters/env"}],"responses":{"204":{"description":"強制終了の受付け成功\n- ボディは空です\n"},"404":{"description":"対象Roomに1Connectionも入室していません","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Error"},{"type":"object","properties":{"error_id":{"type":"string","enum":["not_found"]}}}]}}}}}}},"/clients/{client_id}/rooms/{room_id}/connections/{connection_id}":{"delete":{"summary":"Connection強制退室","description":"- ConnectionをRoomから退室させます\n- 対象ConnectionのClientSDKは53002 ConnectionClosedByApplicationでクローズします\n","tags":["Room管理 API"],"security":[{"ClientBasic":[]}],"parameters":[{"$ref":"#/components/parameters/client_id"},{"$ref":"#/components/parameters/room_id"},{"$ref":"#/components/parameters/connection_id"},{"$ref":"#/components/parameters/env"}],"responses":{"204":{"description":"強制退室の受付け成功\n- ボディは空です\n"},"404":{"description":"対象Roomに対象Connectionが入室していません","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Error"},{"type":"object","properties":{"error_id":{"type":"string","enum":["not_found"]}}}]}}}}}}}},"components":{"schemas":{"IDString":{"type":"string","pattern":"^[a-zA-Z0-9.%+^_\"`{|}~<>\\\\\\\\-]{1,255}$","description":"- 1 文字以上 255 文字以下\n- ASCII\n- 以下の文字のみ許可\n - 英数字\n - 次の記号: ``.%+^_\"`{|}~<>\\-``\n"},"RoomInfo":{"type":"object","description":"RoomとRoom内のコネクションに対する情報を格納した構造体","required":["client_id","room_id","room_spec","connections"],"properties":{"client_id":{"type":"string","description":"parameterで指定したclient_id"},"room_id":{"type":"string","format":"IDString","description":"parameterで指定したroom_id"},"room_spec":{"$ref":"#/components/schemas/RoomSpec"},"connections":{"type":"array","items":{"$ref":"#/components/schemas/Connection"}}}},"Connection":{"type":"object","required":["connection_id","meta"],"properties":{"connection_id":{"type":"string","format":"IDString","description":"そのConnectionが接続時に指定したconnection_id"},"meta":{"type":"object","default":{},"description":"- すべてのkeyがIDStringであるobject\n - 使用できるkeyの数は最大32\n- valueはJSON にエンコードされて 0 文字以上 1024 文字以下となるUTF-8でエンコードできる全ての文字が使用できます\n"}}},"LSEnv":{"type":"string","enum":["prod","dev"],"description":"- Live Streaming の環境種別\n - prod: プロダクション環境\n - dev: 開発環境\n"},"RoomType":{"type":"string","enum":["sfu","sfu_large","p2p","p2p_turn"],"description":"- Room の種類\n - sfu: SFU Room 型\n - sfu_large: 大規模イベント向けの SFU Room 型であり、送信できる Client に制限がありますが、1Room あたりの接続可能 Client 数が増えます\n - p2p: P2P Room 型\n - p2p_turn: P2P + TURN Room 型\n"},"MaxConnections":{"title":"最大接続数(sfu_large以外)","type":"integer","minimum":1,"maximum":10000,"description":"- RoomSpec.type に sfu_large 以外を設定した場合の Room に入室できる最大 Connection 数\n- 互換性維持のため1~10000の範囲で指定可能だが、サービス内部では上限50接続に丸められます\n"},"MaxConnectionsLarge":{"title":"最大接続数(sfu_large)","type":"integer","minimum":1,"maximum":300,"description":"- RoomSpec.type に sfu_large を設定した場合の Room に入室できる最大 Connection 数\n"},"MediaControl":{"type":"object","description":"- Room 全体に対するメディア制御設定\n- デフォルト値\n - なし ( \"type\" = \"p2p\" または \"type\" = \"p2p_turn\" の場合 )\n - `{\"bitrate_reservation_mbps\": 10}` ( \"type\" = \"sfu\" または \"sfu_large\" の場合 )\n","properties":{"bitrate_reservation_mbps":{"type":"integer","minimum":1,"maximum":250,"default":10,"description":"- Room ごとに利用可能な帯域幅の最大値を Mbps 単位で指定\n- Room の利用帯域幅は、すべての接続の送信と受信の合計値であり、各接続が利用する帯域は、合計が bitrate_reservation_mbps の設定内に収まるように調整されます\n- デフォルト値: `10`\n"}}},"RoomSpec":{"type":"object","required":["type"],"description":"- 入室する Room の仕様\n- 同時に同じ Room に入室する Connection は同じ RoomSpec が指定されていなければなりません\n","properties":{"type":{"$ref":"#/components/schemas/RoomType"},"max_connections":{"oneOf":[{"$ref":"#/components/schemas/MaxConnections"},{"$ref":"#/components/schemas/MaxConnectionsLarge"}]},"media_control":{"$ref":"#/components/schemas/MediaControl"},"classification_label":{"type":"string","format":"IDString","default":"default","description":"- 課金分類ラベル\n- デフォルト値: `default`\n"}}},"Error":{"type":"object","required":["error_id"],"properties":{"error_id":{"type":"string","description":"- エラーの種類を識別する ID\n"},"message":{"type":"string","description":"- エラーの内容を記述した開発者向けのメッセージ\n- バージョンアップによってテキストの内容が変更される可能性があるため、これに依存した処理を実装してはいけません\n"},"options":{"type":"object","description":"- エラーの補助情報\n- 内容は API および error_id によって異なります\n"}}}},"parameters":{"client_id":{"in":"path","name":"client_id","schema":{"type":"string"},"required":true,"description":"- Client ID\n"},"room_id":{"in":"path","name":"room_id","schema":{"type":"string"},"required":true,"description":"- Room ID\n"},"connection_id":{"in":"path","name":"connection_id","schema":{"type":"string"},"required":true,"description":"- Connection ID\n"},"env":{"in":"query","name":"env","schema":{"$ref":"#/components/schemas/LSEnv","default":"prod"},"description":"操作対象の環境。複数指定不可\n","required":false}},"securitySchemes":{"ClientBasic":{"type":"http","scheme":"basic","description":"Client ID を username、Client Secretを password にした Basic 認証"}}}}},"searchIndex":{"store":["tag/Room-API","tag/Room-API/paths/~1clients~1{client_id}~1rooms~1{room_id}/get","tag/Room-API/paths/~1clients~1{client_id}~1rooms~1{room_id}/delete","tag/Room-API/paths/~1clients~1{client_id}~1rooms~1{room_id}~1connections~1{connection_id}/delete"],"index":{"version":"2.3.9","fields":["title","description"],"fieldVectors":[["title/0",[0,0.286,1,0.967]],["description/0",[]],["title/1",[0,0.388]],["description/1",[2,0.467,3,1.123,4,1.123,5,0.646]],["title/2",[0,0.388]],["description/2",[2,0.44,5,0.593,6,1.03,7,1.03,8,0.593]],["title/3",[9,1.311]],["description/3",[2,0.44,8,0.593,10,1.03,11,1.03,12,1.03]]],"invertedIndex":[["",{"_index":2,"title":{},"description":{"1":{},"2":{},"3":{}}}],["api",{"_index":1,"title":{"0":{}},"description":{}}],["client_idとroom_idに一致するroom",{"_index":3,"title":{},"description":{"1":{}}}],["clients/{client_id}/rooms/{room_id",{"_index":5,"title":{},"description":{"1":{},"2":{}}}],["clients/{client_id}/rooms/{room_id}/connections/{connection_id",{"_index":12,"title":{},"description":{"3":{}}}],["connect",{"_index":9,"title":{"3":{}},"description":{}}],["connectionclosedbyappl",{"_index":8,"title":{},"description":{"2":{},"3":{}}}],["connectionのclientsdkは53002",{"_index":11,"title":{},"description":{"3":{}}}],["connectionをroom",{"_index":10,"title":{},"description":{"3":{}}}],["room",{"_index":0,"title":{"0":{},"1":{},"2":{}},"description":{}}],["room_specのβ機能やリコー内専用機能になっているフィールドは、connectメッセージでデフォルト値指定だった場合、本api",{"_index":4,"title":{},"description":{"1":{}}}],["roomに入室していたconnectionのclientsdkは53002",{"_index":7,"title":{},"description":{"2":{}}}],["roomに入室していたconnectionを全て切断させてroom",{"_index":6,"title":{},"description":{"2":{}}}]],"pipeline":[]}},"options":{}}; var container = document.getElementById('redoc'); Redoc.hydrate(__redoc_state, container);