设置会议入会方式
1. 接口描述
接口名称：
/eventopenapi/event/settings/joinconfway/update
发送方式：
POST
参数格式：
accept: application/json;content-type: application/json
2. 输入参数
| 参数 | 类型 | 必须 | 说明 |
|---|---|---|---|
| token | String | 是 | 统一鉴权token |
| eventId | Long | 是 | 直播会议ID |
| joinLimit | Int | 是 | 直播入会限制 0: 公开, 1: 白名单, 2: 加密, 5: 外部授权认证 |
| audienceJoinLimit | Int | 否 | 观众入会限制条件 0:不限制, 1:限制 |
| guestJoinLimit | Int | 否 | 嘉宾入会限制条件 0:不限制, 1:限制 |
| namespaceId | Long | 否 | 白名单ID |
| switchEnable | Int | 否 | 开启或关闭白名单 0: 关闭; 1: 开启; 默认值1 |
| nonWhiteJoinconfway | Int | 否 | 非白名单（电话入会）入会方式 0：电话人工接引; 1：拒绝入会（默认0） |
| encrypt | String | 否 | 加密密码（只在joinLimit=2时有效） |
- 电话会议: 观众不支持加密、外部授权认证
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:限制 |
| namespaceId | Long | 白名单ID |
| groupId | Long | 组ID |
| switchEnable | Int | 开启或关闭白名单 0: 关闭; 1: 开启; 默认值1 |
| joinconfway | Int | 会议入会方式 1: 电话; 2: 网络; 3: 电话+网络; 4: 直播; 7: 电话+网络+直播 |
| tmpWhiteJoinconfway | Int | 临时白名单入会方式 1: 电话; 2: 网络; 3: 电话+网络; 4: 直播; 7: 电话+网络+直播 |
| nonWhiteJoinconfway | Int | 非白名单（电话入会）入会方式 0：电话人工接引; 1：拒绝入会 |
| encrypt | String | 加密密码（只在joinLimit=2时有效） |
| joinVerifyLink | String | 外部授权认证入会链接 |
4. 示例
输入示例1：设置白名单入会方式 + 入会验证方式
{
"token":"5d41c4ac806c6440eb6aa8e071115f2b",
"eventId": 565021,
"joinLimit": 1,
"audienceJoinLimit": 1,
"guestJoinLimit": 1
}
输入示例2：设置白名单入会方式 + 打开白名单
{
"token":"5d41c4ac806c6440eb6aa8e071115f2b",
"eventId": 565021,
"joinLimit": 1,
"namespaceId": 25462,
"switchEnable": 0
}
输入示例3：设置白名单入会方式 + 非白名单入会方式
{
"token":"5d41c4ac806c6440eb6aa8e071115f2b",
"eventId": 565021,
"joinLimit": 1,
"nonWhiteJoinconfway": 1
}
输入示例4：设置加密入会方式 + 密码
{
"token":"5d41c4ac806c6440eb6aa8e071115f2b",
"eventId": 565021,
"joinLimit": 2,
"encrypt": "password123"
}
输出示例
{
"timeStamp": 1653386741230,
"code": 200,
"msg": "Successfully to set the event joinconfway!",
"data": {
"eventId": 565021,
"switchEnable": 0,
"groupId": 12216685,
"nonWhiteJoinconfway": 1,
"joinLink": null,
"joinconfway": 1,
"joinLimit": 1,
"tmpWhiteJoinconfway": 1,
"namespaceId": 25462,
"encrypt": "password123",
"audienceJoinLimit": 1,
"liveRole": null,
"guestJoinLimit": 1,
"joinVerifyLink": null
},
"requestId": "10.255.0.106_20220524_180540_1653386740685"
}
