GenerateMessageChatToken - 生成直播互动消息所需的token

生成直播互动消息所需的token。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ice:GenerateMessageChatTokennone
*全部资源
*

请求参数

名称类型必填描述示例值
AIAgentIdstring

The ID of the AI agent.

19de81b3b3d94abda22******
UserIdstring

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
Rolestring

The role. A value of admin indicates that the user can perform management operations. This parameter is empty by default.

user
Expireinteger

The validity period. Unit: seconds. Default value: 3600.

3600

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

The request ID.

req_1234567890abcdef
Tokenstring

The generated token.

acet**********
AppIdstring

The AppID of the user.

***********
UserIdstring

The ID of the user for joining the channel.

YOURUSERID
Noncestring

The nonce used to generate the token.

AK-***********
Rolestring

The role used to generate the token.

admin
AppSignstring

The application signature.

H4sIAAAAAAAE******************
TimeStamplong

The expiration time. Unit: seconds. Expiration time = Current time + Validity period.

1700000000

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。