REST API 概览

最近更新时间:2025-03-05 18:02:22

我的收藏

基础 API

账户管理

模块
API
说明
自建应用(AK/SK)
三方应用(OAuth2.0)
企业用户管理
创建企业用户。
支持
不支持
删除企业用户。
支持
不支持
更新企业用户。
支持
不支持
获取该企业下的用户基本信息。
支持
支持
使用 userid 获取企业用户详情。
支持
不支持
获取企业用户列表。
支持
不支持
获取企业用户列表。
支持
不支持
发送认证短信或邮件,邀请用户认证账号,用户确认后账号变为激活态。
支持
不支持
未激活的账号,可以获取激活链接。
支持
不支持
查询指定会议的用户的 ms_open_id。
支持
支持
使用 userid 启用或禁用本企业下的用户。
支持
不支持
获取用户个人会议号配置信息。
支持
不支持
修改用户个人会议号配置信息。
支持
不支持
取消用户的授权。
不支持
支持
将三方应用获取到 open_id 转换为本企业用户的 userid。
支持
不支持
针对已删除企业用户,将该用户账号下的资产移交给指定在职用户。
支持
不支持
通过 userid 发送验证短信,邀请成员验证账号。
支持
不支持
未验证的账号,可以获取验证链接。
支持
不支持
企业资源管理
拥有用户管理权限的用户可以为企业下账号设置 AI 账号能力。
支持
不支持
拥有用户管理权限的用户可移除企业下账号的 AI 能力。
支持
不支持
拥有用户查看权限的用户可以查看企业下各类型账号资源的统计数据。
支持
不支持
当账户类型为企业版时,可设置企业成员发起会议的权限。
支持
不支持
当账户类型为企业版时,可查询企业下可发起会议的成员列表。
支持
不支持
当账户类型为企业版且当前企业发起会议权限为部分用户可发起会议时,可批量移除企业下用户可发起会议的权限。
支持
不支持
当账户类型为企业版或教育版时,可为企业下具有发起会议权限的成员预留虚拟会议室。
支持
不支持
当账户类型为企业版或教育版时,可查询企业预留虚拟会议室成员列表。
支持
不支持
当账户类型为企业版或教育版时,可批量移除企业下具有发起会议权限用户已预留的虚拟会议室。
支持
不支持
获取账户中在指定时间段内即将召开的会议列表。
支持
不支持
获取账户中正在进行中的会议列表。
支持
不支持
获取账户中在指定时间段内已经结束的会议列表。
支持
不支持
企业部门管理
创建企业部门。
支持
不支持
更新企业部门信息。
支持
不支持
删除企业部门。
支持
不支持
查询企业部门信息。
支持
不支持
查询企业部门列表。
支持
不支持
查询企业部门用户列表。
支持
不支持
企业成员管理
获取账户中的所有用户列表。
支持
不支持
获取账户中的所有角色列表。
支持
不支持
取账户中的被分配给某一个角色的所有用户列表。
支持
不支持
批量为企业成员分配角色,仅有角色编辑权限的用户可调用接口。
支持
不支持
批量变更企业成员角色,仅有角色编辑权限的用户可调用接口。
支持
不支持
删除企业角色,仅有角色编辑权限的用户可调用接口。
支持
不支持
查询管理员在企业管理 Web 端的操作行为日志。
支持
不支持
查询成员登录登出、会议管理、会议控制等行为的记录。
支持
不支持

会前管理

模块
API
说明
自建应用(AK/SK)
三方应用(OAuth2.0)
会议管理
快速创建或预定一个会议。
支持
支持
用户能取消自己创建的会议和自己所管理企业下的会议。
支持
支持
修改某指定会议的会议信息。
支持
支持
查询会议详情。
支持
支持
待开始的会议,会议创建者可以设置统一虚拟背景,并设置生效范围。
支持
支持
参会成员管理
根据会议 ID 设置邀请成员,只有会议的创建者才有权限设置。
支持
支持
查询会议嘉宾列表。
支持
支持
修改会议嘉宾列表。
支持
支持
报名管理
支持查询会议中已报名成员的报名 ID。
支持
支持
修改会议的报名配置和报名问题。
支持
支持
查询会议的报名配置和报名问题。
支持
支持
批量审批会议的报名信息。
支持
支持
查询已报名观众数量和报名观众答题详情。
支持
支持
指定会议中导入报名信息。
支持
支持
删除指定会议的报名信息,支持删除用户手动报名的信息和导入的报名信息。
支持
支持
专属参会链接
创建用户专属参会链接。
支持
不支持
获取指定会议的所有专属参会链接。
支持
不支持
等候室管理
为已开启等候室的会议配置等候室欢迎语。
支持
支持
查询会议的等候室欢迎语。
支持
支持
应用管理
绑定扩展应用到某一个会议,重复调用时后面的调用会覆盖前面的绑定信息。
支持
支持
查询绑定的扩展应用。
支持
支持
绑定扩展应用到某一个会议,可给应用传入 unique_code。
支持
支持
文档管理
根据会议 ID 获取会议下的文档列表。
支持
支持
根据用户 ID 获取用户创建会议下的文档列表。
支持
支持
当用户为会议创建者时,可修改会议下文档的权限。
支持
支持
当用户为会议创建者、主持人、联席支持人时,可以为会议上传文档。文档上传为异步上传。
支持
支持
当用户为会议创建者时,可删除会议下指定文档。
支持
支持
会议布局管理
查询企业下所有的布局模板列表。
支持
不支持
根据会议 ID 返回会议的布局定义信息列表。
支持
不支持
根据会议 ID 和用户 ID 返回用户的布局设置信息。
支持
不支持
对成功预定的会议添加会议布局,支持多个布局的添加。
支持
不支持
对当前会议添加高级自定义布局,支持批量添加。
支持
不支持
根据布局 ID 对设置好的会议布局进行修改。
支持
不支持
对会议中的布局进行修改。
支持
不支持
对成功预定的会议设置默认布局。
支持
不支持
根据布局 ID 删除单个会议布局。
支持
不支持
根据布局 ID 删除多个会议布局。
支持
不支持
根据布局 ID 批量删除布局。
支持
不支持
根据会议 ID 返回会议布局列表信息。
支持
不支持
将会议中的高级自定义布局应用到指定成员或者整个会议。
支持
不支持
会议背景管理
对成功预定的会议添加会议背景,支持多个背景图片的添加。
支持
不支持
对成功预定的会议设置默认背景。
支持
不支持
根据背景 ID 删除单个会议背景。
支持
不支持
根据背景 ID 删除多个会议背景。
支持
不支持
根据会议 ID 返回会议背景列表信息。
支持
不支持

会中管理

模块
API
说明
自建应用(AK/SK)
三方应用(OAuth2.0)
会议控制
设置会议中的会议属性,例如:全体静音、锁定会议等。
支持
支持
设置或撤销会议中的参会者联席主持人身份。
支持
支持
将会议中用户移出会议,操作者必须是会议的创建者、主持人或者联席主持人才可以设置。
支持
支持
会议中用户静音操作。
支持
支持
关闭会议中用户屏幕共享权限。
支持
支持
关闭指定用户视频,支持关闭或开启 MRA 设备的视频。
支持
支持
设置会议中文档上传权限。
支持
支持
会议等候室设置,允许主持人或创建者将等候室成员移入会议等操作。
支持
支持
结束一个进行中的会议。
支持
支持
会中修改参会者昵称,支持创建者、主持人和联席主持人对会中成员进行改名。
支持
支持
语音转写
开启/关闭会中实时语音转写,调用时需要会议处于进行中的状态。
支持
支持
会议创建者可开启本场会议的实时转写内容推送。
支持
支持
通过接口自定义设置字幕、转写、智能录制等功能的热词。
支持
支持
会议开启了实时转写,可以导出转写记录。
支持
支持
直播管理
通过会议 ID 修改直播配置信息。
支持
不支持
通过会议 ID 查询直播回看信息。
支持
不支持
根据会议 ID 和直播房间 ID 删除该直播房间 ID 下的直播回看文件。
支持
不支持
可根据会议 ID 在会前和会中设置直播推流地址。
支持
不支持
当用户为企业管理员或会议创建者时,可根据会议 ID 获取直播观看人数。
支持
不支持
可根据会议 ID 在会前,会中和会后查询直播推流地址。
支持
不支持
签到管理
会议创建者和主持人可以对会议发起签到。
支持
支持
会议创建者和主持人能够在签到时间未到之前终止签到。
支持
支持
会中会议创建者和主持人可以查询会议签到列表。
支持
支持
会中会议创建者和会议主持人可以导出一次签到的签到记录。
支持
支持
投票管理
为指定的会议创建投票。
支持
支持
修改投票主题信息。
支持
支持
查询指定会议的投票列表。
支持
支持
查投票模板的详细信息,包括问题、选项,但不包括投票结果。
支持
支持
查投票的详情。
支持
支持
删除会议投票。
支持
支持
使用已有的投票主题发起投票。
支持
支持
结束指定会议的投票。
支持
支持

会议报告

模块
API
说明
自建应用(AK/SK)
三方应用(OAuth2.0)
会议信息查询
支持查询网络研讨会参会成员列表。
支持
支持
导出参会成员单场会议的累计参会时长,用于教学、培训等场景的考勤分析等。
支持
支持
根据会议 ID 获取受邀成员列表。
支持
支持
获取异步导出任务的结果。
支持
支持
可以查询等候室成员列表,包括等候室内所有用户的进出记录。
支持
支持
查询已结束会议的会议及参会成员的健康度。
支持
支持
企业开启聊天存档功能后,拥有会议管理权限的用户可以导出同企业下创建的会议的会中公共聊天内容。
支持
不支持
用户信息查询
获取某指定用户的进行中或待开始的会议列表。
支持
支持
获取某指定用户的已结束的会议列表。
支持
支持
查询个人会议号(PMI)会议的会议列表(进行中、已结束)。
支持
不支持
查询本企业用户在当前时间是否有设备进入指定的会议中。
支持
不支持
实时信息查询
查询当前会中成员列表,仅包括会中的成员。
支持
支持
获取某指定会议的等候室成员列表,需开启等候室且为“会议进行中”状态。
支持
支持
获取实时会议质量检测数据。
支持
不支持

高级 API

录制管理

模块
API
说明
自建应用(AK/SK)
三方应用(OAuth2.0)
录制文件管理
根据用户 ID、会议 ID、会议 code 进行查询用户云录制记录。
支持
支持
获取会议云录制的播放地址和下载地址。
支持
支持
查询单个云录制的详情信息,包括录制文件和录制转写,并可获取播放地址和下载地址。
支持
支持
删除会议的所有录制文件。
支持
不支持
删除单个录制文件。
支持
不支持
获取云录制转写的详情。
支持
支持
获取云录制转写的段落信息(段落总数、段落 ID)。
支持
支持
根据指定内容搜索录制转写。
支持
支持
设置指定会议的录制文件是否转存。
支持
不支持
获取账户的云录制记录。
支持
不支持
录制权限管理
根据会议录制 ID 修改共享等配置。
支持
支持
根据会议录制 ID 查询共享等配置。
支持
支持
企业录制管理权限的用户,可以对云录制观看申请进行审批操作。
支持
支持
仅会议创建者、企业超级管理员或企业角色有录制管理权限的用户支持添加参会成员或企业内成员为录制访问成员。
支持
支持
仅会议创建者、企业超级管理员或有企业录制管理权限的用户可调用。
支持
支持
查询会议录制 ID 对应的访问数据。
支持
支持
查询会议录制 ID 对应的操作记录。
支持
支持
查询会议云录制在一段时间内的观看记录。
支持
支持
智能录制
查询单个云录制的智能章节。
支持
支持
查询单个云录制的智能发言人列表。
支持
支持
查询单个云录制的智能话题。
支持
支持
查询单个云录制的智能总结。
支持
支持
查询单个云录制的智能纪要。
支持
支持
上传录制文件
企业 secret 鉴权用户可上传文件到录制文件列表。
支持
不支持
企业 secret 鉴权用户可预上传文件到录制文件列表。
支持
不支持
企业 secret 鉴权用户可分块上传文件到录制文件列表。
支持
不支持
企业 secret 鉴权用户可上传文件到录制文件列表。
支持
不支持

网络研讨会管理(Webinar)

模块
API
说明
自建应用(AK/SK)
三方应用(OAuth2.0)
研讨会管理
预定一个网络研讨会。
支持
支持
修改指定的网络研讨会信息。
支持
支持
查询指定的网络研讨会详细信息。
支持
支持
取消指定的网络研讨会。
支持
支持
支持查询网络研讨会参会成员列表。
支持
支持
查询指定的网络研讨会嘉宾列表。
支持
支持
修改指定的网络研讨会嘉宾列表。
支持
支持
对网络研讨会进行 Webinar 进行暖场设置。
支持
支持
会议创建者和企业超级管理员可以查询准备模式参会记录。
支持
支持
研讨会专属链接
可用 customer_data 进行区分,为一场会议生成多个会议链接。
支持
不支持
可以获取指定会议的所有专属参会链接及 customer_data。
支持
不支持
研讨会报名管理
支持查询网络研讨会中已报名成员的报名 ID。
支持
支持
查询网络研讨会的报名配置和报名问题。
支持
支持
修改网络研讨会的报名配置和报名问题。
支持
支持
查询已报名观众数量和报名观众答题详情。
支持
支持
批量审批网络研讨会的报名信息。
支持
支持
在指定网络研讨会(Webinar)中导入报名信息。
支持
支持
删除指定网络研讨会(Webinar)的报名信息。
支持
支持

会议室(Rooms)管理

模块
API
说明
自建应用(AK/SK)
三方应用(OAuth2.0)
会议室管理
通过会议 ID 预定会议室,支持多个会议室预定。
支持
不支持
通过会议 ID 释放会议室,支持多个会议室释放。
支持
不支持
对会议室信息进行设置。
支持
不支持
修改会议室各种配置项。
支持
不支持
会议可以通过会议室 ID 呼叫会议室邀请其入会。
支持
不支持
会议可以通过会议室 ID 进行取消呼叫操作。
支持
不支持
生成会议室中设备激活码。
支持
不支持
为会议室设置会议室背景。
支持
不支持
会议室信息查询
根据会议室 ID 查询该会议室详细信息。
支持
不支持
查询企业下的会议室列表。
支持
不支持
查询指定会议室(Rooms)下的会议列表。
支持
不支持
查询企业下的可用设备列表。
支持
不支持
查询企业下的控制器列表。
支持
不支持
查询会议室的配置项。
支持
不支持
一个会议可以查询它所呼叫的会议室对其的应答状态。
支持
不支持
查询当前会议室的背景。
支持
不支持
通过 Rooms 上的投屏码查询会议室基本信息。
支持
不支持
查询企业的会议室告警信息。
支持
不支持
查询 Rooms 账号资源使用情况。
支持
不支持
查询企业购买的 Rooms 资源。
支持
不支持

会议室连接器(MRA)管理

API
说明
自建应用(AK/SK)
三方应用(OAuth2.0)
会议中查询指定 MRA 设备的当前状态信息。
支持
不支持
会议中对 MRA 的默认布局进行设置。
支持
不支持
对 MRA 进行举手和手放下操作。
支持
不支持
会议中对 MRA 进行呼叫挂断操作。
支持
不支持

PSTN 管理

API
说明
自建应用(AK/SK)
三方应用(OAuth2.0)
会议创建者、主持人、联席主持人可以批量外呼电话入会。
支持
不支持
会议创建者、主持人、联席主持人查询外呼电话入会的数据。
支持
不支持
会议创建者、主持人、联席主持人可以查询 PSTN 的 ms_open_id。
支持
不支持
超管、企业管理员拥有结算信息查看或编辑权限点的企业成员可以查询企业的通话详单信息。
支持
不支持
会议创建者、主持人、联席主持人可以批量取消外呼电话入会。
支持
不支持
获取异步导出 PSTN 通话详单任务的结果。
支持
不支持