博灵语音通知终端 使用说明书-V1.12.1

# 设备Api

适用范围

博灵A4系列支持IP地址以及云服务方式调用
博灵A3系列仅支持通过云服务使用下列功能，请参考云服务章节，注意地址变化

特别注意

本章节所有的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:清空周期播报；2:清空无限循环播报；3:清空待播报队列；4:邮件；5：Trap；6：清空播报队列；（可以同时指定清空多个播报类型）

响应成功示例：

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

响应失败示例：

{
    "code": 500,
    "msg": "参数错误，正确参数应为：true、false",
    "data": null
}

# 清空播报队列

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

地址：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/api/get_play_queue_size

请求方法：GET

参数：无

响应成功示例：

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

# 清空指定告警

用途：用于清空周期性播报、无限循环播报和播报队列

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

请求方法：POST

数据类型：form-data

参数：

参数名 类型 示例 说明
clear_opt array [1,2,3] 1:清空周期播报；2:清空无限循环播报；3:清空待播报队列；（可以同时指定清空多个播报类型）

响应成功示例：

{
  "code": 200,
  "msg": "OK",
  "data": {
    "method": 64,
    "id": "507e3d37b39ffce7e875e0404a0f988b",
    "data": "OK",
    "res_code": 0
  }
}

响应失败示例：

  1. 参数格式错误

    {
    "code": 500,
    "msg": "参数格式不正确",
    "data": null
}

  2. 未指定参数

    {
    "code": 500,
    "msg": "参数为空，至少指定一项",
    "data": null
}

# 修改待机样式

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

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

请求方法：POST

数据类型：form-data

参数：

参数名 类型 示例 说明
style string 3 待机模式下报警灯显示的样式 -1:关闭、0：闪烁、1：呼吸、2：贪吃蛇、3：缓动圆、4：灯塔、5：渐变、7：火焰
color json ["#FF00ff"] 待机模式下报警灯显示的颜色
flag int 3 样式参数参见待机样式
wait_time int 10 待机样式被其他告警打断后，多久后恢复待机样式。

响应成功示例：

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

# 旧版告警灯Api

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

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

← 通知回调 →