查询号码是否在黑名单

该接口用于查询单个号码是否在黑名单中。命中时一并返回该号码的原因与备注。

GEThttps://dashboard.avavox.com/open/api/v1/phone-blacklists/check

请求头

Authorization string 必填

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

请求参数

phoneNumber string 必填

待查询的号码，作为 Query 参数传入。

响应数据

code int

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

---

success boolean

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

---

message string

描述信息。

---

data object

点击展开字段说明

phoneNumber string

被查询的号码。

---

blacklisted boolean

是否在黑名单中。true 表示命中。

---

reason string

加入黑名单原因。命中时返回，未命中为 null。枚举值： 加入黑名单原因，枚举值：

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

---

remark string

备注。命中时返回，未命中为 null。

请求示例

curl -X GET --location 'https://dashboard.avavox.com/open/api/v1/phone-blacklists/check?phoneNumber=13800000000' \
--header 'Authorization: Bearer $Key'

响应示例

命中：

{
  "code": 200,
  "message": "操作成功",
  "success": true,
  "data": {
    "phoneNumber": "13800000000",
    "blacklisted": true,
    "reason": "invalid_number",
    "remark": "2026-05 来自工单系统"
  }
}

未命中：

{
  "code": 200,
  "message": "操作成功",
  "success": true,
  "data": {
    "phoneNumber": "user_opt_out",
    "blacklisted": false,
    "reason": null,
    "remark": null
  }
}