编辑允许号码规则

编辑白名单规则的相关配置。

请求 URL

POST {base_url}/{api_path}/allow_numbers/update?access_token={access_token}

请求参数

1.
参数 是否必填 类型 说明
id Integer 白名单规则的唯一 ID。
注: 你可以通过 搜索特定的允许号码规则 查询白名单规则的 ID。
name String 白名单规则的名称。
limit_type String 适用于白名单的通话类型。

取值范围

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

响应参数

2.
参数 类型 说明
errcode Integer 返回错误码。
  • 0:请求成功。
  • 非零值:请求失败。
注: 更多错误码和错误信息说明,请参见 错误码 & 错误信息
errmsg String 返回信息。
  • SUCCESS:请求成功。
  • FAILURE:请求失败。

示例

请求示例

POST /openapi/v1.0/allow_numbers/update?access_token=ffUn1DAFD3kfBYjqxISx18dR531iTrMd HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com
Content-Type: application/json
{
    "id":3,
    "limit_type":"both"
}

响应示例

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