设置服务器地址信息 接口描述 调用此接口,可以设置对接的会议云服务的地址,可用于如果有代理时,连接到代理的地址。 SDK 连接时使用HTTPS协议和Web Socket Secure协议。
获取会议控制服务对象 接口功能 获取会议控制服务对象 函数原型 getConfCtrlApi(): IConfCtrl 返回值 IConfCtrl 父主题: UISDK接口管理对象
用户重置密码 描述 该接口提供给用户重置密码功能,服务器收到请求,重新设置用户密码并返回结果。 调试 您可以在API Explorer中调试该接口。
500 服务端异常。 响应参数 表3 响应参数 参数 类型 描述 usedAccountsCount Integer SP下所有企业已使用的会议并发数量。
WebSocket建链 描述 通过此接口,完成与会议服务器端会控WebSocket通道的建立。请求前缀通过会议控制中获取会控Token的接口可获取建链地址(wsURL)。请求鉴权处理失败时,会议服务器端会主动关闭WebSocket通道。
示例1:企业通讯录查询 应用场景 第三方通过企业用户(含管理员)账号登录成功后,可以查询所属企业的通讯录。 业务流程 图1 企业通讯录查询流程图 第三方通过企业用户账号、密码登录,获取Token。 初始化参数,填入查询偏移量、搜索条件等请求参数,第三方携带这些参数向网关APIG发送查询企业通讯录请求
邀请结果信息推送 该事件可以通知邀请会场的结果事件,或者会场离会的原因事件。 表1 邀请终端结果推送消息帧 参数 类型 描述 action String "InviteResultNotify" version Long 全量消息为:消息生成时的时间戳(毫秒)。 增量消息为:递增序列号
msgMode Integer 消息模式: 0:全量消息 1: 增量消息 confID String 订阅的会议ID data SubtitleData object 实时字幕信息,内容由实时字幕服务与终端约定。SubtitleData数据结构如下。
第三方服务端收到事情推送的POST请求后,都应响应200 OK消息。 父主题: 企业级会议事件推送设置
接口参考 设置事件推送 查询事件推送 删除事件推送 开启事件推送 父主题: 企业级会议事件推送设置
500 服务端异常 响应参数 表3 响应参数 参数 类型 描述 account String 管理员的华为云会议账号。 address String 企业所在地。 adminName String 管理员名称。 autoUserCreate Boolean 是否支持自动开户。
500 服务端异常 响应参数 表3 响应参数 参数 类型 描述 count Integer 总数量。 limit Integer 每页显示的条目数量。 默认值:10。 offset Integer 页面起始页,从0开始。
500 服务端异常。 响应参数 表3 响应参数 参数 类型 描述 usedRecStorage Double 当前已用录制存储空间(单位G)。 usedAccountsCount Integer 当前已用的会议并发数量。
500 服务端异常 响应参数 表3 响应参数 参数 类型 描述 createTime Long 创建时间。 endTime Long 结束时间。 id String 发布ID。 lastUpdatedBy String 更新者。 publishName String 发布名称。
500 服务端异常 响应参数 无 请求消息示例 PUT /v1/usg/dcs/corp Connection: keep-alive X-Access-Token: stbdOWTjFFPAoDfJaWFGWnOTtepUlEsfhQSC Content-Type: application
当服务器收到重置密码的请求时,发送新的密码到企业成员的邮箱或者短信,并返回结果。 调试 您可以在API Explorer中调试该接口。
服务器收到请求,返回校验结果。用户在前台界面通过滑块操作匹配图形,使得抠图和原图吻合。然后服务器进行校验滑块验证码。 调试 您可以在API Explorer中调试该接口。
服务器收到请求,返回抠图以及抠图后的原图等结果。需要在前台界面显示出抠图以及抠图后的原图,用户通过滑块操作来匹配图形。 图1 发送滑块验证示例图 调试 您可以在API Explorer中调试该接口。
500 服务端异常。 响应参数 无 请求消息示例 PUT /v1/mmc/control/conferences/inviteWithPwd?
会议基本信息推送 表1 会议基本信息推送消息帧 参数 类型 描述 action String "ConfBasicInfoNotify" version Long 消息的版本号,当前使用消息生成时的时间戳(毫秒)标识。 createTime Long 消息生成时的时间戳(毫秒)。