更新时间:2024-04-29 GMT+08:00

API概述

本文档主要介绍华为云会议服务对外开放的RESTful API,开发者可通过这些API将华为云会议的音视频会议功能集成到自己的业务系统中。

RESTful API请求URI由如下部分组成:

{URI-scheme}://{Endpoint}/{resource-path}?{query-string}。

表1 URI中的参数说明

参数

描述

URI-scheme

表示用于传输请求的协议,当前所有API均采用HTTPS协议。

Endpoint

国际站的Endpoint是api-intl.meeting.huaweicloud.com。

resource-path

资源路径,也即API访问路径。

query-string

查询参数,是可选部分,并不是每个API都有查询参数。

API分类

表2 API分类

接口

描述

登录鉴权

获取鉴权、刷新鉴权、注销鉴权及SSO鉴权配置。

会议管理

预约会议、编辑或取消预约会议、查询会议列表及会议信息。创建周期会议、编辑或取消周期会议,编辑或取消周期会议子会议。

会议控制

加入会议后的会控操作,包括添加与会者、静音、多画面设置、申请/释放主持人等基本会控,还包括点名、广播会场、录播等会控操作。

会议事件推送

  • 通过Websocket推送单个指定会议的信息,包括:会议基本信息、会议状态、在线与会者、发言方状态、会议媒体质量状态、实时字幕等。
  • 通过Webhook推送企业级的会议信息,包括:会议开始、会议结束。

企业管理

对企业的管理,包括企业管理员查询、修改企业注册信息,企业管理员查询企业内资源及业务权限以及SP管理员创建、删除、查询、修改,搜索企业等功能。

企业部门管理

企业中部门的添加、修改、删除以及部门信息查询等功能。

用户管理

企业中用户账号的管理,包括添加、修改、删除用户以及查询用户详情、修改用户的手机或邮箱等功能。

企业管理员管理

对企业管理员的管理,包括添加、删除、查询等功能。

硬终端管理

对硬终端的管理,包括硬终端的添加、修改、删除、查询以及重置激活码等功能。

云会议室管理

对云会议室的管理,包括云会议室的查询、删除、分配、回收以及个人用户关联的云会议室的查询和修改功能。

用户密码管理

对企业用户的密码的管理,包括企业用户修改密码、企业用户忘记密码重置、以及企业管理员重置企业成员密码等功能。

查询企业通讯录

企业通讯录的查询功能。

企业资源管理

对企业资源的管理,包括分配、删除、修改、分页查询企业资源以及分页查询企业资源操作记录等功能。

会议纪要

IdeaHub等电子版本上生成的会议纪要内容的管理,包括打开文件列表、保存到个人空间、查询列表、查询详情

信息窗管理

  • 信息窗发布管理:

对信息窗发布的管理,包括新增、删除、查询、修改信息窗发布以及查询信息窗发布详情等功能。

  • 信息窗节目管理:

对信息窗节目的管理,包括新增、删除、查询、修改信息窗节目以及查询信息窗节目详情等功能。

  • 信息窗素材管理:

对信息窗素材的管理,包括新增、删除、更新、分页查询信息窗素材等功能。