检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
开发指南 环境搭建 通用接口使用概述 登录认证 呼叫 取消呼叫 查询基本信息 召集 登出 USB模式切换 切换Windows系统 切换Android系统并拉起应用 设置霸屏应用包名 查询当前霸屏应用包名 设置投屏窗口位置和大小 其他第三方应用白板扫码保存
登录认证 使用本参考文档进行开发时首先需要完成登录认证,再进行相应的业务处理,最后处理完业务后需要登出。 图1 API接口的整体使用流程 在使用API接口前,必须完成登录认证。认证的用户名为api,默认密码为Change_Me,实际密码请与管理员确认。 使用本章实例前,请仔细阅读环境搭建
HTTP API接口 本章介绍HTTP API接口的使用方法。 函数接口 消息接口
登录认证类 请求会话ID 请求认证 更换会话ID 请求邮箱数据 订阅邮箱消息数据 取消订阅邮箱消息 退出登录 父主题: 函数接口
版本与状态类 获取通话状态,包括会议中的实时信息 获取多流会议中的通话状态 获取当前会议参数 获取终端型号/版本信息 获取终端型号及尺寸信息 获取投屏码信息 清理在线任务 父主题: 函数接口
终端控制类 查询休眠状态 启动系统休眠 唤醒休眠 关机 重启终端 系统休眠 父主题: 函数接口
登录认证类 IP地址改变指示 消息名称 MSG_WEB_IP_CHANGED 功能描述 终端IP地址改变指示。一般通过WEB_SaveCfgParamAPI接口修改IP地址后,会收到该消息,此时需要重新认证。 是否自动推送 是 subMsgID 不使用 Param1 不使用 Param2
会议控制类 观看会场响应 消息名称 MSG_VIEW_SITE_RSP 功能描述 观看会场响应。一般调WEB_ViewSiteAPI接口观看会场后,会收到这个消息,可以根据参数Param1区分观看会场是否成功,并做相应处理。观看多画面,或者观看多组多画面也是这个接口。 是否自动推送
图像与声音类 暂隐图像状态指示 消息名称 MSG_VIDEO_HIDDEN 功能描述 暂隐图像状态指示。一般通过接口WEB_StartSendBlueScreenAPI开始暂隐图像后,或者通过接口WEB_StopSendBlueScreenAPI停止暂隐图像后,会收到这个消息,可
通讯录会场结构 WEB_ADDR_RECORD ::= STRUCT { uwID INT32, --记录ID ucType INT32, --线路类型 :0: ISDN 1: V35
音量指示数据 WEB_CURRENT_AUDIO_INFO ::= STRUCT { -- mic Mic1ValueIndex<mic1ValueIndex> INT32, --mic1音量 Mic2ValueIndex<mic2ValueIndex> INT32, --mic2音量
终端规格 WEB_TERM_SPECS_ASN ::= STRUCT { --/* 终端规格 */ szAudioProtocol<audioProtocol> STRING [0..256], szVideoProtocol<videoProtocol>
附录 国家或者地区选项枚举值 时区选项枚举值 获取国家和时区可选范围列表的示例 颜色矩阵
国家或者地区选项枚举值 表1 国家或者地区代号 国家或地区名称 枚举值 安哥拉 0 阿根廷 1 澳大利亚 2 奥地利 3 比利时 4 贝宁 5 玻利维亚 6 巴西 7 柬埔寨 8 喀麦隆 9 加拿大 10 乍得 11 智利 12 中国 13 哥伦比亚 14 哥斯达黎加 15 古巴
时区选项枚举值 表1 时区代号 时区枚举表 枚举值 (GMT-12:00)日界线西 0 (GMT-11:00)中途岛,萨摩亚群岛 1 (GMT-10:00)夏威夷 2 (GMT-09:00)阿拉斯加 3 (GMT-08:00)太平洋时间(美国和加拿大) 4 (GMT-07:00)山地时间(美国和加拿大)
停止人脸检测 表1 停止人脸检测 REST URL格式 访问方法 URI POST /v1/ai/face-detection/stop 接口功能 停止人脸检测功能 接口说明 本接口调用后,人脸检测功能停止 响应数据 参见表2、表3 参数 参数名称 可选/必选/条件必选 参数类型
切换到windows系统 REST URL格式 访问方法 URI POST https://ip/action.cgi?ActionID=WEB_SwitchWindows 接口功能 本接口用于从安卓系统切换至windows系统。 接口说明 当前终端处于安卓系统表1下时,调用本接
硬终端开放性 设置霸屏应用包名 查询当前霸屏应用包名 设置HDMI有线投屏窗口大小和位置 查询终端光感信息 查询白板标注状态 开始白板标注 结束白板标注 查询入会时隐藏提示弹框配置项 设置入会时隐藏提示弹框配置项 打开摄像机 关闭摄像机 静默升级第三方应用 查询有线网络IPv4信息
设置霸屏应用包名 表1 设置应用霸屏 REST URL格式 访问方法 URI POST https://ip/action.cgi?ActionID=WEB_SetSingleAppAPI 接口功能 本接口用于设置霸屏应用的包名 接口说明 第三方应用调用接口设置当前屏上显示的应用