# 查询任务列表

<span style="display:inline-block;background:#e6f8ea;color:#22a366;border-radius:6px;padding:2px 8px;font-weight:bold;font-family:monospace;margin-right:8px;">GET</span>
`https://dashboard.avavox.com/open/api/task/list`

## 请求头

<span style="font-family:monospace; color:#3451b2; ">Authorization</span> <code style="background:#f0f0f0; ">string</code> <span style="background:#dc3545; color:white; padding:2px 6px; border-radius:3px; font-size:12px;">必填</span>

- 填写格式：`Authorization: Bearer <App Key>`
- `<App Key>` 为控制台「App Key 管理」页面生成的 Key。
- 获取方式详见：[《App Key 创建与管理》](https://avavox.com/docs/developer/app-key.html)。

## 请求参数

以下参数均作为 Query 参数拼接在 URL 中传入。

<span style="font-family:monospace; color:#3451b2;">clientBizId</span> <code style="background:#f0f0f0;">string</code> <span style="background:#28a745; color:white; padding:2px 6px; border-radius:3px; font-size:12px;">可选</span>

调用方业务ID，精确匹配

---

<span style="font-family:monospace; color:#3451b2;">taskName</span> <code style="background:#f0f0f0;">string</code> <span style="background:#28a745; color:white; padding:2px 6px; border-radius:3px; font-size:12px;">可选</span>

任务名称，模糊匹配

---

<span style="font-family:monospace; color:#3451b2;">status</span> <code style="background:#f0f0f0;">string</code> <span style="background:#28a745; color:white; padding:2px 6px; border-radius:3px; font-size:12px;">可选</span>

任务状态，枚举值如下：

- `pending`: 未开始
- `running`：进行中
- `paused`：暂停中
- `completed`：已完成



## 响应数据

<span style="font-family:monospace; color:#3451b2; ">code</span> <code style="background:#f0f0f0; ">int</code>

状态码，200 为成功，其他状态均为失败。

---

<span style="font-family:monospace; color:#3451b2; ">success</span> <code style="background:#f0f0f0; color: #333; ">boolean</code>

是否成功，`true` 表示成功，`false` 表示失败。

---

<span style="font-family:monospace; color:#3451b2; ">message</span> <code style="background:#f0f0f0;">string</code>

描述信息

---

<span style="font-family:monospace; color:#3451b2; ">data</span> <code style="background:#f0f0f0;">array</code>

任务列表数据，结构如下：

<details>
<summary>点击展开字段说明</summary>

<div style="margin: 16px 0; padding: 16px;  border-left: 1px solid #f0f0f0; border-radius: 6px;">

<span style="font-family:monospace; color:#3451b2; ">taskId</span> <code style="background:#f0f0f0; ">string</code>

任务 ID。

---

<span style="font-family:monospace; color:#3451b2; ">taskName</span> <code style="background:#f0f0f0; ">string</code>

任务名称

---

<span style="font-family:monospace; color:#3451b2; ">clientBizId</span> <code style="background:#f0f0f0; ">string</code>

调用方业务ID，创建任务时传入，未传入则为 `null`

---

<span style="font-family:monospace; color:#3451b2; ">metadata</span> <code style="background:#f0f0f0; ">object</code>

随路数据，创建任务时传入，未传入则为 `null`

---

<span style="font-family:monospace; color:#3451b2; ">robotId</span> <code style="background:#f0f0f0; ">string</code>

任务使用的机器人 ID

---

<span style="font-family:monospace; color:#3451b2; ">robotName</span> <code style="background:#f0f0f0; ">string</code>

机器人名称

---

<span style="font-family:monospace; color:#3451b2; ">status</span> <code style="background:#f0f0f0; ">object</code>

任务状态

<details>
<summary>点击展开字段说明</summary>

<div style="margin: 16px 0; padding: 16px;  border-left: 1px solid #f0f0f0; border-radius: 6px;">

<span style="font-family:monospace; color:#3451b2; ">status</span> <code style="background:#f0f0f0; ">string</code>

任务状态，取值如下：
- `pending`: 未开始
- `running`：进行中
- `paused`：暂停中
- `completed`：已完成

---

<span style="font-family:monospace; color:#3451b2; ">pauseReason</span> <code style="background:#f0f0f0; ">string</code>

任务暂停的原因



</div>
</details>



</div>
</details>


## 请求示例

```shell
curl --location 'https://dashboard.avavox.com/open/api/task/list?clientBizId=ORDER_20260722001&taskName=任务名称&status=running' \
--header 'Authorization: Bearer $Key' \
--header 'Content-Type: application/json'

```



## 响应示例

```json
{
  "code": 200,
  "message": "操作成功",
  "success": true,
  "data": [
    {
      "taskId": "adfase",
      "taskName": "任务1",
      "clientBizId": "ORDER_20260722001",
      "metadata": {
        "orderId": "10001"
      },
      "robotId": "fwegw",
      "robotName": "机器人1",
      "status": {
        "status": "completed",
        "pauseReason": null
      }
    }
  ]
}
```