查询单个禁止号码规则的信息

查询单个黑名单号码规则的具体信息。

请求 URL

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

请求参数

表 1.
参数 是否必填 类型 说明
id 是 Integer 黑名单规则的唯一 ID。
注： 你可以通过 搜索特定的禁止号码规则 查询黑名单号码规则的 ID。

响应参数

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

示例

请求示例

GET /openapi/v1.0/block_numbers/get?access_token=OPmgiTyngN4XJrvYAYepnmVJdggXbOjF&id=3 HTTP/1.1
Host: 192.168.5.150:8088

响应示例

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "block_number_info": {
        "id": 3,
        "name": "Fraud Calls",
        "limit_type": "inbound",
        "number_list": "82469079"
    }
}