Skip to main content

任务报告推送

注册回调,你将实时接收任务报告。

要注册回调,你只需提供回调信息。

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

当任务报告生成时,你的回调将立即被调用。

示例curl命令:

curl --location 'https://{{host}}/xx/xx' \
--header 'accept: */*' \
--header 'Content-Type: application/json' \
--data '{ 
  "appId": "24416c36-aaaa-4d74-aaaa-d6ca461faaaa", 
  "payload": { 
    "serialNumber": "TEST00-0000-000-XXXX", 
    "modelTypeCode": "Scrubber S1", 
    "taskReport": { 
      "id": "684c183c-4ad9-467b-ac7c-55835255AAAA", 
      "taskId": "233123123-d9c7-4d74-a047-d6ca461faaaa",
      "planId": "233123123-d9c7-4d74-a047-d6ca461faaaa",
      "taskInstanceId": "893cbadf-3bb1-45be-b7ef-d590d54fAAAA", 
      "displayName": "ceshi2", 
      "startTime": 1714124784000, 
      "endTime": 1714124890000, 
      "robot": "S2153", 
      "robotSerialNumber": "TEST00-0000-000-xxxx", 
      "operator": "admin", 
      "completionPercentage": 0.156, 
      "durationSeconds": 106, 
      "plannedCleaningAreaSquareMeter": 67.425, 
      "actualCleaningAreaSquareMeter": 10.548, 
      "efficiencySquareMeterPerHour": 407.965, 
      "plannedPolishingAreaSquareMeter": null, 
      "actualPolishingAreaSquareMeter": null, 
      "waterConsumptionLiter": 0.0, 
      "startBatteryPercentage": 38.0, 
      "endBatteryPercentage": 38.0, 
      "consumablesResidualPercentage": { 
        "brush": 100.0, 
        "filter": 100.0, 
        "suctionBlade": 100.0 
      }, 
      "cleaningMode": "清扫", 
      "taskEndStatus": 1, 
      "subTasks": [ 
        { 
          "mapId": "370192bd-fe7f-40d0-8d0a-4360415bb8cf", 
          "mapName": "ceshi2", 
          "actualCleaningAreaSquareMeter": 10.548,
          "taskId": "233123123-d9c7-4d74-a047-d6ca461faaaa" 
        } 
      ], 
      "taskReportPngUri": "https://bot.release.gs-robot.com/robot-task/task/report/png/v2/en/684c183c-4ad9-467b-ac7c-55835255aaaa" 
    } 
  } 
}'

参数描述:

字段名称字段类型字段描述示例
appIdString用于认证"24416c36-d9c7-4d74-a047-d6ca461fxxxx"
payloadObject事件消息内容
payload.serialNumberString机器人序列号"TEST00-0000-000-XXXX"
payload.modelTypeCodeString机器人型号代码"Scrubber 50H"
payload.taskReportObject任务报告
payload.taskReport.idString任务ID"24416c36-d9c7-4d74-a047-d6ca461faaaa"
payload.taskReport.taskInstanceIdString任务实例ID"32803b4c-7a58-45c5-a1e4-e636e89baaaa"
payload.taskReport.taskIdString静态任务id"32803b4c-7a58-45c5-a1e4-e636e89baaaa"
payload.taskReport.planIdString调度计划id"32803b4c-7a58-45c5-a1e4-e636e89baaaa"
payload.taskReport.displayNameString任务的可读名称"10楼清洁任务"
payload.taskReport.startTimeLong任务开始时间,时间戳,单位:毫秒1714290913000
payload.taskReport.endTimeLong任务结束时间,时间戳,单位:毫秒1714290952000
payload.taskReport.robotString机器人的可读名称"S2153"
payload.taskReport.robotSerialNumberString机器人序列号"GS000-XXXX-XXX-XXXX"
payload.taskReport.operatorString任务操作员"Mike"
payload.taskReport.completionPercentageDouble任务完成百分比,范围0-10.55
payload.taskReport.durationSecondsInteger任务持续时间(秒)300
payload.taskReport.plannedCleaningAreaSquareMeterDouble计划清洁面积(平方米)200.5
payload.taskReport.actualCleaningAreaSquareMeterDouble实际清洁面积(平方米)100.2
payload.taskReport.efficiencySquareMeterPerHourDouble清洁效率(平方米/小时)300.7
payload.taskReport.plannedPolishingAreaSquareMeterDouble计划抛光面积(平方米)200.5
payload.taskReport.actualPolishingAreaSquareMeterDouble实际抛光面积(平方米)200.5
payload.taskReport.waterConsumptionLiterDouble任务期间的水消耗量(升)5.0
payload.taskReport.startBatteryPercentageDouble任务开始时的电池电量百分比,范围0-10070.0
payload.taskReport.endBatteryPercentageDouble任务结束时的电池电量百分比,范围0-10040.0
consumablesResidualPercentageObject消耗品剩余百分比
consumablesResidualPercentage.brushDouble刷子的剩余寿命百分比50.0
coumablesResidualPercentage.filterDouble过滤器的剩余寿命百分比50.0
coumablesResidualPercentage.suctionBladeDouble吸尘器刮刀的剩余寿命百分比50.0
cleaningModeString清洁模式"扫地"
taskEndStatusInteger任务结束状态。-1:未知,0:正常结束,1:手动结束,2:异常结束,3:启动失败0
subTasksArray子任务列表
subTasks[0].mapIdString地图ID"370192bd-fe7f-40d0-8d0a-4360415baaaa"
subTasks[0].mapNameString地图名称"测试地图"
subTasks[0].actualCleaningAreaSquareMeterDouble实际清洁面积(平方米)10.0
subTasks[0].taskIdDouble子任务id"32803b4c-7a58-45c5-a1e4-e636e89baaaa"
taskReportPngUriString任务报告png URI"https://bot.gs-robot.com/robot-task/task/report/png/v2/en/47e3628b-a2b9-4124-bbbc-45e0d4bfaaaa"