Agent控制接口

快捷请求

Base URLs:

• 开发环境: http://192.168.20.168:9999

Authentication

Default

POST 开始任务

POST /robots/{sn}/tasks/start

机器人开始执行讲解任务并前往第一个讲解点

请求参数

名称	位置	类型	必选	说明
sn	path	string	是	机器人SN

返回示例

200 Response

{
  "code": 0,
  "msg": "string",
  "data": {
    "instanceId": "string"
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» code	integer	true	none	业务返回码	none
» msg	string	true	none	消息	none
» data	object	true	none	数据	none
»» instanceId	string	true	none	创建的任务实例ID	none

GET 获取当前讲解内容

GET /robot-tasks/{instanceId}/speech

获取机器人当前所在任务节点的讲解文本

请求参数

名称	位置	类型	必选	说明
instanceId	path	string	是	任务实例ID

返回示例

200 Response

{
  "code": 0,
  "message": "string",
  "data": {
    "content": "string"
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» code	integer	true	none		none
» message	string	true	none		none
» data	object	false	none		none
»» content	string	true	none	要说的文本	none

POST 前往任务链的下一个讲解点

POST /robot-tasks/{instanceId}/next-point

控制机器人前往任务链的下一个讲解点

请求参数

名称	位置	类型	必选	说明
instanceId	path	string	是	任务实例ID

返回示例

200 Response

{
  "code": 0,
  "message": "string"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» code	integer	true	none		none
» message	string	true	none		none

POST 暂停导航任务

POST /robot-tasks/{instanceId}/pause

取消机器人的当前导航任务

请求参数

名称	位置	类型	必选	说明
instanceId	path	string	是	none

返回示例

200 Response

{
  "code": 0,
  "message": "string"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» code	integer	true	none		none
» message	string	true	none		none

GET 获取任务状态

GET /robot-tasks/{instanceId}/status

获取机器人当前导航任务状态

请求参数

名称	位置	类型	必选	说明
instanceId	path	string	是	任务实例ID

返回示例

200 Response

{
  "code": 0,
  "message": "string",
  "data": {
    "finish": true
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» code	integer	true	none		none
» message	string	true	none		none
» data	object	false	none		none
»» finish	boolean	true	none		导航任务是否完成

POST 结束任务，返回停靠点

POST /robot-tasks/{instanceId}/end

结束讲解任务，返回停靠点

请求参数

名称	位置	类型	必选	说明
instanceId	path	string	是	任务实例ID

返回示例

200 Response

{
  "code": 0,
  "message": "string"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» code	integer	true	none		none
» message	string	true	none		none

数据模型

标准响应

{
  "code": 0,
  "message": "string",
  "data": {}
}
 

属性

名称	类型	必选	约束	中文名	说明
code	integer	true	none		none
message	string	true	none		none
data	object	false	none		none