批量写入黑名单

该接口用于将一批号码写入号码黑名单。命中黑名单的号码在外呼时将被拦截。

POSThttps://dashboard.avavox.com/open/api/v1/phone-blacklists/batch-create

请求头

Authorization string 必填

• 填写格式：Authorization: Bearer <App Key>
• <App Key> 为控制台「App Key 管理」页面生成的 Key。
• 获取方式详见：《App Key 创建与管理》。

请求体参数

entries array 必填

需要写入的黑名单列表，单次最大 2000 条。数组元素结构如下：

点击展开字段说明

phoneNumber string 必填

号码。支持标准手机号，也支持固话。同一号码重复提交时，以最后一条为准。

---

reason string 必填

加入黑名单原因，枚举值：

• user_opt_out： 用户拒绝
• complaint_risk： 投诉风险
• invalid_number： 无效号码
• internal_test：内部测试
• carrier_number_pool：运营商号码池
• other： 其他

---

remark string 可选

备注，最大长度 255。

响应数据

code int

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

---

success boolean

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

---

message string

描述信息。

---

data object

点击展开字段说明

total int

本次请求去重后的处理总条数。

---

successCount int

写入成功条数。

---

failCount int

写入失败条数。

---

failedItems array

失败明细，元素结构：phoneNumber（失败号码）、reason（失败原因）。全部成功时为空数组。

请求示例

curl -X POST --location 'https://dashboard.avavox.com/open/api/v1/phone-blacklists/batch-create' \
--header 'Authorization: Bearer $Key' \
--header 'Content-Type: application/json' \
--data '{
  "entries": [
    {
      "phoneNumber": "13800000000",
      "reason": "carrier_number_pool",
      "remark": "2026-05 来自工单系统"
    },
    {
      "phoneNumber": "139000",
      "reason": "complaint_risk",
      "remark": ""
    }
  ]
}'

响应示例

{
  "code": 200,
  "message": "操作成功",
  "success": true,
  "data": {
    "total": 2,
    "successCount": 1,
    "failCount": 1,
    "failedItems": [
      {
        "phoneNumber": "139000",
        "reason": "号码格式不支持"
      }
    ]
  }
}