API docs by Redocly

RICOH Live Streaming REST API: Room管理 API (v1)

Download OpenAPI specification:Download

RICOH Live Streaming REST API は Live Streaming サービスの公開 REST API です。

本ページは Room 管理 API の仕様について記載します。

共通仕様

  • API の認証/認可に失敗した場合、ステータスコード 401 のレスポンスが返却されます

Room 管理 API

Room 情報の取得

  • パラメータで指定した client_id と room_id に一致する Room 情報を返します
  • Room の type が "p2p" または "p2p_turn" の時は、録画に対応しないため recording_status 要素は省略されます
Authorizations:
ClientBasic
path Parameters
client_id
required
string
  • Client ID
room_id
required
string
  • Room ID
query Parameters
env
string (LSEnv)
Enum: "prod" "dev"

操作対象の環境。複数指定不可

Responses

Response samples

Content type
application/json
{
  • "client_id": "string",
  • "room_id": "string",
  • "room_spec": {
    },
  • "connections": [
    ],
  • "recording_status": {
    }
}

Room 強制終了

  • Room に入室していた Connection を全て切断させて Room を強制的に終了します
  • Room に入室していた Connection の ClientSDK は 53002 ConnectionClosedByApplication でクローズします
Authorizations:
ClientBasic
path Parameters
client_id
required
string
  • Client ID
room_id
required
string
  • Room ID
query Parameters
env
string (LSEnv)
Enum: "prod" "dev"

操作対象の環境。複数指定不可

Responses

Response samples

Content type
application/json
{
  • "error_id": "not_found",
  • "message": "string",
  • "options": { }
}

Connection 強制退室

  • Connection を Room から退室させます
  • 対象 Connection の ClientSDK は 53002 ConnectionClosedByApplication でクローズします
Authorizations:
ClientBasic
path Parameters
client_id
required
string
  • Client ID
room_id
required
string
  • Room ID
connection_id
required
string
  • Connection ID
query Parameters
env
string (LSEnv)
Enum: "prod" "dev"

操作対象の環境。複数指定不可

Responses

Response samples

Content type
application/json
{
  • "error_id": "not_found",
  • "message": "string",
  • "options": { }
}

Room 録画 API

Room の録画開始

  • sfu または sfu_large が指定された Room の録画を開始します
    • p2p または p2p_turn 指定の Room は録画に非対応です
  • 録画中に呼び出した場合は、何もせず 200 を返します
  • 現在の録画状態は、 Room API の GET で取得できます
  • 録画の停止直後に開始を実行すると、 waiting_recording_complete エラーが発生します
Authorizations:
ClientBasic
path Parameters
client_id
required
string
  • Client ID
room_id
required
string
  • Room ID
query Parameters
env
string (LSEnv)
Enum: "prod" "dev"

操作対象の環境。複数指定不可

Responses

Response samples

Content type
application/json
{
  • "in_recording": true
}

Room の録画停止

  • sfu または sfu_large が指定された Room の録画を停止します
    • p2p または p2p_turn 指定の Room は録画に非対応です
  • 録画の停止中に呼び出した場合は、何もせず 200 を返します
  • 現在の録画状態は、 Room API の GET で取得できます
Authorizations:
ClientBasic
path Parameters
client_id
required
string
  • Client ID
room_id
required
string
  • Room ID
query Parameters
env
string (LSEnv)
Enum: "prod" "dev"

操作対象の環境。複数指定不可

Responses

Response samples

Content type
application/json
{
  • "in_recording": true
}

RoomInfo

client_id
required
string

parameter で指定した client_id

room_id
required
string <IDString>

parameter で指定した room_id

required
object (RoomSpec)
  • 入室する Room の仕様
  • 同時に同じ Room に入室する Connection は同じ RoomSpec が指定されていなければなりません
required
Array of objects (Connection)
object (RecordingStatus)
  • Room の録画に関する状態を格納するオブジェクト
{
  • "client_id": "string",
  • "room_id": "string",
  • "room_spec": {
    },
  • "connections": [
    ],
  • "recording_status": {
    }
}

IDString

string (IDString) ^[a-zA-Z0-9.%+^_"`{|}~<>\\\\-]{1,255}$
  • 1 文字以上 255 文字以下
  • ASCII
  • 以下の文字のみ許可
    • 英数字
    • 次の記号: .%+^_"`{|}~<>\-
"string"