开发者平台

TP-LINK官网首页
开发者平台 / 视频管理系统(VMS)/ API功能接口定义 / 直播管理

4.11.3 报警消息转发


4.11.3.1 设置报警消息转发服务信息

接口说明:

名称 内容
URL https://xxx/tums/custom/v1/setMsgTransportServerInfo
功能说明 设置报警消息转发服务信息
使用限制

请求参数:

参数名称 参数描述
serverUrl
String
目标服务器的IP地址或域名
port
short
目标服务器的端口号
openAlarmMsgTransport
short
是否开启报警消息转发
0: 不开启
1: 开启

返回参数:

参数名称 参数描述
error_code 返回码,0 – 成功,其他- 失败,具体请参考返回码章节

代码示例

        https://xxx/tums/ custom/v1/setMsgTransportServerInfo
        request:
        {
            "serverUrl":"192.168.1.138",
            "port":10180,
            "openAlarmMsgTransport":1
        }
        response:
        {
            "error_code": 0,
        }                                                                        
      

4.11.3.2 获取报警消息转发服务信息


接口说明:

名称 内容
URL https://xxx/tums/custom/v1/getMsgTransportServerInfo
功能说明 获取报警消息转发服务信息
使用限制

请求参数:

参数名称 参数描述

返回参数:

参数名称 参数描述
error_code 返回码,0 – 成功,其他- 失败,具体请参考返回码章节
serverUrl 目标服务器的IP地址或域名
port 目标服务器的端口号
openAlarmMsgTransport 是否开启报警消息转发
0: 不开启
1: 开启

代码示例

        https://xxx/tums/custom/v1/getMsgTransportServerInfo 
        request:
        {
        }
        response:
        {
            "result": {
                "serverUrl": "192.168.1.140",
                "port": 10180,
                "openAlarmMsgTransport": 1
            },
            "error_code": 0
        }                                                                                 
      

4.11.3.3 报警消息转发接口示例


配置好报警消息转发服务器的信息之后,VMS触发报警消息就会往对应的{serverUrl}:{port}发送报警消息,请求示例如下:


POST /v1/msg/alarmMsgTranspond HTTP/1.1
Content-Type: application/json
User-Agent: Jakarta Commons-HttpClient/3.1
Host: 192.168.1.139:10180
Content-Length: 140
{"devId":"3","deviceName":"TL-IPC43AN 音频增强版","alarmTime":"1609135966","alarmType":"越界侦测报警","deviceMac":"7CB59BFFEBF1"}