GenerateMessageChatToken-阿里云帮助中心

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

ice:GenerateMessageChatToken

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
AIAgentId	string	Yes	The ID of the AI agent.	19de81b3b3d94abda22******
UserId	string	Yes	The ID of the user to sign in. It can be up to 64 characters in length and can contain only letters, digits, and underscores (_).	YOURUSERID
Role	string	No	The role. A value of admin indicates that the user can perform management operations. This parameter is empty by default.	user
Expire	integer	No	The validity period. Unit: seconds. Default value: 3600.	3600

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	req_1234567890abcdef
Token	string	The generated token.	acet**********
AppId	string	The AppID of the user.	***********
UserId	string	The ID of the user for joining the channel.	YOURUSERID
Nonce	string	The nonce used to generate the token.	AK-***********
Role	string	The role used to generate the token.	admin
AppSign	string	The application signature.	H4sIAAAAAAAE******************
TimeStamp	integer	The expiration time. Unit: seconds. Expiration time = Current time + Validity period.	1700000000

Examples

Success response

JSON format

{
  "RequestId": "req_1234567890abcdef",
  "Token": "acet**********",
  "AppId": "***********",
  "UserId": "YOURUSERID",
  "Nonce": "AK-***********",
  "Role": "admin",
  "AppSign": "H4sIAAAAAAAE******************",
  "TimeStamp": 1700000000
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.