获取免校验入会链接
通常情况下,创建会议后获取到的入会链接,在浏览器打开后会唤起客户端应用程序,用户需要再次输入入会信息才可以入会。免校验入会链接就是为用户提供直接入会链接,用户在浏览器中输入入会链接,会自动唤起客户端并直接入会。观众端可以直接入会并观看直播、发送聊天信息。
1. 接口描述
接口名称:
/eventopenapi/event/joinLink
发送方式:
POST
参数格式:
accept: application/json;content-type: application/json
2. 输入参数
参数 | 类型 | 必须 | 说明 |
---|---|---|---|
token | String | 是 | 统一鉴权token |
eventId | Long | 是 | 直播会议ID |
liveRole | Int | 是 | 会议角色 标准活动:0: 观众,1: 主持人,2: 联席主持人,3:嘉宾 专业活动:取决于会议详情中的btplRole字段中的列表值 |
name | String | 否 | 姓名 |
countryCode | String | 否 | 国家码 |
mobile | String | 否 | 手机号 |
String | 否 | 邮箱 | |
company | String | 否 | 公司名称 |
position | String | 否 | 职位 |
extInfo | String | 否 | 第三方扩展信息(比如thirdPartyId信息等) |
usableCount | Int | 否 | 免校验Token的使用次数(仅对观众入会链接有效)默认值6次 |
timeout | Int | 否 | 免校验Token的失效时间(单位分钟, 仅对观众入会链接有效)默认值8小时 |
permission | Json | 否 | 入会权限 |
isHostNeedToken | Int | 否 | 主持人入会链接,是否需要免校验Token, 1: 需要, 0: 不需要(默认值1) |
permission 参数说明
参数 | 类型 | 必须 | 说明 |
---|---|---|---|
outboundCall | Int | 是 | 电话外呼开关 |
allowHandFun | Json | 是 | 是否允许举手连麦 |
allowHandFun 参数说明
参数 | 类型 | 必须 | 说明 |
---|---|---|---|
value | Int | 是 | 功能值定义0:不允许,1:允许 |
hide | Boolean | 是 | 是否显示入口,true:不显示此功能,false: 显示此功能 |
tips | String | 是 | 不允许举手的提示语 |
3. 输出参数
参数 | 类型 | 说明 |
---|---|---|
timeStamp | Long | 返回时间(时间戳,单位毫秒) |
requestId | String | 请求ID(在接口异常时, 需提供请求ID) |
code | Int | 返回的状态码 |
msg | String | 当返回结果的状态码不为200时,包含的错误信息 |
data | json | 返回数据 |
data 参数说明
参数 | 类型 | 说明 |
---|---|---|
eventId | Long | 直播会议ID |
liveRole | Int | 会议角色 |
joinType | Int | 入会方式 |
joinLink | String | 入会链接 |
name | String | 姓名 |
countryCode | String | 国家码 |
mobile | String | 手机号 |
String | 邮箱 | |
company | String | 公司名称 |
extInfo | String | 第三方扩展信息 |
pcode1 | String | 主持人入会密码 |
pcode2 | String | 参会人入会密码 |
usableCount | Int | token可使用次数 |
timeout | Int | token失效时间, 单位分钟 |
accessNumbers | Array | 接入号信息 |
accessNumbers 参数说明
参数 | 类型 | 说明 |
---|---|---|
name | String | 接入号名称 |
value | String | 接入号信息 |
countryName | String | 国家名称 |
cityName | String | 城市名称 |
free | Boolean | 是否自选语言 true: 是 false: 否 |
4. 示例
输入示例1: 获取主持人免校验入会链接
{
"token":"5d41c4ac806c6440eb6aa8e071115f2b",
"eventId": 542818,
"liveRole": 1,
"name": "主持人001",
"company": "全时公司主持人"
}
输出示例1
{
"timeStamp": 1639472622669,
"code": 200,
"msg": "Successfully to get the event join link!",
"data": {
"eventId": 542818,
"accessNumbers": [
{
"cityName": "北京",
"name": "北京 +86(10)5030-4321(中文)",
"countryName": "中国",
"free": false,
"value": "+86(10)5030-4321"
},
{
"cityName": "",
"name": " 01058512042(中文)",
"countryName": "",
"free": false,
"value": "01058512042"
},
{
"cityName": "中国大陆",
"name": "中国大陆 400-810-8888(中文)",
"countryName": "中国",
"free": false,
"value": "400-810-8888"
},
{
"cityName": "",
"name": " 0805-980-051(英文)",
"countryName": "法国",
"free": false,
"value": "0805-980-051"
},
{
"cityName": "",
"name": " 0800-452-462(英文)",
"countryName": "新西兰",
"free": false,
"value": "0800-452-462"
},
{
"cityName": "",
"name": " 800-500-9232(英文)",
"countryName": "俄罗斯",
"free": false,
"value": "800-500-9232"
}
],
"mobile": null,
"joinLink": "https://mtest.qsh1.cn/k/mkh3YRT5g2T?token=70459424-22fa-4c67-8562-1dd9fa973a6e&wuid=88406965&extType=4&extName=eyJ3aGl0ZWxpc3RfdHlwZSI6IiIsIm5hbWUiOiLkuLvmjIHkurowMDEiLCJtb2JpbGUiOiIiLCJjb21wYW55Ijoi5YWo5pe25YWs5Y+45Li75oyB5Lq6IiwiZXh0SWQiOiJhMDAyMDAxMDA5MDAwMSIsImVtYWlsIjoiYTAwMkBxdWFuc2hpLmNvbSIsImdyb3VwIjoiIn0=&nickName=%E4%B8%BB%E6%8C%81%E4%BA%BA001",
"timeout": 480,
"extInfo": null,
"pcode2": "201501000037372258",
"pcode1": "201501000037372257",
"usableCount": 6,
"countryCode": null,
"joinType": null,
"name": "主持人001",
"linkJoinWay": 0,
"company": "全时公司主持人",
"liveRole": 1
},
"requestId": "10.255.0.106_20211214_170341_1639472621776"
}
输入示例2: 获取观众免校验入会链接
{
"token":"5d41c4ac806c6440eb6aa8e071115f2b",
"eventId": 542818,
"liveRole": 0,
"name": "观众11",
"countryCode": "86",
"mobile": "181826563011",
"extInfo": "76fb00dfe5914db7aa8e91327acb37011",
"usableCount": 1000,
"timeout": 6000,
"linkJoinWay": 1,
"permission":{"outboundCall":1,"allowHandFun":{"value":0,"hide":true,"tips":"提示语sss"}},
"position":"测试23qw职位",
"company": "全时观众quanshi.com"
}
输出示例2
{
"timeStamp": 1639472677797,
"code": 200,
"msg": "Successfully to get the event join link!",
"data": {
"eventId": 542818,
"accessNumbers": [
{
"cityName": "北京",
"name": "北京 +86(10)5030-4321(中文)",
"countryName": "中国",
"free": false,
"value": "+86(10)5030-4321"
},
{
"cityName": "",
"name": " 01058512042(中文)",
"countryName": "",
"free": false,
"value": "01058512042"
},
{
"cityName": "中国大陆",
"name": "中国大陆 400-810-8888(中文)",
"countryName": "中国",
"free": false,
"value": "400-810-8888"
},
{
"cityName": "",
"name": " 0805-980-051(英文)",
"countryName": "法国",
"free": false,
"value": "0805-980-051"
},
{
"cityName": "",
"name": " 0800-452-462(英文)",
"countryName": "新西兰",
"free": false,
"value": "0800-452-462"
},
{
"cityName": "",
"name": " 800-500-9232(英文)",
"countryName": "俄罗斯",
"free": false,
"value": "800-500-9232"
}
],
"mobile": "181826563011",
"joinLink": "https://ltest.qsh1.cn/activity/gdm9jO8?t=652765d9-8abb-40c2-97f8-0c6b5853ea76&j=3&priority=web",
"timeout": 6000,
"extInfo": "76fb00dfe5914db7aa8e91327acb37011",
"pcode2": "201501000037372258",
"pcode1": "201501000037372257",
"usableCount": 1000,
"countryCode": "86",
"joinType": 3,
"name": "观众11",
"email": "",
"linkJoinWay": 1,
"company": "全时观众quanshi.com",
"liveRole": 0
},
"requestId": "10.255.0.106_20211214_170437_1639472677356"
}