RCS接口文档 > 接口详情 更新时间：2025-12-29 14:20:00

RCS接口文档

欢迎使用中扬RCS开放平台 API。本文档提供了完整的接口说明，包含请求参数、返回结果以及示例代码。每个接口都提供了 Mock 功能，方便您快速测试和集成。

📌 快速对接指南

接口中标 * 的为常用接口，初步对接时，只需要调通以下接口：

如果上层系统需要接收任务的执行状态，需要提供以下接口，供调度系统回调：

⚠️ 超时设置：中扬调度系统调用上层系统的接口，获取连接超时时间默认为 30秒，数据返回超时时间默认为 60秒，超时情况下，调度系统会返回连接失败。

📋 对接约定

接口概览

🔗 基础信息

基础 URL http://IP:PORT
请求格式 application/json
返回格式 application/json
字符编码 UTF-8

📋 通用请求参数

以下参数为所有接口的通用参数，每次调用时需要携带：

参数名 是否必填 描述
reqTime 选填 请求时间戳，格式: yyyy-MM-dd HH:mm:ss。由上层系统设定。
tokenCode 选填 令牌号，由调度系统颁发。如果填写，需先在 RCS-2000 系统配置，上层系统调用时进行填写。

📤 通用返回值定义

所有接口的响应都遵循以下统一格式：

参数名 是否必填 描述
code 必填 返回编号，200 表示成功，1~N 表示失败
message 必填 返回消息，请求成功 表示成功，内容为详细的错误描述
data 选填 返回的数据结构，具体内容根据接口而定

生成任务单* 常用

POST 创建搬运任务

/api/open/bus/submit

请求参数

参数名 类型 必填 说明
batchNo string 是 批次编号（上层系统生成，唯一标识）
tasks array 是 任务数组，包含具体的任务详情

任务数组元素参数

参数名 类型 必填 说明
taskNo string 是 任务编号（上层系统生成，唯一标识）
oriSta string 否 起点站点编号
destSta string 否 终点站点编号
oriLoc string 否 起点库位编号
destLoc string 否 终点库位编号
priority int 否 优先级：1-300，默认为1

请求示例

{
  
  "batchNo": "122334",
  "tasks": [
    {
        "taskNo": "TASK20231220001",
      "oriLoc": "A100100101",
      "destSta": "STA001",
      "priority": 1
    },
    {
        "taskNo": "TASK20231220001",
      "oriSta": "STA002",
      "destLoc": "B02-03-05",
      "priority": 2
    }
  ]
}

返回示例

{
  "code": 200,
  "message": "任务创建成功",
  "data": {
    "taskNo": "TASK20231220001",
    "taskId": "T1234567890",
    "status": "ASSIGN"
  },
  "timestamp": 1671526800000
}

Mock 测试

取消任务单* 常用

POST 取消已创建的任务

/api/open/task/cancel

请求参数

参数名 类型 必填 说明
tasks array 是 要取消的任务编号数组
batchNo string 是 任务批次编号

请求示例

{
	“batchNo”: “12345”,
	“tasks”: [“123”, “456”]
}

返回示例

{
	code: 200,
	msg: ‘…’,
	data: [
		{
			“taskNo”: “123”,
			“success”: true,
			“msg”: null
		},
		{
			“taskNo”: “456”,
			“success”: false,
			“msg”: “456 is not exist”
		}
	]
}
注意事项

• 已经在执行中的任务无法取消，会返回相应错误码

• 取消任务后，AGV会停止执行并返回待命状态

Mock 测试

任务执行通知* 回调接口

POST RCS回调上层系统接口

/api/open/task/report
📢 接口说明

此接口由上层系统提供，RCS系统在任务状态发生变化时主动回调。上层系统需要实现此接口并配置回调地址到RCS系统中。

请求参数（RCS推送）

参数名 类型 必填 说明
batchNo string 是 任务批次
taskNo string 是 任务编号
timestamp string 是 时间戳

推送示例（RCS → 上层系统）

{
  "taskNo": "TASK20231220001",
  "batchNo": "2345",
  "timestamp": "2023-12-20 14:30:25"
}

返回示例（上层系统需返回）

{
  "code": 200,
  "message": "接收成功"
}

Mock 测试（模拟RCS推送）

申请入库任务* 常用

POST 申请入库任务

/api/open/location/allocate
📢 接口说明

此接口由上层系统提供，RCS系统在任务状态发生变化时主动回调。上层系统需要实现此接口并配置回调地址到RCS系统中。

请求参数

参数名 类型 必填 说明
barcode string 是 料箱码
staNo string 是 入库站点

请求示例

{
  "barcode": "8000001",
  "staNo": "1005"
}

返回示例

{
  "code": 200,
  "message": "success",
  "data": {
    "locNo": "A100100101"
  }
}

Mock 测试

错误码说明

通用错误码

错误码 说明 解决方案
200 成功 -
500 参数错误 检查请求参数是否完整和正确

以上内容对您有帮助吗?

☆ ☆ ☆ ☆ ☆