PhoneNumberEncrypt - 加密号码

将原始号码加密为一个140开头的虚拟号码。通过结合阿里云的通信服务,可以使用加密后的140号码发起语音呼叫。实现虚拟号码呼叫的效果。

接口说明

使用本接口前,请登录号码百科控制台,在标签广场页面,找到对应的标签,单击申请开通,填写申请资料,审批通过后即可使用。

QPS 限制

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

调试

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

授权信息

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

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

请求参数

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

授权码。

说明 号码百科控制台我的申请页面,获取授权 ID 即授权码。
QASDW@#**
InputNumberstring

待查询的号码。

说明 目前仅支持单个号码查询。
1390000****
Maskstring

号码的加密方式。取值:NORMAL

注意 目前仅支持 NORMAL 加密方式。

NORMAL

返回参数

名称类型描述示例值
object

结构体

RequestIdstring

请求 ID。

CC3BB6D2-2FDF-4321-9DCE-B38165CE4C47
Messagestring

返回状态码描述。

OK
Dataarray<object>

数组。

DataItemobject

结构体。

OriginalNumberstring

原始号码。

1390000****
EncryptedNumberstring

加密后的号码。

1400513****
ExpireTimestring

号码过期时间。

2022-05-27 16:05:23
Codestring

请求状态码。

  • 返回 OK 代表请求成功。

  • 其他错误码,请参见错误码列表

OK

示例

正常返回示例

JSON格式

{
  "RequestId": "CC3BB6D2-2FDF-4321-9DCE-B38165CE4C47",
  "Message": "OK",
  "Data": [
    {
      "OriginalNumber": "1390000****",
      "EncryptedNumber": "1400513****",
      "ExpireTime": "2022-05-27 16:05:23"
    }
  ],
  "Code": "OK"
}

错误码

HTTP status code错误码错误信息描述
400Product.UnsubscriptYou have not subscribed to the specified product.未订阅该功能
400Ram.PermissionDenyYou are not authorized to perform the operation.权限不足
400System.LimitControlThe system is under flow control.系统限流控制
400Unknown.ResourceOwnerIdThe resource does not belong to the current user.资源不属于当前用户
400InvalidParameterInvalid parameter.无效参数
400AuthCodeIllegalIllegal authCode.鉴权时使用的authcode不可用于该接口
403Permission.NotAuthorizedYou are not authorized to perform the operation.您没有权限执行此操作
500InternalErrorA system error occurred.系统异常
500RequestTimeoutRequest supplier timed out.请求供应商超时
500RequestSupplierErrorRequest supplier error.请求第三方服务异常。

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

变更历史

变更时间变更内容概要操作
2023-09-12OpenAPI 错误码发生变更查看变更详情
2023-01-09OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情
2022-04-08新增 OpenAPI查看变更详情
2022-04-08OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情