Sora API¶

概要¶

Sora の API を実行します。

Sora との違い¶

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

sora-api¶

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

Sora の API を実行します。

$ https -A bearer -a <API-KEY> \
    POST api.sora-cloud.shiguredo.app/sora-api \
    x-sora-target:'Sora_20151104.DisconnectChannel' \
    channel_id='sora-cloud@SJW1TPPMQ3JGXM6XD0DTEH77RZDWX0N1' \
    -vvv

利用可能な 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_20161101.StartRecording
- 2025-12 月リリース予定の Sora にて廃止します
Sora_20161101.StopRecording
- 2025-12 月リリース予定の Sora にて廃止します
Sora_20161101.GetStartedRecording
- 2025-12 月リリース予定の Sora にて廃止します
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
Sora_20201005.ResetRtpStream
Sora_20200401.PauseRtpStream
Sora_20200401.ResumeRtpStream
Sora_20200401.ListPauseRtpStreams
Sora_20211215.ListChannelRtcStats
Sora_20211215.GetRtcStats
Sora_20211215.ListChannelUserAgentStats
- 2025-06 月リリース予定の Sora にて廃止します
- Sora_20211215.ListChannelRtcStats をご利用ください
Sora_20211215.GetUserAgentStats
- 2025-06 月リリース予定の Sora にて廃止します
- 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

録画 API の制限¶

以下の録画 API はプロジェクトにてオブジェクトストレージ設定が行われていないと利用できません。

Sora_20161101.StartRecording
Sora_20161101.StopRecording
Sora_20231220.StartRecording
Sora_20231220.StopRecording

シーケンス図¶

        sequenceDiagram
   autonumber
   participant sora as WebRTC SFU Sora
   participant cloud as Sora Cloud
   participant app as アプリケーションサーバー
   app->>+cloud: ListChannelConnections API
   cloud->>+sora: ListChannelConnections API
   sora-->>-cloud: 200 OK
   cloud-->>-app: 200 OK