質問・問題
Restful API で入室・配信制限を設定する際のベストプラクティスを教えてください
回答・解決方法
Video/Voice SDK のユーザーを制御する手段として、チャンネル管理用 Restful API から「ルール」を設定する方法がございます。
各ルールでは、一定時間、対象のユーザーに対して以下の操作を禁止するよう設定することができます:
- チャンネルへの接続 (join_channel)
- 映像の配信 (publish_video)
- 音声の配信 (publish_audio)
ルール設定・管理について
チャンネル管理用 Restful API は、次の操作をサポートしています。 書式・パラメーター含む設定の詳細は、各項目のリンクからご覧ください:
- ルールの作成 (Creates a rule)
- ルール一覧の取得 (Gets the rule list)
- ルールの更新 (Updates a rule)
- ルールの削除 (Deletes a rule)
ルール追加に関するベストプラクティス
ルール追加のベストプラクティスとして、以下の手順をご参考ください:
- ルール作成 (Creates a rule) API が返すレスポンス値の "id" は、貴社サービス側で保持・管理してください。
- ルール作成 (Creates a rule) のリクエストには 20 秒以上のタイムアウトを設定してください。 Agora 社では、5 秒未満のタイムアウトに設定しないことを強く推奨します。
- ルール作成 (Creates a rule) リクエストがタイムアウトとなった、またはステータスコード 504 がレスポンスとして返された、等、実行結果の取得に失敗した場合は、制限ルール取得 (Get rule list) API から現在の有効ルール一覧を取得してください。対象のルールが一覧に含まれている場合、ルール作成 (Creates a rule) リクエストが成功した事を意味します。対象ルールの "id" は、貴社サービス側で保持・管理してください。
尚、Restful API はクライアントサイドからの呼び出しには対応しておりません。詳しくは以下の記事をご覧ください:
また、入室制限中であることを他のユーザーに知らせる方法については以下のFAQを参照ください。