PhoneNumberStatusForPublic-阿里云帮助中心

Operation description

Before you call this operation, make sure that you fully understand the pricing of Phone Number Intelligence.
By default, only an Alibaba Cloud account can call this operation. A RAM user must be granted the required permissions before calling this operation. For more information, see Grant permissions to RAM users.
Before calling this operation, log on to the Phone Number Intelligence console. On the Tag Square page, find the required tag, click Apply, and submit your application. You can use the operation after your application is approved.
The number status query feature supports numbers from China Telecom, China Unicom, and China Mobile, but does not support numbers from China Broadnet. If you call this operation to query the status of a China Broadnet number, the OperatorLimit error code is returned, which indicates that the query is prohibited by the carrier.

QPS limit

The queries per second (QPS) limit for each user is 300. API calls that exceed this limit are throttled. To avoid business disruptions, 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:PhoneNumberStatusForPublic

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
AuthCode	string	Yes	The authorization code. Note On the My Applications page of the Phone Number Intelligence console, you can obtain the authorization ID and use it as the authorization code.	Dd1r***4id
InputNumber	string	No	The phone number to be queried. If `Mask` is set to `NORMAL`, this parameter must be an 11-digit mobile phone number. If `Mask` is set to `MD5`, this parameter must be a 32-character encrypted string. If `Mask` is set to `SHA256`, this parameter must be a 64-character encrypted string. If `Mask` is set to `SM3`, this parameter must be a 64-character encrypted string. Note The encrypted strings are case-insensitive.	139****1234
Mask	string	Yes	The encryption method. Valid values: NORMAL: The phone number is not encrypted. MD5 SHA256 SM3	NORMAL

Response elements

Element	Type	Description	Example
	object	The response object.
RequestId	string	The ID of the request.	CC3BB6D2-**-**-9DCE-B38165CE4C47
Message	string	The description of the status code.	OK
Data	object	The returned data.
Status	string	The status of the queried 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 non-existent. SUSPECTED_POWER_OFF: The phone is suspected to be powered off. BUSY: The line is busy. UNKNOWN: The status is unknown. Note Due to carrier system adjustments, the `BUSY`, `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 basic carrier of the number. If the number has been ported, this parameter returns the current carrier. Valid values: CMCC: China Mobile CUCC: China Unicom CTCC: China Telecom CBN: China Broadnet	CMCC
Code	string	The status code of the request. Valid values: OK: The request was successful. OperatorLimit: The query for the phone number is prohibited by the carrier. RequestFrequencyLimit: Carrier restrictions prohibit frequent queries for the same number in a short period. If this error code is returned, try again later. Note For a list of other error codes, see API Error Center.	OK

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
200	OperatorLimit	The number is limited by the operator
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 Error Codes for a complete list.

Release notes

See Release Notes for a complete list.