PhoneNumberStatusForSms-阿里云帮助中心

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

Operation description

Before you call this operation, make sure you understand the Product Pricing of Phone Number Pedia.
By default, only an Alibaba Cloud account can call this operation. A RAM user can call this operation only after being granted the required permissions. For more information, see Grant permissions to a RAM user.
Before calling this operation, log on to the Phone Number Pedia console. On the Tag Square page, find the required tag, click Request Activation, and then complete the application form. You can use this operation only after your application is approved.
This feature supports phone numbers from China Telecom, China Unicom, and China Mobile, but does not support phone numbers from China Broadnet. If you call this operation to query the status of a China Broadnet number, the OperatorLimit error code and the "The number is limited by the operator." message are returned.

QPS limit

This operation is limited to 300 queries per second (QPS) for each user. Calls that exceed this limit are throttled, 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:PhoneNumberStatusForSms

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 Pedia console, obtain the authorization ID and use it as the value for this parameter.	zf08***pi6
InputNumber	string	Yes	The phone number to query. If `Mask` is set to `NORMAL`, specify an 11-digit phone number. If `Mask` is set to `MD5`, specify a 32-character encrypted string. If `Mask` is set to `SHA256`, specify a 64-character encrypted string. If `Mask` is set to `SM3`, specify a 64-character encrypted string. Important The encrypted string is not case-sensitive.	181****1234
Mask	string	Yes	The encryption method for the phone number. Valid values: NORMAL: The number is not encrypted. MD5 SHA256 SM3	NORMAL

Response elements

Element	Type	Description	Example
	object	The returned data.
Code	string	The request status code. Valid values: OK: The request was successful. OperatorLimit: The carrier restricts queries for this phone number. RequestFrequencyLimit: Indicates that requests for a single number are too frequent. Due to carrier restrictions, repeated queries for the same number within a short period are prohibited. If you receive this error code, try again later.	OK
Message	string	The description of the status code.	OK
RequestId	string	The unique ID of the request. Use this ID to troubleshoot issues.	68A40250-50CD-034C-B728-0BD135850177
Data	object	A container for the returned data.
Status	string	The status of the phone number. Valid values: NORMAL: Active. SHUTDOWN: Shutdown. POWER_OFF: Powered off. NOT_EXIST: Non-existent number. DEFECT: Invalid number. UNKNOWN: Unknown. Note Due to carrier system adjustments, the statuses for busy, suspected to be powered off, and powered off are not returned for China Telecom numbers. For more information, see the official announcement.	NORMAL
Carrier	string	The carrier of the phone number. If the number has been ported, this parameter returns the current 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": "68A40250-50CD-034C-B728-0BD135850177",
  "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	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	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.