检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
登录 Login 接口描述 该接口用于登录。登录分为华为云会议账户登录和AppID登录,由authType参数决定。 注意事项 创建会议,被邀入会等功能只有在登录后才能使用,若不登录,将无法体验完整会议功能。 该接口为异步接口,返回值只代表接口是否调用成功,实际业务处理结果在对应的回调函数中返回。
场景3: App ID方式登录 描述 在使用云会议服务之前,如果申请了App ID,可使用App ID的方式进行登录,不需要账号和密码 在未登录状态下,只能加入已经创建的会议。 业务流程 接口调用 创建登录参数AppIdAuthParam。 设置第三方账号的唯一标识。 设置随机字符串。
校验滑块验证码 描述 该接口提供校验滑块验证码的功能。服务器收到请求,返回校验结果。用户在前台界面通过滑块操作匹配图形,使得抠图和原图吻合。然后服务器进行校验滑块验证码。 调试 您可以在API Explorer中调试该接口。 接口原型 表1 接口原型 请求方法 PUT 请求地址
通过Web界面快速配置 如果您已获取硬件终端的IP地址,可以通过Web界面的设置向导,对终端进行快速设置。 登录Web界面,选择“系统配置 > 设置向导”,进入“设置向导”界面,如图1所示,参数说明如表1所示。 图1 基本信息和IP设置 表1 基本信息和IP设置 参数名称 如何理解
App ID方式登录 1 HWMSdk.getOpenApi.loginByAppId(AppIdAuthParam,HwmCallback) 接口描述 该接口用于通过App ID的方式登录和鉴权。 注意事项 除匿名入会外,在使用其他业务之前必须进行成功登录。 登录成功以后会发送登录成功事件onSuccess回调。
创建会议 接口功能 该接口用于创建即时会议。注意事项:1、该接口默认已将自己作为主持人加入会议,调用接口时,在与会者参数中不需要带上自己的信息; 2、若需要在创建会议的同时邀请其他与会者,需要传入其他与会者信息。若不需要,与会者信息和与会者个数可以为空。 函数原型 createConf(createConfInfo:
校验短信/邮件验证码 描述 该接口提供校验验证码的功能,服务器收到请求,返回结果。 调试 您可以在API Explorer中调试该接口。 接口原型 表1 接口原型 请求方法 PUT 请求地址 /v1/usg/acs/verifycode/check 传输协议 HTTPS 请求参数
修订记录 表1 修订记录 日期 版本 修订内容 2025-1-2 100.12.5 1. 新增本地录制状态更新通知onSelfLocalRecordStateNotify。 2. 发起立即会议接口新增参数是否来宾免密isGuestJoinConfWithoutPwd、允许入会范围
订阅会议列表通知 接口功能 收到该通知时,表示会议列表信息发生变更。 函数原型 setOnConfListChangedCB(onConfListChanged: (confListInfo: ConfListInfo) => void): void 请求参数 表1 入参说明 参数名称
用户重置密码 描述 该接口提供给用户重置密码功能,服务器收到请求,重新设置用户密码并返回结果。 调试 您可以在API Explorer中调试该接口。 接口原型 表1 接口原型 请求方法 PUT 请求地址 /v1/usg/acs/password/reset 传输协议 HTTPS 请求参数
通过Web界面快速配置 如果您已获取硬件终端的IP地址,可以通过Web界面的设置向导,对终端进行快速设置。 登录Web界面,选择“系统配置 > 设置向导”,进入“设置向导”界面,如图1所示,参数说明如表1所示。 图1 基本信息和IP设置 表1 基本信息和IP设置 参数名称 如何理解
企业管理员重置企业成员密码 描述 企业管理员通过该接口提供企业管理员重置企业成员密码的功能。当服务器收到重置密码的请求时,发送新的密码到企业成员的邮箱或者短信,并返回结果。 调试 您可以在API Explorer中调试该接口。 接口原型 表1 接口原型 请求方法 PUT 请求地址
修订记录 表1 修订记录 日期 版本 修订内容 2025-01-10 100.12.6 问题修复,体验更稳定。 具体使用请见100.12.6更新内容 2024-12-31 100.12.5 HWMStartP2PConfParam新增是否来宾免密码入会isGuestJoinCon
获取会议列表 接口功能 该接口用于获取会议列表(仅对mac平台生效)。注意事项:1、已登录状态,首次收到会议列表通知之后,调用才有效,否则返回为空的列表 函数原型 getConfList(onGetConfListResult?: (ret: SDKERR, reason: string
发送短信/邮件验证码 描述 该接口提供发送验证码的功能,服务器收到请求,发送验证码到邮箱或者短信并返回结果。用户在前台界面通过滑块验证后,再进行发送验证码操作。 调试 您可以在API Explorer中调试该接口。 接口原型 表1 接口原型 请求方法 POST 请求地址 /v1/
修改密码 描述 企业成员通过该接口实现用户修改密码功能,服务器收到请求,修改用户密码并返回结果。 调试 您可以在API Explorer中调试该接口。 接口原型 表1 接口原型 请求方法 PUT 请求地址 /v1/usg/acs/password 传输协议 HTTPS 请求参数 表2
设置视图显示 注意事项 请在调用加入会议接口后再调用此接口。 接口描述 Web SDK中已经提供了会议中的界面,界面上的部分元素是否显示通过该接口配置。 图1 会议窗口的显示控制 如图上图所示,当前SDK支持的窗口显示控制包含: 1. 窗口标题栏 2. 聊天框 3. 与会者列表 4
预约会议 接口描述 该接口用于预约会议。 注意事项 不在登录状态下,不应调用该接口。 会议开始时间必须晚于当前时间,会议时长应大于15分钟。 个人会议或者云会议室的时候要传入vmrId。 携带与会者入会的时候需要传入attendees。 callback中的result返回会议详情信息(ConfInfo类型说明)
校验Token 描述 该接口提供校验token合法性功能。服务器收到请求后,验证token合法性并返回结果。如果参数needGenNewToken为true时,生成新的token并返回。 调试 您可以在API Explorer中调试该接口。 接口原型 表1 接口原型 请求方法 POST
获取会议详情 接口功能 该接口用于获取会议的详细信息。注意事项:1、该接口在已登录状态下才能调用。 函数原型 getConfDetail(getConfDetailParam: GetConfDetailParam, onGetConfDetailResult?: (ret: SDKERR