API 总览

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

对接流程

一个典型的对接过程分 4 步：准备（拿到 App Key，查询机器人 / 线路 / 变量等基础资源）→ 创建任务（或查询并复用已有任务）→ 导入客户数据（触发外呼）→ 任务控制（查询、暂停、恢复、修改、删除）。号码导入结果和通话过程结果，由 AVAVOX 通过异步回调主动推送到你的系统。

鉴权

所有接口调用都需要在请求头携带 Authorization: Bearer <App Key>，App Key 的创建与管理见 App Key 创建与管理。

接口清单

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

基础查询

接口	方法 & 路径
查询机器人列表	GET /open/api/task/robot
查询可用线路	GET /open/api/task/line

任务管理

接口	方法 & 路径
创建任务	POST /open/api/task
查询任务列表	GET /open/api/task/list
查询任务详情	GET /open/api/task/{taskId}
修改任务	PUT /open/api/task/{taskId}
暂停任务	POST /open/api/task/{taskId}/pause
恢复任务	POST /open/api/task/{taskId}/resume
删除任务	DELETE /open/api/task/{taskId}
查询任务机器人变量	GET /open/api/task/{taskId}/robot-variables

数据导入

接口	方法 & 路径
客户导入	POST /open/api/task/import

异步回调

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

回调	说明
导入结果回调	AVAVOX → 你的系统，通知号码导入的成功 / 失败明细
通话记录回调	AVAVOX → 你的系统，共 4 个阶段，顺序不固定

号码黑名单

接口	方法 & 路径
批量写入黑名单	POST /open/api/v1/phone-blacklists/batch-create
批量删除黑名单	POST /open/api/v1/phone-blacklists/batch-delete
查询号码是否在黑名单	GET /open/api/v1/phone-blacklists/check
查询黑名单列表	GET /open/api/v1/phone-blacklists