本指南介绍了如何使用 Google Meet REST API 为 Google Meet 创建和管理会议。
会议空间代表 一个虚拟场所或持久性对象(例如会议室),会议在此举行。在任何给定时间,一个空间中只能有一场正在进行的会议。会议空间还有助于用户会面和查找共享资源。
如需使用会议空间,请参阅创建和管理 会议空间。如需了解如何以 编程方式配置会议空间,请参阅配置会议空间和 成员。
如何调用会议空间方法
下表详细介绍了使用会议空间方法所需的会议角色:
| 方法 | 所有者 | 参与者 | 其他 |
|---|---|---|---|
endActiveConference |
x | ||
get |
x | x | x |
| 通过“设置” | x | ||
| 通过正在进行的会议 | x | x | |
patch |
x |
Meet 如何识别会议空间
Google Meet REST API 会为每个
会议空间生成一个
spaces资源。spaces 资源提供多个加入会议的入口点。
下表展示了如何识别和加入会议空间:
| 字段名称 | 说明 |
|---|---|
name |
空间的名称。{space} 字符串是空间的资源标识符,格式为 spaces/{space}。它是由服务器生成的唯一 ID,区分大小写。例如,
spaces/jQCFfuBOdN5z。 |
meetingCode |
空间名称的别名。{meetingCode} 是可输入的唯一字符串,不区分大小写。其格式为
spaces/{meetingCode}。例如,
spaces/abc-mnop-xyz。最长为 128 个字符。
它是 meetingUri:
https://meet.google.com/abc-mnop-xyz 的一部分。 |
phoneAccess |
此会议空间的电话访问方法。phoneAccess 对象包含拨入会议所需的信息,包括会议空间的区域电话号码以及特定于该电话号码的 PIN 码。PIN 码仅包含十进制数字,长度可能会有所不同。例如,"pin": 19707127300。与 Meet 界面类似, spaces 资源包含一组有限的拨入号码。您可以通过将 {meetingCode} 附加到以下网址来查看会议空间的更多电话号码:https://meet.google.com/tel/。例如,https://meet.google.com/tel/abc-mnop-xyz。
|
gatewaySipAccess |
此会议空间的会话发起协议 (SIP) 访问方法。SIP 地址详细说明了第三方视频会议硬件如何查找和加入 Meet 会议。gatewaySipAccess 对象包含 URI 和数字访问代码。Meet 支持 SIP URI scheme。 |
如需管理会议空间,请为
name 字段使用以下值:
如需获取有关会议空间的详细信息,您可以使用
spaces/{space}或别名spaces/{meetingCode}。如需了解详情,请参阅获取会议 空间。如需更新会议空间的详细信息,您只能使用
spaces/{space}。 如需了解详情,请参阅更新会议 空间。如需结束会议空间中正在进行的会议,您只能使用
spaces/{space}。如需了解详情,请参阅结束正在进行的 会议。
会议空间的生命周期
会议空间在其生命周期中会经历多种状态。下图展示了会议空间生命周期的高级别步骤:
调用
spaces.create。 会议空间已创建,返回的spaces对象包含meetingUri字符串。然后,meetingUri会分发给参与者。轮询新的会议空间 。调用
spaces.get方法以 检查会议状态。除了轮询之外,您还可以订阅 Meet 事件 以接收推送 通知。
开始会议 。当第一位参与者点击会议空间内的
meetingUri时,会议开始。activeConference对象 已填充,并且activeConference.conferenceRecord字符串已设置。(可选)获取会议数据 。在会议进行期间,您可以访问一些
conferenceRecord值。例如,调用conferenceRecords.participants.list方法以查看会议中的所有参与者。您还可以在会议结束后最多 30 天内访问此信息。(可选)结束会议 。在会议期间,会议所有者 可以调用
spaces.endActiveConference方法,以编程方式为所有参与者结束正在进行的会议。会议结束 。当最后一位参与者离开时,会议结束。
轮询会议后制品 。会议已结束 (
STATE=ENDED),但制品尚未生成。会议的startTime和endTime也已填充。您必须轮询制品端点,直到制品对象STATE显示FILE_GENERATED。除了轮询之外,您还可以订阅 Meet 事件以接收推送通知。
获取会议后制品 。生成录制内容和文字记录等制品后,您可以检索这些制品。例如,调用
conferenceRecords.recordings.get方法以按录制内容 ID 获取录制内容。准备就绪后,系统会填充制品对象的 URI,并将其作为资源对象的一部分返回。