创建 Webinar 专属参会链接

最近更新时间:2024-07-08 11:48:52

我的收藏

接口描述

描述:
使用该接口,可用 customer_data 进行区分,为一场会议生成多个会议链接。通过用户入会等事件,或通过获取参会成员列表的 API 查询到该参数。
参会者腾讯会议客户端版本需大于等于 3.2.0。
暂不支持 OAuth 2.0 鉴权方式访问。
请求方式:POST
接口请求域名:
https://api.meeting.qq.com/v1/webinars/customer-short-url


输入参数

HTTP 请求头公共参数请参见签名验证章节的 公共参数说明
参数名称
必选
参数类型
参数描述
meeting_id
String
会议的唯一 ID。
is_webinar_guest
uint32
1:嘉宾;则通过链接入会的用户视为嘉宾。
2:观众,则通过链接入会的用户视为观众,不传默认为2。
customer_data
String
用户专属字段,长度不超过256 字节。
is_join_meeting
Integer
1:打开链接立即入会。
2:打开链接会进入嘉宾邀请页面或会议详情页(会议开启报名该参数失效)。

输出参数

参数名称
参数类型
参数描述
webinar_short_url_customer_data
CustomerData 对象
用户专属参会链接对象。

CustomerData 对象

参数名称
参数类型
参数描述
customer_data
String
用户专属字段。
webinar_short_url
String
用户专属参会链接。
is_webinar_guest
uint32
1:嘉宾;则通过链接入会的用户视为嘉宾。
2:观众,则通过链接入会的用户视为观众。
is_join_meeting
Integer
1:打开链接立即入会。
2:打开链接会进入嘉宾邀请页面或会议详情页(会议开启报名该参数失效)。

示例

输入示例

POST https://api.meeting.qq.com/v1/webinars/customer-short-url
{
"customer_data":"test",
"meeting_id":"7567xxxxxxxx9276131"
"is_webinar_guest":"1"
"is_join_meeting":1
}

输出示例

{
"webinar_short_url_customer_data":
{
"customer_data":"test"
"webinar_short_url":"https://meeting.tencent.com/dm/jCTxxxxxxx8C"
"is_webinar_guest":"1"
"is_join_meeting":1
}
}