Skip to main content

IncidentPush

注册回调,你将实时接收事件报警。

要注册回调,你只需要提供两件事。

首先,你需要指定语言。IETF BCP 47标准:{语言}-{地区}。例如:en-US。

其次,提供回调。回调包含用于认证的url和appId。url格式如https://{{host}}/xx/xx。appId格式如"24416c36-d9c7-4d74-a047-d6ca461fxxxx"。此外,http方法应为POST。

当事件发生时,你的回调将立即被调用。

示例curl命令:

curl -X POST "{{host}}" \
-H "accept: */*" \
-H "Content-Type: application/json" \
-d '{
  "appId": "{{appId}}",
  "payload": {
    "content": {
      "endTime": "",
      "incidentCode": "1011",
      "incidentId": "74bbc189-3313-4665-8204-9fbe45dfxxxx",
      "incidentLevel": "H2",
      "incidentName": "Clean water full",
      "incidentStatus": 1,
      "startTime": "2023-01-14T02:09:28Z",
      "taskId": "74bbc189-3313-4665-8204-9fbe45dfxxxx",
      "subTaskId": "74bbc189-3313-4665-8204-9fbe45dfxxxx",
      "taskInstanceId": "74bbc189-3313-4665-8204-9fbe45dfxxxx",
      "taskName": "74bbc189-3313-4665-8204-9fbe45dfxxxx",
      "mapId": "74bbc189-3313-4665-8204-9fbe45dfxxxx",
      "mapName": "74bbc189-3313-4665-8204-9fbe45dfxxxx"
    },
    "modelTypeCode": "Scrubber 50H",
    "serialNumber": "ITEST00-0000-000-XXXX"
  }
}'

参数描述:

字段名称字段类型字段描述示例
appIdString用于认证"24416c36-d9c7-4d74-a047-d6ca461fxxxx"
payloadObject事件消息内容
payload.serialNumberString机器人序列号"TEST00-0000-000-XXXX"
payload.modelTypeCodeString机器人型号代码"Scrubber 50H"
payload.contentObject事件内容
payload.content.incidentCodeString事件代码"1011"
payload.content.incidentNameString事件名称"Clean water full"
payload.content.incidentLevelString事件等级"H2"
payload.content.incidentIdString事件ID"c084a905-597e-4085-90dd-ecab697dxxxx"
payload.content.incidentStatusint事件状态,1 报警,0 恢复1
payload.content.startTimeString事件开始时间,UTC时间"2023-01-14T02:09:28Z"
payload.content.endTimeString事件结束时间,UTC时间。如果事件未恢复,结束时间为空字符串"2023-01-14T02:09:28Z" 或 ""
payload.content.taskIdString事件发生时,机器人正在执行的任务id"c084a905-597e-4085-90dd-ecab697dxxxx"
payload.content.subTaskIdString事件发生时,机器人正在执行的子任务id"c084a905-597e-4085-90dd-ecab697dxxxx"
payload.content.taskInstanceIdString事件发生时,机器人正在执行的任务实例id"c084a905-597e-4085-90dd-ecab697dxxxx"
payload.content.taskNameString事件发生时,机器人正在执行的任务名称"task1"
payload.content.mapIdString事件发生时,机器人所在地图的id"c084a905-597e-4085-90dd-ecab697dxxxx"
payload.content.mapNameString事件发生时,机器人所在的地图名称"map1"

payload.content.incidentLevel:

名称描述
H0事件这不是报警,仅是事件通知
H1状态埋点统计
H2状态机器人的常规状态,用户无需指导即可解决
H3警告不影响机器人任务,用户可以解决
H4协助,问题影响机器人任务,用户可以解决
H5隐患不影响机器人任务,用户无法解决
H6故障影响机器人任务,用户无法解决
H7质量问题严重故障