PhoneNumberEncrypt-阿里云帮助中心

Operation description

Before you call this operation, log on to the Cell Phone Number Service console. On the Tag Square page, find the required tag and click Request Access. Fill in the application information. You can use the service after your application is approved.

QPS limits

The queries per second (QPS) limit for a single user for this operation is 1,000 calls per second. If you exceed the limit, API calls are throttled. This may affect your business. Call the operation at a reasonable rate.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dytns:PhoneNumberEncrypt

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
AuthCode	string	Yes	The authorization code. Note In the Cell Phone Number Service console, go to the My Approvals page to obtain the authorization ID. The authorization ID is the authorization code.	QASDW@#**
InputNumber	string	Yes	The phone number to query. Note You can query only one phone number at a time.	1390000****
Mask	string	Yes	The encryption method for the phone number. Set the value to NORMAL. Important Currently, only the NORMAL encryption method is supported.	NORMAL
OutId	string	No	A custom `outId`. This parameter is optional. The format is not restricted, but the length cannot exceed 64 characters.	213e367117422635749191493eea68

Response elements

Element	Type	Description	Example
	object	The data structure.
RequestId	string	The request ID.	CC3BB6D2-2FDF-4321-9DCE-B38165CE4C47
Message	string	The description of the status code.	OK
Data	array<object>	The array of returned data.
	object	The data structure.
OriginalNumber	string	The original phone number.	1390000****
EncryptedNumber	string	The encrypted phone number.	1400513****
ExpireTime	string	The expiration time of the number.	2022-05-27 16:05:23
OutId	string	A custom ID that is reserved for the caller when the request is initiated. This ID is returned to the caller. This is a string with a maximum length of 64 characters.	215044c917374256269257695e9d22
Code	string	The status code of the request. OK indicates that the request is successful. For other error codes, see Error codes.	OK

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
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.
500	InternalError	A system error occurred.
500	RequestTimeout	Request supplier timed out.	Request supplier timeout
500	RequestSupplierError	Request supplier error.	Request supplier error.
403	Permission.NotAuthorized	You are not authorized to perform the operation.

See for a complete list.

Release notes

See Release Notes for a complete list.