设置项(Setting)API接口

设置项API,主要涉及设置项相关的控制,通过API,您可以实现接收常规设置项更新通知/获取设置项信息 等功能。

1. 查询设置项信息 (Query Setting)

1.1 查询设置项所有信息

接口说明

1)接口解释:用于查询设置项模块的相关信息

2)引入版本: 3.9.150

3)调用方式(method):Query

4)调用结果:同步返回调用结果

输入参数(params)

参数名称

是否必选

参数类型

参数描述

path

array

模块名

输出参数(data)

参数名称

参数类型

参数描述

setting

object

设置项信息,详见设置项信息表

normal_setting

object

常规设置项信息,详见常规设置项信息表

常规设置项信息表(normal_setting)

参数名称

参数类型

参数描述

setting_list

array

设置项列表

设置项列表(setting_list)

参数名称

参数类型

参数描述

title

string

设置项标题

desc

string

设置项描述

id

int

设置项id:
0:入会是否开启摄像头
1:入会是否开启麦克风

checked

bool

设置项状态,是否开启
true:开启
false:关闭

is_switch

bool

设置项是否开启,固定值为true

enable

bool

设置项是否可用,固定值为true

请求示例

request

{
    "jsonrpc": "2.0",
    "id": "xxx",
    "method": "Query",
    "params": {
        "path": ["Setting"]
    }
}

response

{
    "jsonrpc": "2.0",
    "method": "Query",
    "id": "KR7C51JMWE8Q4CI",
    "result": {
        "error_code": 0,
        "message": "成功",
        "data": {
            "setting": {
                "normal_setting": {
                    "setting_list": [{
                        "title": "入会开启摄像头",
                        "desc": "",
                        "id": 0,
                        "checked": true,
                        "is_switch": true,
                        "enable": true
                    }, {
                        "title": "入会开启麦克风",
                        "desc": "",
                        "id": 1,
                        "checked": true,
                        "is_switch": true,
                        "enable": true
                    }]
                }
            }
        }
    }
}

下载 设置项(Setting).pdf
文章内容是否对您有帮助?
有帮助
无帮助