添加禁止号码规则

添加和配置黑名单规则。

请求 URL

POST {base_url}/{api_path}/block_numbers/create?access_token={access_token}

请求参数

表 1.
参数 是否必填 类型 说明
name 是 String 黑名单规则的名称。
limit_type 是 String 适用于黑名单规则的通话类型。

取值范围：

  • inbound：禁止号码呼入 PBX。
  • outbound：禁止 PBX 分机拨打号码。
  • both：禁止号码呼入 PBX 以及禁止 PBX 分机拨打号码。
number_list 是 String 列表中的号码将被系统禁止呼叫。
注： 使用 & 分隔多个号码。

响应参数

表 2.
参数 类型 说明
errcode Integer 返回错误码。
  • 0：请求成功。
  • 非零值：请求失败。
注： 更多错误码和错误信息说明，请参见 错误码 & 错误信息。
errmsg String 返回信息。
  • SUCCESS：请求成功。
  • FAILURE：请求失败。
id Integer 黑名单规则的唯一 ID。

示例

请求示例

POST /openapi/v1.0/block_numbers/create?access_token=OPmgiTyngN4XJrvYAYepnmVJdggXbOjF HTTP/1.1
Host: 192.168.5.150:8088
Content-Type: application/json
{
    "name":"Product Promotion",
    "limit_type":"inbound",
    "number_list":"1386011111&010879378"
}

响应示例

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "id": 5
}