Appearance
抄水表数据接口文档
接口链接
URL地址: http://api2.tqdianbiao.com/Api_v2/water_read
(水表采用电池供电,频繁抄表严重影响电池寿命,建议3天主动查询一次水表数据)
接口参数
字段名 | 变量名 | 必填 | 类型 | 描述 |
---|---|---|---|---|
授权码 | auth_code | 是 | String(32) | 系统为使用区域分配的授权码,在后台配置页面获取 |
时间戳 | timestamp | 是 | String(10) | 自1970年1月1日(08:00:00 GMT)至当前时间的总秒数 |
请求内容 | request_content | 是 | String | 详见request_content字段说明,注意 request_content 是json数组,注意合并请求⭐ |
回调地址 | notify_url | 是 | String | 系统处理完查询请求后,通过这个回调地址,把数据推送给请求方 |
签名 | sign | 是 | String(32) | 通过签名算法计算得出的签名值,详见签名生成算法 |
请求内容request_content字段说明
字段名 | 变量名 | 必填 | 类型 | 描述 |
---|---|---|---|---|
操作ID | opr_id | 是 | String | 操作ID,长度16-32,请求时自己生成,用于标识一次异步操作任务,须保证唯一性 |
采集器号 | cid | 是 | String | 采集器号,4G、NB设备采集器号与表号一致 |
表号 | address | 是 | String | 表号(表地址) |
超时时间 | time_out | 否 | int | 超时时间 单位秒,任务因通讯异常等情况未执行自动失效的时间 ,默认1年 |
是否必须在线 | must_online | 否 | Boolean | 如果传true ,则系统接受任务时设备不在线直接返回失败 ,默认 false |
重试次数 | retry_times | 否 | int | 重试次数(0-3) ,默认1次 |
操作类型 | type | 是 | int | 操作类型ID |
水表抄表类型
操作类型ID | 描述 |
---|---|
42 | 抄水表数据 |
98 | 剩余金额 |
提示
购买水量的水表不支持抄剩余金额,可以测试下抄表来确认,或者联系销售确认
同步返回结果
字段名 | 变量名 | 必填 | 类型 | 描述 |
---|---|---|---|---|
返回状态码 | status | 是 | String | SUCCESS/FAIL,此字段是通信标识 |
时间戳 | timestamp | 是 | String(10) | 自1970年1月1日(08:00:00 GMT)至当前时间的总秒数 |
回复内容 | response_content | 是 | String | 详见response_content字段说明 |
签名 | sign | 是 | String(32) | 通过签名算法计算得出的签名值,详见签名生成算法 |
出错原因 | error_msg | 否 | String | 当返回状态码为"FAIL"时,返回信息为错误原因 |
同步回复内容response_content字段说明
字段名 | 变量名 | 必填 | 类型 | 描述 |
---|---|---|---|---|
操作ID | opr_id | 是 | String | 操作ID,长度16-32,请求时自己生成,用于标识一次异步操作任务,须保证唯一性 |
采集器号 | cid | 是 | String | 采集器号,4G、NB设备采集器号与表号一致 |
表号 | address | 是 | String | 表号(表地址) |
抄表状态 | status | 是 | String | 抄表请求结果状态,说明提交的任务成功或者失败 |
错误信息 | error_msg | 否 | String | 当抄表状态:status值不为“SUCCESS”时,填入具体的出错内容 |
异步返回结果
字段名 | 变量名 | 必填 | 类型 | 描述 |
---|---|---|---|---|
时间戳 | timestamp | 是 | String(10) | 自1970年1月1日(08:00:00 GMT)至当前时间的总秒数 |
回复内容 | response_content | 是 | String | 处理结果数据,查询类型不同,包含数据也会有所差异。 |
签名 | sign | 是 | String(32) | 通过签名算法计算得出的签名值,详见签名生成算法 |
示例 JSON
json
{
"auth_code": "37577f8fb62a7b14ba55cc6faec5a142",
"timestamp": "1586740681",
"request_content": [
{
"opr_id": "ece49fbc76ea48f18b217eec47c0a1e0",
"time_out": 0,
"must_online": true,
"retry_times": 1,
"cid": "10000000031",
"address": "20040900000003",
"type": 42
},
{
"opr_id": "10d9cf7ac3ea4ffd9ec2216e07a17d6e",
"time_out": 0,
"must_online": true,
"retry_times": 1,
"cid": "88020206100",
"address": "C1E81000007859",
"type": 42
}
],
"notify_url": "http://115.221.11.179:8022/notify",
"sign": "fee536cf6a37a200d6761df04f5bf368"
}
抄水表数据 回调 数据示例
16101 : ModBus有线水表
json
[
{
"type": 42,
"value": [
"1146.00"
],
"dsp": "1146.00 m³"
}
]
MBus有线水表 水表数据示例
json
[
{
"type": 42,
"value": [
"0.0",
"0.0",
"0.0"
],
"dsp": "总用量:0.0 m³ 剩余量:0.0 m³ 总购量:0.0 m³ 阀门状态:Off"
}
]
19500 : NS-Lora普通预付费水表
json
[
{
"type": 42,
"value": [
"7.740|7.740|192.56"
],
"dsp": "总用量:7.740m³ 阀门状态:On 电压:3.7V 当前单价:1.00元\/m³ 余额:192.56元 结算周期用量:0.310m³\/192.56元 累计充值:200.00元 信号强度:-62 "
}
]
NS-无线普通预付费水表
json
[
{
"type": 42,
"value": [
"8953.600|0.000|0.00"
],
"dsp": "后付费模式 总用量:8953.600m³ 累计正向流量:8922.490m³ 日最大流量:8.000m³\/h 最大流量发生时间:2025\/1\/3 2:40:55 电压:3.59V rsrp:0,snr:0,ecl:0,csq:25 结算周期用量:0.000m³ 剩余金额:0.00元 总充值:0.00元 阀门状态:On "
}
]