获取会议通用属性

 

一、接口描述

1.接口名称:

https://openapi.quanshi.com/conference/conference/getConfig

2.发送方式:

POST

3.参数格式:

accept: application/json;content-type: application/json

 

二、输入参数

参数名 必选 类型 说明
appId int 应用ID,请传6
userId int 账号userID

 

三、示例

返回示例

{
    "status": 0,
    "result": {
        "userId": 4307081,
        "emailLanguage": "En-us",
        "isFreeJoin": 1,
        "confTips": 1,
        "allowMobile": 1,
        "videoConferenceMode": 1,
        "videoControl": 1,
        "videoStandardSet": 2,
        "relieveMute": 0,
        "enableDoc": 1,
        "enableWhiteboard": 1,
        "shareNotes": 0,
        "sharePageTurn": 0,
        "watermark": 0,
        "saveShare": 0,
        "autoRecord": 0,
        "showWholeAttendList": 0,
        "isFreeChat": 0,
        "muteSoundMsg": 1
    },
    "msg": "getConfConfig success",
    "request_id": "confopenapiserver-10.90.43.102-1599532545.848910555.106",
    "timestamp": 1599532545848,
    "callSeq": "",
    "content_type": "application/json",
    "request_duration": "29.989512ms"
}

 

四、返回参数

参数名 类型 说明
status int 0:成功,非0失败
result int 返回结果
userId int 用户userID
emailLanguage string 用户会议邀请的邮件语言 (En-us:英文,Zh-cn:中文,Zh-cnEn-us:中英文)
isFreeJoin int 参会人提前入会设置 0:主持人入会后方可入会;1:不限(默认)
confTips int 入会退会提示,0:不提示;1:提示,默认1
allowMobile int 允许手机入会0:禁止参会人手机端入会,1:允许参会人手机端入会(默认)
videoConferenceMode int 视频入会,0:入会不自动开视频(默认),1:入会自动开视频
videoControl int 视频权限 1:会中由主持人控制,2:参会人会中可自由开关(默认)
videoStandardSet int 视频清晰度 1:标清(默认),2:高清,4:超清
relieveMute int 解除静音0:仅主持人才能解除(默认),1:允许参会人自己解除
enableDoc int 共享文档0:不允许共享文档(默认), 1:仅主持人共享文档,2:所有人都可以共享文档
enableWhiteboard int 共享白板0:不允许共享白板(默认), 1:仅主持人共享白板,2:所有人都可以共享白板
shareNotes int 共享批注0:不允许参会人批注 1:允许自由批注(默认)
sharePageTurn int 共享翻页 0:不允许参会人翻页 1:允许自由翻页(默认)
watermark int 查看共享桌面0:不加水印(默认) 1:加水印
saveShare int 保存共享0:不允许保存共享 1:允许保存共享(默认)
autoRecord int 录制0:手动开启录制(默认) 1:入会自动开启录制
showWholeAttendList int 参会列表0:对参会人隐藏参会列表 1:显示完整参会列表(默认)
isFreeChat int 会中聊天0:仅与主持人聊天,1:允许自由聊天(默认)
muteSoundMsg int 提示语音0:关闭语音提示, 1:开启语音提示(默认)

备注

更多返回错误代码请看首页的错误代码描述