进行无效号码过滤操作。
接口说明
使用本接口前，请登录号码百科控制台，在标签广场页面，找到对应的标签，单击申请开通，填写申请资料，审批通过后即可使用。
QPS 限制
本接口的单用户 QPS 限制为 1000 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| dytns:InvalidPhoneNumberFilter | create |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| AuthCode | string | 是 | 授权码。 说明
在号码百科控制台我的申请页面，获取授权 ID 即授权码。
| QASDW@#** |
| InputNumber | string | 是 | 待查询的号码。 | 1390000**** |
| Mask | string | 是 | 号码的加密方式。 注意 目前仅支持 NORMAL 加密方式。 | NORMAL |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "CC3BB6D2-2FDF-4321-9DCE-B38165CE4C47",
"Code": "OK",
"Message": "OK",
"Data": [
{
"Code": "YES",
"OriginalNumber": "1390000****",
"EncryptedNumber": "1400513****",
"ExpireTime": "2022-05-27 16:05:23"
}
]
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | Product.Unsubscript | You have not subscribed to the specified product. | 未订阅该功能 |
| 400 | Ram.PermissionDeny | You are not authorized to perform the operation. | 权限不足 |
| 400 | System.LimitControl | The system is under flow control. | 系统限流控制 |
| 400 | Unknown.ResourceOwnerId | The resource does not belong to the current user. | 资源不属于当前用户 |
| 400 | InvalidParameter | Invalid parameter. | 无效参数 |
| 400 | AuthCodeIllegal | Illegal authCode. | 鉴权时使用的authcode不可用于该接口 |
| 403 | Permission.NotAuthorized | You are not authorized to perform the operation. | 您没有权限执行此操作 |
| 500 | InternalError | A system error occurred. | 系统异常 |
| 500 | RequestTimeout | Request supplier timed out. | 请求供应商超时 |
| 500 | RequestSupplierError | Request supplier error. | 请求第三方服务异常。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2023-09-11 | OpenAPI 错误码发生变更 | 查看变更详情 |
| 2022-04-08 | 新增 OpenAPI | 查看变更详情 |
| 2022-04-08 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |