平素よりSkyWayをご利用いただき、誠にありがとうございます。 この度、お客様サーバーから SkyWay の操作を行うための API である「 Channel API 」の後継として、「 Room API 」をリリースいたしました。
概要
これまでお客様サーバーから SkyWay を操作するための API である「 Channel API 」を提供してきましたが、多人数通信を実現するために SFU Bot（多人数通話用エージェント）を用いた複雑な実装が必要となる課題がありました。この度、SFU Bot についての管理や制御をシステム側にて実施し、お客様側での SFU Bot の考慮を不要とする「 Room API 」の提供を開始しました。
Room API のメリット
- Channel APIでは、多人数通信を実現するために SFU Bot という特殊なメンバーを Channel に参加させ、API のレスポンスから SFU Bot を判別して排除するなど、SFU Bot を考慮した複雑な処理が必要でした。Room APIでは SFU Bot についてシステム側で管理や制御を行うため、お客様側で SFU Bot の存在を考慮する必要がなくなり、シンプルな実装が可能になります。
- Webhook機能で通知されるイベントについては、Room APIでの利用に最適化された設計となっており、Roomに関するイベントをトリガーに、お客様のシステム側での柔軟な状態管理やログ記録を行うことができます。 詳細は、開発者ドキュメントにある「Webhook機能」の概要をご確認ください。
- Room API では、Channel APIには存在しなかった Room 管理に利用できる機能の追加 / 改善を行い、利便性の向上を図っています。
- メンバーの強制退出（removeMember）APIの追加: ルーム内の特定のメンバーを個別に退出させることが可能になりました。
- ルームの即時終了（closeRoom）APIの追加: 管理者の任意のタイミングでルームを終了できます。
- ルーム失効タイミング管理の改善 :
findRoomおよびfindOrCreateRoomのレスポンスに、ルームの有効期限を示すexpiresAtフィールドを追加しました。これにより、ルームのライフサイクル管理が容易になります。
ご利用方法
詳細については、開発者向けドキュメントから各ページをご確認ください。 Room API リファレンスはこちら
Channel APIの利用について
Room API のリリースをもって、Channel API につきましては非推奨 API とさせていただきます。 当面は Channel API の提供についても維持しますが、将来的には後継となる Room API への移行を予定しております。
新たに SkyWay をご利用いただく場合は Room APIをご利用ください。また、すでに Channel API をご利用中のお客様におかれましても、 Room API への移行をご検討ください。
Channel APIからRoom APIへの移行に関しては、移行をサポートする記事を用意しております。Channel APIからRoom APIへの移行の記事をご参照ください。
ご不明点がございましたら、こちら からお問い合わせください。