查看会议入会方式
云直播支持多种入会验证方式: 公开、白名单、加密、外部授权验证。通过接口可以
- 设置会议的入会验证方式（公开、白名单、加密、外部授权验证）
- 设置嘉宾、观众入会限制条件
- 设置加密入会方式观看密码
- 获取外部授权验证入会方式链接
1. 接口描述
接口名称：
/eventopenapi/event/settings/joinconfway
发送方式：
POST
参数格式：
accept: application/json;content-type: application/json
2. 输入参数
| 参数 | 类型 | 必须 | 说明 |
|---|---|---|---|
| token | String | 是 | 统一鉴权token |
| eventId | Long | 是 | 直播会议ID |
| isShowList | Int | 否 | 是否显示白名单列表 0: 否, 1: 是（默认0） |
3. 输出参数
| 参数 | 类型 | 说明 |
|---|---|---|
| timeStamp | Long | 返回时间（时间戳，单位毫秒） |
| requestId | String | 请求ID（在接口异常时, 需提供请求ID） |
| code | Int | 返回的状态码 |
| msg | String | 当返回结果的状态码不为200时，包含的错误信息 |
| data | json | 返回数据 |
data 参数说明
| 参数 | 类型 | 说明 |
|---|---|---|
| eventId | Long | 直播会议ID |
| joinLimit | Int | 直播入会方式 0: 公开, 1: 白名单, 2: 加密, 5: 外部授权认证 |
| audienceJoinLimit | Int | 观众入会限制条件 0:不限制, 1:限制 |
| guestJoinLimit | Int | 嘉宾入会限制条件 0:不限制, 1:限制 |
| tmpWhiteJoinconfway | Int | 临时白名单入会方式 1: 电话; 2: 网络; 3: 电话+网络; 4: 直播; 7: 电话+网络+直播 |
| nonWhiteJoinconfway | Int | 非白名单（电话入会）入会方式 0：电话人工接引; 1：拒绝入会 |
| encrypt | String | 加密密码（只在joinLimit=2时有效） |
| whiteNamespaces | Array | 白名单列表 |
whiteNamespaces 参数说明
| 参数 | 类型 | 说明 |
|---|---|---|
| namespace_id | Long | 白名单ID |
| namespace_name | String | 白名单名称 |
| type | Int | 白名单类型 1：普通 2：标签 |
| whitelist_count | Int | 白名单联系人数量 |
| grouplist | Array | 组列表 |
| switch | Int | 开启或关闭白名单 0: 关闭; 1: 开启 |
grouplist 参数说明
| 参数 | 类型 | 说明 |
|---|---|---|
| group_id | Long | 组ID |
| group_name | String | 组名称 |
| joinconfway | Int | 会议入会方式 1: 电话; 2: 网络; 3: 电话+网络; 4: 直播 |
| contact_count | Int | 本组联系人数量 |
| list | Array | 联系人列表 |
4. 示例
输入示例
{
"token":"5d41c4ac806c6440eb6aa8e071115f2b",
"eventId": 564696,
"isShowList": 0
}
输出示例
{
"timeStamp": 1653041948293,
"code": 200,
"msg": "Successfully to get the event joinconfway!",
"data": {
"eventId": 564696,
"tmpWhiteJoinconfway": 1,
"encrypt": "-",
"audienceJoinLimit": 1,
"whiteNamespaces": [
{
"namespace_id": 29207,
"namespace_name": "22",
"type": 2,
"whitelist_count": 0,
"grouplist": [
{
"group_id": 12216634,
"group_name": "QQS3",
"joinconfway": 0,
"contact_count": 0,
"list": []
}
],
"switch": 1
},
{
"namespace_id": 25462,
"namespace_name": "用户白名单",
"type": 1,
"whitelist_count": 2,
"grouplist": [
{
"group_id": 12216685,
"group_name": "G1",
"joinconfway": 0,
"contact_count": 2,
"list": []
}
],
"switch": 0
}
],
"nonWhiteJoinconfway": 1,
"joinLink": null,
"joinLimit": 1,
"liveRole": null,
"guestJoinLimit": 1,
"joinVerifyLink": ""
},
"requestId": "10.255.0.106_20220520_181907_1653041947124"
}
