腾讯会议查询会议_办公协同解决方案

腾讯会议

9 月 15, 2023

133 0

通过会议 ID 查询

接口描述

描述：通过会议 ID 查询会议详情。企业 secret 鉴权用户可查询到任何该用户创建的企业下的会议，OAuth2.0 鉴权用户只能查询到通过 OAuth2.0 鉴权创建的会议。支持企业管理员查询企业下的会议。本接口的邀请参会成员限制调整至300人。当会议为周期性会议时，主持人密钥每场会议固定，但单场会议只能获取一次。支持查询周期性会议的主持人密钥。支持查询 MRA 当前所在会议信息。请求方式：GET接口请求域名：

https://api.meeting.qq.com/v1/meetings/{meetingId}?userid={userid}&instanceid={instanceid}

输入参数

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

参数名称	必选	参数类型	参数描述
meetingId	是	String	有效的会议 ID。
operator_id	否	String	操作者 ID。operator_id 必须与 operator_id_type 配合使用。根据 operator_id_type 的值，operator_id 代表不同类型。说明：userid 字段和 operator_id 字段二者必填一项。若两者都填，以 operator_id 字段为准。
operator_id_type	否	Integer	操作者 ID 的类型：3：rooms_id说明：当前仅支持 rooms_id。如操作者为企业内 userid 或 openId，请使用 userid 字段。
userid	否	String	调用方用于标示用户的唯一 ID（企业内部请使用企业唯一用户标识；OAuth2.0 鉴权用户请使用 openId）。企业唯一用户标识说明：1：企业对接 SSO 时使用的员工唯一标识 ID。2：企业调用创建用户接口时传递的 userid 参数。
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

输出参数

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

MeetingInfo 对象

参数名称	参数类型	参数描述
subject	String	会议主题。
meeting_id	String	会议的唯一标识。
meeting_code	String	会议 App 的呼入号码。
password	String	会议密码。
need_password	Boolean	非会议创建者是否需要密码入会。非会议创建者查询会议，且存在会议密码，则字段为 true；其他情况，字段不返回。
status	String	当前会议状态：1. MEETING_STATE_INVALID：非法或未知的会议状态，错误状态。2. MEETING_STATE_INIT：会议待开始。会议预定到预定结束时间前，会议尚无人进会。3. MEETING_STATE_CANCELLED：会议已取消。主持人主动取消会议，待开始的会议才能取消，且取消的会议无法再进入。4. MEETING_STATE_STARTED：会议已开始。会议中有人则表示会议进行中。5. MEETING_STATE_ENDED：会议已删除。会议已过预定结束时间且尚无人进会时，主持人删除会议，已删除的会议无法再进入。6. MEETING_STATE_NULL：会议无状态。会议已过预定结束时间，会议尚无人进会。7. MEETING_STATE_RECYCLED：会议已回收。会议已过预定开始时间30天，则会议号将被后台回收，无法再进入。
type	Integer	会议类型：0：预约会议类型1：快速会议类型
join_url	String	加入会议 URL。
hosts	User 对象数组	指定主持人列表，仅商业版和企业版可指定主持人。
current_hosts	User 对象数组	会议当前主持人列表。
current_co_hosts	User 对象数组	联席主持人列表。
participants	User 对象数组	邀请的参会者，仅商业版和企业版可邀请参会用户，且只有会议创建者、邀请列表中的成员以及在会议中的成员才可以查询该字段，最多返回200个邀请者；需要查询超过200人的会议邀请者请调用获取会议受邀成员列表接口。
start_time	String	会议开始时间戳（单位秒）。
end_time	String	会议结束时间戳（单位秒）。
settings	Setting 对象	会议的配置，可为缺省配置。
meeting_type	Integer	会议类型。 0：一次性会议1：周期性会议2：微信专属会议3：Rooms 投屏会议5：个人会议号会议6：网络研讨会
recurring_rule	RecurringRule 对象	周期性会议设置。
sub_meetings	SubMeeting 对象数组	周期性子会议列表。
has_more_sub_meeting	Integer	0：无更多子会议特例 1：有更多子会议特例
remain_sub_meetings	Integer	剩余子会议场数。
current_sub_meeting_id	String	当前子会议 ID（进行中或即将开始）。
enable_live	Boolean	是否开启直播（会议创建人才有权限查询）。true：开启false：关闭
live_config	LiveConfig 对象	会议的直播配置（会议创建人才有权限查询）。
enable_doc_upload_permission	Boolean	是否允许成员上传文档，默认为允许。
guests	Guest 对象数组	会议嘉宾列表（会议创建人才有权限查询）。
has_vote	Boolean	是否有投票（会议创建人和主持人才有权限查询）。
enable_enroll	Boolean	是否激活报名。
enable_host_key	Boolean	是否开启主持人密钥。true：开启false：关闭
host_key	String	主持人密钥，仅支持6位数字（会议创建人才有权限查询）。如开启主持人密钥后没有填写此项，将自动分配一个6位数字的密钥。
sync_to_wework	Boolean	会议是否同步至企业微信，该字段仅支持创建会议时设置，创建后无法修改。该配置仅支持与企业微信关联的企业。 true：同步，默认同步false：不同步
time_zone	String	时区，可参见 Oracle-TimeZone 标准。
location	String	会议地点。最长支持18个汉字或36个英文字母。

User 对象

参数名称	参数类型	参数描述
userid	String	调用方用于标示用户的唯一 ID（企业内部请使用企业唯一用户标识；OAuth2.0 鉴权用户请使用 openId）。企业唯一用户标识说明：1：企业对接 SSO 时使用的员工唯一标识 ID。2：企业调用创建用户接口时传递的 userid 参数。

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	加入静音状态，默认值为true。true：开启false：关闭
allow_unmute_self	Boolean	是否允许参会者取消静音，默认值为true。true：开启false：关闭
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_allow_enterprise_user_join	Boolean	是否仅企业内部成员可入会。 true：仅企业内部用户可入会false：所有人可入会
auto_record_type	String	自动录制类型，仅客户端2.7及以上版本生效。none：禁用local：本地录制 cloud：云录制
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及以上版本生效。

SubMeeting 对象

参数名称	参数类型	参数描述
sub_meeting_id	String	子会议 ID。
status	Integer	子会议状态。0：默认存在1：已删除
start_time	String	子会议开始时间（UTC 秒）。
end_time	String	子会议结束时间（UTC 秒）。

RecurringRule 对象

参数名称	必选	参数类型	参数描述
recurring_type	否	Integer	重复类型，默认值为0。0：每天1：每周一至周五2：每周3：每两周4：每月5：自定义，示例请参见自定义周期规则 API 调用示例
until_type	否	Integer	结束重复类型，默认值为0。0：按日期结束重复1：按次数结束重复
until_date	否	Integer	结束日期时间戳，默认值为当前日期 + 7天。
until_count	否	Integer	限定会议次数（1-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 调用示例

LiveConfig 对象

参数名称	参数类型	参数描述
live_subject	String	直播主题。
live_summary	String	直播简介。
live_password	String	直播密码。
enable_live_im	Boolean	是否允许观众讨论，默认值为 false。true：开启false：不开启
enable_live_replay	Boolean	是否开启直播回看，默认值为 false。true：开启false：不开启
live_addr	String	直播观看地址。
live_watermark	LiveWatermark 对象	直播水印对象信息。

LiveWatermark 对象

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

Guest 对象

参数名称	参数类型	参数描述
area	String	国家/地区代码（例如：中国传86，不是+86，也不是0086）。
phone_number	String	手机号。
guest_name	String	嘉宾名称。

代码示例

输入示例

GET https://api.meeting.qq.com/v1/meetings/7567173273889276131?userid=tester1&instanceid=1

输出示例（普通会议）

{   "meeting_number": 1,   "meeting_info_list": [     {       "subject": "tester's meeting",       "meeting_id": "7567173273889276131",       "meeting_code": "806146667",       "password": "1111",       "status": "MEETING_STATE_ENDED",       "start_time": "1572085800",       "end_time": "1572089400",       "type": 1,       "hosts": [       {          "userid": "tester"        }      ],      "participants": [          {          "userid": "tester"        }       ],      "join_url": "https://wemeet.qq.com/w/5NmV29k",      "meeting_type": 0,       "settings": {         "mute_enable_type_join": 2,         "allow_unmute_self": false,        "play_ivr_on_leave": false,        "allow_in_before_host": true,        "auto_in_waiting_room": false,        "allow_screen_shared_watermark": true,        "only_allow_enterprise_user_join": false       },       "enable_live":true,        "live_config":{            "live_subject":"test",            "live_summary":"test",            "live_password":"654321",            "enable_live_im":true,            "enable_live_replay":true,            "live_addr":"https://meeting.tencent.com/l/xxxx",            "live_watermark":{              "watermark_opt":0            }       },       "guests":[          {                "area":"86",                "phone_number":"xxxxxxxxx",                "guest_name":"xxxx"          }        ],        "enable_host_key":true,        "host_key":"191810"      }     ] }

输出示例（周期性会议）

{  "meeting_number": 1,  "meeting_info_list": [    {      "subject": "tester's meeting",      "meeting_id": "18357763596888459343",      "meeting_code": "31380342405",      "status": "MEETING_STATE_INIT",      "start_time": "1599622242",      "end_time": "1599625842",      "hosts": [        {          "userid": "tester"        }      ],      "join_url": "https://meeting.tencent.com/s/iY4GQ2HkQQGL",      "settings": {        "mute_enable_type_join": 2,        "allow_unmute_self": false,        "allow_in_before_host": true,        "auto_in_waiting_room": true,        "allow_screen_shared_watermark": true,        "only_enterprise_user_allowed": false      },      "sub_meetings": [      {          "sub_meeting_id": "1599622242",          "status": 0,          "start_time": 1599622242,          "end_time": 1599625842      },      {          "sub_meeting_id": "1599708642",          "status": 0,          "start_time": 1599708642,          "end_time": 1599712242      },      {          "sub_meeting_id": "1599795042",          "status": 0,          "start_time": 1599795042,          "end_time": 1599798642      },      {          "sub_meeting_id": "1599881442",          "status": 0,          "start_time": 1599881442,          "end_time": 1599885042      },      {          "sub_meeting_id": "1599967842",          "status": 0,          "start_time": 1599967842,          "end_time": 1599971442      }    ],    "recurring_rule": {      "recurring_type": 0,      "until_type": 1,      "until_count": 7    },    "meeting_type": 1,    "has_more_sub_meetings": 0,    "remain_sub_meetings": 5,    "current_sub_meeting_id": "1599622242",    "enable_live":true,    "live_config":{          "live_subject":"test",          "live_summary":"test",           "live_password":"654321",          "enable_live_im":true,          "enable_live_replay":true,          "live_addr":"https://meeting.tencent.com/l/xxxx"      },      "enable_host_key":true,      "host_key":"191810"    }  ]}

通过会议 Code 查询