HistoryThreeElementsVerification-阿里云帮助中心

Operation description

Usage notes

Before you use this API, ensure you understand its pricing.
Before you use this API, log on to the Phone Number Intelligence console and apply for the required tag on the Tag Plaza page.
You are charged for a call only when the response returns Code='OK' and IsConsistent != 0. No charges are incurred for any other results.
Verification of China Broadcasting Network numbers (numbers with the 192 prefix) is not supported. If you provide a number with the 192 prefix, an HTTP 400 error is returned.
Due to number portability, the actual carrier may differ from the current carrier of record. You can use the Carrier parameter to route the query to a specific carrier.
The queries per second (QPS) limit per user is 200. Requests that exceed this limit are throttled.
In the authorization information, the action is dytns:HistoryThreeElementsVerification, the access level is Read, and the resource type is All Resources.

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

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
AuthCode	string	Yes	The authorization code. You can obtain it from the following sources: On the Tag Plaza page in the Phone Number Intelligence console, select the three-element ID verification tag and submit an application. You will receive an authorization code after the application is approved. On the My Applications page in the Phone Number Intelligence console, find the authorization ID for your approved three-element ID verification service.	example
InputNumber	string	Yes	The phone number to query. If `Mask` is set to `NORMAL`, this parameter must be an 11-digit mobile phone number.	example
Mask	string	Yes	The encryption method. Valid value: NORMAL: The phone number is not encrypted.	example
Name	string	Yes	The name to verify.	example
CertCode	string	Yes	The ID number to verify. If `Mask` is set to `NORMAL`, the value of this parameter is in plaintext.	example
VerificationTime	string	Yes	The historical point in time to verify, in `yyyyMMddHHmmss` format. If the specific time of day is unknown, set the `HHmmss` portion to `000000`. For example, `20230615000000` verifies ownership as of June 15, 2023.	example
Carrier	string	No	The carrier to query. By default, the system queries the number's carrier of record. Specify this parameter to route the query to a specific carrier. Valid values: `CMCC`: China Mobile `CUCC`: China Unicom `CTCC`: China Telecom Note Due to number portability, a ported number's historical carrier may be unknown. Use this parameter to explicitly query a specific carrier. If omitted, the query defaults to the number's current carrier of record. Important Specifying China Broadcasting Network is not supported and results in an HTTP 400 error.	CMCC

Response elements

Element	Type	Description	Example
	object
AccessDeniedDetail	string	Details about why access is denied. Note This parameter is returned only when RAM authentication fails.	-
RequestId	string	The request ID.	CC3BB6D2-2FDF-4321-9DCE-B38165CE4C47
Message	string	The description of the status code.	OK
Data	object	The query results.
IsConsistent	integer	The consistency of the verification result. Valid values: `0`: No record found. `1`: The phone number, ID number, and name match the carrier's records. `2`: The phone number and ID number match the carrier's records, but the name does not. `3`: The phone number and name match the carrier's records, but the ID number does not. `4`: The phone number matches the carrier's records, but the name and ID number do not.	72
RequestCarrier	string	The carrier to which the request was routed.	CMCC
Code	string	The status code of the request. A value of `OK` indicates the request was successful. For other values, see the Error Codes section.	OK

Examples

Success response

JSON format

{
  "AccessDeniedDetail": "-",
  "RequestId": "CC3BB6D2-2FDF-4321-9DCE-B38165CE4C47",
  "Message": "OK",
  "Data": {
    "IsConsistent": 72,
    "RequestCarrier": "CMCC"
  },
  "Code": "OK"
}

Error codes

HTTP status code	Error code	Error message	Description
400	OperatorLimit	Number is limited by the operator.	Number prohibited by the operator
400	MobileNumberIllegal	Wrong format of phone number
400	CarrierIllegal	运营商类型非法
400	CertCodeIllegal	Invalid CertCode value.
400	InvalidParameter	请求参数非法
400	AuthCodeIllegal	Illegal authCode.
500	SystemError	系统异常
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.