接口描述
描述:修改某指定会议的会议信息。企业 secret 鉴权用户可修改任何该企业该用户创建的有效会议,OAuth2.0 鉴权用户只能修改通过 OAuth2.0 鉴权创建的有效会议。支持企业管理员修改企业下会议。当您想实时监测会议修改状况时,您可以通过订阅 会议更新 的事件,接收事件通知。本接口的邀请参会成员限制调整至300人。当会议为周期性会议时,主持人密钥每场会议固定,但单场会议只能获取一次。支持修改周期性会议的主持人密钥。请求方式:PUT接口请求域名:
https://api.meeting.qq.com/v1/meetings/{meetingId}
输入参数
以下请求参数列表仅列出了接口请求参数,HTTP 请求头公共参数请参见签名验证章节的 公共参数说明。
meetingId |
是 |
String |
会议的唯一 ID。 |
userid |
是 |
String |
会议创建者或企业管理员 ID(企业内部请使用企业唯一用户标识;OAuth2.0 鉴权用户请使用 openId)。企业唯一用户标识说明:1:企业对接 SSO 时使用的员工唯一标识 ID。2:企业调用创建。 |
instanceid |
是 |
Integer |
用户的终端设备类型:0:PSTN1:PC2:Mac3:Android4:iOS5:Web6:iPad7:Android Pad8:小程序9:voip、sip 设备10:linux20:Rooms for Touch Windows21:Rooms for Touch MacOS22:Rooms for Touch Android30:Controller for Touch Windows32:Controller for Touch Android33:Controller for Touch iOS |
subject |
否 |
String |
会议主题。长度不能超过512个字节。 |
hosts |
否 |
User 对象数组 |
会议指定主持人的用户 ID,如果无指定,主持人将被设定为 userId;如果有指定,指定主持人列表需包含 userId(企业内部请使用企业唯一用户标识;OAuth2.0 鉴权用户请使用 openId)。如果不传入该字段,则不做修改;如果传入空列表,则该字段清空。注意:仅腾讯会议商业版和企业版可指定主持人。企业唯一用户标识说明:1:企业对接 SSO 时使用的员工唯一标识 ID。2:企业调用创建用户接口时传递的 userid 参数。 |
invitees |
否 |
User 对象数组 |
调用方用于标示用户的唯一 ID,仅支持邀请与会议创建者同企业的成员(企业内部请使用企业唯一用户标识;OAuth2.0 鉴权用户请使用 openId)。企业唯一用户标识说明:企业对接 SSO 时使用的员工唯一标识 ID。企业调用创建用户接口时传递的 userid 参数。注意:仅腾讯会议商业版和企业版可邀请参会者,邀请者列表仅支持300人;需要邀请超过300人的场景请调用 设置会议邀请成员 接口。 |
start_time |
否 |
String |
会议开始时间戳(单位秒)。需大于当前时间。 |
end_time |
否 |
String |
会议结束时间戳(单位秒)。需大于开始时间。 |
password |
否 |
String |
会议密码(4~6位数字),可不填。如果将字段值改为空字符串””,则表示取消会议密码。 |
settings |
否 |
Setting 对象 |
会议的配置,可为缺省配置。 |
meeting_type |
否 |
Integer |
默认值为0。 0:普通会议1:周期性会议 |
recurring_rule |
否 |
RecurringRule 对象 |
周期性会议配置,meeting_type 为1时必填。 |
enable_live |
否 |
Boolean |
是否开启直播,默认不开启。 |
live_config |
否 |
LiveConfig 对象 |
直播配置对象,enable_live 为 true 时才生效。 |
enable_doc_upload_permission |
否 |
Boolean |
是否允许成员上传文档,默认为允许。 |
guests |
否 |
Guest 对象数组 |
会议嘉宾列表,不传该字段代表不修改。注意:传空数组会清空嘉宾列表。一天最多可设置嘉宾10次,且同一用户最多被设置为嘉宾10次。超出限制会议将不会出现在嘉宾会议列表中。 |
media_set_type |
否 |
Integer |
该参数仅提供给支持混合云的企业可见,默认值为0。0:公网会议1:专网会议 |
enable_enroll |
否 |
Boolean |
是否激活报名。 |
enable_host_key |
否 |
Boolean |
是否开启主持人密钥。true:开启false:关闭修改周期性会议的主持人密钥适用于接下来的所有子会议。 |
host_key |
否 |
String |
主持人密钥,仅支持6位数字。如开启主持人密钥后没有填写此项,将自动分配一个6位数字的密钥。 |
time_zone |
否 |
String |
时区,可参见 Oracle-TimeZone 标准。 |
location |
否 |
String |
会议地点。最长支持36个汉字或英文字母。 |
User 对象
userid |
是 |
String |
用户 ID(企业内部请使用企业唯一用户标识;OAuth2.0 鉴权用户请使用 openId)。 企业唯一用户标识说明: 企业对接 SSO 时使用的员工唯一标识 ID,企业调用创建用户接口时传递的 userid 参数。 |
is_anonymous |
否 |
boolean |
用户是否匿名入会,缺省为 false,不匿名。true:匿名false:不匿名 |
nick_name |
否 |
String |
用户匿名字符串。如果字段“is_anonymous”设置为“true”,但是无指定匿名字符串, 会议将分配缺省名称,例如 “会议用户xxxx”,其中“xxxx”为随机数字。 |
Setting 对象
mute_enable_type_join |
否 |
Integer |
成员入会时静音选项。当同时传入“mute_enable_join”和“mute_enable_type_join”时,将以“mute_enable_type_join”的选项为准。0:关闭1:开启2:超过6人后自动开启 |
mute_enable_join |
否 |
boolean |
入会时静音。 |
allow_unmute_self |
否 |
boolean |
允许参会者取消静音(暂不支持)。 |
play_ivr_on_leave |
否 |
boolean |
参会者离开时播放提示音。 |
play_ivr_on_join |
否 |
boolean |
有新的与会者加入时播放提示音。 |
allow_in_before_host |
否 |
boolean |
是否允许成员在主持人进会前加入会议,默认值为 true。true:允许false:不允许 |
auto_in_waiting_room |
否 |
boolean |
是否开启等候室,默认值为 false。true:开启false:不开启 |
allow_screen_shared_watermark |
否 |
boolean |
是否开启屏幕共享水印,默认值为 false。true:开启false:不开启 |
water_mark_type |
否 |
Integer |
水印样式,默认为单排。0:单排1:多排 |
only_enterprise_user_allowed |
否 |
boolean |
是否仅企业内部成员可入会,默认值为 false。 true:仅企业内部用户可入会false:所有人可入会 |
auto_record_type |
否 |
String |
自动录制类型:none:禁用,代表不开启自动会议录制。local:本地录制,代表主持人入会后自动开启本地录制。cloud:云录制,代表主持人入会后自动开启云录制。说明:该参数依赖企业账户设置,当企业强制锁定后,该参数必须与企业配置保持一致。仅客户端2.7及以上版本可生效。 |
participant_join_auto_record |
否 |
boolean |
当有参会成员入会时立即开启云录制,默认值为 false 关闭,关闭时,主持人入会自动开启云录制;当设置为开启时,则有参会成员入会自动开启云录制。说明:该参数必须 auto_record_type 设置为“cloud”时才生效,该参数依赖企业账户设置,当企业强制锁定后,该参数必须与企业配置保持一致。仅客户端2.7及以上版本生效。 |
enable_host_pause_auto_record |
否 |
boolean |
允许主持人暂停或者停止云录制,默认值为 true 开启,开启时,主持人允许暂停和停止云录制;当设置为关闭时,则主持人不允许暂停和关闭云录制。说明:该参数必须将 auto_record_type 设置为“cloud”时才生效,该参数依赖企业账户设置,当企业强制锁定后,该参数必须与企业配置保持一致。仅客户端2.7及以上版本生效。 |
RecurringRule 对象
recurring_type |
否 |
Integer |
重复类型,默认值为0。0:每天1:每周一至周五2:每周3:每两周4:每月5:自定义,示例请参见 自定义周期规则 API 调用示例 |
until_type |
否 |
integer |
结束重复类型。0:按日期结束重复1:按次数结束重复 |
until_date |
否 |
integer |
结束日期时间戳,最大支持预定50场子会议。 |
until_count |
否 |
integer |
限定会议次数(1-50次)。 |
sub_meeting_id |
否 |
String |
子会议 ID,表示修改该子会议时间,不可与周期性会议规则同时修改。如不填写,默认修改整个周期性会议时间。 |
customized_recurring_type |
否 |
Integer |
自定义周期性会议的循环类型。0:按天。1:按周。2:按月,以周为粒度重复。例如:每3个月的第二周的周四。3:按月,以日期为粒度重复。例如:每3个月的16日。按周;按月、以周为粒度; 按月、以日期为粒度时,需要包含会议开始时间所在的日期。 |
customized_recurring_step |
否 |
Integer |
每[n](天、周、月)重复,使用自定义周期性会议时传入。例如:customized_recurring_type=0 && customized_recurring_step=5 表示每5天重复一次。customized_recurring_type=2 && customized_recurring_step=3 表示每3个月重复一次,重复的时间依赖于 customized_recurring_days 字段。 |
customized_recurring_days |
否 |
Integer |
哪些天重复。根据 customized_recurring_type 和 customized_recurring_step 的不同,该字段可取值与表达含义不同。如需选择多个日期,加和即可。customized_recurring_type = 0 时,传入该字段将被忽略。详细请参见 自定义周期规则 API 调用示例 |
LiveConfig 对象
live_subject |
否 |
String |
直播主题。长度最大128个字符。 |
live_summary |
否 |
String |
直播简介。长度最大400个字符。 |
enable_live_password |
否 |
boolean |
开启直播密码。true:开启false:不开启 |
live_password |
否 |
String |
直播密码。当设置开启直播密码时,该参数必填。4-6位数字。 |
enable_live_im |
否 |
boolean |
允许观众讨论。true:开启false:不开启 |
enable_live_replay |
否 |
boolean |
开启直播回看。true:开启false:不开启 |
live_watermark |
否 |
LiveWatermark 对象 |
直播水印对象信息。 |
LiveWatermark 对象
watermark_opt |
否 |
integer |
水印选项,默认为0。0:默认水印1:无水印 |
Guest 对象
area |
是 |
String |
国家/地区代码(例如:中国传86,不是+86,也不是0086)。 |
phone_number |
是 |
String |
手机号。 |
guest_name |
否 |
String |
嘉宾名称。 |
输出参数
meeting_number |
integer |
会议数量。 |
meeting_info_list |
MeetingInfo 对象数组 |
会议列表。 |
MeetingInfo 对象
meeting_id |
String |
会议 ID。 |
meeting_code |
String |
会议号码。 |
enable_live |
Boolean |
是否开启直播。 |
live_config |
LiveCfg 对象 |
直播配置对象,内部只返回 live_addr(直播观看地址)。 |
host_key |
String |
主持人密钥,仅支持6位数字。如开启主持人密钥后没有填写此项,将自动分配一个6位数字的密钥。 |
LiveCfg 对象
示例
输入示例
PUT https://api.meeting.qq.com/v1/meetings{ "userid" : "tester", "instanceid" : 1, "subject" : "tester's meeting", "hosts" : ["tester"], "invitees" : ["test1", "guest1", "guest2"], "start_time" : "1572172200", "end_time" : "1572175800", "password" : "1111", "enable_host_key":true, "user_non_registered":["test1","test2"], "settings" : { "mute_enable_type_join":2, "allow_unmute_self":false, "play_ivr_on_leave": false, "play_ivr_on_join": false, "allow_in_before_host":true, "auto_in_waiting_room":false, "allow_screen_shared_watermark":false, "only_enterprise_user_allowed":false }, "meeting_type":1, "recurring_rule":{ "recurring_type":0, "until_type":1, "until_count":7, "until_date":1600682957 }, "enable_live": true, "live_config": { "live_subject":"test_subject", "live_summary":"test_summary", "enable_live_password": true, "live_password":"1234", "enable_live_im": true, "enable_live_replay": true }}
输出示例
{ "meeting_number": 1, "meeting_info_list":[ { "subject": "tester's meeting", "meeting_id": "433471464134410364", "meeting_code": "637228110", "password": "1111", "start_time" : "1572172200", "end_time" : "1572175800", "hosts":["test1"], "participants":[], "join_url": "https://wemeet.qq.com/w/5oxCqAc", "settings":{ "mute_enable_type_join": 2 }, "enable_live":true, "live_config":{ "live_addr":"https://meeting.tencent.com/l/ehewFSfengBPae" }, "host_key":"415411" } ]}
对腾讯办公协同的解决方案有疑惑?想了解解决方案收费? 联系解决方案专家
腾讯云限时活动1折起,即将结束: 马上收藏
同尘科技为腾讯云授权服务中心,购买腾讯云享受折上折,更有现金返利:同意关联,立享优惠
阿里云解决方案也看看?: 点击对比阿里云的解决方案