TwoElementsVerification-阿里云帮助中心

Two-element (name and phone number) verification. Used to compare whether the name and phone number entered by the user belong to the same user.

Operation description

Before using this API, ensure that you fully understand the product pricing of Cell Phone Number Service.
Before using this API, log on to the Cell Phone Number Service console, go to the Tag Square page, find the corresponding tag, click Apply to Enable, fill in the application materials, and use it after the approval.
Billing is applied when the API returns Code="OK" and IsConsistent != 2. Other return results are not billed.
MVNO number verification is not supported. MVNO numbers refer to numbers starting with 170, 171, 162, and 165.

QPS limit

The per-user QPS limit of this API is 200 times/second. If the limit is exceeded, API calls will be throttled, which may affect your business. Please call the API reasonably.

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

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 Cell Phone Number Service console, obtain the authorization ID, which is the authorization code.	QASDW@#**
InputNumber	string	Yes	The phone number to be verified. If Mask is set to NORMAL, this field is in plaintext. If Mask is set to MD5, encrypt this field with MD5. If Mask is set to SHA256, encrypt this field with SHA256. Important Letters in the encrypted string are not case-sensitive.	1390000****
Mask	string	Yes	The encryption method. Valid values: NORMAL: No encryption. MD5 SHA256	MD5
Name	string	Yes	The name to be verified. If Mask is set to NORMAL, this field is in plaintext. If Mask is set to MD5, encrypt this field with MD5. If Mask is set to SHA256, encrypt this field with SHA256. Important Letters in the encrypted string are not case-sensitive.	阿里云

Response elements

Element

Type

Description

Example

object

Code

string

The request status code.

OK: The request was successful.
For other error codes, see the error code table in this chapter.
RequestFrequencyLimit: Due to operator restrictions, repeated high-frequency queries against the same number or name in a short period are prohibited. If this error code is returned, try again later.

Message

string

The description of the status code.

RequestId

string

The request ID.

CC3BB6D2-2FDF-4321-9DCE-B38165CE****

Data

object

The structure.

IsConsistent

integer

Indicates whether the verification result is consistent. Returns:

1: Consistent.
0: Inconsistent.
2: Not found.

The data update timeliness for different operators and cities is typically T+1 to T+3. The verification results for different operator phone numbers in different states are as follows:

Operator/Phone Number Status	Suspended	Empty Number	Cancelled
China Mobile	Normal verification	Not found	Not found
China Unicom	Normal verification	Inconsistent	Inconsistent
China Telecom	Normal verification	Not found	Not found

BasicCarrier

string

The basic operator. Valid values:

China Mobile.
China Unicom.
China Telecom.

Important China Broadcasting Network numbers are not currently supported.

中国移动

Examples

Success response

JSON format

{
  "Code": "OK",
  "Message": "OK",
  "RequestId": "CC3BB6D2-2FDF-4321-9DCE-B38165CE****",
  "Data": {
    "IsConsistent": 1,
    "BasicCarrier": "中国移动"
  }
}

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	EncyrptTypeIllegal	The encryption type of the mobile phone number is illegal
400	CarrierIllegal	Illegal carrier type
400	AuthCodeNotExist	The label application form does not exist, please replace the authorization code.
400	MobileNumberTypeNotMatch	The number and number type do not match.
400	InvalidParameter	Invalid parameter.
400	AuthCodeIllegal	Illegal authCode.
500	Unknown	Unknown error
500	SystemError	System 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.