检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API概述 本文档主要介绍华为云会议服务对外开放的RESTful API,开发者可通过这些API将华为云会议的音视频会议功能集成到自己的业务系统中。 RESTful API请求URI由如下部分组成: {URI-scheme}://{Endpoint}/{resource-path}
旗舰版套餐 华为云会议旗舰版套餐中可以选择搭配包年/包月、一次性计费的会议资源。 本章节将介绍华为云会议旗舰版套餐的计费规则。 适用场景 华为云会议旗舰版套餐适用于中大型企业在线办公、会议、培训、跨地域沟通的会议场景,为企业提供云端一体、高质量、安全可靠、全球化的专业云会议服务。
登录 登录分为账号密码鉴权登录和App ID鉴权登录。 login:password: 接口描述 该接口用于通过账号密码鉴权登录。 注意事项 创建会议,被邀入会等功能只有在登录后才能使用,若不登录,将无法体验完整会议功能。 回调error表示错误信息,nil表示成功。 方法定义 1
登录 登录分为账号密码鉴权登录和App ID鉴权登录。 login:password: 接口描述 该接口用于通过账号密码鉴权登录。 注意事项 创建会议,被邀入会等功能只有在登录后才能使用,若不登录,将无法体验完整会议功能。 回调error表示错误信息,nil表示成功。 方法定义 1
查询在线会议列表 描述 该接口用于查询正在召开的会议列表。管理员可以查询本企业内所有在线会议,普通用户仅能查询自己账号创建或者需要参加的在线会议。不带查询参数时,默认查询权限范围内的在线会议,按开始时间升序排列。 调试 您可以在API Explorer中调试该接口。 接口原型 表1
创建周期性会议 描述 该接口用于预约周期性会议。 调试 您可以在API Explorer中调试该接口。 接口原型 表1 接口原型 请求方法 POST 请求地址 /v1/mmc/management/cycleconferences 传输协议 HTTPS 请求参数 表2 参数说明 参数
查询企业级会议已购资源使用统计数据 描述 该接口用于查询企业内已购资源使用状况数据统计: 查询已购资源使用状况,按日/按月统计。 仅旗舰版企业的企业管理员有权限查询。 调试 您可以在API Explorer中调试该接口。 接口原型 表1 接口原型 请求方法 GET 请求地址 /v
创建会议 描述 该接口用于创建立即会议和预约会议。 调试 您可以在API Explorer中调试该接口。 接口原型 表1 接口原型 请求方法 POST 请求地址 /v1/mmc/management/conferences 传输协议 HTTPS 请求参数 表2 参数说明 参数 是否必须
预约周期会议 BookCycleConf 接口描述 该接口用于预约周期会议。 注意事项 该接口在已登录状态下才能调用。 该接口为异步接口,返回值只代表接口是否调用成功,实际业务处理结果在对应的回调函数中返回。 会议开始时间必须晚于当前时间,会议时长应大于15分钟。 携带与会者入会的时候需要传入attendees。
查询企业级会议的用户统计数据 描述 该接口用于查询企业内用户数据统计: 查询会议用户登录数据,按日/按月统计。 查询会议用户激活数据,按日/按月统计。 查询会议用户登录设备数据,按日/按月统计。 仅旗舰版企业的企业管理员有权限查询。 调试 您可以在API Explorer中调试该接口。
查询会议列表 描述 该接口用于查询尚未结束的会议。 管理员可以查询本企业内所有的会议,普通用户仅能查询自己创建或者需要参加的会议。不带查询参数时,默认查询权限范围内正在召开或还未召开的会议。 只能查询尚未结束的会议(既正在召开的会议和已预约还未召开的会议)。如果需要查询历史会议列表,请参考查询历史会议列表。
查询录制列表 描述 该接口用于查询会议录制列表。管理员可以查询本企业内所有的录制,普通用户仅能查询自己创建的会议的录制。不带查询参数时,默认查询权限范围内的录制。 调试 您可以在API Explorer中调试该接口。 接口原型 表1 接口原型 请求方法 GET 请求地址 /v1/
查询在线会议详情 描述 该接口用于查询正在召开的会议详情。管理员可以查询本企业内所有的在线会议详情,普通用户仅能查询自己账号创建或者需要参加的在线会议详情。 调试 您可以在API Explorer中调试该接口。 接口原型 表1 接口原型 请求方法 GET 请求地址 /v1/mmc
查询企业级会议总体统计数据 描述 该接口用于查询企业内会议数据统计: 单日内按小时统计的会议数据。 指定日期范围内按日/按月统计的会议数据。 仅旗舰版企业的企业管理员有权限查询。 调试 您可以在API Explorer中调试该接口。 接口原型 表1 接口原型 请求方法 GET 请求地址
查询历史会议详情 描述 该接口用户查询指定历史会议的详情。管理员可以查询本企业内所有的历史会议详情,普通用户仅能查询自己创建或者被邀请的历史会议详情。 调试 您可以在API Explorer中直接运行调试该接口。 接口原型 表1 接口原型 请求方法 GET 请求地址 /v1/mm
订阅会中信息更新通知 接口功能 订阅会中信息更新通知 函数原型 setOnMeetingInfoChangedCB(onMeetingInfoChanged: (meetingInfo: MeetingInfo) => void): void 请求参数 表1 入参说明 参数名称 是否必选
修订记录 表1 修订记录 日期 版本 修订内容 2022-11-11 28 新增申请联席主持人、批量举手、准入等候室、移入等候室、允许客户端录制、查询多画面布局、保存多画面布局、删除多画面布局。 2022-03-30 27 新增激活会议。 2021-09-26 26 新增SSO登
常见错误码 表1 HwmErrCode枚举说明 变量 值 描述 HWM_COMMON_ERR_FAILED 1 通用错误。 HWM_COMMON_ERR_PARAM_ERROR 2 参数错误。 HWM_LOGIN_ERR_ACCOUNT_OR_PASSWORD_ERROR 10006
查询企业级会议与会统计数据 描述 该接口用于查询企业内与会者数据统计: 查询与会用户统计数据,按日/按月统计。 查询与会硬件终端统计数据,按日/按月统计。 查询与会设备统计数据,按日/按月统计。 仅旗舰版企业的企业管理员有权限查询。 调试 您可以在API Explorer中调试该接口。
编辑预约会议 描述 该接口用于修改已预约的会议。会议开始后,不能被修改。 调试 您可以在API Explorer中调试该接口。 接口原型 表1 接口原型 请求方法 PUT 请求地址 /v1/mmc/management/conferences 传输协议 HTTPS 请求参数 表2