DescribePhoneNumberAnalysisAI-阿里云帮助中心

Operation description

Before you call this operation, log on to the Cell Phone Number Service console. On the Tag Square page, find the tag that you need, click Request Activation, and then complete the application form. You can use the service after your request is approved. Make sure that you understand the billing for Cell Phone Number Service.

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

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InputNumber	string	Yes	The phone number that you want to query.	187****5620
Rate	integer	No	The score threshold for the phone number. Valid values: 0 to 100. Note The server determines whether to accept the specified score threshold. If the server does not accept the specified score threshold, the value of this parameter is invalid.	96
AuthCode	string	Yes	The authorization code. Note Go to Phone Number Analysis Service > Tag Square. Select a tag and submit a request. You will receive an authorization code after your request is approved.	HwD***nG
ModelConfig	string	No	The model parameter settings. This parameter is required for some tag capabilities.	{"trainingJobId": "17**********48"}

Response elements

Element	Type	Description	Example
	object
AccessDeniedDetail	string	The details about the access denial.	-
RequestId	string	The request ID.	68A40250-50CD-034C-B728-0BD******177
Message	string	The description of the status code.	OK
Data	object	The returned result.
Number	string	The phone number that was passed in.	187****5620
Code	string	The returned result code. YES: The number is valid. NO: The number is invalid. UNKNOWN: The status is unknown.	YES
Code	string	The request status code. Valid value: OK: The request was successful.	OK

Examples

Success response

JSON format

{
  "AccessDeniedDetail": "-",
  "RequestId": "68A40250-50CD-034C-B728-0BD******177",
  "Message": "OK",
  "Data": {
    "Number": "187****5620",
    "Code": "YES"
  },
  "Code": "OK"
}

Error codes

HTTP status code	Error code	Error message	Description
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 for a complete list.

Release notes

See Release Notes for a complete list.