PhoneNumberStatusForReal-阿里云帮助中心

Queries the real-time status of a mobile phone number, such as normal, suspended, or not in service. This operation supports queries for phone numbers that are in plaintext or encrypted by using MD5, SHA256, or SM3.

Operation description

Before calling this operation, ensure you fully understand the pricing of Phone Number Intelligence.
By default, only an Alibaba Cloud account can call this operation. To allow a RAM user to call this operation, you must first grant the required permissions. For more information, see Grant permissions to RAM users.
Before you call this operation, log on to the Phone Number Intelligence console. On the Tag Square page, find the required tag, click Request Activation, and then submit your application. You can call this operation only after your application is approved.
This operation supports phone numbers from China Telecom, China Unicom, and China Mobile. Numbers from China Broadnet are not supported. If you call this operation to query a China Broadnet number, the API returns the error code OperatorLimit and an error message indicating that the query is restricted by the carrier.

QPS limit

The QPS limit for this operation is 300 queries per second (QPS) per user. The system throttles calls that exceed this limit, which may affect your business. Plan your calls accordingly.

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

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
AuthCode	string	Yes	The authorization code. Note On the My Applications page in the Phone Number Intelligence console, you can find the authorization code for your API calls.	Dd1r***4id
InputNumber	string	Yes	The phone number to query. If `Mask` is set to `NORMAL`, this parameter specifies an 11-digit mobile phone number. If `Mask` is set to `MD5`, this parameter specifies a 32-character encrypted string. If `Mask` is set to `SHA256`, this parameter specifies a 64-character encrypted string. If `Mask` is set to `SM3`, this parameter specifies a 64-character encrypted string. Important The encrypted string is not case-sensitive.	189****8999
Mask	string	Yes	The encryption method of the phone number. Valid values: NORMAL: The number is not encrypted. MD5 SHA256 SM3	NORMAL

Response elements

Element	Type	Description	Example
	object	The data returned.
Code	string	The request status code. Valid values: OK: The request was successful. OperatorLimit: The query for the phone number is restricted by the carrier. RequestFrequencyLimit: Carriers prohibit high-frequency queries for the same number within a short period. If this error code is returned, try again later.	OK
Message	string	The description of the status code.	OK
RequestId	string	A unique identifier for the request. You can use this ID to troubleshoot issues.	CC3BB6D2-2FDF-4321-9DCE-B38165CE4C47
Data	object	The data returned for the request.
Status	string	The status of the phone number. Valid values: NORMAL: The number is in service. SHUTDOWN: The service for the number is suspended. POWER_OFF: The phone is powered off. NOT_EXIST: The number is not in service. BUSY: The line is busy. SUSPECTED_POWER_OFF: The phone is suspected to be powered off. DEFECT: The number is invalid. UNKNOWN: The status is unknown. Note Due to carrier system adjustments, China Telecom numbers no longer return the `BUSY`, `SUSPECTED_POWER_OFF`, and `POWER_OFF` statuses. For more information, see the official announcement.	NORMAL
Carrier	string	The carrier that provides service for the phone number. If the number has been ported through mobile number portability (MNP), this field returns the new carrier. Valid values: CMCC: China Mobile. CUCC: China Unicom. CTCC: China Telecom. Note Queries for China Broadnet numbers are not supported.	CMCC

Examples

Success response

JSON format

{
  "Code": "OK",
  "Message": "OK",
  "RequestId": "CC3BB6D2-2FDF-4321-9DCE-B38165CE4C47",
  "Data": {
    "Status": "NORMAL",
    "Carrier": "CMCC"
  }
}

Error codes

HTTP status code	Error code	Error message	Description
200	OperatorLimit	The number is limited by the operator.	This mobile phone number is restricted by the carrier.
400	MobileNumberIllegal	Wrong format of phone number
400	CarrierIllegal	Illegal carrier type
400	AuthCodeNotExist	The label application form does not exist, please replace the authorization code.
400	MobileNumberTypeIllegal	Invalid number type.
400	MobileNumberTypeNotMatch	The number and number type do not match.
400	InvalidParameter	Invalid parameter.
400	AuthCodeIllegal	Illegal authCode.
500	SystemError	System error
500	Unknown	Unknown error
500	EncyrptTypeIllegal	The encryption type of the mobile phone number is illegal
500	RequestTimeout	Request supplier timed out.	Request supplier timeout
500	RequestSupplierError	Request supplier error.	Request supplier error.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.