检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
描述 通过此接口,完成与会议服务器端会控WebSocket通道的建立。请求前缀通过会议控制中获取会控Token的接口可获取建链地址(wsURL)。请求鉴权处理失败时,会议服务器端会主动关闭WebSocket通道。 该Websocket的连接在会议结束后服务端会主动拆除。 接口原型 表1
状态码 表3 状态码说明 HTTP状态码 描述 200 操作成功。 400 参数异常。 401 未鉴权或鉴权失败。 403 权限受限。 500 服务端异常。 响应参数 无 请求消息示例 DELETE /v1/wss/webinar/conferences/989692846 HTTP/1
无法处理的请求。 401 未鉴权或鉴权失败。 413 图片大小过大,目前服务端大小限制最大为10MB,具体限制可受网络中前置负载均衡影响。 415 不支持的数据类型,意味着上传的图片类型无法解析或者不支持。 500 服务端异常。 响应参数 无 请求消息示例 POST /v1/usg/a
证”请求,第三方服务端需要按照要求返回响应,响应中带的nonce必须跟上述请求中保持一致。请参考接口启用验证事件。 启用成功后,企业内的会议事件产生后,华为云会议后台会给指定的URL推送相应的事件。请参考接口会议开始事件、会议结束事件和会议关闭事件。 第三方服务端收到事情推送的POST请求后,都应响应200
会控操作 setConfConfig 接口描述 进行会控操作 注意事项 请在调用加入会议接口后再调用此接口 方法定义 1 setConfConfig(config):Promise<Result> 相关事件 会控状态变更通知 参数描述 表1 参数说明 参数 是否必须 类型 描述
用户重置密码 描述 该接口提供给用户重置密码功能,服务器收到请求,重新设置用户密码并返回结果。 调试 您可以在API Explorer中调试该接口。 接口原型 表1 接口原型 请求方法 PUT 请求地址 /v1/usg/acs/password/reset 传输协议 HTTPS 请求参数
状态码 表3 状态码说明 HTTP状态码 描述 200 操作成功。 400 参数异常。 401 未鉴权或鉴权失败。 403 权限受限。 500 服务端异常。 响应参数 表4 响应参数 参数 类型 描述 usedAccountsCount Integer SP下所有企业已使用的会议并发数量。
示例1:企业通讯录查询 应用场景 第三方通过企业用户(含管理员)账号登录成功后,可以查询所属企业的通讯录。 业务流程 图1 企业通讯录查询流程图 第三方通过企业用户账号、密码登录,获取Token。 初始化参数,填入查询偏移量、搜索条件等请求参数,第三方携带这些参数向网关APIG发送查询企业通讯录请求。
1: 增量消息 confID String 订阅的会议ID data SubtitleData object 实时字幕信息,内容由实时字幕服务与终端约定。SubtitleData数据结构如下。 表4 SubtitleData数据结构 参数 类型 描述 msgs Msgs<0..*>
状态码 表3 状态码说明 HTTP状态码 描述 200 操作成功。 400 参数异常。 401 未鉴权或鉴权失败。 403 权限受限。 500 服务端异常。 响应参数 无 请求消息示例 PUT /v1/wss/webinar/conferences HTTP/1.1 Host: 251
接口参考 设置事件推送 查询事件推送 删除事件推送 开启事件推送 父主题: 企业级会议事件推送设置
邀请结果信息推送 该事件可以通知邀请会场的结果事件,或者会场离会的原因事件。 表1 邀请终端结果推送消息帧 参数 类型 描述 action String "InviteResultNotify" version Long 全量消息为:消息生成时的时间戳(毫秒)。 增量消息为:递增序列号。
状态码 表5 状态码说明 HTTP状态码 描述 200 操作成功。 400 参数异常。 401 未鉴权或鉴权失败。 403 权限受限。 500 服务端异常。 响应参数 表6 响应参数 参数 类型 描述 conferenceId String 网络研讨会ID。 corpId String
场景5:离开会议 描述 在第三方网页需要离开会议时,需要调用SDK的leaveConf接口,如果强制结束进程或者关闭网页,可能会导致该离会用户在其他用户的与会者列表中,仍存在一小段时间。 业务流程 需要离开会议时,先调用leaveConf接口,然后处理回调事件leave_conf_result。
设置切换到后台后是否允许麦克风收音 接口描述 调用此接口,可以设置切换到后台后是否允许麦克风收音。 1、该接口在入会前和入会中均可设置。 2、如果不调用该接口,PC端默认切换到后台后允许麦克风收音,移动端默认切换到后台后不允许麦克风收音。 方法定义 setAllowVisibil
状态码 表3 状态码说明 HTTP状态码 描述 200 操作成功。 400 参数异常。 401 未鉴权或鉴权失败。 403 权限受限。 500 服务端异常 响应参数 无 请求消息示例 PUT /v1/usg/dcs/corp Connection: keep-alive X-Access-Token:
企业管理员重置企业成员密码 描述 企业管理员通过该接口提供企业管理员重置企业成员密码的功能。当服务器收到重置密码的请求时,发送新的密码到企业成员的邮箱或者短信,并返回结果。 调试 您可以在API Explorer中调试该接口。 接口原型 表1 接口原型 请求方法 PUT 请求地址
状态码 表3 状态码说明 HTTP状态码 描述 200 操作成功。 400 参数异常。 401 未鉴权或鉴权失败。 403 权限受限。 500 服务端异常 响应参数 表4 响应参数 参数 类型 描述 count Integer 总数量。 limit Integer 每页显示的条目数量。
状态码 表3 状态码说明 HTTP状态码 描述 200 操作成功。 400 参数异常。 401 未鉴权或鉴权失败。 403 权限受限。 500 服务端异常 响应参数 表4 响应参数 参数 类型 描述 createTime Long 创建时间。 endTime Long 结束时间。 id
会议基本信息推送 表1 会议基本信息推送消息帧 参数 类型 描述 action String "ConfBasicInfoNotify" version Long 消息的版本号,当前使用消息生成时的时间戳(毫秒)标识。 createTime Long 消息生成时的时间戳(毫秒)。