接口文档

Appearance

水价设置接口文档 ​

接口链接 ​

URL地址: http://api2.tqdianbiao.com/Api_v2/water_write/price

部分表类型使用参数设置接口设置水价，具体表类型请参考 水表参数文档

设置水价的三种方式 ​

  • 通过当前接口 (普通无线水表) 🌟
  • 通过充值接口 一般充值时购买水量表用 充值接口 🌟
  • 通过参数设置接口 一般是系统里显示 有参数设置的表用 参数设置接口 🌟

提示 ⭐

具体如何选择 可以前往 了解产品

接口参数 ​

字段名变量名必填类型描述
授权码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字段说明 ​

字段名变量名必填类型描述
操作IDopr_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次
操作数据params是json String操作所需的数据

操作数据params字段说明 ​

字段名变量名必填类型描述
用水价格 (一阶水价)p1是String水价(一阶水价|单费率水价仅此字段有效)
二阶水价p2否String二阶水价 （仅仅阶梯水价水表支持）
三阶水价p3否String三阶水价 （仅仅阶梯水价水表支持）
二阶起始值p4否String二阶起始值 （仅仅阶梯水价水表支持）
三阶起始值p5否String三阶起始值 （仅仅阶梯水价水表支持）

同步返回结果 ​

字段名变量名必填类型描述
返回状态码status是StringSUCCESS/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字段说明 ​

字段名变量名必填类型描述
操作IDopr_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": "eb8dc0e967664e289f9f1204065c6c25",
      "time_out": 0,
      "must_online": true,
      "retry_times": 1,
      "cid": "10000000031",
      "address": "20040900000003",
      "params": {
        "p1": "1"
      }
    }
  ],
  "notify_url": "http://115.221.11.179:8022/notify",
  "sign": "fee536cf6a37a200d6761df04f5bf368"
}

接口测试工具 ​

POST
key
value
json
{
  "data": {}
}