签名信息
alias SOS passsword 123456
定制终端调用API接口说明
文档修改说明: 【2019-3-14】添加配置项返回,增加终端上传数据的频率空着,满足个性化需求的前提下最大限度优化终端功耗,红色为本次修改新增 【2019-3-15】完善配置交换机制,红色为本次修改新增
1 定制机定位信息上传接口 1.1 接口名称 功能机定位信息上传接口(/cstmzPosition) 1.2接口描述 接口地址:http://202.100.190.58:8090/api/cstmzPosition 返回格式:JSON 请求方式:GET/ POST 请求示例: http://202.100.190.58:8088/api/cstmzPosition?longitude=87.5775380&latitude=43.8951940&meid=A100006069E0F8&time=2019-03-10%2011:53:33&tel=13319801000&model=HBA7+&cfgv=2019031512 接口备注:用于定制机上传位置信息,使用前需要先在系统中绑定用户的MEID信息,如果未绑定,后台服务将直接丢弃该定位信息。 1.3 请求参数说明(入参) 参数名 类型 说明 默认值 举例 必选 longitude string 经度 必填无默认 87.5775380 是 latitude string 纬度 必填无默认 43.8951940 是 meid string 移动设备识别码 必填无默认 A100006069E0F8 是 time string 手机侧获取位置的时间(格式要求:yyyy-mm-dd hh24:mi:ss) 必填无默认 2019-03-10%2011:53:33 是 tel string 手机号码 获取不到填0 是 iccid string SIM卡卡号 获取不到填0 是 imsi string 用户SIM卡识别码 获取不到填0 是 model string 机型编码 必填无默认 BHA7 是 cfgv String 配置版本 第一次预制ROM中的,不是服务器下发的配置,传0,后续按系统返回上传 是
机型编码 model 名称 厂商 说明 BHA7 百合A7+ 百合 3.5寸屏 1+16 按键智能机 HBA18L 百合A18L 百合 F12 5寸屏 1+16 智能机 GXEF36 广信EF36 广信 3.5寸屏 1+16 按键智能机 GXF12 广信F12 广信 F12 5寸屏 1+16 智能机
1.4 返回参数说明(出参) 参数名 类型 说明 举例 ret_code int 返回结果( 成功:0, 配置变化:1, 失败:错误码) 0 ret_message string 当返回结果为成功时,该字段返回success,当返回结果为失败时,该字段返回错误信息。 success 以下ret_code 为 1 时返回,0和错误不返回 url string 配置 url地址 不变化返回 0 time_span int 上传时间间隔,约定999999 再不上传数据 不变化返回 0 cfgv string 配置版本号 2019031512 情况1、正常返回JSON返回示例: { "ret_code": 0, "ret_message": "success" }
情况2、配置变化JSON返回示例: { "ret_code": 1, "ret_message": "config", "url": "http://202.100.190.58:8090/api/cstmzPosition", "time_span": 30, "cfgv": "2019031513",
}
1.5 错误码参照 错误码 说明 201001 入参错误:MEID无效 201002 入参错误:经纬度信息无效 100001 服务错误:内部处理错误
注意:为了避免接口返回URL地址错误,导致再无法获取配置信息,请做如下异常保障: 1、保留隐藏菜单设置参数,功能(必须支持) 2、对修改配置后长时间(建议4小时)连接失败,建议保留前一个配置版本,进行配置回退(非必须支持,可自行处理)
测试服务器地址: http://202.100.179.139:8088/api
测试规则说明: 传入cfgv <= YYYYMMDDHH 下发配置,切换至url http://202.100.179.139:8088/api_b 时间间隔为 1-5的随机数