VerifyMobile-阿里云帮助中心

Operation description

Preparations

Before you use this operation, review the billing model and pricing for Phone Number Verification Service.
Complete Alibaba Cloud account registration, obtain an AccessKey pair, and create a verification plan. For more information, see Quick Start.

Note

This operation supports only device-based phone number verification. To implement one-click logon, use GetMobile.

QPS limit

The per-user QPS limit for this operation is 5,000 calls per second. Calls that exceed this limit are rate limited, which may affect your business. Make sure to call the operation within the limit.

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

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
AccessCode	string	Yes	Token validity and usage limits: China Telecom: valid for 10 minutes. Use once only. China Unicom: valid for 30 minutes. Use once only. China Mobile: valid for 2 minutes. Use once only.	Dfafdafad542****
PhoneNumber	string	Yes	The phone number to verify.	13800****00
OutId	string	No	The external sequence number.	123456

Response elements

Element	Type	Description	Example
	object
Code	string	The status code. OK means the request succeeded. For other error codes, see Server-side API return codes.	OK
Message	string	A description of the status code.	请求成功
RequestId	string	The request ID.	8906582E-6722
GateVerifyResultDTO	object	The response struct.
VerifyResult	string	The verification result. Valid values: PASS: The numbers match. REJECT: The numbers do not match. UNKNOWN: Unable to determine.	PASS
VerifyId	string	The sequence number.	121343241

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.