有奖捉虫:办公协同&微信生态&物联网文档专题 HOT

接口描述

描述:查询指定的网络研讨会嘉宾列表,支持通过会议 ID 或会议 Code 方式查询,只有网络研讨会的创建者才有权限查询。
请求方式:GET
接口请求域名
https://api.meeting.qq.com/v1/webinars/guests?meeting_id={meeting_id}&userid={userid}&instanceid={instanceid}

输入参数

HTTP 请求头公共参数请参见签名验证章节的 公共参数说明
参数名称
必选
参数类型
参数描述
meeting_id
String
网络研讨会唯一标识。meeting_id 和 meeting_code 二者必须送一个,二者都送时以 meeting_id 为准。
meeting_code
String
会议 App 的呼入号码。meeting_id 和 meeting_code 二者必须送一个,二者都送时以 meeting_id 为准。
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

输出参数

参数名称
参数类型
参数描述
guests
Guest 对象数组
网络研讨会嘉宾列表。

Guest 对象

参数名称
必选
参数类型
参数描述
guest_type
Integer
嘉宾类型:
1:内部嘉宾
2:外部嘉宾
3:链接嘉宾
userid
String
用户的唯一 ID(企业内部请使用企业唯一用户标识;OAuth2.0 鉴权用户请使用 openId)。内部嘉宾使用该字段,忽略其他字段。
area
String
国家/地区代码,外部嘉宾必填(例如:中国传86,不是+86)。
phone_number
String
手机号,外部嘉宾必填。通过嘉宾链接接入会的嘉宾无此字段。
guest_name
String
嘉宾名称,外部嘉宾必填(1~16位字符长度)。
email
String
邮箱,外部嘉宾选填。通过嘉宾链接接入会的嘉宾无此字段。

错误码列表

状态码
错误码
错误描述
500
9003
MEETING NOT EXIST。
400
190004
参数非法,请对照接口文档检查您的参数。
500
9042
无权限进行该操作,建议检查操作者身份或资源归属。
400
190001
存在未注册的用户。

示例

输入示例

GET
/v1/webinars/guests?userid=aaa&instanceid=1&meeting_id=7687691388848559125

输出示例

{
"guests":[
{
"guest_type":1,
"userid":"guest1"
},
{
"guest_type":2,
"area":"86",
"phone_number":"15900000001",
"guest_name":"cat",
"email":""
}
]
}