接口描述
描述:
使用该接口,可用 customer_data 进行区分,为一场会议生成多个会议链接。通过用户入会等事件,或通过获取参会成员列表的 API 查询到该参数。
参会者腾讯会议客户端版本需大于等于3.2.0。
暂不支持 OAuth 2.0鉴权方式访问。
请求方式:POST
接口请求域名:
https://api.meeting.qq.com/v1/webinars/customer-short-url
输入参数
请求体
参数名称 | 必选 | 参数类型 | 示例值 | 参数描述 |
meeting_id | 是 | String | 418***688 | 会议的唯一 ID。 |
is_webinar_guest | 是 | Uint32 | 1 | 1:嘉宾;则通过链接入会的用户视为嘉宾。 2:观众,则通过链接入会的用户视为观众,不传默认为2。 |
customer_data | 是 | String | eyJ2ZXIiOiAiMS4wIiwgInVzZXJEYXRhIjoiY2h1eGlhb2h1b2RvbmcxMDAxIn0= | 用户专属字段,长度不超过256字节。customer_data 需以 {"ver": "1.0", "userData":"自定义字段"} 的结构,进行 Base64编码。 |
is_join_meeting | 是 | Integer | 1 | 1:打开链接立即入会。 2:打开链接会进入嘉宾邀请页面或会议详情页(会议开启报名该参数失效)。 |
operator_id | 是 | String | meeting****001 | 操作者 ID。 operator_id 必须与 operator_id_type 配合使用。根据 operator_id_type 的值,operator_id 代表不同类型。 |
operator_id_type | 是 | Integer | 1 | 操作者 ID 的类型: 1:userid |
instanceid | 是 | Integer | 1 | 用户的终端设备类型: 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 81:HarmonyOS Phone 82:HarmonyOS Tablet 83:HarmonyOS PC 84:HarmonyOS Intelligent Cockpit 86:HarmonyOS AR/VR |
输出参数
参数名称 | 参数类型 | 示例值 | 参数描述 |
webinar_short_url_customer_data | - | 用户专属参会链接对象。 |
CustomerData 对象
参数名称 | 参数类型 | 示例值 | 参数描述 |
customer_data | String | eyJ2ZXIiOiAiMS4wIiwgInVzZXJEYXRhIjoiY2h1eGlhb2h1b2RvbmcxMDAxIn0= | 用户专属字段。 |
webinar_short_url | String | https://meeting.tencent.com/******** | 用户专属参会链接。 |
is_webinar_guest | uint32 | 1 | 1:嘉宾;则通过链接入会的用户视为嘉宾。 2:观众,则通过链接入会的用户视为观众。 |
is_join_meeting | Integer | 1 | 1:打开链接立即入会。 2:打开链接会进入嘉宾邀请页面或会议详情页(会议开启报名该参数失效)。 |
示例
输入示例
POST https://api.meeting.qq.com/v1/webinars/customer-short-url{"operator_id":"KM4Ss4T******1JiK","operator_id_type":1,"customer_data":"eyJ2ZXIiOiAiMS4wIiwgInVzZXJEYXRhIjoiY2h1eGlhb2h1b2RvbmcxMDAxIn0=","meeting_id":"7567xxxxxxxx9276131","is_webinar_guest":"1","is_join_meeting":"1","instanceid":1}
输出示例
{"webinar_short_url_customer_data":{"customer_data":"eyJ2ZXIiOiAiMS4wIiwgInVzZXJEYXRhIjoiY2h1eGlhb2h1b2RvbmcxMDAxIn0=","webinar_short_url":"https://meeting.tencent.com/dm/jCTxxxxxxx8C","is_webinar_guest":"1","is_join_meeting":1}}