检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
邀请外部与会者 handleInviteUserResult 接口描述 该接口支持邀请软终端用户和宝利通设备 注意事项 请在调用加入会议接口后再调用此接口 方法定义 1 handleInviteUserResult(userInfo):Promise<Result> 参数描述 表1
自定义本地录制路径 setLocalRecordPath 接口描述 用于自定义本地录制文件的存储路径。 注意事项 如果用户调用该接口指定了录制文件夹,则开启沙盒后不能重新创建,会写到默认路径。 方法定义 1 - (void)setLocalRecordPath:(NSURL *)url;
加入会议 接口描述 该接口用于加入会议。 注意事项 该接口可以在登录和未登录状态下加入会议。加入会议的方式有两种: 未登录:会议ID+会议密码(或Random码)入会。入参无需传入token字段 已登录: 会议ID + 会议密码 + Token 通过邮件会议通知中的会议链接入会时,
SSO登录 LoginBySSO 接口描述 该接口用于通过SSO的方式登录和鉴权。需要先通过GetSSOAuthorizeUrl接口获取到鉴权code。GetSSOAuthorizeUrl通过传域名获取到鉴权网站,用户在网站上输入账号+密码或者扫码完成鉴权获取到临时code(使用code完成登录)。
退出登录 logout 接口描述 该接口用于退出已登录的会议账号。 注意事项 请在已登录的场景下调用。 回调error表示错误信息,nil表示成功。。 方法定义 1 - (void)logout:(_Nonnull HWMSDKCompleteHandler)callback;
查询与会者的QoS数据 描述 该接口用于查询企业内在线会议或历史会议的与会者QoS数据。仅旗舰版企业的企业管理员有权限查询。 仪表盘的QoS统计功能需要申请才能开通。请联系华为销售人员,并提供华为云会议企业ID。 调试 您可以在API Explorer中调试该接口。 接口原型 表1
App ID方式登录 1 HWMSdk.getOpenApi.loginByAppId(AppIdAuthParam,HwmCallback) 接口描述 该接口用于通过App ID的方式登录和鉴权。 注意事项 除匿名入会外,在使用其他业务之前必须进行成功登录。 登录成功以后会发送登录成功事件onSuccess回调。
SDK已知安全漏洞修复说明 表1 SDK已知安全漏洞及修复版本 安全漏洞描述 涉及SDK 修复版本 版本发布时间 更新OpenSSL版本到 3.0.7,修复漏洞: CVE-2023-0215 CVE-2023-2650 CVE-2023-0216 CVE-2022-4304 CVE-2023-0217
退出登录 logout 接口描述 该接口用于退出已登录的会议账号。 注意事项 请在已登录的场景下调用。 回调error表示错误信息,nil表示成功。 方法定义 1 - (void)logout:(_Nonnull HWMSDKLogoutCompleteHandler)callback;
会议状态变更通知 在OpenSDKConfig中配置会议UI页面变更相关的通知监听 入会的时候UI创建,离会的时候销毁UI 使用场景 入会场景:onConfDetailNotify 离会场景:onConfEnded、onLeaveConf 弱网提示:onPoorNetworkQualityInfoNotify
发起投屏 StartProjection 接口描述 该接口用于发起投屏。 注意事项 该接口在已登录状态下才能调用。 该接口为异步接口,返回值只代表接口是否调用成功,实际业务处理结果在对应的回调函数中返回。 方法定义 1 HWM_SDK_AGENT_API hwmsdk::HwmErrCode
场景3:预约会议 描述 登录后,可以调用接口预约会议。 业务流程 使用SDK预约会议时,先调用bookConf接口,然后处理回调callback。 接口调用 调用bookConf预约会议。 处理回调 处理回调callback。 示例代码 1 2 3 4 5 6 7
场景12:退出 描述 在第三方APP退出时,需要去初始化SDK,否则名称为HwmSdk.exe的进程(Electron SDK的windows 64位下的主进程)一直在后台运行,仅针对windows 64位平台。 业务流程 需要退出SDK时,调用Exit同步接口。 接口调用 调用Exit退出SDK。
场景3:预约会议 描述 登录后,可以调用接口预约会议。 业务流程 使用SDK预约会议时,先调用bookConf接口,然后处理回调callback。 接口调用 调用bookConf预约会议。 处理回调 处理回调callback。 示例代码 1 2 3 4 5 6 7
发起立即会议 startP2PConf 接口描述 该接口用于发起立即会议。 注意事项 1. 实际业务处理结果在对应的callback回调中。 方法定义 - (void)startP2PConf:(HWMStartP2PConfParam *)param callback:(_Nonnull
场景5:创建会议 描述 登录后,可以调用创建会议接口创建立即会议。创建会议时可以携带与会人信息,也可以不携带。 在登录状态下,才能创建会议。 业务流程 使用SDK创建立即会议时,先调用CreateConf接口,然后处理回调callback。 接口调用 组装模型HWMCreateConfParam。
SP管理员查询SP下资源使用信息 描述 SP管理员查询所属SP的共享资源使用信息。 调试 您可以在API Explorer中调试该接口。 接口原型 表1 接口原型 请求方法 GET 请求地址 /v1/mmc/management/spRes 传输协议 HTTPS 请求参数 表2 参数说明
登录 登录分为账号密码鉴权登录和App ID鉴权登录。 login:password: 接口描述 该接口用于通过账号密码鉴权登录。 注意事项 创建会议,被邀入会等功能只有在登录后才能使用,若不登录,将无法体验完整会议功能。 回调error表示错误信息,nil表示成功。 方法定义 1
取消周期会议 接口描述 该接口用于取消未开始的周期会议。 注意事项 周期会议未全部结束前可以调用接口,结束后调用则无效。 方法定义 1 2 3 4 5 6 7 /** * 取消周期会议 * * @param cycleConfId 周期会议Id
场景3: App ID方式登录 描述 在使用云会议服务之前,如果申请了App ID,可使用App ID的方式进行登录,不需要账号和密码 在未登录状态下,只能加入已经创建的会议。 业务流程 接口调用 创建登录参数AppIdAuthParam。 设置第三方账号的唯一标识。 设置随机字符串。