GetIdentificationSession - Cell Phone Number Service - Alibaba Cloud Documentation Center

Operation description

Before calling this operation, sign in to the Phone Number E-encyclopedia console. On the Tag Plaza page, find the required tag, click Apply for Activation, and complete the application. This operation is available only after your application is approved.
This operation is not billed.

QPS limit

The QPS limit for a single user is 200. If you exceed this limit, subsequent API calls are throttled. This may affect your business, so plan your calls 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

dytns:GetIdentificationSession

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
AuthCode	string	Yes	The authorization code.	example

Response elements

Element	Type	Description	Example
	object
AccessDeniedDetail	string	Details about why access was denied.	-
RequestId	string	The ID of the request.	68A40250-50CD-034C-B728-0BD******177
Message	string	A description of the status code.	OK
Data	object	The data object.
ExpireDate	string	The authorization expiration time.	example
SessionId	string	The session ID.	example
Code	string	The status code for the request. OK: The request succeeded. NoIdentificationResult: No identification result is available or the identification failed. SessionNotValid: The session is invalid or has expired. MobileNumberIllegal: The provided phone number is in an invalid format.	OK

Examples

Success response

JSON format

{
  "AccessDeniedDetail": "-",
  "RequestId": "68A40250-50CD-034C-B728-0BD******177",
  "Message": "OK",
  "Data": {
    "ExpireDate": "example",
    "SessionId": "example"
  },
  "Code": "OK"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.