下发回盘任务
概述
- 此 API 用于给机器人下发回盘任务，用于远程控制机器人执行回盘任务；
- 下发的回盘任务会进入任务队列，空闲的机器人会从任务队列中获取回盘任务并执行；
- 已经下发的回盘任务在没有执行之前，与之有相同点位的回盘任务不允许重复下发；
授权方式
| 数据维度授权 | 企业级授权 | 此 API 为企业级授权，企业级授权和代理商级授权的授权账号均可以调用此 API。请参考 授权方式。 |
|---|
| 接口维度授权 | 特殊授权 | 此 API 为特殊授权，您需要为您的授权账号额外申请接口维度授权才可以调用。请参考 授权方式。 |
|---|
请求
请求域名
请求协议
| HTTP URL 路径 | /v1/robot/task/exec_zcb_plate_back_table_task |
|---|---|
| HTTP Method | POST |
| Content-Type | application/x-www-form-urlencoded |
请求体参数
| 参数 | 类型 | 必填 | 参数说明 |
|---|---|---|---|
| ov_corpid | string | 是 | 企业 id |
| pos_name | string | 是 | 回盘点位名称，点位名称中不能包含英文逗号，多个点位使用英文逗号分隔。 |
| lang | string | 否 | 回盘点位名称对应的语言，默认是中文 zh_CN。例如：英文 en_US。 |
请求 cURL 示例
# 请根据您的区域替换域名 curl --location 'https://openapi.orionstar.com/v1/robot/task/exec_zcb_plate_back_table_task' \ --header 'Authorization: Bearer YOUR-ACCESS-TOKEN' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --data-urlencode 'ov_corpid=test_ov_corpid' \ --data-urlencode 'pos_name=餐桌A01'
响应
公共响应体
| 参数 | 类型 | 参数说明 |
|---|---|---|
| code | int | 错误代码。0 是成功，非 0 是失败，请参考 错误代码。 |
| msg | string | 错误描述，当失败的时候会给出具体的错误描述。 |
| req_id | string | 日志跟踪 id，当遇到问题需要猎户星空协助查问题时候，请提供此跟踪 id 值。 |
| data | object | 业务数据 data 对象，详见下述 响应体 data 对象。 |
响应体 data 对象
| 参数 | 类型 | 参数说明 |
|---|---|---|
| exec_result_list | array | 任务下发提交结果信息对象列表数组，数组的每个元素都是一个回盘点位任务下发提交结果信息对象，请参考 任务下发提交结果信息对象。 |
任务下发提交结果信息对象
| 参数 | 类型 | 参数说明 |
|---|---|---|
| ret | string | 提交结果错误代码。0 是成功，非 0 是失败。 |
| msg | string | 提交结果错误描述。当失败的时候会给出具体的错误描述。 |
| pos_name | string | 点位名称 |
响应体示例
{ "code": 0, "msg": "", "data" : { "exec_result_list": [ { "ret": "0", "msg": "", "pos_name": "餐桌A01" }, // ... 其他回盘点位任务下发提交结果 ] } }