文档

AddSecretBlacklist - 添加黑名单

更新时间:

向号码池添加黑名单。仅AXB、AXN隐私号、AXN分机号、95AXN隐私号类型的号码池支持设置黑名单。

接口说明

  • 此接口不是批处理接口,仅支持一次添加一组点对点黑名单号码,或者一个号池黑名单号码。
  • 若需删除黑名单,可调用 DeleteSecretBlacklist 接口。

QPS 限制

本接口的单用户 QPS 限制为 100 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dypls:AddSecretBlacklistWrite
  • 全部资源
    *

请求参数

名称类型必填描述示例值
PoolKeystring

号码池 Key。

在号码隐私保护控制台,号码池管理页面获取号码池 Key

FC2235****
BlackNostring

黑名单号码。根据 BlackType 参数值决定取值类型:

  • 点对点黑名单:一对号码,用英文冒号(:)分隔。
  • 号池黑名单:单个号码。
说明 (*)不是通配符。
1825638****:1825248****
Remarkstring

黑名单备注。

黑名单备注
BlackTypestring

黑名单类型。取值:

  • POINT_TO_POINT_BLACK:点对点黑名单。
  • PARTNER_GLOBAL_NUMBER_BLACK:号码池黑名单。
POINT_TO_POINT_BLACK
WayControlstring

呼叫方向控制。取值:

  • PHONEA_REJECT:BlackNo 中第一个号码可以呼叫第二个号码,第二个号码不能呼叫第一个。
  • PHONEB_REJECT:BlackNo 中第一个号码不可呼叫第二个号码,第二个号码可呼叫第一个号码。
  • 不填:BlackNo 中两个号码不可相互呼叫。
说明 只有在点对点黑名单时候才有用。
枚举值:
  • DUPLEX_REJECT
  • PHONEA_REJECT
  • PHONEB_REJECT
PHONEA_REJECT

返回参数

名称类型描述示例值
object

返回数据。

Codestring

请求状态码。

  • 返回 OK 代表请求成功。
  • 其他错误码,请参见错误码列表
OK
Messagestring

状态码的描述。

OK
RequestIdstring

请求 ID。

F655A8D5-B967-440B-8683-DAD6FF8DE990

示例

正常返回示例

JSON格式

{
  "Code": "OK",
  "Message": "OK",
  "RequestId": "F655A8D5-B967-440B-8683-DAD6FF8DE990"
}

错误码

HTTP status code错误码错误信息描述
400RamPermissionDeniedRAM permission is denied.RAM权限DENY

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)