检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API概述 本文档主要介绍华为云会议服务对外开放的RESTful API,开发者可通过这些API将华为云会议的音视频会议功能集成到自己的业务系统中。 RESTful API请求URI由如下部分组成: {URI-scheme}://{Endpoint}/{resource-path}
scheduserUuid String 预订者uuid scheduserName String 预订者姓名 orgId String 企业id,可以用作判断是否外部用户 isWebinar boolean 是否是网络研讨会 isCreator boolean 是否是会议预订者 conferenceType
WebSocket建链 描述 通过此接口,完成与会议服务器端会控WebSocket通道的建立。请求前缀通过会议控制中获取会控Token的接口可获取建链地址(wsURL)。请求鉴权处理失败时,会议服务器端会主动关闭WebSocket通道。 该Websocket的连接在会议结束后服务端会主动拆除。
取消网络研讨会 描述 该接口用于取消已预约的网络研讨会。 调试 您可以在API Explorer中调试该接口。 接口原型 表1 接口原型 请求方法 DELETE 请求地址 /v1/wss/webinar/open/conferences/{conference_id} 传输协议 HTTPS
邀请结果信息推送 该事件可以通知邀请会场的结果事件,或者会场离会的原因事件。 表1 邀请终端结果推送消息帧 参数 类型 描述 action String "InviteResultNotify" version Long 全量消息为:消息生成时的时间戳(毫秒)。 增量消息为:递增序列号。
预约网络研讨会 描述 该接口用于创建网络研讨会。 调试 您可以在API Explorer中调试该接口。 接口原型 表1 接口原型 请求方法 POST 请求地址 /v1/wss/webinar/open/conferences 传输协议 HTTPS 请求参数 表2 参数说明 参数 是否必须
查询历史会议的与会者记录 描述 该接口用于查询指定历史会议的与会者记录。 调试 您可以在API Explorer中直接运行调试该接口。 接口原型 表1 接口原型 请求方法 GET 请求地址 /v1/mmc/management/conferences/history/confAttendeeRecord
场景描述 提供企业成员忘记密码后,需要重新设置新的密码。重置密码的过程包括以下五个步骤: 发送滑块验证码。 校验滑块验证码。 发送验证码。 校验验证码。 企业成员设置新密码。 父主题: 企业成员忘记密码
企业管理员修改企业注册信息 描述 企业管理员通过该接口修改企业注册信息。 调试 您可以在API Explorer中调试该接口。 接口原型 表1 接口原型 请求方法 PUT 请求地址 /v1/usg/dcs/corp 传输协议 HTTPS 请求参数 表2 参数说明 参数 是否必须 类型
企业管理员重置企业成员密码 描述 企业管理员通过该接口提供企业管理员重置企业成员密码的功能。当服务器收到重置密码的请求时,发送新的密码到企业成员的邮箱或者短信,并返回结果。 调试 您可以在API Explorer中调试该接口。 接口原型 表1 接口原型 请求方法 PUT 请求地址
会议基本信息推送 表1 会议基本信息推送消息帧 参数 类型 描述 action String "ConfBasicInfoNotify" version Long 消息的版本号,当前使用消息生成时的时间戳(毫秒)标识。 createTime Long 消息生成时的时间戳(毫秒)。
查询QoS告警阈值 描述 该接口用于查询QoS告警阈值。仅旗舰版企业的企业管理员有权限查询。 仪表盘的QoS统计功能需要申请才能开通。请联系华为销售人员,并提供华为云会议企业ID。 调试 您可以在API Explorer中调试该接口。 接口原型 表1 接口原型 请求方法 GET 请求地址
企业管理员查询企业注册信息 描述 企业管理员通过该接口查询企业注册信息。 调试 您可以在API Explorer中调试该接口。 接口原型 表1 接口原型 请求方法 GET 请求地址 /v1/usg/dcs/corp 传输协议 HTTPS 请求参数 表2 参数说明 参数 是否必须 类型
发送滑块验证码 描述 该接口提供发送滑块验证码的功能。服务器收到请求,返回抠图以及抠图后的原图等结果。需要在前台界面显示出抠图以及抠图后的原图,用户通过滑块操作来匹配图形。 图1 发送滑块验证示例图 调试 您可以在API Explorer中调试该接口。 接口原型 表1 接口原型 请求方法
会议ID和密码邀请与会者 描述 该接口用于通过会议ID和密码邀请与会者。一般用于App已知会议ID和来宾密码,通过扫码等方式获取其他终端的SIP号码后,使用该接口将其他终端邀请加入会议中。 需要管理员在企业的“会议设置”>“来宾扫码邀请任意硬终端入会”设置成打开,才允许通过来宾密码邀请其他终端入会。
用户重置密码 描述 该接口提供给用户重置密码功能,服务器收到请求,重新设置用户密码并返回结果。 调试 您可以在API Explorer中调试该接口。 接口原型 表1 接口原型 请求方法 PUT 请求地址 /v1/usg/acs/password/reset 传输协议 HTTPS 请求参数
SP管理员查询SP下资源使用信息 描述 SP管理员查询所属SP的共享资源使用信息。 调试 您可以在API Explorer中调试该接口。 接口原型 表1 接口原型 请求方法 GET 请求地址 /v1/mmc/management/spRes 传输协议 HTTPS 请求参数 表2 参数说明
实时字幕信息推送 描述 会议中任何人都可以通过该接口首次启动会议的实时字幕。当会议处于开启实时字幕状态时,会议中任何人都可以订阅实时字幕推送消息帧。 会议结束时,会议的实时字幕才会停止。 表1 请求文本 参数 类型 描述 action String 消息类型,必须为ConfControl。
编辑网络研讨会 描述 该接口用于修改已创建的网络研讨会。网络研讨会开始后不能修改。 调试 您可以在API Explorer中调试该接口。 接口原型 表1 接口原型 请求方法 PUT 请求地址 /v1/wss/webinar/open/conferences 传输协议 HTTPS 请求参数
接口参考 设置事件推送 查询事件推送 删除事件推送 开启事件推送 父主题: 企业级会议事件推送设置