DescribePhoneNumberAnalysis-阿里云帮助中心

Retrieves the result of a phone number analysis.

Operation description

Before you call this operation, log on to the Cell Phone Number Service console. On the Tag Plaza page, find the tag that you want to use and click Request Activation. You can use the tag after you submit the required information and your application is approved.
Before you call this operation, make sure that you understand the billing of Cell Phone Number Service.

QPS limit

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

Authorization information

By default, this operation can be called only by Alibaba Cloud accounts. RAM users can call this operation only after they are granted the required permissions. For more information, see Grant permissions to RAM users.

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

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
AuthCode	string	Yes	The authorization code. Note Obtain the authorization code on the My Applications page in the Cell Phone Number Service console.	QASDW@#**
InputNumber	string	Yes	The number to query.	187****5620
NumberType	integer	No	The number type. Valid values: 0: phone number 1: International Mobile Equipment Identity (IMEI)	0
Mask	string	No	The encryption method of the number. Valid values: NORMAL: The number is not encrypted. MD5 SHA256	NORMAL
Rate	integer	No	The score threshold for the number. The value ranges from 0 to 100. Important The server determines whether to accept the specified score threshold. If the server does not accept the specified score threshold, the value of this parameter is invalid.	10

Response elements

Element	Type	Description	Example
	object
AccessDeniedDetail	string	The details about the access denial. This parameter is returned only when RAM authentication fails.	-
RequestId	string	The request ID.	CC3BB6D2-2FDF-4321-9DCE-B38165CE4C47
Message	string	The description of the number status.	OK
Data	object	The information about the number analysis result.
List	array<object>	The list of data.
	object
Number	string	The phone number that you provided.	187****5620
Code	string	The returned result code. YES: valid NO: invalid UNKNOWN: unknown	NO
Code	string	The request status code. A value of OK indicates that the request is successful. OK: Indicates success.	OK

Status codes

HTTP status code	Return code	Description	Solution
200	OK	The request was successful.	The API call was successful.

Error codes returned by the service

HTTP status code	Error code	Description	Solution
400	MobileNumberIllegal	The phone number is invalid.	If the phone number is not encrypted, enter a valid 11-digit number. If the phone number is encrypted using MD5, enter a 32-bit encrypted string. If the phone number is encrypted using SHA256, enter a 64-bit encrypted string.
400	EncyrptTypeIllegal	The encryption type is invalid.	Only NORMAL, MD5, and SHA256 are supported. The value must be in uppercase.
400	MobileNumberTypeNotMatch	The phone number and encryption type do not match.	Enter a phone number in the correct format and specify the correct encryption type.
400	AuthCodeNotExist	The authorization code does not exist or is unavailable.	The authorization code does not exist or has not been approved. Verify that the authorization code is correct.
400	TagNotExist	The tag or business resource does not exist.	The tag or business resource does not exist. Verify the availability of the tag.
400	RateIllegal	The threshold parameter is invalid.	The threshold parameter is invalid. Check that the parameter is valid.
400	InvalidParameter	Invalid parameter.	The request parameter is incorrect. Check that the parameter is correct.
400	System.LimitControl	Throttling error.	Keep the query frequency within the normal range. For numbers that trigger this error code, retry the query. Do not retry more than three times.
500	SystemError	System error.	A system error occurred. Try again later.

Examples

Success response

JSON format

{
  "AccessDeniedDetail": "-",
  "RequestId": "CC3BB6D2-2FDF-4321-9DCE-B38165CE4C47",
  "Message": "OK",
  "Data": {
    "List": [
      {
        "Number": "187****5620",
        "Code": "NO"
      }
    ]
  },
  "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	MobileNumberIllegal	Wrong format of phone number
400	EncyrptTypeIllegal	The encryption type of the mobile phone number is illegal
400	MobileNumberTypeNotMatch	Phone number and encryption type do not match
400	CarrierIllegal	Illegal carrier type
400	RateIllegal	Illegal threshold parameter
400	InvalidParameter	invalid parameter
400	AuthCodeNotExist	The authorization code application failed and cannot be used.	Failed to apply for an authorization code.
400	TagNotExist	The label does not exist.
400	AuthCodeIllegal	Illegal authCode.
500	InternalError	A system error occurred.
500	SystemError	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.