GetAuthorizationUrl-阿里云帮助中心

This operation is offline.

Operation description

Preparations

Register an Alibaba Cloud account and obtain an AccessKey pair. For more information, see Communication Authorization Service workflow.

QPS limit

The per-user QPS limit for this operation is 1,000 calls per second. Exceeding this limit triggers rate limiting, which may affect your business. Call this operation only as needed.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
PhoneNo	string	Yes	The phone number.	1390000****
SchemeId	integer	Yes	The authorization scenario ID. You can view the authorization scenario ID on the Authorization Scenarios page in the Phone Number Verification Service console.	234****
EndDate	string	No	The authorization end date. This field is required for contract-based plans. Format: yyyy-MM-dd.	2020–12–28

Response elements

Element	Type	Description	Example
	object
Code	string	The status code. OK means the request succeeded. For other status codes, see Server-side API status codes.	OK
Message	string	A description of the status code.	请求成功
RequestId	string	The request ID.	8906582E-6722
Data	object	The response struct.
AuthorizationUrl	string	The authorization URL.	https://render.****.com/p/s/web-call-minapp/auth-bao?page=commauth/index&token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJiaXpUeXBlIjoiQ29tbUF1dGgiLCJiaXpJZCI6IjVmNWZjNjAzZDQzMTQ0MWZiYTZiNjYzM2QyMjIyNzU0IiwiZXhwIjoxNjA4MTkxODQxfQ.5IvBj2nKgr60APtotaIB13vtPVrdsPQ6avIfWxte1pA&_env=prod

Examples

Success response

JSON format

{
  "Code": "OK",
  "Message": "请求成功",
  "RequestId": "8906582E-6722",
  "Data": {
    "AuthorizationUrl": "https://render.****.com/p/s/web-call-minapp/auth-bao?page=commauth/index&token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJiaXpUeXBlIjoiQ29tbUF1dGgiLCJiaXpJZCI6IjVmNWZjNjAzZDQzMTQ0MWZiYTZiNjYzM2QyMjIyNzU0IiwiZXhwIjoxNjA4MTkxODQxfQ.5IvBj2nKgr60APtotaIB13vtPVrdsPQ6avIfWxte1pA&_env=prod"
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameters	The specified parameter is not valid.
400	MissingParameter	You must specify the parameter.
400	Throttling.System	The request was denied due to API flow control.	Request was denied due to api flow control.
400	MobileNumberIllgeal	The specified mobile phone number is invalid.
400	DataNotFound	The specified scheme does not exist.
400	IllegalParameter	The specified endDate is invalid.
400	SchemeNotPassed	The scheme is not passed.
500	IdentityCertifyNotExist	The identity verification record does not exist.
500	InternalError	An error occurred while processing your request.
500	SystemError	A system error occurred.
500	OutOfService	The account is suspended.
500	FunctionNotSubscribed	You have not subscribed to the function.
403	Forbidden	The user is not authorized to operate on the specified resource.
403	UnauthorizedOperation	Failed to verify your access permissions.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.