Skip to content

回调管理

设置回调地址

设置的回调地址用于设备上报数据后,回调推送到第三方平台。

回调地址是基础地址,不同的回调信息会拼接不同的路由,基础地址后请勿添加/

  • URL/openapi/callback/set
  • MethodPOST

请求参数

参数类型约束
Body
callbackUrlString回调地址的基础地址,请勿在结尾添加/

请求示例

json
{
    "callbackUrl": "http://www.baidu.com"
}

成功响应

条件:请求参数合法,并且用户身份校验通过。

状态码:200 OK

响应示例

json
{
  "code": 200,
  "type": "success",
  "message": "",
  "extras": "string",
  "time": "2024-07-30 16:54:21"
}

采集数据上报回调

  • URL基础地址/upload
  • MethodPOST

请求参数

参数类型约束
BodyArray采集数据的列表
imeiString设备编号
pointNumString子设备地址,根据实际情况决定是否需要
keyString采集的自定义key,代表含义,请向平台索取
dataString采集到的报文或原数据,木吉云平台未解析。
valueNumber解析后的数据,是否有值,需要根据应用选择的品牌型号来判断。
timeInt64unix毫秒时间戳(13位),设备上报到木吉云的时间戳

请求示例

json
[{
  "imei": "861290073728458",
  "pointNum": "AAAAAAAAAAAA",
  "key": "ua",
  "data":"0001",
  "value": 0.001,
  "time":1722335584640
}]

成功响应

条件:木吉云平台根据来判断是否回调成功,且后,仍判断为推送失败。

状态码:200 OK

设备上线回调

  • URL基础地址/online
  • MethodPOST

请求参数

参数类型约束
BodyArray采集数据的列表
imeiString设备编号
longitudeNumber经度
latitudeNumber纬度
addressesArray子设备地址数组
timeInt64unix毫秒时间戳(13位),设备上报到木吉云的时间戳

请求示例

json
{
  "imei": "861290073728458",
  "longitude": 118.33,
  "latitude": 38.12,
  "addresses":["AAAAAAAAAAAA"],
  "time":1722335584640
}

成功响应

条件:木吉云平台根据来判断是否回调成功,且后,仍判断为推送失败。

状态码:200 OK

设备下线回调

  • URL基础地址/offline
  • MethodPOST

请求参数

参数类型约束
BodyArray采集数据的列表
imeiString设备编号
timeInt64unix毫秒时间戳(13位),设备上报到木吉云的时间戳

请求示例

json
{
  "imei": "861290073728458",
  "time":1722335584640
}

成功响应

条件:木吉云平台根据来判断是否回调成功,且后,仍判断为推送失败。

状态码:200 OK