跳转到内容
本站为社区维护的非官方中文翻译,与 Cloudflare, Inc. 无关联。本站不提供账户登录,请勿在任何非官方站点输入您的 Cloudflare 账户信息。官方文档:developers.cloudflare.com

结束会话

最后更新 查看 MarkdownAgent 设置

要为所有参与者结束当前 会话(session),请使用 kickAll() 移除所有参与者。这将停止该会话的任何正在进行的录制,并将会话状态设置为 ENDED。

结束会话与离开会议不同。离开会议仅断开当前参与者的连接。如果其他参与者仍然存在,会话将保持活动状态。

步骤

  1. 检查本地参与者是否具有移除参与者的权限。

  2. 通过移除所有参与者来结束会话。

  3. 监听会话结束事件。

您还可以通过使用 移除所有参与者 API 移除所有参与者,从而从后端结束会话。

从后端结束会话

使用 API 移除所有参与者

使用 Kick all participants API 方法从会议的活动会话中移除所有参与者。

Required API token permissions

At least one of the following token permissions is required:
  • Realtime Admin
  • Realtime
Kick all participantsbash
curl "https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/realtime/kit/$APP_ID/meetings/$MEETING_ID/active-session/kick-all" \
	--request POST \
	--header "Authorization: Bearer $CLOUDFLARE_API_TOKEN"

使用 Webhook 监听会话结束事件

注册订阅了 meeting.ended 的 Webhook。RealtimeKit 会在会话结束时发送此事件。 您可以使用它来触发后端工作流,例如发送通知、生成报告或更新数据库中的会话记录。

Required API token permissions

At least one of the following token permissions is required:
  • Realtime Admin
  • Realtime
Add a webhookbash
curl "https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/realtime/kit/$APP_ID/webhooks" \
	--request POST \
	--header "Authorization: Bearer $CLOUDFLARE_API_TOKEN" \
	--json '{
		"name": "Session ended webhook",
		"url": "<YOUR_WEBHOOK_URL>",
		"events": [
				"meeting.ended"
		]
	}'

禁用会议

结束 session 不会禁用会议。参与者可以再次加入会议并启动新的 session。 要阻止参与者再次加入并启动新的 session,请使用更新会议 API 将会议状态设置为 INACTIVE。如果会议存在活动 session,RealtimeKit 还会从中移除所有参与者。

Required API token permissions

At least one of the following token permissions is required:
  • Realtime Admin
  • Realtime
Update a meetingbash
curl "https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/realtime/kit/$APP_ID/meetings/$MEETING_ID" \
	--request PATCH \
	--header "Authorization: Bearer $CLOUDFLARE_API_TOKEN" \
	--json '{
		"status": "INACTIVE"
	}'

后续步骤

  • 在 预设 中查看预设如何控制权限。
  • 查看本地参与者中本地参与者会议室状态的可能值。

这篇文档对您有帮助吗?