基础功能

特别注意

所有的Api均需要传输Api签名和时间戳，详情请查看签名算法。

本节内API均支持form-data和json数据格式

获取声音配置

URL：http://<报警灯IP地址>/api/system/get_sound_conf

请求方法：GET

附加参数：无

响应成功示例：

{
    "code": 200,
    "msg": "OK",
    "data": {
        "volume": {
            "method": 18,
            "id": "83f694bc8be08bff30c6c1e0df254ce9",
            "data": 20,          // 音量值
            "res_code": 0
        },
        "tts": 1,                // 语音合成标志位，1为自动，2为仅离线
        "auto_mute": true        // 插入耳机是否静音扬声器
    }
}

设置音量

URL：http://<报警灯IP地址>/api/system/set_vol

请求方法：POST

数据类型：form-data

参数：

参数名	类型	说明
value	int	音量大小，范围0~31，请严格遵守

响应成功示例：

{
    "code": 200,
    "msg": "OK",
    "data": {
        "method": 19,
        "id": "3bc704df1863d16d430b59dbde33f6e6",
        "data": "ok",
        "res_code": 0
    }
}

跳过当前播报

用途：停止当前播报内容（可选择是否删除周期性播报），直接播报下一个(如有)

注意：跳过当前的播报如果是无限循环播报将直接删除

URL：http://<报警灯IP地址>/api/api/play_next

请求方法：POST

数据类型：form-data

参数：

参数名	类型	示例	说明
is_delete	text	0	1:删除周期播报；0:禁用删除周期播报

响应成功示例：

{
  "code": 200,
  "msg": "OK",
  "data": {
    "method": 61,
    "id": "1703a60c360835dfb88f42bbbf91266a",
    "data": "OK",
    "res_code": 0
  }
}

清空播报队列

用途：清空之后等待播报的播报队列

地址：http://<报警灯IP地址>/api/api/clear_queue

请求方法：GET

参数：该接口无参数

响应成功示例：

{
  "code": 200,
  "msg": "OK",
  "data": {
    "method": 60,
    "id": "ec79e09e56cb8717da42b7714556e96d",
    "data": "OK",
    "res_code": 0
  }
}

清空指定告警

URL：http://<报警灯IP地址>/api/system/set_vol

请求方法：POST

数据类型：form-data

参数：

参数名	类型	说明
clear_opt	array	清空指定类型的告警，1：清空周期性播报；2：清空无限循环播报；3：清空待播报队列；例如：[1,2,3]

响应成功示例：

{
  "code": 200,
  "msg": "OK",
  "data": {
    "method": 64,
    "id": "29ce6dd94fe605c4a2452ec0280742b0",
    "data": "OK",
    "res_code": 0
  }
}

获取待播报队列长度

用途：获取正在排队等待播报的请求数量，当前正在播报不计算在内。

URL：http://<报警灯IP地址>/api/api/get_play_queue_size

请求方法：GET

参数：无

响应成功示例：

{
  "code": 200,
  "msg": "OK",
  "data": {
    "method": 62,
    "id": "d5bc9edc6479bc7c017e5c9e645eb340",
    "data": 0,    // 待播报的数量
    "res_code": 0
  }
}

旧版告警灯Api

用途：该Api供"黑猫侦探智能网络报警灯"用户使用，用来兼容旧版接口。

只需将原有的IP地址映射到该报警灯，即可实现原有功能。

修改待机样式

用途：用于修改报警灯待机状态时显示的样式

URL：http://<报警灯IP地址>/api/system/set_standby_mode

请求方法：POST

数据类型：form-data

参数：

参数名	类型	示例	说明
style	string	3	待机模式下报警灯显示的样式
color	json	["#FF00ff"]	待机模式下报警灯显示的颜色
flag	int	3	0 :单色，永不变颜色; 0.5 :单色，逐渐变换颜色; 1 ~ 2 :0 - 360度 色相渐变 led最上层是初始颜色，最下层是 加上多少度之后的色相。中间层是渐变色。
wait_time	int	10	待机样式被其他告警打断后，多久后恢复待机样式。

响应成功示例：

{
  "code": 200,
  "msg": "OK",
  "data": {
    "method": 23,
    "id": "f3d4e9894b8951d74024dc879471ef8b",
    "data": "ok",
    "res_code": 0
  }
}