向号码池添加黑名单。仅AXN隐私号、AXN分机号、95AXN隐私号类型的号码池支持设置黑名单。
接口说明
- 此接口不是批处理接口，仅支持一次添加一组点对点黑名单号码，或者一个号池黑名单号码。
- 若需删除黑名单，可调用 DeleteSecretBlacklist 接口。
QPS 限制
本接口的单用户 QPS 限制为 100 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| dypls:AddSecretBlacklist | create |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| PoolKey | string | 是 | 号码池 Key。 在号码隐私保护控制台，号码池管理页面获取号码池 Key。 | FC2235**** |
| BlackNo | string | 是 | 黑名单号码。根据 BlackType 参数值决定取值类型：
说明
（*）不是通配符。
| 1825638****:1825248**** |
| Remark | string | 否 | 黑名单备注。 | 黑名单备注 |
| BlackType | string | 是 | 黑名单类型。取值：
| POINT_TO_POINT_BLACK |
| WayControl | string | 否 | 呼叫方向控制。取值：
说明
只有在点对点黑名单时候才有用。
| PHONEA_REJECT |
返回参数
示例
正常返回示例
JSON格式
{
"Code": "OK",
"Message": "OK",
"RequestId": "F655A8D5-B967-440B-8683-DAD6FF8DE990"
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | RamPermissionDenied | RAM permission is denied. | RAM权限DENY |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|
暂无变更历史