# 查询号码是否在黑名单

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

<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/v1/phone-blacklists/check`

## 请求头

<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)。

## 请求参数

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

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

## 响应数据

<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;">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;">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;">phoneNumber</span> <code style="background:#f0f0f0;">string</code>

被查询的号码。

---

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

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

---

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

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

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


---

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

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

</div>
</details>

## 请求示例

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

## 响应示例

命中：

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

未命中：

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