DescribeEmptyNumber-阿里云帮助中心

Operation description

This operation verifies whether a phone number is nonexistent. You are charged CNY 0.01 for each verification. Make sure that you understand this product's billing methods and pricing before you use this operation.
You are charged for a call only when the `Code` parameter in the response is `OK` and the `Status` parameter is not `UNKNOWN`. No fees are incurred in other cases.
This product uses an AI algorithm to predict the probability that a phone number is nonexistent. The prediction is not 100% accurate. The current accuracy and recall rates are about 95%. Keep this in mind when you call the operation.
Before you use this operation, log on to the Cell Phone Number Service console. On the Tag Plaza page, find the required tag and click Request Activation. Fill in the application information. You can use the operation after your application is approved.

Queries per second (QPS) limit

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

Authorization information

By default, only Alibaba Cloud accounts can call this operation. A Resource Access Management (RAM) user can call this operation only after being granted the required permissions. For more information, see Grant permissions to a RAM user.

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:DescribeEmptyNumber

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
AuthCode	string	Yes	The authorization code. Note On the My Approvals page of the Cell Phone Number Service console, obtain the authorization ID. The authorization ID is the authorization code.	Dd1r***4id
InputNumber	string	Yes	The phone number that you want to query. Note You can query only one phone number at a time.	189****1234
Mask	string	Yes	The encryption method used for the phone number. Valid values: NORMAL: The phone number is not encrypted. MD5 SHA256	NORMAL

Response elements

Element	Type	Description	Example
	object	struct
RequestId	string	The ID of the request. This is a common parameter. The ID is unique to each request. You can use this ID to locate and troubleshoot issues.	CC3BB6D2-2FDF-4321-9DCE-B38165CE4C47
Message	string	The description of the status code.	OK
Data	object	The data returned.
Status	string	The status of the phone number. Valid values: EMPTY: The number is nonexistent. NORMAL: The number is active. SUSPECT_EMPTY: The number is likely nonexistent. UNKNOWN: The status is unknown.	EMPTY
Number	string	The phone number that you queried.	189****1234
Code	string	The returned status code. Valid values: OK: The request was successful. InvalidPhoneNumber.Check: The phone number is invalid.	OK

Examples

Success response

JSON format

{
  "RequestId": "CC3BB6D2-2FDF-4321-9DCE-B38165CE4C47",
  "Message": "OK",
  "Data": {
    "Status": "EMPTY",
    "Number": "189****1234"
  },
  "Code": "OK"
}

Error codes

HTTP status code	Error code	Error message	Description
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.

See for a complete list.

Release notes

See Release Notes for a complete list.