GetMobile-阿里云帮助中心

Operation description

Prerequisites

Before you use this API, review the billing model and pricing of the Phone Number Verification Service.
Register an Alibaba Cloud account, obtain your AccessKey pair, and create an authentication scheme. For more information, see Quick Start.

Note

This operation is applicable only to one-click login or registration scenarios. You can call this operation only after the end user confirms the authorization on the authorization page that is provided by the one-click login SDK. Do not simulate or bypass the authorization in any way. Otherwise, Alibaba Cloud reserves the right to suspend the service and pursue legal action.

Limits

The per-user limit for this operation is 5,000 queries per second (QPS). If you exceed this limit, rate limiting is triggered, which may affect your business.

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

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
AccessToken	string	Yes	Login token obtained from the app-side SDK. Token validity period and usage limits: China Telecom: 10 minutes, usable once. China Unicom: 30 minutes, usable once. China Mobile: 2 minutes, usable once.	Dfafdafad5422****
OutId	string	No	External transaction ID.	22345****

Response elements

Element	Type	Description	Example
	object
Code	string	Status code. OK indicates a successful request. For other error codes, see Server-side API return codes.	OK
Message	string	Description of the status code.	请求成功
RequestId	string	Request ID.	8906582E-6722
GetMobileResultDTO	object	Struct.
Mobile	string	Retrieved mobile phone number. Important The example value in this field is masked. A successful request returns an 11-digit plaintext mobile phone number.	139****1234

Examples

Success response

JSON format

{
  "Code": "OK",
  "Message": "请求成功",
  "RequestId": "8906582E-6722",
  "GetMobileResultDTO": {
    "Mobile": "139****1234"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.