---
title: API 总览
---

# API 总览

本页汇总 AVAVOX 开放 API 的对接流程与全部接口清单，帮助你在深入具体接口文档前，先建立一个全局认知：有哪些接口、分别做什么、以及一个典型对接流程该按什么顺序调用它们。

::: tip 通过 AI 助手使用开放 API
希望通过自然语言查询资源、管理外呼任务或查看账单与质检洞察，可以安装 [avavox 智能外呼 Skill](https://avavox.com/docs/developer/avavox-call.html)。指南提供 SkillHub 安装入口、本站技能包下载和首次配置说明。
:::

## 对接流程

一个典型的对接过程分 4 步：**准备**（拿到 App Key，查询机器人 / 线路 / 变量等基础资源）→ **创建任务**（或查询并复用已有任务）→ **导入客户数据**（触发外呼）→ **任务控制**（查询、暂停、恢复、修改、删除）。号码导入结果和通话过程结果，由 AVAVOX 通过异步回调主动推送到你的系统。此外，还提供一组**账单查询**接口，可按账户 / 空间 / 机器人 / 任务四个维度拉取账单数据；以及一组**洞察数据**接口，用于拉取通话质检的洞察结果。

![AVAVOX Open API 对接流程图](https://avavox.com/docs/developer/open-arch.png)

::: tip 鉴权
所有接口调用都需要在请求头携带 `Authorization: Bearer <App Key>`，App Key 的创建与管理见 [App Key 创建与管理](https://avavox.com/docs/developer/app-key.html)。
:::

## 接口清单

下表按域列出全部接口，点击接口名跳转到对应的详细文档（入参、返回值、示例）。

### 基础查询

| 接口 | 方法 & 路径 |
| --- | --- |
| [查询机器人列表](https://avavox.com/docs/developer/query-robot.html) | `GET /open/api/task/robot` |
| [查询可用线路](https://avavox.com/docs/developer/query-line.html) | `GET /open/api/task/line` |

### 任务管理

| 接口 | 方法 & 路径 |
| --- | --- |
| [创建任务](https://avavox.com/docs/developer/task/create.html) | `POST /open/api/task` |
| [查询任务列表](https://avavox.com/docs/developer/task/query.html) | `GET /open/api/task/list` |
| [查询任务详情](https://avavox.com/docs/developer/task/query-details.html) | `GET /open/api/task/{taskId}` |
| [修改任务](https://avavox.com/docs/developer/task/update.html) | `PUT /open/api/task/{taskId}` |
| [暂停任务](https://avavox.com/docs/developer/task/pause.html) | `POST /open/api/task/{taskId}/pause` |
| [恢复任务](https://avavox.com/docs/developer/task/resume.html) | `POST /open/api/task/{taskId}/resume` |
| [删除任务](https://avavox.com/docs/developer/task/delete.html) | `DELETE /open/api/task/{taskId}` |
| [查询任务机器人变量](https://avavox.com/docs/developer/task/query-robot-variables.html) | `GET /open/api/task/{taskId}/robot-variables` |

### 数据导入

| 接口 | 方法 & 路径 |
| --- | --- |
| [客户导入](https://avavox.com/docs/developer/data-import.html) | `POST /open/api/task/import` |

### 异步回调

由 AVAVOX 主动推送到你预先配置的地址，无需轮询。两类回调的地址在平台 **空间管理 → 接口回调 → 回调设置** 中**分别配置**，互不影响，需要哪类就配置哪类。

| 回调 | 说明 |
| --- | --- |
| [导入结果回调](https://avavox.com/docs/developer/data-import-callback.html) | AVAVOX → 你的系统，通知号码导入的成功 / 失败明细 |
| [通话记录回调](https://avavox.com/docs/developer/call-record.html) | AVAVOX → 你的系统，共 4 个阶段，顺序不固定 |

### 号码黑名单

| 接口 | 方法 & 路径 |
| --- | --- |
| [批量写入黑名单](https://avavox.com/docs/developer/blacklist/create.html) | `POST /open/api/v1/phone-blacklists/batch-create` |
| [批量删除黑名单](https://avavox.com/docs/developer/blacklist/delete.html) | `POST /open/api/v1/phone-blacklists/batch-delete` |
| [查询号码是否在黑名单](https://avavox.com/docs/developer/blacklist/check.html) | `GET /open/api/v1/phone-blacklists/check` |
| [查询黑名单列表](https://avavox.com/docs/developer/blacklist/query.html) | `GET /open/api/v1/phone-blacklists` |

### 账单查询

按账户、空间、机器人、任务四个维度查询账单，支持月粒度与日粒度。鉴权方式、公共参数与数据口径见 [账单接口总览](https://avavox.com/docs/developer/bill/)。

| 接口 | 方法 & 路径 |
| --- | --- |
| [账户账单](https://avavox.com/docs/developer/bill/account.html) | `POST /open/api/v1/bills/account/query` |
| [空间账单](https://avavox.com/docs/developer/bill/space.html) | `POST /open/api/v1/bills/spaces/query` |
| [机器人账单](https://avavox.com/docs/developer/bill/robot.html) | `POST /open/api/v1/bills/robots/query` |
| [任务账单](https://avavox.com/docs/developer/bill/task.html) | `POST /open/api/v1/bills/tasks/query` |
| [查询 Key 信息](https://avavox.com/docs/developer/bill/key-info.html) | `GET /open/api/v1/auth/key-info` |
| [查询空间列表](https://avavox.com/docs/developer/bill/space-list.html) | `GET /open/api/v1/spaces` |
| [查询计费项字典](https://avavox.com/docs/developer/bill/fee-items.html) | `GET /open/api/v1/bills/fee-items` |

### 洞察数据

查询通话质检的洞察结果，覆盖列表筛选、详情、录音与筛选字典。鉴权方式、枚举、错误码与数据口径见 [洞察数据接口总览](https://avavox.com/docs/developer/insight/)。

| 接口 | 方法 & 路径 |
| --- | --- |
| [洞察列表查询](https://avavox.com/docs/developer/insight/record-query.html) | `POST /open/api/v1/insight/records/query` |
| [洞察详情](https://avavox.com/docs/developer/insight/record-detail.html) | `GET /open/api/v1/insight/records/{insightId}` |
| [通话录音地址](https://avavox.com/docs/developer/insight/record-audio.html) | `GET /open/api/v1/insight/records/{insightId}/audio` |
| [查询筛选字典](https://avavox.com/docs/developer/insight/dicts.html) | `GET /open/api/v1/insight/dicts` |