UAIDVerification-阿里云帮助中心

Obtains a User Agent ID (UAID) based on a carrier authorization token. To obtain the authorization token and its signature value, see the GetUAIDApplyTokenSign API reference. A UAID is 64 characters long. The first 32 characters represent the device information, and the last 32 characters represent the number information.

Operation description

Before you use this operation, review the billing methods and pricing of Cell Phone Number Service.

This operation obtains a UAID based on a carrier authorization token.
To obtain the authorization token and its signature value, see the GetUAIDApplyTokenSign API reference.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
OutId	string	No	The external serial number.	b8b5b3a*******0b9893484fdf412c99
Carrier	string	Yes	The carrier of the user. Valid values: CM: China Mobile. CU: China Unicom. CT: China Telecom.	CM
Token	string	Yes	The carrier authorization token. Note To obtain the authorization token and its signature value, see the GetUAIDApplyTokenSign API reference.	MIGfMA0********3DQEBAQUAA4GNADCB
UserGrantId	string	No	The user authorization code. It indicates that the user has granted authorization. The value can be any unique random number of up to 128 bits. Warning When you integrate the service, add information about the UAID privacy policy to your product's privacy policy.	Md****a3Em
AuthCode	string	Yes	The authorization code. Note Go to Label Plaza in the Cell Phone Number Service console. Select a label and submit a request. After your request is approved, you receive the authorization code.	HwD97InG
Ip	string	No	The public IP address. This parameter is required when the carrier is China Unicom (CU). Both IPv4 and IPv6 addresses are supported.	2408:8440:308:29dc:ed00:c4ec:475c:25a4
Province	string	No	The province ID. This parameter is optional when the carrier is China Unicom (CU). The value must be the same as the `province` field in the response of the token acquisition operation.	1

Response elements

Element	Type	Description	Example
	object
AccessDeniedDetail	string	The details about the access denial.	-
Message	string	The description of the status code.	OK
RequestId	string	The request ID.	68A40250-50CD-034C-B728-0BD******177
Data	object	The returned data.
Uaid	string	The value of the obtained UAID.	B1E0C1********9F757AF52A035
Code	string	The status code of the request. Valid values: OK: The request was successful.	OK

Examples

Success response

JSON format

{
  "AccessDeniedDetail": "-",
  "Message": "OK",
  "RequestId": "68A40250-50CD-034C-B728-0BD******177",
  "Data": {
    "Uaid": "B1E0C1********9F757AF52A035"
  },
  "Code": "OK"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	Invalid parameter.
400	AuthCodeIllegal	Illegal authCode.
500	RequestTimeout	Request supplier timed out.	Request supplier timeout
500	RequestSupplierError	Request supplier error.	Request supplier error.

See for a complete list.

Release notes

See Release Notes for a complete list.