成员（Members）API接口
成员API，主要涉及设备相关的控制，通过API，您可以实现接收主持人变更通知/获取成员信息 等功能。
1. 查询成员信息 (Query Members)
1.1 查询成员所有信息
接口说明
1）接口解释：用于查询成员模块的相关信息
2）引入版本： 3.8.10
3）调用方式（method）：Query
4）调用结果：同步返回调用结果
输入参数（params）
参数名称 | 是否必选 | 参数类型 | 参数描述 |
|---|---|---|---|
path | 是 | array | 模块名 |
输出参数（data）
参数名称 | 参数类型 | 参数描述 |
|---|---|---|
host_info | object | 主持人信息，详见主持人信息表 |
self_user_info | object | 当前用户信息，详见用户信息表 |
user_list_info | array | 用户信息，详见用户信息列表 |
主持人信息表（host_info）
参数名称 | 参数类型 | 参数描述 |
|---|---|---|
host | object | 主持人表，只在会中返回 |
host_status | int | 主持人状态，只在等候室中返回： |
主持人表（host）
参数名称 | 参数类型 | 参数描述 |
|---|---|---|
app_uid | string | 账号id |
app_id | string | 企业id |
user_id | string | 会中用户id |
co_host | bool | 是否联席主持人： |
instance_id | int | 应用类型id |
user_type | int | 用户类型： |
is_creator | bool | 是否会议创建者： |
role_type | int | 角色类型：0：未知 |
video_on | bool | 是否开启视频： |
audio_on | bool | 是否开启音频： |
screen_sharing | bool | 是否开启屏幕共享： |
screen_share_type | int | 屏幕共享类型： |
web_sharing | bool | 是否文档共享： |
nickname | string | 用户名称 |
用户信息表（self_user_info）
详见主持人表（host）
用户信息列表（user_list_info）
详见主持人表（host）
请求示例
request
{
"jsonrpc": "2.0",
"id": "xxx",
"method": "Query",
"params": {
"path": ["Members"]
}
}
response
{
"jsonrpc": "2.0",
"method": "Query",
"id": "XY6FD1B95MT2UO5",
"result": {
"error_code": 0,
"message": "成功",
"data": {
"host_info": {
"host": {
"app_uid": "",
"app_id": "",
"user_id": "",
"host": true,
"co_host": true,
"instance_id": 0,
"user_type": 0,
"is_creator": true,
"role_type": 0,
"video_on": true,
"audio_on": true,
"screen_sharing": true,
"screen_share_type": 0,
"web_sharing": true,
"nickname": ""
},
"host_status": 0
},
"self_user_info": {
"app_uid": "",
"app_id": "",
"user_id": "",
"host": true,
"co_host": true,
"instance_id": 0,
"user_type": 0,
"is_creator": true,
"role_type": 0,
"video_on": true,
"audio_on": true,
"screen_sharing": true,
"screen_share_type": 0,
"web_sharing": true,
"nickname": ""
},
"user_list_info": [{
"user_id": "xxx",
"nickname": "xxx"
}]
}
}
}1.2 查询成员部分信息
接口说明
1）接口解释：用于查询成员模块的相关信息
2）引入版本： 3.8.10
3）调用方式（method）：Query
4）调用结果：同步返回调用结果
输入参数（path）
输出参数（data）
request
{
"jsonrpc": "2.0",
"id": "xxx",
"method": "Query",
"params": {
"path": ["Members", "SelfUserInfo"] // 查询Members模块下的self_user_info节点
}
}
response
{
"jsonrpc": "2.0",
"method": "Query",
"id": "NR3WISR858WSUD8",
"result": {
"error_code": 0,
"message": "成功",
"data": {
"self_user_info": {
"app_uid": "xxx",
"app_id": "xxx",
"is_creator": true,
"co_host": false,
"instance_id": 20,
"screen_share_type": 0,
"user_id": "xxx",
"user_type": 1,
"host": true,
"role_type": 1,
"video_on": true,
"audio_on": true,
"web_sharing": false,
"screen_sharing": false,
"nickname": "xxx"
}
}
}
}