向号码池添加黑名单。仅AXN隐私号、AXN分机号、95AXN隐私号类型的号码池支持设置黑名单。
接口说明
此接口不是批处理接口,仅支持一次添加一组点对点黑名单号码,或者一个号池黑名单号码。
若需删除黑名单,可调用 DeleteSecretBlacklist 接口。
数量限制
本接口的单号池数量限制为 200 万个,超过限制,API 调用添加黑名单号码将会失败,这可能会影响您的业务,如需特殊要求请联系您的阿里云商务经理。
QPS 限制
本接口的单用户 QPS 限制为 100 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
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 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
返回数据。 |
||
| Code |
string |
请求状态码。取值:
|
OK |
| Message |
string |
状态码的描述。 |
OK |
| RequestId |
string |
请求 ID。 |
F655A8D5-B967-440B-8683-DAD6FF8DE990 |
示例
正常返回示例
JSON格式
{
"Code": "OK",
"Message": "OK",
"RequestId": "F655A8D5-B967-440B-8683-DAD6FF8DE990"
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | RamPermissionDenied | RAM permission is denied. | RAM权限DENY |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。