GetMessageToken - ApsaraVideo Live - Alibaba Cloud Documentation Center

Operation description

Usage notes

First obtain the client UserId, DeviceId, and DeviceType information, then pass them to the server. The server uses this interface to obtain the authentication token and returns it to the client. Different users need to use different UserIds, and different terminal devices need to use different DeviceIds.

QPS limits

The QPS limit for this API is 100 queries per second (QPS) per user. If you exceed this limit, API calls will be throttled, which may affect your business. You can call this API at a reasonable rate. For more information, see QPS limits.

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

live:GetMessageToken

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
AppId	string	Yes	Interactive Messages application ID.	a494caec-***-695ef345db77
DeviceId	string	Yes	Terminal device ID, uniquely representing a user terminal device, user-defined. It consists of lowercase letters, numbers, underscores (_), and hyphens (-), with a maximum length of 64 characters. Different terminal devices need to use different DeviceIds. We recommend obtaining it from the terminal device and passing it to the server.	a494caec-***-695ef345db77
DeviceType	string	Yes	Terminal device type. Valid values: ios android web pc	android
UserId	string	Yes	User UserId, user-defined, unique within the AppId. It consists of lowercase letters, numbers, underscores (_), and periods (.), with a maximum length of 32 characters. Different users need to use different UserIds.	de1**a0

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	Request ID.	16A96B9A-****-CB92E68F4CD8
Result	object	Return results.
AccessToken	string	Token used for establishing persistent connections.	oauth_cloud_key:***-b0YY5Gy6Q
AccessTokenExpiredTime	integer	Logon token expiration time in milliseconds.	86400000
RefreshToken	string	Refresh token. If the AccessToken expires, you can use the RefreshToken to obtain a new token.	oauth_cloud_key:****-Q62xggOTdgk3gw=

Examples

Success response

JSON format

{
  "RequestId": "16A96B9A-****-CB92E68F4CD8",
  "Result": {
    "AccessToken": "oauth_cloud_key:***-b0YY5Gy6Q",
    "AccessTokenExpiredTime": 86400000,
    "RefreshToken": "oauth_cloud_key:****-Q62xggOTdgk3gw="
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvaildParameter	Invalid Parameter	Invalid request parameter.
403	Forbidden	User not authorized to operate on the specified resource.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.