办事窗口与云迹机器结合

窗口办公与云迹机器人用例图

GET

结果

窗口工作人员

呼叫机器人

GET

字段值

含义

taskId

调度任务的ID

index

提交的任务在队列中的位置

/openapi/v1/robot/schedule/query

开启仓门

查询当前的任务排队状态

参数

placeId

服务地点ID

POST

/openapi/v1/robot/callable

1. 查询机器人是否可接收呼叫2. 呼叫机器人到指定地点

productId

机器人的编号，例如：HOTQY00SZ201704180503001

target

目的地，例如房间号502

password

可选参数，取物密码，调用方生成，传md5加密后的值: md5(password)

关闭仓门

查看状态

调度机器人API

基本状态接口

/openapi/v1/robot/door/open

data字段的含义：

true

取消成功

false

取消失败

机器人编号

调度机器人

/openapi/v1/robot/task/cancel

呼叫一个指定的机器人到指定位置，有四个接口组成:

开门接口

将机器人呼叫到指定地点，有两个接口组成:

可调度，此时可调用下面的调度接口

不可调度，机器人任务队列已满

/openapi/v1/robot/schedule

/openapi/v1/robot/schedulable

查询机器人是否可呼叫

机器人基本控制API

注意：data只有一个状态true，没有其它状态，如果呼叫失败errcode!=0，会通过errmsg给出错误提示，所以可以直接通过errcode==1来判断是否呼叫成功。

关门接口

/openapi/v1/robot/back

/openapi/v1/robot/door/close

取消任务接口

callback的接口由调用放自己定义，POST接口，参数为JSON格式，包括，但不限于以下信息，由调用方解析并决定如何使用：

取消指定的任务（排队中的）

可呼叫，此时可调用下面的呼叫接口

不可呼叫，机器人此时处于工作状态

/openapi/v1/robot/status

调度接口返回的任务ID

1. 查询是否可调度（任务队列未满）2. 提交呼叫机器人的任务3. 查询当前的任务状态4. 取消指定的任务

/openapi/v1/robot/call

返回充电桩接口

查询是否可调度

callback

可选参数，任务开始执行时的回调URL，用来通知调用方被调用的机器人相关信息

/openapi/v1/robot/schedule/cancel