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¶
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 ドキュメント をご確認ください
- Sora_20151104.DisconnectChannel
- Sora_20151104.DisconnectClient
- Sora_20151104.DisconnectConnection
- Sora_20201120.DisconnectChannelByRole
- Sora_20201013.ListChannelConnections
- Sora_20160711.PushChannel
- Sora_20160711.PushClient
- Sora_20160711.PushConnection
- Sora_20201120.PushChannelByRole
- Sora_20170529.GetStatsClient
- Sora_20170529.GetStatsConnection
- Sora_20200807.FocusSpotlightFixed
- Sora_20200807.FocusSpotlight
- Sora_20200807.UnfocusSpotlight
- Sora_20200807.ChangeSpotlightNumber
- Sora_20211215.RequestSpotlightRid
- Sora_20211215.ResetSpotlightRid
- Sora_20211215.BatchRequestSpotlightRid
- Sora_20201005.RequestRtpStream
- 2027 年 12 月廃止予定
- 代わりに
RequestSimulcastRidAPI を利用してください
- Sora_20201005.ResetRtpStream
- 2026 年 12 月廃止予定
- 代わりに
RequestSimulcastRidAPI を利用してください
- Sora_20211215.ListChannelRtcStats
- Sora_20211215.GetRtcStats
- Sora_20230628.TerminateSession
- Sora_20230628.ListForwardingFilters
- Sora_20230628.CreateChannelForwardingFilter
- Sora_20230628.UpdateChannelForwardingFilter
- Sora_20230628.DeleteChannelForwardingFilter
- Sora_20230628.CreateConnectionForwardingFilter
- Sora_20230628.UpdateConnectionForwardingFilter
- Sora_20230628.DeleteConnectionForwardingFilter
- Sora_20231220.StartRecording
- Sora_20231220.StopRecording
- Sora_20231220.GetSession
- Sora_20241218.RequestKeyFrame
- Sora_20251217.RequestSimulcastRid
- Sora_20251217.ChangeSimulcastAuto
録画 API の制限¶
以下の録画 API はプロジェクトにオブジェクトストレージ設定が行われていない場合、 または録画機能利用の 制限 に該当する指定を行っていた場合は利用できません。
- Sora_20231220.StartRecording
- Sora_20231220.StopRecording