Appearance
抄电表数据接口文档
接口说明
- 用于通过接口异步查询查询和读取电表数据,支持多种类型的电表(如单相表、三相表等),并提供详细的电表运行状态信息。
- 当前接口需要回调地址 notify_url,用于接收抄表数据。
- 回调常见问题
接口地址
URL地址: http://api2.tqdianbiao.com/Api_v2/ele_read
接口参数
字段名 | 变量名 | 必填 | 类型 | 描述 |
---|---|---|---|---|
授权码 | 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 |
示例 JSON
json
{
"auth_code": "37577f8fb62a7b14ba55cc6faec5a142",
"timestamp": "1586740681",
"request_content": [
{
"opr_id": "be0b6a276a8f41ac865512c1404c3c4b",
"time_out": 0,
"must_online": true,
"retry_times": 1,
"cid": "19020618114",
"address": "000066660942",
"type": 3
}
],
"notify_url": "http://115.221.11.179:8022/notify",
"sign": "fee536cf6a37a200d6761df04f5bf368"
}
抄表类型
抄表类型
抄表项 | 抄类型值 | 表类型 | 示例值 | 描述 | 单位 |
---|---|---|---|---|---|
正向有功总电能 | 3 | 不区分 | 1 | 即总用电量,倍率表要 * 倍率 获取倍率 | kwh |
电表状态数据块 | 253 | 不区分 | 详细 | ||
反向有功总电能 | 4 | 多费率表 | |||
组合无功1总电能 | 5 | 多费率表 | |||
组合无功2总电能 | 6 | 多费率表 | |||
ABC三相电压 | 15 | 三相表 | 380,380,380 | v | |
ABC三相电流 | 16 | 三相表 | 10,10,10 | A | |
ABC三相有功功率 | 17 | 三相表 | 10,10,10 | kw | |
ABC三相无功功率 | 18 | 三相表 | 10,10,10 | kw | |
剩余金额 | 22 | 预付费表类型 | 1 | 剩余金额 | 元 |
A相电流 | 27 | 三相表 | 10 | A | |
B相电流 | 28 | 三相表 | 10 | A | |
C相电流 | 29 | 三相表 | 10 | A | |
A相电压 | 30 | 三相表 | 380 | V | |
B相电压 | 31 | 三相表 | 380 | V | |
C相电压 | 32 | 三相表 | 380 | V | |
瞬时有功功率 | 33 | 不区分 | 12 | 当前功率 | kw |
瞬时无功功率 | 34 | 抄表确认 | 12 | kw | |
读取费率电价 | 35 | 预付费 | 12 | ||
读取阶梯差价 | 36 | 阶梯费率预付费表 | |||
读取一级报警金额 | 38 | 预付费 | 余额小于此值、电表上报警灯闪烁 | 元 | |
读取二级报警金额 | 39 | 预付费 | 断电报警、一般无效不会断电 | 元 | |
读取电流互感器变比 | 40 | 互感表 | 互感器变比(倍率) | ||
读取电压互感器变比 | 41 | 互感表 | 电压互感器变比 | ||
查询继电器状态 | 106 | 不区分 | 电表拉合闸状态 | ||
当月最大需量 | 141 | 不区分 | |||
上月最大需量 | 146 | 不区分 | |||
上月尖最大需量 | 147 | 不区分 | |||
上月峰最大需量 | 148 | 不区分 | |||
上月平最大需量 | 149 | 不区分 | |||
上月谷最大需量 | 150 | 不区分 | |||
当月总电量 | 151 | 不区分 | |||
读时区表 | 125 | 多费率表 | |||
读取日时段表1 | 127 | 多费率表 | |||
读取日时段表2 | 128 | 多费率表 | |||
读取日时段表3 | 183 | 多费率表 | |||
读取日时段表4 | 184 | 多费率表 |
读 106 : 电表运行状态字 回调参数 示例
json
[
{
"type": 106,
"value": [
"0"
],
"dsp": "有功功率:反向 无功功率:反向 继电器状态:通 继电器命令状态:通 A相潮流反向 B相潮流反向 C相潮流反向 "
}
]
读 22 : 剩余金额 回调参数 示例
json
[
{
"type": 22,
"value": [
"0.00"
],
"dsp": " 购电次数: 0 剩余金额: 0.00 元 总用电量: 150.81 kWh 当前表类型 : 后付费模式 "
}
]
读 3 正向有功总电能 回调 参数示例
json
[
{
"type": 3,
"value": [
"411.58"
],
"dsp": "411.58 kWh"
}
]
或
[
{
"type": 106,
"value": [
"0"
],
"value_v2": [
...
],
"dsp": "有功功率:反向 无功功率:反向 继电器状态:通 继电器命令状态:通 A相潮流反向 B相潮流反向 C相潮流反向 "
}
]
-- 表类型不一样 响应数据内容 会有区别 --
或
[
{
"type": 3,
"value": [
"16092.67"
],
"dsp": " 购电次数: 7 剩余金额: 2061.00 元 总用电量: 16092.67 kWh "
}
]
-- 多费率表 响应数据内容 会有区别 --
[
{
"type": 3,
"value": [
"444.31",
"50.12",
"202.78",
"153.03",
"38.38"
],
"dsp": "总 : 444.31 kWh 尖 : 50.12 kWh 峰 : 202.78 kWh 平 : 153.03 kWh 谷 : 38.38 kWh"
}
]
27 : A相电流
json
[
{
"type": 27,
"value": [
"1.216"
],
"dsp": "1.216 A"
}
]
同步返回结果
字段名 | 变量名 | 必填 | 类型 | 描述 |
---|---|---|---|---|
返回状态码 | 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) | 通过签名算法计算得出的签名值,详见签名生成算法 |