# 查询黑名单列表（分页）

该接口用于分页查询全部黑名单号码。

<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`

## 请求头

<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;">pageNum</span> <code style="background:#f0f0f0;">int</code> <span style="background:#28a745; color:white; padding:2px 6px; border-radius:3px; font-size:12px;">可选</span>

页码，从 1 开始，默认 `1`。

---

<span style="font-family:monospace; color:#3451b2;">pageSize</span> <code style="background:#f0f0f0;">int</code> <span style="background:#28a745; color:white; padding:2px 6px; border-radius:3px; font-size:12px;">可选</span>

每页条数，默认 `20`，最大 `200`。

## 响应数据

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

总记录数。

---

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

当前页码。

---

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

每页条数。

---

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

总页数。

---

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

当前页数据，元素结构：`phoneNumber`（号码）、`reason`（加入黑名单原因）、`remark`（备注）、`createTime`（加入时间）。

</div>
</details>

## 请求示例

```shell
curl -X GET --location 'https://dashboard.avavox.com/open/api/v1/phone-blacklists?pageNum=1&pageSize=20' \
--header 'Authorization: Bearer $Key'
```

## 响应示例

```json
{
  "code": 200,
  "message": "操作成功",
  "success": true,
  "data": {
    "total": 2,
    "pageNum": 1,
    "pageSize": 20,
    "pages": 1,
    "list": [
      {
        "phoneNumber": "13800000000",
        "reason": "invalid_number",
        "remark": "2026-05 来自工单系统",
        "createTime": "2026-05-29 10:00:00"
      },
      {
        "phoneNumber": "13900000000",
        "reason": "internal_test",
        "remark": "",
        "createTime": "2026-05-29 10:05:00"
      }
    ]
  }
}
```
