# 廃止 API ## 概要 廃止 API とはすでに廃止された API です。 ## レガシー録画 API > **注意** > > [レガシー録画機能 API](OBSOLETE_API_LEGACY_RECORDING.html) は 2025 年 12 月リリースの Sora にて廃止します。 > 今後は [録画機能 (セッション単位) API](API_RECORDING.html) をご利用ください。 ## RTP ストリーム停止/再開 API > **注意** > > [RTP ストリーム停止/再開 API](OBSOLETE_API_RTP_STREAM_PAUSE_RESUME.html) は 2025 年 12 月リリースの Sora にて廃止します。 > 今後は [転送フィルター API](API_FORWARDING_FILTER.html) をご利用ください。 ## 廃止ユーザーエージェント API *バージョン 2025.1.0 で削除。* [ユーザーエージェント統計 API](OBSOLETE_API_USER_AGENT_STATS.html) は 2025 年 6 月リリースの Sora にて廃止しました。 今後は [RTC 統計 API](API_RTC_STATS.html) をご利用ください。 ## 廃止クラスター API ### JoinCluster *バージョン 2024.2.0 で削除。* > **危険** > > この API は廃止しました。 全く同じ機能をもつ [RegisterClusterNode](API_CLUSTER.html#09ed96) API を利用してください。 **廃止**: 2024 年 12 月リリースの Sora にて廃止 **x-sora-target**: Sora_20211215.JoinCluster 指定したクラスターノードに参加します。 参加したいクラスターに属するノードのいずれかを `contact_node_name` で指定してください。 クラスターに属していれば、どのノードでもかまいません。 - 参加したいクラスターがすでに初期化されている必要があります。 - クラスターに参加するためには、参加したいクラスターの過半数のノードが正常に稼働している必要があります > **注釈** > > 新規にクラスターを作成する場合には、まず [InitCluster](API_CLUSTER.html#621990) API を使用してください。 * - キー - 型 * - contact_node_name - string ```console $ curl -sS \ -X POST \ http://127.0.0.1:3000/ \ -H "x-sora-target: Sora_20211215.JoinCluster" \ --json '{"contact_node_name":"node-03@10.99.0.8"}' \ | jq . { "node_name_list": [ "node-01@192.0.2.5", "node-02@192.0.2.7", "node-03@192.0.2.8", "node-04@192.0.2.9", "node-05@192.0.2.10" ] } ``` ## 廃止シグナリング API ### ListAllConnections *バージョン 2021.2.0 で削除。* > **危険** > > この API は廃止しました。 **廃止**: 2021 年 12 月リリースの Sora にて廃止 **代替 API**: Sora_20201013.ListConnections **x-sora-target**: Sora_20151104.ListAllConnections すべての接続一覧を取得します。 #### レスポンス項目 **リスト** - role - channel_id - client_id - connection_id - simulcast - spotlight ```console $ curl -sS \ -X POST \ http://127.0.0.1:3000/ \ -H "x-sora-target: Sora_20151104.ListAllConnections" \ | jq . [ { "channel_id": "sora", "client_id": "6DXMKHX8Q106K9YKN693C2D69C", "connection_id": "6DXMKHX8Q106K9YKN693C2D69C", "role": "sendrecv", "simulcast": true, "spotlight": false }, { "channel_id": "sora", "client_id": "QR3H6TYEA907B2HRDF6KCBGWYG", "connection_id": "QR3H6TYEA907B2HRDF6KCBGWYG", "role": "sendrecv", "simulcast": true, "spotlight": false }, { "channel_id": "sora1", "client_id": "K3VJGRFG614SV4RRF74QDEYHVC", "connection_id": "K3VJGRFG614SV4RRF74QDEYHVC", "role": "sendrecv", "simulcast": true, "spotlight": false } ] ``` ### ListChannelClients *バージョン 2021.2.0 で削除。* > **危険** > > この API は廃止しました。 **廃止**: 2021 年 12 月リリースの Sora にて廃止 **代替 API**: Sora_20201013.ListChannelConnections **x-sora-target**: Sora_20170814.ListChannelClients 指定したチャネルのクライアント情報を取得します。 * - キー - 型 * - channel_id - string #### レスポンス項目 **リスト** - role - channel_id - client_id - connection_id - audio - video - minutes- 分単位での接続経過時間 - event_metadata- 認証時に認証サーバーから指定した event_metadata ```console $ curl -sS \ -X POST \ http://127.0.0.1:3000/ \ -H "x-sora-target: Sora_20170814.ListChannelClients" \ --json '{"channel_id":"sora"}' \ | jq . [ { "audio": { "codec_type": "OPUS" }, "channel_id": "sora", "client_id": "6DXMKHX8Q106K9YKN693C2D69C", "connection_id": "6DXMKHX8Q106K9YKN693C2D69C", "minutes": 2, "role": "sendrecv", "video": { "bit_rate": 3000, "codec_type": "VP8" } }, { "audio": { "codec_type": "OPUS" }, "channel_id": "sora", "client_id": "QR3H6TYEA907B2HRDF6KCBGWYG", "connection_id": "QR3H6TYEA907B2HRDF6KCBGWYG", "minutes": 2, "role": "sendrecv", "video": { "bit_rate": 3000, "codec_type": "VP8" } } ] ``` ### DisconnectChannelUpstream *バージョン 2021.1.0 で削除。* > **危険** > > この API は廃止しました。 **廃止**: 2021 年 6 月リリースの Sora にて廃止 **代替 API**: 20201013.DisconnectChannelByRole **x-sora-target**: Sora_20151104.DisconnectChannelUpstream 指定したチャネルすべての配信者の接続を切断します。 * - キー - 型 * - channel_id - string * - reason (オプション) - object `reason` に値を指定した場合、イベントウェブフック `connection.destroyed` の `reason` に指定した値が入ってきます。 ```console $ curl -sS \ -X POST \ http://127.0.0.1:3000 \ -H "x-sora-target: Sora_20151104.DisconnectChannelUpstream" \ --json '{"channel_id":"sora"}' \ | jq . ``` ### DisconnectChannelDownstream > **危険** > > この API は廃止しました。 **廃止**: 2021 年 6 月リリースの Sora にて廃止 **代替 API**: 20201013.DisconnectChannelByRole **x-sora-target**: Sora_20151104.DisconnectChannelDownstream 指定したチャネルすべての視聴者の接続を切断します。 * - キー - 型 * - channel_id - string * - reason (オプション) - object reason に値を指定した場合、イベントウェブフック connection.destroyed の reason に指定した値が入ってきます。 ```console $ curl -sS \ -X POST \ http://127.0.0.1:3000 \ -H "x-sora-target: Sora_20151104.DisconnectChannelDownstream" \ --json '{"channel_id":"sora"}' \ | jq . ``` ### Disconnect > **危険** > > この API は廃止しました。 > **警告** > > sora.conf にて allow_client_id_assignment を true にしていた場合はこの API は利用できません **廃止**: 2021 年 6 月リリースの Sora にて廃止 **代替 API**: Sora_20151104.DisconnectClient **x-sora-target**: Sora_20151104.Disconnect 指定したクライアント ID の接続を切断する * - キー - 型 * - channel_id - string * - client_id - string * - reason (オプション) - object reason に値を指定した場合、イベントウェブフック connection.destroyed の reason に指定した値が入ってきます。 ``` $ curl -sS \ -X POST \ http://127.0.0.1:3000/ \ -H "x-sora-target: Sora_20151104.Disconnect" \ --json '{"channel_id":"sora","client_id":"HMRVPQEXJX03D3B3WE778SJGRC"}' \ | jq . ``` ### ListConnections > **危険** > > この API は廃止しました。 **廃止**: 2021 年 6 月リリースの Sora にて廃止 **代替 API**: Sora_20201013.ListChannelConnections **x-sora-target**: Sora_20151104.ListConnections 指定したチャネルの接続一覧を取得します。 * - キー - 型 * - channel_id - string ```console $ curl -sS \ -X POST \ http://127.0.0.1:3000/ \ -H "x-sora-target: Sora_20151104.ListConnections" \ --json '{"channel_id":"sora"}' \ | jq . [ { "channel_id": "sora", "client_id": "6DXMKHX8Q106K9YKN693C2D69C", "connection_id": "6DXMKHX8Q106K9YKN693C2D69C", "role": "sendrecv", "simulcast": true, "spotlight": false }, { "channel_id": "sora", "client_id": "QR3H6TYEA907B2HRDF6KCBGWYG", "connection_id": "QR3H6TYEA907B2HRDF6KCBGWYG", "role": "sendrecv", "simulcast": true, "spotlight": false } ] ``` ## 廃止サイマルキャスト API ### ChangeSimulcastQuality > **危険** > > この API は廃止しました。 **廃止**: 2021 年 6 月リリースの Sora にて廃止 **代替 API**: Sora_20201005.RequestRtpStream **x-sora-target**: Sora_20180820.ChangeSimulcastQuality 指定した参加者の視聴する映像の画質を変更する * - キー - 型 * - channel_id - string * - connection_id - string * - stream_id (オプション) - string * - quality - string (high | middle | low) ```console $ curl -sS \ -X POST \ http://127.0.0.1:3000/ \ -H "x-sora-target: Sora_20180820.ChangeSimulcastQuality" \ --json '{"channel_id":"sora","connection_id":"KD9N57E2RN5T1BDEA7S7SH038M","quality":"high"}' \ | jq . { "channel_id": "sora", "connection_id": "KD9N57E2RN5T1BDEA7S7SH038M", "quality": "high" } ``` ## 廃止統計 API ### GetStats > **危険** > > この API は廃止しました。 > **警告** > > sora.conf にて allow_client_id_assignment を true にしていた場合はこの API は利用できません **廃止**: 2021 年 6 月リリースの Sora にて廃止 **x-sora-target**: Sora_20170529.GetStats 指定したクライアントの統計情報を取得します。 * - キー - 型 * - channel_id - string * - client_id - string ```console $ curl -sS \ -X POST \ http://127.0.0.1:3000/ \ -H "x-sora-target: Sora_20170529.GetStats" \ --json '{"channel_id":"sora","client_id":"WZXPMM6K8113K83VB8G9XZDTFW"}' \ | jq . { "channel_id": "sora", "client_id": "WZXPMM6K8113K83VB8G9XZDTFW", "connection_id": "WZXPMM6K8113K83VB8G9XZDTFW", "dtls": { "total_received_dtls": 2, "total_sent_dtls": 2 }, "network_status": { "unstable_level": 0 }, "packet_loss_simulator": { "total_dropped_received_rtp": 0, "total_dropped_sent_rtp": 0 }, "rtp": { "total_generic_nack_cache_hit": 0, "total_generic_nack_cache_miss": 0, "total_pli_trigger": 0, "total_received": 1105, "total_received_byte_size": 845972, "total_received_rtcp": 20, "total_received_rtcp_bye": 0, "total_received_rtcp_byte_size": 1304, "total_received_rtcp_psfb_afb": 0, "total_received_rtcp_psfb_fir": 0, "total_received_rtcp_psfb_pli": 0, "total_received_rtcp_rr": 2, "total_received_rtcp_rtpfb_generic_nack": 0, "total_received_rtcp_rtpfb_tmmbn": 0, "total_received_rtcp_rtpfb_tmmbr": 0, "total_received_rtcp_rtpfb_transport_wide": 0, "total_received_rtcp_sdes": 18, "total_received_rtcp_sr": 18, "total_received_rtcp_unknown": 0, "total_received_rtcp_xr": 0, "total_received_rtp": 1085, "total_received_rtp_byte_size": 844668, "total_received_rtp_red": 0, "total_received_rtp_red_rtx": 0, "total_received_rtp_red_ulpfec": 0, "total_received_rtp_rtx": 0, "total_sent": 9, "total_sent_byte_size": 606, "total_sent_rtcp": 9, "total_sent_rtcp_bye": 0, "total_sent_rtcp_byte_size": 606, "total_sent_rtcp_psfb_afb": 8, "total_sent_rtcp_psfb_fir": 0, "total_sent_rtcp_psfb_pli": 0, "total_sent_rtcp_rr": 9, "total_sent_rtcp_rtpfb_generic_nack": 0, "total_sent_rtcp_rtpfb_tmmbn": 0, "total_sent_rtcp_rtpfb_tmmbr": 0, "total_sent_rtcp_rtpfb_transport_wide": 0, "total_sent_rtcp_sdes": 0, "total_sent_rtcp_sr": 0, "total_sent_rtcp_unknown": 0, "total_sent_rtcp_xr": 0, "total_sent_rtp": 0, "total_sent_rtp_byte_size": 0 }, "timestamp": "2020-06-09T05:42:40Z", "turn": { "total_received_allocate_request": 11, "total_received_binding_request": 0, "total_received_channel_bind_request": 1, "total_received_channel_data": 1113, "total_received_create_permission_request": 2, "total_received_expired_channel_number": 0, "total_received_refresh_request": 0, "total_received_send_indication": 7, "total_received_turn_binding_error": 0, "total_received_turn_binding_request": 7, "total_received_turn_binding_success": 6, "total_received_turn_invalid_stun": 0, "total_received_turn_unknown": 0, "total_received_turn_unknown_stun": 0, "total_received_unknown_channel_number": 0, "total_sent_allocate_error": 7, "total_sent_allocate_success": 2, "total_sent_binding_error": 0, "total_sent_binding_success": 0, "total_sent_channel_bind_error": 0, "total_sent_channel_bind_success": 1, "total_sent_channel_data": 19, "total_sent_create_permission_error": 0, "total_sent_create_permission_success": 2, "total_sent_data_indication": 5, "total_sent_refresh_error": 0, "total_sent_refresh_success": 0, "total_sent_turn_binding_error": 0, "total_sent_turn_binding_request": 6, "total_sent_turn_binding_success": 2, "total_sent_turn_unknown": 0 } } ``` ## 廃止プッシュ API ### PushUpstream > **危険** > > この API は廃止しました。 **廃止**: 2021 年 6 月リリースの Sora にて廃止 **代替 API**: Sora_20201120.PushChannelByRole **x-sora-target**: Sora_20160711.PushUpstream 指定したチャネルの配信クライアントにプッシュ通知を送ります。 * - キー - 型 * - channel_id - string * - data - object ```console $ curl -sS \ -X POST \ http://127.0.0.1:3000/ \ -H "x-sora-target: Sora_20160711.PushUpstream" \ --json '{"channel_id":"sora","data":{"spam":"egg"}}' \ | jq . { "data": { "spam": "egg" }, "type": "push" } ``` ### PushDownstream > **危険** > > この API は廃止しました。 **廃止**: 2021 年 6 月リリースの Sora にて廃止 **代替 API**: Sora_20201120.PushChannelByRole **x-sora-target**: Sora_20160711.PushDownstream 指定したチャネルの視聴クライアントにプッシュ通知を送ります。 * - キー - 型 * - channel_id - string * - data - object ``` $ curl -sS \ -X POST \ http://127.0.0.1:3000/ \ -H "x-sora-target: Sora_20160711.PushDownstream" \ --json '{"channel_id":"sora","data":{"spam":"egg"}}' \ | jq . { "data": { "spam": "egg" }, "type": "push" } ``` ## 廃止リモート統計情報 API ### 統計情報更新のタイミングについて この統計情報は、シグナリングで死活監視用の Pong メッセージに含まれてくるクライアント統計情報の最新の値を返します。 Ping メッセージは 5 秒間隔で Sora から送られるため、ネットワークが正常であれば Pong メッセージが返ってくるのは 5 秒間隔となります。 そのため、統計情報は 5 秒間隔で更新されます。 ### GetAllRemoteStats > **危険** > > この API は廃止しました。 **廃止**: 2022 年 6 月リリースの Sora にて廃止 **代替 API**: Sora_20211215.ListUserAgentStats **x-sora-target**: Sora_20200225.GetAllRemoteStats すべてのリモート統計情報を取得する。 ```console $ curl -sS \ -X POST \ http://127.0.0.1:3000/ \ -H "x-sora-target: Sora_20200225.GetAllRemoteStats" \ | jq . [ { "channel_id": "sora", "connection_id": "HMRVPQEXJX03D3B3WE778SJGRC", "remote_stats": [ { "audioLevel": 0, "id": "RTCAudioSource_1", "kind": "audio", "timestamp": 1586417492054.487, "totalAudioEnergy": 0, "totalSamplesDuration": 24.930000000001098, "trackIdentifier": "8de161d9-c93f-4c8a-ab0e-c4cb1ed45543", "type": "media-source" }, ... ], "timestamp": "2020-04-09T07:31:32.056Z" } ] ``` ### GetChannelRemoteStats > **危険** > > この API は廃止しました。 **廃止**: 2022 年 6 月リリースの Sora にて廃止 **代替 API**: Sora_20211215.ListChannelUserAgentStats **x-sora-target**: Sora_20200225.GetChannelRemoteStats 指定したチャネルのリモート統計情報を取得する。 * - キー - 型 * - channel_id - string ```console $ curl -sS \ -X POST \ http://127.0.0.1:3000/ \ -H "x-sora-target: Sora_20200225.GetChannelRemoteStats" \ --json '{"channel_id":"sora"}' \ | jq . [ { "channel_id": "sora", "connection_id": "HMRVPQEXJX03D3B3WE778SJGRC", "remote_stats": [ { "audioLevel": 0, "id": "RTCAudioSource_1", "kind": "audio", "timestamp": 1586417557067.526, "totalAudioEnergy": 0, "totalSamplesDuration": 89.95000000000911, "trackIdentifier": "8de161d9-c93f-4c8a-ab0e-c4cb1ed45543", "type": "media-source" }, ... ], "timestamp": "2020-04-09T07:32:37.069Z" } ] ``` ### GetConnectionRemoteStats > **危険** > > この API は廃止しました。 **廃止**: 2022 年 6 月リリースの Sora にて廃止 **代替 API**: Sora_20211215.GetUserAgentStats **x-sora-target**: Sora_20200225.GetConnectionRemoteStats 指定した接続のリモート統計情報を取得する。 * - キー - 型 * - channel_id - string * - connection_id - string ```console $ curl -sS \ -X POST \ http://127.0.0.1:3000/ \ -H "x-sora-target: Sora_20200225.GetConnectionRemoteStats" \ --json '{"channel_id":"sora","connection_id":"HMRVPQEXJX03D3B3WE778SJGRC"}' \ | jq . { "channel_id": "sora", "connection_id": "HMRVPQEXJX03D3B3WE778SJGRC", "stats": [ { "audioLevel": 0, "id": "RTCAudioSource_1", "kind": "audio", "timestamp": 1586417622080.464, "totalAudioEnergy": 0, "totalSamplesDuration": 154.96000000000404, "trackIdentifier": "8de161d9-c93f-4c8a-ab0e-c4cb1ed45543", "type": "media-source" }, ... ], "timestamp": "2020-04-09T07:33:42.081Z" } ``` ## 廃止スポットライト API ### CastSpotlight > **危険** > > この API は廃止しました。 **廃止**: 2021 年 12 月リリースの Sora にて廃止 **x-sora-target**: Sora_20180404.CastSpotlight 指定した参加者を強制的に画面に表示する。 * - キー - 型 * - channel_id - string * - connection_id - string ```console $ curl -sS \ -X POST \ http://127.0.0.1:3000/ \ -H "x-sora-target: Sora_20180404.CastSpotlight" \ --json '{"channel_id":"sora","connection_id":"KD9N57E2RN5T1BDEA7S7SH038M"}' \ | jq . { "channel_id": "sora", "connection_id": "KD9N57E2RN5T1BDEA7S7SH038M" } ``` ### CastAlwaysSpotlight > **危険** > > この API は廃止しました。 **廃止**: 2021 年 12 月リリースの Sora にて廃止 **x-sora-target**: Sora_20180404.CastAlwaysSpotlight 指定した参加者を常に画面に表示します。 * - キー - 型 * - channel_id - string * - connection_id - string * - spotlight_id (オプション) - string spotlight_id を指定しない場合はどこかのスポットライトに入ります。 ```console $ curl -sS \ -X POST \ http://127.0.0.1:3000/ \ -H "x-sora-target: Sora_20180404.CastAlwaysSpotlight" \ --json '{"channel_id":"sora","connection_id":"KD9N57E2RN5T1BDEA7S7SH038M","spotlight_id":"spotlight-1"}' \ | jq . { "channel_id": "sora", "connection_id": "KD9N57E2RN5T1BDEA7S7SH038M", "spotlight_id": "spotlight-1" } ``` ### CancelSpotlight > **危険** > > この API は廃止しました。 **廃止**: 2021 年 12 月リリースの Sora にて廃止 **x-sora-target**: Sora_20180404.CancelSpotlight 指定した参加者を常に画面に表示する状態を解除します。 * - キー - 型 * - channel_id - string * - connection_id - string ```console $ curl -sS \ -X POST \ http://127.0.0.1:3000/ \ -H "x-sora-target: Sora_20180404.CancelSpotlight" \ --json '{"channel_id":"sora","connection_id":"KD9N57E2RN5T1BDEA7S7SH038M"}' \ | jq . { "channel_id": "sora", "connection_id": "KD9N57E2RN5T1BDEA7S7SH038M" } ``` ### DowngradeSpotlightBitRate > **危険** > > この API は廃止しました。 **廃止**: 2021 年 12 月リリースの Sora にて廃止 **x-sora-target**: Sora_20181023.DowngradeSpotlightBitRate 指定したスポットライトチャネルのビットレートを下げる。 * - キー - 型 * - channel_id - string 現時点ではどの程度下げるかどうかは指定できません。 ``` $ curl -sS \ -X POST \ http://127.0.0.1:3000/ \ -H "x-sora-target: Sora_20181023.DowngradeSpotlightBitRate" \ --json '{"channel_id":"sora"}' \ | jq . ``` ### ResetSpotlightBitRate > **危険** > > この API は廃止しました。 **廃止**: 2021 年 12 月リリースの Sora にて廃止 **x-sora-target**: Sora_20181023.ResetSpotlightBitRate 指定したスポットライトチャネルのビットレートを戻します。 * - キー - 型 * - channel_id - string ``` $ curl -sS \ -X POST \ http://127.0.0.1:3000/ \ -H "x-sora-target: Sora_20181023.ResetSpotlightBitRate" \ --json '{"channel_id":"sora"}' \ | jq . { "channel_id": "sora", "connection_id": "DRPBMP6FEH49S5CSB04EDSTQ38", "quality": "low" } ``` ### RequestSpotlightQuality > **危険** > > この API は廃止しました。 **廃止**: 2020 年 12 月リリースの Sora にて廃止 **代替 API**: Sora_20201005.RequestRtpStream **x-sora-target**: Sora_20200807.RequestSpotlightQuality 指定した参加者の受信している映像ストリームのクオリティを変更します。 スポットライトのフォーカスとは別に、画質を受信ストリームすべて、またはストリームごと変更できます。 現時点では low か middle のみ指定できます。 * - キー - 型 * - channel_id - string * - connection_id - string * - stream_id (オプション) - string * - quality - string (low / middle / high) ```console $ curl -sS \ -X POST \ http://127.0.0.1:3000/ \ -H "x-sora-target: Sora_20200807.RequestSpotlightQuality" \ --json '{"channel_id":"sora","connection_id":"DRPBMP6FEH49S5CSB04EDSTQ38","quality":"low"}' \ | jq . { "channel_id": "sora", "connection_id": "DRPBMP6FEH49S5CSB04EDSTQ38", "quality": "low" } ``` ### ResetSpotlightQuality > **危険** > > この API は廃止しました。 **廃止**: 2020 年 12 月リリースの Sora にて廃止 **代替 API**: Sora_20201005.ResetRtpStream **x-sora-target**: Sora_20200807.ResetSpotlightQuality 指定した参加者の受信している映像ストリームのクオリティをリセットします。 RequestSpotlightQuality で変更された画質をリセットします。 * - キー - 型 * - channel_id - string * - connection_id - string * - stream_id (オプション) - string ```console $ curl -sS \ -X POST \ http://127.0.0.1:3000/ \ -H "x-sora-target: Sora_20200807.ResetSpotlightQuality" \ --json '{"channel_id":"sora","connection_id":"DRPBMP6FEH49S5CSB04EDSTQ38"}' \ | jq . { "channel_id": "sora", "connection_id": "DRPBMP6FEH49S5CSB04EDSTQ38" } ```