请注意,本文编写于 1655 天前,最后修改于 1547 天前,其中某些信息可能已经过时。
Meeting
创建会议室
API:Create a Meeting
提示
此 API 的请求数量具有限制,每个授权用户在 24 小时内仅允许提交 100个创建会议的 API 请求。
POST /users/{userId}/meetings
{
# 基础信息
"topic": "string", # 会议主题
"type": "integer", # 会议类型。1:即时会议;2:预定会议;3:没有固定时间的周期会议;8:周期性会议。
"start_time": "string [date-time]", # 开始时间 字符串 yyyy-MM-ddTHH:mm:ss
"duration": "integer", # 持续时间,预定会议填写
"schedule_for": "string", # 替其他人安排会议
"timezone": "string", # 时区
"password": "string", # 会议密码
"agenda": "string", # 会议说明
# 会议重复周期控制:一般不使用,仅在 type = 8,即周期性会议时需设置
"recurrence": {
"type": "integer", # 1:日;2:周;3:月。
"repeat_interval": "integer", # 间隔周期:例如:每两个月 1 次,设置 type : 3,此值为 2。当重复周期为日时,此值最大为 90; 为周时,最大值为 12;为月时,最大值为 3。
"weekly_days": "string", # type = 2 时设置,1 - 7 : 周日 - 周六
"monthly_day": "integer", # type = 3 时设置,1 - 31 :每月几号
"monthly_week": "integer", # type = 3 时设置,需与 monthly_week_day 联用,此字段设置会议在每月的发生周。-1:每月的最后一周;1:每月的第一周;2:每月的第二周;3:每月的第三周;4:每月的第四周。
"monthly_week_day": "integer", # type = 3 时设置,需与 monthly_week 联用,此字段设置会议在每周的发生日。1 - 7 : 周日 - 周六
"end_times": "integer", # 选择取消会议之前会议应重复多少次。不能与 end_date_time 同时使用。
"end_date_time": "string [date-time]" # 选择取消会议之前会议将再次发生的最终日期。UTC 时间的字符串格式,例:2017-11-25T12:00:00Z。不能与 end_times 同时使用。
},
# 会议设置控制
"settings": {
"host_video": "boolean", # 主持人加入会议时,是否打开视频
"participant_video": "boolean", # 参会者加入会议时,是否打开视频
"cn_meeting": "boolean", # 中国会议
"in_meeting": "boolean", # 印度会议
"join_before_host": "boolean", # 在主持人开始会议前,允许参会者加入。仅用于预定或定期会议
"mute_upon_entry": "boolean", # 加入时静音
"watermark": "boolean", # 在共享屏幕时添加水印,
"use_pmi": "boolean", # 使用个人会议ID代替会议ID。只能用于无固定时间的预约会议,即使会议,和定期会议
"approval_type": "integer", # 0:自动批准;1:手动批准;2:无需注册。
"registration_type": "integer", # 注册类型,默认:1。1:参会者注册一次即可参加任何时间;2:参会者需每次注册;3 参会者注册一次可选择一个或多个事件参加。仅用于固定时间的周期会议。
"audio": "string", # 音频。both:电话和网络;telephony:电话;voip:网络。
"auto_recording": "string", # 自动录制。 local:在本地记录;cloud:记录在云上;none:禁用。
"enforce_login": "boolean", # 只有登陆的用户可以加入会议
"enforce_login_domains": "string", # 只有指定域的用户可以加入会议
"alternative_hosts": "string", # 其他主持人,多个值,英文逗号分隔
"global_dial_in_countries": [ # 全球拨入的国家列表
"string"
],
"registrants_email_notification": "boolean" # 向注册人发送有关批准,例如:取消会议通知
}
}
{
列出会议注册用户
API:List Meeting Registrants
描述
当主持人或具有管理员权限的用户设置"必须注册才能参与会议"时,使用此 API 可以获取已提交注册申请的用户列表。
GET /meetings/{meetingId}/registrants
{
"meetingId": "integer", # 会议ID,长度可能会超过10位数,数据类型应为"long",JSON:"Int64"
}
Query
{
"occurrence_id": , # 会议发生ID,暂未测试,不清楚是什么,可能是 Meeting 的 uuid
"status": approved, # pending:等待批准的用户;approved:已批准的用户;denied:拒绝的用户。
"page_size": 30, # 返回条数。
"page_number": 1, # 当前已获取到的数据位于查询数据中的页码。官方已不推荐使用,将被 next_page_token 替代。
"next_page_token": , # 下一页标记。用于对大型结果集进行分页。每当可用结果集超过当前页面大小时,将返回下一页标记。该 token 有效期为15分钟。
}
更新会议注册用户状态
API:Update Meeting Registrant Status
描述
修改会议中已提交注册用户的状态为:批准注册,拒绝注册,取消注册。
PUT /meetings/{meetingId}/registrants/status
{
"action": "string", # approve: 批准用户的注册,cancel: 取消已批准用户的已注册状态,deny: 拒绝用户注册
"registrants": [
{
"id": "string", # 使用 List Meeting Registrants 查询
"email": "string" # 用户邮箱
},
{
"id": "string",
"email": "string"
},
...
]
}
兄弟挂友链不,刚
可以啊,已挂。
请教楼主,是否了解,如何控制单场zoom会议的参会者是否有观看的权限?
观看权限?是否允许一个人参会某场会议吗?如果是的话,可以看看 Meeting Registrant 的相关字段。Meeting Registrant 有 List Meeting Registrants 获取会议注册的用户,Update Meeting Registrant:更新注册用户的状态:approve(允许注册),cancel(取消注册人的已注册状态),deny(拒绝注册)。这个字段,从zoom的介绍上来说,再配合 Meeting 的必须注册参能参会,似乎能够控制单场会议的参会人是否能够参会,还未测试过。
registrant应该是只能针对recurring meeting设置,其他类型会议(比如scheduled meeting)好像没法做权限校验
是否是看到了 Create a Meeting 中的 registration_type 字段?然后理解为只有固定时间的周期会议才能做注册用户的权限校验?我的理解应该是这样:Update Meeting Registrant Status 这个 API 是针对所有启用了"必须注册才能参会"的会议使用的。而 registration_type 是在"必须注册才能参会"的基础上, 对具有固定时间的周期性会议的提供了更多的选项。如果设置为 2 ,每次参加会议都需要重新注册,可以适当的提高会议安全等级,相当于给管理者一个更多的选项。当然具体的还是得测试的,只不过近期应该都没有时间测试。
我做了测试,已经没有问题了,需要通过Update Meeting Registrant Status将注册的会议参会者approve以后才能正常进入会议,不然用户单纯注册以后是无法进入会议的。多谢楼主提醒,超赞
你说的那个是预约会议,定期会议,这个字段是控制会议时间的,理论上不会影响用户能否进入。至于 Meeting Registrant 是强制更新已注册用户的状态,并且主持人/管理员必须启用了必须注册才能加入会议才会生效。目前我的理解是这样的:你发出邀请函给10个同事参会三天后的一个会议,这个会议启用了"必须注册才能参会",并且设置的是"自动批准用户的注册",但是在第二天的时候,检查会议的注册用户时发现了12个人,其中有两个人使用的邮箱并不是公司邮箱,这时候可以强制更新非公司邮箱注册的2个用户的这个字段来决绝这2个人参会。但是现在不清楚的是,如果会议已经在进行中了,不该参与的用户已经参会了,如果这个时候更改用户的注册状态为拒绝,是否可以强制让用户登出。
楼主,你好,你也在用 zoom v2版本的 api 吗?新版本的加入会议必须要支持人准入操作,approval_type 这个参数设置了为0 ,但不起作用,你有遇到过这个问题吗?在线等。
恩。最近在用。不清楚你说的支持人准入操作是在哪?我这边目前只用了meetings相关的基础操作。创建会议室后,没有出现无法加入的问题。