获取用户设置
获取用户设置
1. 接口描述
接口名称:
/confopenapi/common/user/settings
发送方式:
POST
参数格式:
accept: application/json;content-type: application/json
2. 输入参数
Http Header
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
token | 是 | 接口调用鉴权参数 | 也可以放在http body中 |
Http Body
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
userId | 是 | int | 全时用户ID |
btplId | 否 | int | 全时业务模版ID, 非必填参数, 当btplId为有效值时, 会使用业务模版的属性,覆盖个人设置的属性, 但仅限于Watchword,ParJoinConfLogined,WaitingRoomSwitch,JoinConfSelTag四个属性 |
请求示例
{
"userId":1000
}
4. 返回参数
参数名 | 类型 | 说明 |
---|---|---|
status | int | 0:成功,非0失败 |
result | JSON | 预约会议返回的结果 |
msg | string | 消息 |
result参数说明
-1 : 统一代表, 没有找到此属性
参数名 | 类型 | 说明 |
---|---|---|
identify | int | 个人用户属性, 云会议主持人权限, 0-关闭;1-开通; |
isSupportTelphone | int | 个人用户属性, 是否支持电话功能 1:支持 0:不支持 |
allowUserVoice | int | 个人用户属性, 允许用户使用语音接入方式 0:电话+VoIP;1:电话;2:VoIP;3:VoIP+国内本地接入 |
allowAttendeeCall | int | 个人用户属性, 允许参会人自我外呼 0:否;1:是 |
allowHostCall | int | 个人用户属性, 允许主持人自我外呼 0-否;1-是 |
UnattendedDialOutAllowed | int | 个人用户属性, 外呼模式 0:禁止外呼;1:允许网络端外呼,禁止*8外呼;2:允许外呼 |
hardwareVideo | int | 个人用户属性, 是否启用SIP 1:启用,0-不启用 |
autoRecord | int | 个人用户属性, 录制,0:手动开启录制,1:自动开启录制 |
confMute | int | 个人用户属性, 入会全体静音,0:关闭 ,1:打开 |
relieveMute | int | 个人用户属性, 会议解除静音,0:仅主持人才能解除,1:允许参会人自己解除 |
videoControl | int | 个人用户属性, 会中视频共享权限,1:是主持人控制,2:是参会人自由控制 |
autoVideo | int | 个人用户属性, 视频入会,0:入会时不自动开启视频,1:入会时自动开启视频,2:自由开关 |
watchword | int | 个人用户属性, 是否有开启入会口令的功能,0:否,1:是 |
parJoinConfLogined | int | 个人用户属性, 是否参会人加入会议时必须登录才能入会(0:否,1:是) |
waitingRoomSwitch | int | 个人用户属性, 等候室是否开启(0:关闭,1:开启) |
joinConfSelTag | int | 个人用户属性, 是否参会人加入会议时必须选择标签(0:否,1:是) |
showPreview | int | 个人用户属性, 是否加入会议时都显示视频预览(0:不显示,1:显示) |
waitingRoomWhoStay | int | 个人用户属性, 谁应该进到等候室0:所有人,1:不在企业内账号使用者,2:未邀请的参会人 |
waitingRoomController | int | 个人用户属性, 谁能控制等候室里的人能否加入会议 0:主持人,1:联席主持人(或主持人) |
livingPlayback | int | 个人用户属性, 直播回放设置: -1:不允许回看;0:永不过期; 1:自定义过期时间;2:1个月有效;3:3个月有效;4:6个月有效 |
livingPlaybackTime | int | 个人用户属性 直播过期时间 仅当livePlaybackFlag为1至3时有效,取值范围:-1:不允许回看 ,0:永不过期,其他是时间戳ttl |
liveService | int | 个人属性,是否支持直播 0:不支持, 1:支持 |
meetingType | int | 全时业务模版属性, 基础会议形式, 1:网络会议,2:直播会议, 此属性只有btplId有有效值时有效, 没有btplId时,返回-1,代表没有没有此属性 |
templateConference | int | 个人用户属性, 是否支持模版会议 0:不支持, 1:支持 |
subtitles | int | 个人用户属性, 字幕及翻译, 0:关闭, 1:开启 |
rstt | int | 个人用户属性, 录制语音转文字 0:关闭, 1:开启 |
contractProperty | Object | 合同属性 |
contractProperty
参数名 | 类型 | 说明 |
---|---|---|
contractId | int | 合同ID |
contractStatus | int | 合同状态,8:正常已开通;11:已终止 |
contractType | int | 合同类型, 0:免费合同;1:付费合同;2:测试合同 |
aiSpeechToText | int | 合同属性,是否支持语音转文字 0:不支持, 1:支持 |
templateConference | int | 合同属性,是否支持模版会议 0:不支持, 1:支持 |
hardwareVideo | int | 合同属性,是否启用SIP 0:不启用 1:启用 |
isSupportTelphone | int | 合同属性,是否支持电话功能 0:不启用 1:启用 |
返回示例
{
"status": 0,
"result": {
"identify": 1,
"autoRecord": 0,
"confMute": 0,
"allowH323": 0,
"relieveMute": 1,
"videoControl": 2,
"autoVideo": 0,
"isSupportTelphone": 1,
"allowUserVoice": 0,
"allowAttendeeCall": 1,
"allowHostCall": 1,
"unattendedDialOutAllowed": 2,
"watchword": 1,
"parJoinConfLogined": 1,
"waitingRoomSwitch": 0,
"joinConfSelTag": 0,
"showPreview": 1,
"hardwareVideo": 0,
"livingPlayback": 0,
"livingPlaybackTime": 0,
"waitingRoomWhoStay": 0,
"waitingRoomController": 0,
"meetingType": -1,
"templateConference": 0,
"subtitles": 0,
"rstt": 0,
"contractProperty": {
"contractId": 397095,
"contractStatus": 8,
"contractType": 0,
"aiSpeechToText": 0,
"templateConference": 0,
"hardwareVideo": 0,
"isSupportTelphone": 1
}
},
"msg": "GetUserPrivilege SUCCESS",
"request_id": "confopenapiserver-172.10.5.226-1719310027.583075252.81",
"timestamp": 1719310027583,
"request_duration": "574.849949ms"
}
备注
- 更多返回错误代码请看首页的错误代码描述