- 产品介绍
- 开发指南
-
API参考
- 前言
- 简介
- 开发指南
-
HTTP API接口
-
函数接口
- 登录认证类
- 通讯录类
- 会议、呼叫类
- 会议控制类
- 图像与声音类
- 版本与状态类
- 终端控制类
-
配置类
- AI
- AGS
-
硬终端开放性
- 设置霸屏应用包名
- 查询当前霸屏应用包名
- 设置HDMI有线投屏窗口大小和位置
- 查询终端光感信息
- 查询白板标注状态
- 开始白板标注
- 结束白板标注
- 查询入会时隐藏提示弹框配置项
- 设置入会时隐藏提示弹框配置项
- 打开摄像机
- 关闭摄像机
- 静默升级第三方应用
- 查询有线网络IPv4信息
- 设置有线网络IPv4信息
- 获取终端网络状态
- 查询WI-FI状态
- 设置WI-FI状态
- 扫描wifi
- 查询wifi列表
- 连接wifi
- 不保存wifi
- 查询NTP信息
- 设置NTP信息
- 配置文件导入
- 上传apk文件
- 获取第二个结果文件
- 获取一键诊断的文件
- 获取TOUCH ROM文件
- 接收HID日志
- 获取Hid的代理
- 获取代理版本
- 获取新的CA证书文件路径
- 保存配置当前值
- 清除任务
- 查询Query参数
- 根据ID值返回配置当前值
- 查询单个无线演示客户端信息
- 是否允许无线演示连接
- 当前是否连接无线演示
- 巡检开始请求
- 下发巡检项
- 巡检状态查询
- 巡检结果查询
- 强制停止巡检请求
- 查询终端外设的序列号
- 获取HID软件版本
- 设置web登录类型
- 查询web登录类型
- 清除首次开机标识
- 获取终端首次开机标识
- 查询云服务类型
- 查询是否获取到华为云地址
- 查询是否使用激活码激活华为云
- 查询投屏码
- 查询辅流源的分辨率是否支持
- 查询物理网口是连接或断开
- 获取音视频能力
- 更新 Touch 信息
- 取消订阅邮箱状态数据
- 订阅邮箱状态数据
- 请求系统支持的呼叫类型下拉列表
- 获取蓝牙设备的物理工作状态
- 激活TMS或者Esight
- 查询电子标签
- 设置电子标签
- 关闭wifi热点
- 获取连接的无线MIC相关信息
- 导入提供给API用户的地址本文件
- 读取配置文件
- 界面取消呼叫
- 获取公共网络密码状态
- 发送邮件
- 获取TOUCH ROM升级文件列表
- 获取设备状态
- 摄像机画面显示与隐藏
- 获取邮箱服务器参数
- 取消共享请求
- 获取wifiAP密钥修改标志
- 查询串口连接状态
- 获取Ideahub定制类型
- 设置Ops信号类型
- 获取Smc状态
- 获取系统内存大小
- 获取休眠状态和原因
- 恢复出厂配置
- USB导入配置接口
- 取消导入USB 配置
- 设置TOUCH 版本型号信息
- 设置TOUCH 升级下载安装的结果
- 设置TOUCH升级进度
- 获取当前签到数据
- 切换大屏和触屏
- 获取本地有线的状态
- 获取添加会场列表
- 获取呼叫信息
- 添加会场
- 获取会后签到详情
- 判断RC密码是否为空
- 获取当前终端是否有选看能力
- 获取App下载路径
- 获取二维码和服务热线
- 获取终端名称和大小
- 获取会议记录信息
- 会场静音
- 取消会场静音
- 设置屏幕显示模式
- 取消申请发言列表
- 查询是否获取到NTP 服务器地址
- 启动AI人脸检测
- 关闭AI人脸检测
- 获取AI人脸图片
- 获取无线辅流连接码
- WPS启动
- 获取媒体方向
- 根据选择的输入口返回配置值
- 读取摄像机输入参数
- 智能诊断
- 获取智能诊断参数诊断的结果
- 获取智能诊断音频诊断结果
- 获取智能诊断视频诊断结果
- 获取设备CTEI码
- 获取外置摄像机版本号
- 获取在线会场列表
- 通知主控更新LDAP地址本
- 获取LDAP地址本搜索结果列表
- 获取云平台数据
- 摄像机控制操作
- 获取摄像机位置图像
- 设置内置摄像机图像模式
- 设置外置摄像机样式
- 屏幕克隆
- 获取当前的交换/克隆状态
- 获取usb导入状态
- 获取日志导出文件
- WEB服务器证书导入
- 获取SIP的呼叫方式
- 获取本地摄像机的下拉列表框内容
- 判断是否接收到远端辅流
- 查询是否是 RP 型号
- 获取IMS信息
- 设置演示屏画面内容
- 改变其他输出口显示内容
- 设置主流和演示视频源
- 设置界面编辑框
- 进入摄像机控制界面
- 设置视频输出配置参数
- 获取视频输出配置参数
- 设置是否允许视频监控
- 获取监控视频状态
- 设置配置向导
- 校验RC密码
- 设置配置参数
- 获取无线信息
- 获取会场配对信息
- 白板浏览器扫码带走
- 音频控制类
- 消息接口
-
函数接口
- 邮箱
- 枚举定义
- 错误码
- 数据定义
- 附录
- 各型号HTTP API列表
-
SDK参考
-
IdeaShare
- SDK下载
- Android SDK
-
IOS SDK
- 概述
- 变更记录
- 快速入门
- 典型场景
- 常见问题
-
IOS接口参考
- 概述
- 变更记录
-
接口参考
- 启动APP
-
连接设备
- 设置TLS验证
- 设备连接
- 断开连接
- 开始投屏
- 结束投屏
- 远程遥控功能
- 打开/关闭麦克风
- 调节扬声器音量
- 打开/关闭扬声器
- 打开/关闭摄像头
- 离开会议
- 结束会议
- 获取客户端SDK版本
- 服务端版本查询
- 辅助进程发送视频数据
- 辅助进程发送音频数据
- 辅助进程投屏初始化
- 接口调用结果通知
- discoverCallback
- connectCallback
- disconnectCallback
- startSharingCallback
- stopSharingCallback
- remoteServiceStatusCallback
- micMuteCallback
- speakerVolumeCallback
- speakerMuteCallback
- cameraMuteCallback
- leaveConfCallback
- finishConfCallback
- sdkLatestVersionCallback
- tlsCallback
- 设备推送通知
- 错误通知
- 附录
- 错误码参考
- MAC SDK
-
Windows SDK
- 概述
- 变更记录
- 快速入门
- 典型场景
- 常见问题
-
Windows接口参考(C++)
- 概述
- 变更记录
- 接口参考
-
通知参考
-
接口调用结果通知
- OnDiscoverResult
- OnConnectResult
- OnDisconnectResult
- OnSharePlayResult
- OnShareStopResult
- OnGetRemoteServiceStatusResult
- OnSetRemoteMicMuteResult
- OnSetRemoteSpeakerVolumeResult
- OnSetRemoteSpeakerMuteResult
- OnSetRemoteCameraMuteResult
- OnSetLeaveConferenceResult
- OnSetEndConferenceResult
- OnGetSDKLatestVersionResult
- OnSetMouseShapeResult
- 设备推送通知
- 错误通知
-
接口调用结果通知
- 附录
- Windows接口参考(JavaScript)
- 错误码参考
- 个人数据处理说明
-
IdeaShare
- Demo
- IdeaManager
- 企业微定制
- 文档下载
- 通用参考
链接复制成功!
请求邮箱数据
接口名称
WEB_GetMailboxDataAPI
功能描述
Web前台向后台请求邮箱数据时调用该接口,包括常用的状态数据和消息数据。
应用场景
该接口用于请求消息数据,同时用于维持客户端和服务端之间的常连接。客户端向服务端发送该请求的时间间隔必须小于60秒。
URL
https://ip/action.cgi?ActionID=WEB_GetMailboxDataAPI
参数
无
返回值
参数 |
类型 |
取值范围 |
参数说明 |
---|---|---|---|
success |
int |
[0, 1] |
响应结果 0:失败 1:成功 |
data |
Object |
可选 |
成功返回数据。详细参考表2。 例如: {"success":1,"data":"{\"state\":{\"sitename\":\"site\",\"speaker\":1,\"mic\":1,\"gk\":1,\"sip\":1,\"upgrade\":0,\"callstate\":0,\"calltype\":0,\"conftype\":0,\"sitecall\":0,\"chair\":0,\"miniMcu\":0,\"isInConf\":0,\"pstnstate\":0,\"t140cap\":2,\"isHwGk\":1,\"h239cap\":0,\"tv_H239_hd2\":0,\"useminimcu\":0,\"wifi\":0,\"RemoteMicStates\":0,\"cfgonebit\":189,\"statebit\":4,\"speakerValue\":0,\"micValue\":0,\"statebit2\":0,\"bluetooth\":0,\"upgradeProc\":5640,\"shownew\":7,\"confNetType\":0,\"auditsite\":0,\"streamType\":0},\"msgStruct\":\"{\\\"iResult\\\":0,\\\"msg\\\":[\\\"{\\\\\\\"msgID\\\\\\\":4500,\\\\\\\"msgName\\\\\\\":\\\\\\\"MSG_SAVEBOOK_ADDR\\\\\\\",\\\\\\\"subMsgID\\\\\\\":31744,\\\\\\\"param1\\\\\\\":0,\\\\\\\"param2\\\\\\\":0,\\\\\\\"msgData\\\\\\\":\\\\\\\"\\\\\\\",\\\\\\\"sessionID\\\\\\\":\\\\\\\"\\\\\\\"}\\\"]}\"}"} |
error |
Object |
可选 |
失败返回错误信息。详细参考表5。 例如:{"success":0,"error":"id":100666995,"code":33558532,"params":[]}} |
参数 |
类型 |
取值范围 |
参数说明 |
---|---|---|---|
sitename |
string |
可为空 |
会场名字 |
speaker |
int |
[0, 1] |
喇叭 0:关 1:开 |
mic |
int |
[0, 1] |
麦克风 0:关 1:开 |
gk |
int |
[0, 1] |
注册GK 0:失败 1:成功 |
sip |
int |
[0, 1] |
注册SIP 0:失败 1:成功 |
upgrade |
int |
[0, 1] |
升级状态 0:空闲中 1:升级中 |
callstate |
int |
[0, 2] |
呼叫状态 0:无呼叫 1:正在呼出 2:呼叫已经连接 |
calltype |
int |
[0, 10] |
呼叫线路类型 0:ISDN呼叫 1:V35呼叫 2:E1呼叫 3:H.323呼叫 4:电话(纯音频) 5:PSTN(窄带) 6:T1呼叫 7:4E1呼叫 8:SIP呼叫 9:SIP Phone呼叫 10:auto自动切换呼叫类型 |
conftype |
int |
[0, 4] |
会议类型 0:无呼叫 1:点对点呼叫 2:在远端多点会议 3:在本地多点会议 4:在级联会议中 |
confstate |
int |
[0, 7] |
会议状态 0:空闲 1:呼叫操作 2:接听呼叫 3:拒绝呼叫 4:主叫呼集 5:预约呼叫 6:查询预约 7:删除预约 |
sitecall |
int |
[0, 1] |
本端是否主叫呼集发起方 0:非本端发起 1:本端发起 |
chair |
int |
[0, 1] |
本端是否主席 0:非主席 1:主席 |
miniMcu |
int |
[0, 1] |
是否支持内置MCU 0:不支持 1:支持 |
isInConf |
int |
[0, 1] |
本端是否入会 0:本端未入会 1:本端已入会 |
pstnstate |
int |
[0, 5] |
PSTN状态 1:未插卡 2:已插卡 3:已插卡已接线/挂机 4:已插卡已接线/振铃 5:已插卡已接线/摘机 |
t140cap |
int |
[0, 2] |
T.140能力状态 0:无T.140能力 1:有T.140能力 2:非T.140 |
isHwGk |
int |
[0, 1] |
是否启用增强GK 0:禁用 1:启用 |
h239cap |
int |
[0, 1] |
h239能力 0:未使用 1:使用 |
tv_H239_hd2 |
int |
[0, 1] |
是否启用双屏 0:未启用 1:启用 |
useminimcu |
int |
[0, 1] |
当前是否启用minimcu 0:未启用 1:启用 |
wifi |
int |
[0, 2] |
Wifi状态 0:WIFI没有启用 1:WIFI启用,但是未连接 2:WIFI启用并连接上 |
RemoteMicStates |
int |
[0, 1] |
远端麦克风 0:关 1:开 |
cfgonebit |
int |
32位整数 |
状态位1表示当前启用,0表示未启用或不支持。 bit 0: ldap bit 1: espace bit 2: mic1 bit 3: mic2 bit 4: line 1 bit 5: line 2 |
statebit |
int |
32位整数 |
状态标识 |
speakerValue |
int |
16位整数 |
喇叭音量 |
micValue |
int |
16位整数 |
麦克风音量 |
statebit2 |
int |
32位整数 |
拼接字段组合 |
bluetooth |
int |
[0, 1] |
是否支持蓝牙 0:不支持 1:支持 |
upgradeProc |
int |
32位整数 |
升级进度 |
confNetType |
int |
[0, 1] |
终端呼叫状态 |
auditsite |
int |
[0, 1] |
旁听会场的媒体方向 |
streamType |
int |
[0, 2] |
0:传统会议 1:协作会议 2:多流会议 |
isSupportAI |
int |
[0, 1] |
是否支持AI 0:不支持 1:支持 |
curStatusCP |
int |
[0, 1] |
是否支持协作 0:不支持 1:支持 |
shareType |
int |
[0, 1] |
- |
dontDisturb |
int |
[0, 1] |
- |
camStateInConf |
int |
[0, 1] |
- |
webExpiredTime |
int |
32位整数 |
- |
imageSwitch |
int |
[0, 1] |
- |
参数 |
类型 |
取值范围 |
参数说明 |
---|---|---|---|
id |
int |
32位整数 |
错误id,用于转换。 |
code |
int |
32位整数 |
错误码,跟错误id对应,具体含义参考错误码。 |
param |
Object |
param对象 |
失败响应的附带参数。 |