查询禁止号码列表

查询黑名单列表。

请求URL

GET {base_url}/{api_path}/block_numbers/list?access_token={access_token}

请求参数

表 1.
参数 是否必填 类型 说明
page 否 Integer 定义显示第几个页面。
page_size 否 Integer 定义每页显示几项查询结果。
sort_by 否 String 定义排序字段。

取值范围：

  • id
  • name
order_by 否 String 定义显示顺序。

取值范围：

  • asc：升序
  • desc：降序

响应参数

表 2.
参数 类型 说明
errcode Integer 返回错误码。
  • 0：请求成功。
  • 非零值：请求失败。
注： 更多错误码和错误信息说明，请参见 错误码 & 错误信息。
errmsg String 返回信息。
  • SUCCESS：请求成功。
  • FAILURE：请求失败。
total_number Integer 黑名单规则的总数量。
data Array <Blocklist_Info> 黑名单规则的信息。
Blocklist_Info
表 3.
参数 类型 说明
id Integer 黑名单规则的唯一 ID。
name String 黑名单规则的名称。
limit_type String 适用于黑名单规则的通信类型。
number_list String 被系统禁止的号码。

示例

请求示例

GET /openapi/v1.0/block_numbers/list?access_token=iQbvOlCrG2LgsXxDm5nl8vSEhlkogu6p HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com

响应示例

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "total_number": 3,
    "data": [
        {
            "id": 3,
            "name": "Fraud Calls",
            "limit_type": "inbound",
            "number_list": "82469079"
        },
        {
            "id": 2,
            "name": "Service Promotion",
            "limit_type": "inbound",
            "number_list": "010059292"
        },
        {
            "id": 1,
            "name": "Ads",
            "limit_type": "inbound",
            "number_list": "28192929"
        }
    ]
}