DescribeNumberHLR - Cell Phone Number Service - Alibaba Cloud Documentation Center

Call this operation to query basic information and the status of a phone number.

Operation description

Ensure you are familiar with the pricing of Number Encyclopedia before you call this operation.
Before you call this operation, log on to the Number Encyclopedia console. On the Tag Square page, find the required tag and click Request Access.
You are charged for this operation only when the Code parameter in the response is OK. You are not charged for calls that return other results.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
PhoneNumber	string	No	The phone number to query.	example
AuthCode	string	No	The authorization code. Note Log on to the Number Encyclopedia console. On the My Applications page, obtain the authorization code.	example

Response elements

Element	Type	Description	Example
	object
AccessDeniedDetail	string	Details about the access denial. This parameter is returned only if RAM authentication fails.	None
RequestId	string	The unique ID of the request.	1C3B8084-3A7D-570B-BC84-BF945A9CF65E
Message	string	The description of the status code.	OK
Data	object	The data returned.
Call	object	The call details.
MinLength	integer	The minimum length.	21
CleansedCode	string	The cleansed code.	example
MaxLength	integer	The maximum length.	22
PhoneType	string	The type of the phone number.	example
CountryIso3	string	The ISO 3166-1 alpha-3 code of the country where the phone number is registered.	example
Live	object	The real-time status of the phone number.
RoamingCountry	string	The roaming country.	example
DeviceStatus	string	The device status.	example
SubscriberStatus	string	The subscription status.	example
Roaming	string	The roaming status.	example
Sms	object	The SMS details.
MinLength	integer	The minimum length.	2
MaxLength	integer	The maximum length.	59
CleansedCode	integer	The cleansed code.	58
Carrier	string	The carrier of the phone number.	example
City	string	The city where the phone number is registered.	example
Blocked	string	Indicates whether the execution is blocked if the analysis fails.	example
Code	string	The status code. Valid value: OK: The request was successful.	OK

Examples

Success response

JSON format

{
  "AccessDeniedDetail": "None",
  "RequestId": "1C3B8084-3A7D-570B-BC84-BF945A9CF65E",
  "Message": "OK",
  "Data": {
    "Call": {
      "MinLength": 21,
      "CleansedCode": "example",
      "MaxLength": 22
    },
    "PhoneType": "example",
    "CountryIso3": "example",
    "Live": {
      "RoamingCountry": "example",
      "DeviceStatus": "example",
      "SubscriberStatus": "example",
      "Roaming": "example"
    },
    "Sms": {
      "MinLength": 2,
      "MaxLength": 59,
      "CleansedCode": 58
    },
    "Carrier": "example",
    "City": "example",
    "Blocked": "example"
  },
  "Code": "OK"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.