VerifySmsCode-阿里云帮助中心

Operation description

Preparations

You can register an Alibaba Cloud account, obtain an AccessKey pair, and create an authentication scheme. For more information, see Text message authentication process.

QPS limits

The queries per second (QPS) limit for a single user is 500 calls per second. API calls that exceed this limit are subject to rate limiting, which may affect your business. Call this operation at a reasonable rate.

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

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
SmsCode	string	Yes	The verification code.	12****
PhoneNumber	string	Yes	The mobile phone number. This is returned when you obtain the text message verification code.	1321111****
SmsToken	string	Yes	The text message token. When you call the operation to send a verification code using the text message verification software development kit (SDK), the end user receives a verification code. The SDK then returns an SmsToken that is used to verify the code. Android clients call the sendVerifyCode operation. iOS clients call the sendVerifyCodeWithTimeout operation. For more information, see Integration overview.	sddsbvdbvjd****

Response elements

Element	Type	Description	Example
	object
Code	string	The status code. A value of OK indicates that the request was successful. For other error codes, see Server-side API return codes.	OK
Message	string	The description of the status code.	请求成功
Data	boolean	Indicates whether the validation was successful. Valid values: true: The validation was successful. false: The validation failed.	true
RequestId	string	The request ID.	8906582E-6722

Examples

Success response

JSON format

{
  "Code": "OK",
  "Message": "请求成功",
  "Data": true,
  "RequestId": "8906582E-6722"
}

Error codes

HTTP status code	Error code	Error message	Description
400	Unsupported.Account	Your account has not activated the product.	Your account not be opened the product.
400	SmsCodeVerifyFail	The specified smsCode is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.