操作指南

开放平台文档

诚邀爱技术、爱分享的你,成为文档内容共建者> HOT

接口描述

  • 描述:快速创建或预定一个会议。
    • 企业 secret 鉴权用户可创建该用户所属企业下的会议,OAuth2.0 鉴权用户只能创建该企业下 OAuth2.0 应用的会议。
    • 用户必须是注册用户,请求头部 X-TC-Registered 字段必须传入为1。
    • 当您想实时监测会议创建状况时,您可以通过订阅 会议创建 的事件,接收事件通知。
    • 本接口的邀请参会成员限制调整至300人。
    • 当会议为周期性会议时,主持人密钥每场会议固定,但单场会议只能获取一次。支持创建周期性会议的主持人密钥。
  • 调用方式:POST
  • 接口请求域名:
    https://api.meeting.qq.com/v1/meetings

输入参数

以下请求参数列表仅列出了接口请求参数,HTTP 请求头公共参数请参见签名验证章节的 公共参数说明

参数名称 必选 参数类型 参数描述
userid String 调用方用于标示用户的唯一 ID(企业内部请使用企业唯一用户标识;OAuth2.0 鉴权用户请使用 openId)。
企业唯一用户标识说明:
1. 企业对接 SSO 时使用的员工唯一标识 ID;
2. 企业调用创建用户接口时传递的 userid 参数。
instanceid Integer 用户的终端设备类型:
0:PSTN
1:PC
2:Mac
3:Android
4:iOS
5:Web
6:iPad
7:Android Pad
8:小程序
9:voip、sip 设备
10:linux
20:Rooms for Touch Windows
21:Rooms for Touch MacOS
22:Rooms for Touch Android
30:Controller for Touch Windows
32:Controller for Touch Android
33:Controller for Touch iOS
创建会议时 userid 对应的设备类型,不影响入会时使用的设备类型,缺省可填1。
subject 是  String 会议主题。
type Integer 会议类型:
0:预约会议
1:快速会议 
hosts UserObj 数组 会议指定主持人的用户 ID,如果无指定,主持人将被设定为参数 userid 的用户,即 API 调用者。
注意:仅腾讯会议商业版和企业版可指定主持人。
invitees UserObj 数组 调用方用于标示用户的唯一 ID,仅支持邀请与会议创建者同企业的成员(企业内部请使用企业唯一用户标识;OAuth2.0 鉴权用户请使用 openId),该会议将添加至邀请成员的会议列表中。
企业唯一用户标识说明:
  • 企业对接 SSO 时使用的员工唯一标识 ID。
  • 企业调用创建用户接口时传递的 userid 参数。
    注意:仅腾讯会议商业版和企业版可邀请参会者,邀请者列表仅支持300人;需要邀请超过300人的场景请调用 设置会议邀请成员 接口。
  • start_time String 会议开始时间戳(单位秒)。
    end_time String 会议结束时间戳(单位秒)。
    password String 会议密码(4~6位数字),可不填。
    settings Object 会议媒体参数配置。
    meeting_type Integer 默认值为0。
    0:普通会议
    1:周期性会议(周期性会议时 type 不能为快速会议,同一账号同时最多可预定50场周期性会议)
    recurring_rule Object 周期性会议配置。
    enable_live Boolean 是否开启直播。
    live_config Object 直播配置。
    enable_doc_upload_permission Boolean 是否允许成员上传文档,默认为允许。
    guests Guest 数组 会议嘉宾列表,会议嘉宾不受会议密码和等候室的限制。
    注意:一天最多可设置嘉宾10次,且同一用户最多被设置为嘉宾10次。超出限制会议将不会出现在嘉宾会议列表中。
    media_set_type String 该参数仅提供给支持混合云的企业可见,默认值为0。
    0:外部会议
    1:内部会议
    enable_interpreter Boolean 同声传译开关,默认值为false。
    false:不开启
    true:开启同声传译
    enable_enroll Boolean 是否激活报名。
    enable_host_key Boolean 是否开启主持人密钥,默认为false。
    true:开启
    false:关闭
    host_key String 主持人密钥,仅支持6位数字。
    如开启主持人密钥后没有填写此项,将自动分配一个6位数字的密钥。
    sync_to_wework Boolean 会议是否同步至企业微信,该字段仅支持创建会议时设置,创建后无法修改。该配置仅支持与企业微信关联的企业。
    true:同步,默认同步
    false:不同步
    time_zone String 时区,可参见 Oracle-TimeZone 标准
    location String 会议地点。最长支持18个汉字或36个英文字母。
    注意:

    • userid 不能为1,为1时会发生不确定错误。
    • 会议主题参数为字符串类型,请求和回复消息体中都需要。


    用户对象 UserObj

    参数名称 必选 参数类型 参数描述
    userid String 用户 ID(企业内部请使用企业唯一用户标识;OAuth2.0 鉴权用户请使用 openId)。
    企业唯一用户标识说明:
    企业对接 SSO 时使用的员工唯一标识 ID,企业调用创建用户接口时传递的 userid 参数。
    is_anonymous Boolean 用户是否匿名入会,缺省为 false,不匿名。
    true:匿名
    false:不匿名
    nick_name String 用户匿名字符串。如果字段“is_anonymous”设置为“true”,但是无指定匿名字符串, 会议将分配缺省名称,例如 “会议用户xxxx”,其中“xxxx”为随机数字。

    会议媒体参数配置对象(Settings 参数)

    参数名称 必选 参数类型 参数描述
    mute_enable_type_join Integer 成员入会时静音选项,默认值为2。
    当同时传入“mute_enable_join”和“mute_enable_type_join”时,将以“mute_enable_type_join”的选项为准。
    0:关闭
    1:开启
    2:超过6人后自动开启
    mute_enable_join Boolean 入会时静音,默认值为 true。
    true:开启
    false:关闭
    allow_unmute_self Boolean 允许参会者取消静音,默认值为 true。
    true:开启
    false:关闭
    mute_all  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及以上版本生效。
  • 周期性会议 recurring_rule

    参数名称 必选 参数类型 参数描述
    recurring_type Integer 重复类型,默认值为0。
    0:每天
    1:每周一至周五
    2:每周
    3:每两周
    4:每月
    5:自定义,示例请参见 自定义周期规则 API 调用示例
    until_type Integer 结束重复类型,默认值为0。
    0:按日期结束重复
    1:按次数结束重复
    until_date Integer 结束日期时间戳。
    说明:结束日期与第一场会议的开始时间换算成的场次数不能超过以下限制:每天、每个工作日、每周最大支持200场子会议;每两周、每月最大支持50场子会议,例如:对于每天的重复类型,第一场会议开始时间为1609430400,则结束日期时间戳不能超过1609430400 + 200 × 24 × 60 × 60 - 1。如未填写,默认为当前日期往后推7天。
    until_count Integer 限定会议次数。
    说明:每天、每个工作日、每周最大支持200场子会议;每两周、每月最大支持50场子会议。如未填写,则默认为7次。
    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 调用示例

    直播配置 live_config

    参数名称 必选 参数类型 参数描述
    live_subject String 直播主题,开启之后。
    live_summary String 直播简介。
    enable_live_password Boolean 是否开启直播密码,默认值为 false。
    true:开启
    false:不开启
    live_password String 直播密码。当设置开启直播密码时,该参数必填。
    enable_live_im Boolean 允许观众讨论,默认值为 false。
    true:开启
    false:不开启
    enable_live_replay Boolean 开启直播回看,默认值为 false。
    true:开启
    false:不开启
    live_watermark Object 直播水印对象信息。

    直播水印信息 live_watermark_info

    参数名称 必选 参数类型 参数描述
    watermark_opt Integer 水印选项,默认为0。
    0:默认水印
    1:无水印


    会议嘉宾 Guest 对象

    参数名称 必选 参数类型 参数描述
    area String 国家/地区代码(例如:中国传86,不是+86,也不是0086)。
    phone_number String 手机号。
    guest_name String 嘉宾名称。

    输出参数

    参数名称 参数类型 参数描述
    meeting_number  Integer 会议数量。
    meeting_info_list  会议对象数组 预约会议列表。

    会议对象

    参数名称 参数类型 参数描述
    subject String 会议主题。
    meeting_id  String  会议的唯一标示。
    meeting_code String 会议 App 的呼入号码。
    password  String 会议密码。
    hosts String 数组  会议主持人的用户 ID,如果无指定,主持人将被设定为上文的 userid,即 API 调用者,仅商业版和企业版可指定主持人。
    participants String 数组   邀请的参会者用户 ID,仅商业版和企业版可邀请参会用户。
    user_non_registered String 数组 邀请的参会者中未注册用户。
    注意:仅腾讯会议商业版和企业版可获取该参数。
    start_time String 会议开始时间戳(单位秒),对于快速会议则为会议创建的时间。
    end_time String 会议结束时间戳(单位秒)。
    join_url String 加入会议 URL(单击链接直接加入会议)。
    settings 会议媒体参数对象  会议的配置,可为缺省配置。 
    enable_live Boolean 是否开启直播。
    live_config Object 直播配置对象,内部只返回 live_addr(直播观看地址)。
    host_key String 主持人密钥,仅支持6位数字。
    如开启主持人密钥后没有填写此项,将自动分配一个6位数字的密钥。

    示例

    输入示例

    POST https://api.meeting.qq.com/v1/meetings
    {
         "userid" : "tester",
         "instanceid" : 1,
         "subject" : "tester's meeting",
         "type" : 0,
         "hosts" : ["tester"],
         "invitees" : ["test1", "guest1", "guest2"],
         "start_time" : "1572172200",
         "end_time" : "1572175800",
         "password" : "1111",
         "enable_host_key":true,
         "host_key":"168168",
         "user_non_registered":["test1","test2"],
         "settings" : {
            "mute_enable_type_join":2,
            "allow_unmute_self":false,
            "mute_all": 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",
            "host_key":"168168",
            "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"
                }
        }
        ]
    }

    目录