Sora API

概要

Sora の API を実行します。

Sora との違い

  • パッケージ版の Sora とは違い一部利用できない API があります。

channel_id について

Sora API の channel_id は {channel_name}@{project_id} の形式です。

channel_name は好きな文字列を指定できます。 project_id は Sora Cloud のプロジェクト ID です。

sora-api

API URL:

https://api.sora-cloud.shiguredo.app/sora-api

Sora の API を実行します。

$ curl -sS \
    -X POST \
    https://api.sora-cloud.shiguredo.app/sora-api \
    -H "Authorization: Bearer <API-KEY>" \
    -H "x-sora-target: Sora_20151104.DisconnectChannel" \
    --json '{"channel_id":"sora-cloud@SJW1TPPMQ3JGXM6XD0DTEH77RZDWX0N1"}' \
    | jq .

利用可能な Sora API

詳細は Sora ドキュメント をご確認ください

録画 API の制限

以下の録画 API はプロジェクトにオブジェクトストレージ設定が行われていない場合、 または録画機能利用の 制限 に該当する指定を行っていた場合は利用できません。

  • Sora_20231220.StartRecording
  • Sora_20231220.StopRecording

シーケンス図

WebRTC SFU SoraSora CloudアプリケーションサーバーWebRTC SFU SoraSora CloudアプリケーションサーバーListChannelConnections API1ListChannelConnections API2200 OK3200 OK4