能力配置（Ability）API接口
能力配置API，主要涉及能力配置相关的控制，通过API，您可以实现获取能力配置信息 等功能。
1. 查询能力配置信息 (Query Ability)
1.1 查询能力配置所有信息
接口说明
1）接口解释：用于查询能力配置模块的相关信息
2）引入版本： 3.8.10
3）调用方式（method）：Query
4）调用结果：同步返回调用结果
输入参数（params）
参数名称 | 是否必选 | 参数类型 | 参数描述 |
|---|---|---|---|
path | 是 | array | 模块名 |
输出参数（data）
参数名称 | 参数类型 | 参数描述 |
|---|---|---|
pre_meeting_ability | object | 会前能力，详见会前能力表 |
会前能力表（pre_meeting_ability）
参数名称 | 参数类型 | 参数描述 |
|---|---|---|
start_meeting_ability | object | 开始会议能力，详见开始会议能力表 |
whiteboard_ability | object | 白板能力，详见白板能力表 |
cast_ability | object | 投屏能力，详见投屏能力表 |
join_meeting_ability | object | 入会能力，详见入会能力表 |
开始会议能力表（start_meeting_ability）
参数名称 | 参数类型 | 参数描述 |
|---|---|---|
instant_meeting_ability | object | 普通会议能力，详见普通会议能力表 |
pmi_meeting_ability | object | 个人会议能力，详见个人会议能力表 |
普通会议能力表（instant_meeting_ability）
参数名称 | 参数类型 | 参数描述 |
|---|---|---|
is_default | bool | 是否默认创建会议类型： |
instant_meeting_ability_enable | bool | 是否支持创建普通会议： |
个人会议能力表（pmi_meeting_ability）
参数名称 | 参数类型 | 参数描述 |
|---|---|---|
is_default | bool | 是否默认创建会议类型： |
pmi_meeting_ability_enable | bool | 是否支持创建pmi会议： |
pmi_code | string | pmi 会议码，仅在 pmi_meeting_ability_enable 为 true 时才返回 |
白板能力表（whiteboard_ability）
参数名称 | 参数类型 | 参数描述 |
|---|---|---|
whiteboard_ability_enable | bool | 是否支持白板： |
投屏能力表（cast_ability）
参数名称 | 参数类型 | 参数描述 |
|---|---|---|
cast_ability_enable | bool | 是否支持投屏： |
入会能力表（join_meeting_ability）
参数名称 | 参数类型 | 参数描述 |
|---|---|---|
join_meeting_ability_enable | bool | 是否支持加入会议： |
请求示例
request
{
"jsonrpc": "2.0",
"id": "xxx",
"method": "Query",
"params": {
"path": ["Ability"]
}
}
response
{
"jsonrpc": "2.0",
"method": "Query",
"id": "SZD868XAQWTCBV5",
"result": {
"error_code": 0,
"message": "成功",
"data": {
"pre_meeting_ability": {
"start_meeting_ability": {
"instant_meeting_ability": {
"is_default": true,
"instant_meeting_ability_enable": true
},
"pmi_meeting_ability": {
"is_default": false,
"pmi_meeting_ability_enable": true,
"pmi_code": ""
}
},
"whiteboard_ability": {
"whiteboard_ability_enable": true
},
"cast_ability": {
"cast_ability_enable": true
},
"join_meeting_ability": {
"join_meeting_ability_enable": true
}
}
}
}
}1.2 查询能力配置部分信息
接口说明
1）接口解释：用于查询能力配置模块的相关信息
2）引入版本： 3.8.10
3）调用方式（method）：Query
4）调用结果：同步返回调用结果
输入参数（path）
输出参数（data）
request
{
"jsonrpc": "2.0",
"id": "xxx",
"method": "Query",
"params": {
"path": ["Ability", "PreMeetingAbility", "WhiteboardAbility"] // 查询Ability模块下的whiteboard_ability节点
}
}
response
{
"jsonrpc": "2.0",
"method": "Query",
"id": "X52NYDHXBDG7PX5",
"result": {
"error_code": 0,
"message": "成功",
"data": {
"whiteboard_ability": {
"whiteboard_ability_enable": true
}
}
}
}