ユーザーが RealtimeKit SDK 経由でミーティングに参加する前に、バックエンドは Add Participant API を使って、そのユーザーをミーティングの参加者として追加する必要があります。 RealtimeKit では、参加者(participant)は、特定のミーティングへの参加を許可されたユーザーを指します。
教室に生徒を登録するイメージです。ミーティングが教室で、参加者の追加は、ユーザーが出席できるよう登録する操作です。
参加者を追加するときは、適用する Preset も選びます。Preset は、その参加者のロール、権限、ミーティング体験を定義します。
Add Participant API エンドポイントで参加者をミーティングに追加すると、次が返ります。
- ミーティング内でこの参加者を識別する参加者
id - その参加者用の認証
token
バックエンドは、これらをフロントエンドアプリケーションから使えるようにします。ユーザーがミーティングへの参加を選ぶと、フロントエンドはトークンを RealtimeKit SDK に渡します。
RealtimeKit はトークンで参加者を認証し、どのミーティングのどの参加者が入るかを判断します。有効な認証トークンがなければ、SDK はその参加者としてミーティングに参加できません。参加者が有効な認証トークンを持っている限り、同じミーティングの複数のライブセッションに、時間をまたいで参加できます。
参加者の認証トークンは JSON Web Token(JWT)です。meetingId と participantId フィールドが、各トークンを 1 つのミーティング内の 1 人の参加者に限定します。
トークンは発行時点から有効になり、100 日後に期限切れになります。開始日や有効期限をカスタム設定することはできません。スケジュールされたアクセスが必要な場合は、自前のシステムでスケジュールを制御してください。RealtimeKit SDK は、スケジュールや時間制限のロジックを管理しません。
バックエンドは、トークンの期限切れの前後に Refresh Participant Token エンドポイントを呼び出せます。新しいトークンは、既存の参加者レコード(参加者 id と Preset を含む)を使います。更新しても、以前発行したトークンは無効になりません。各トークンは、それぞれの有効期限まで有効です。
ミーティング内のある参加者のトークンをすべて取り消すには、Delete Participant エンドポイントを呼び出します。先に Kick Participants エンドポイントを使い、アクティブなセッションから参加者を安全に退出させてください。
期限切れまたは取り消されたトークンでは、参加者はミーティングに参加できません。RealtimeKit の UI と Core SDK は、トークンを無効と報告します。RealtimeKit は、参加者が ミーティングステージ に入る前に拒否するため、課金されません。
参加者を追加するとき、任意でカスタム参加者識別子(custom_participant_id)を渡せます。この値は、利用側のためのものです。
RealtimeKit は保存して API で返しますが、アクセス制御には使いません。アプリケーションのユーザーを RealtimeKit の参加者に対応づけ、RealtimeKit のセッションデータ、イベント、分析を、自システムのユーザー情報と突き合わせるために使えます。
参加者を理解したら、次のトピックを確認できます。
- Preset が参加者のロールと権限をどう定義するかを学ぶ
- RealtimeKit SDK を始める