PhoneNumberStatusForVoice-阿里云帮助中心

Queries the real-time network status of a mobile phone number, such as normal, shutdown, or non-existent. This operation supports queries for numbers in plaintext and numbers encrypted by using MD5, SHA256, or SM3.

Operation description

Before you use this API, make sure that you understand the pricing of Phone Number Encyclopedia.
By default, only Alibaba Cloud accounts can call this API. To allow a RAM user to do so, you must grant them the required permissions. For more information, see Grant permissions to RAM users.
Before you use this API, log in to the Phone Number Encyclopedia console. On the Tag Square page, find the required tag, click Apply for Access, and then complete the application form. You can call this API after your application is approved.
This feature supports phone numbers from China Telecom, China Unicom, and China Mobile, but not from China Broadnet. If you query a China Broadnet number, the OperatorLimit error code and an error message are returned: The number is limited by the operator.

QPS limit

The QPS limit for a single user is 300 queries per second. If you exceed this limit, the system throttles your API calls, which may impact your business. To avoid interruptions, call this API 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:PhoneNumberStatusForVoice

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
AuthCode	string	Yes	The authorization code. Note The authorization code is the authorization ID that you can find on the My Applications page of the Phone Number Encyclopedia console.	Dd1r***4id
InputNumber	string	Yes	The phone number to query. If you set `Mask` to `NORMAL`, specify an 11-digit mobile number. If you set `Mask` to `MD5`, specify a 32-bit encrypted string. If you set `Mask` to `SHA256`, specify a 64-bit encrypted string. If you set `Mask` to `SM3`, specify a 64-bit encrypted string. Important The letters in the encrypted string are not case-sensitive.	139****1234
Mask	string	Yes	The encryption method. Valid values: NORMAL: The number is in plaintext. MD5 SHA256 SM3	NORMAL

Response elements

Element	Type	Description	Example
	object	The returned data.
Code	string	The status code of the request. Valid values: OK: The request was successful. OperatorLimit: The carrier restricts queries for this phone number. RequestFrequencyLimit: Carrier restrictions limit how frequently you can query the same number. If you receive this error, try again later.	OK
Message	string	The description of the status code.	OK
RequestId	string	The request ID. This is a common parameter. Each request has a unique ID that you can use to troubleshoot issues.	CC3BB6D2-2FDF-4321-9DCE-B38165CE4C47
Data	object	The returned data.
Status	string	The status of the phone number. Valid values: NORMAL: The number is active. SHUTDOWN: The service for the number is suspended. POWER_OFF: The phone is powered off. NOT_EXIST: The number does not exist. SUSPECTED_POWER_OFF: The phone is likely powered off. DEFECT: The number is invalid. UNKNOWN: The status is unknown. Note Due to carrier system adjustments, the `SUSPECTED_POWER_OFF` and `POWER_OFF` statuses are not returned for China Telecom numbers. For more information, see the official announcement.	NORMAL
Carrier	string	The current carrier for the number. If the number has been ported, 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.	CTCC

Examples

Success response

JSON format

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

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	EncryptTypeIllegal	Invalid encryption type.
400	isp.UNKNOWN	An error occurred due to unknown reasons.
400	InvalidParameter	Invalid parameter.
400	AuthCodeIllegal	Illegal authCode.
500	SystemError	System error
500	Unknown	Unknown error
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.