VerifyPhoneWithToken-阿里云帮助中心

Operation description

Preparations

Review the billing methods and pricing for the Phone Number Verification Service before you use this API.
Create an Alibaba Cloud account, obtain an AccessKey, and configure a verification scheme. For more information, see H5 Phone Number Verification Process.

QPS limit

This API supports up to 1,000 queries per second (QPS) per user. If you exceed this limit, rate limiting is applied to your API calls, which may impact your business operations. Plan your API usage 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

dypns:VerifyPhoneWithToken

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
PhoneNumber	string	Yes	The phone number to verify.	1380000****
SpToken	string	Yes	The phone number verification token obtained from the JSSDK. The validity period and usage count of the token vary by carrier: China Telecom: 10 minutes, single use. China Unicom: 30 minutes, single use. China Mobile: 2 minutes, single use.	Dfafdafad542****

Response elements

Element	Type	Description	Example
	object
Code	string	The status code. A value of OK indicates that the request is successful. For more information about other error codes, see Server-side API return codes.	OK
Message	string	The description of the status code.	请求成功
RequestId	string	The request ID.	8906582E-6722
GateVerify	object	A structure.
VerifyResult	string	The verification result. Valid values: PASS: The phone number is consistent. REJECT: The phone number is inconsistent. UNKNOWN: The consistency cannot be determined.	PASS
VerifyId	string	The serial number of the verification.	12134****

Examples

Success response

JSON format

{
  "Code": "OK",
  "Message": "请求成功",
  "RequestId": "8906582E-6722",
  "GateVerify": {
    "VerifyResult": "PASS",
    "VerifyId": "12134****"
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	RamPermissionDeny	The user is not authorized to operate on the specified resource.
400	UnknowError	The requested service is not available now, please try again later.
400	Unsupported.Account	Your account has not activated the product.	Your account not be opened the product.
400	MobileNumberIllgeal	The specified mobile phone number is invalid.
400	InvalidToken	The token is invalid.
400	VerifySchemeNotExist	The specified verify scheme already exists.
500	SystemError	A system error occurred.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.