文档

GenerateAIAgentCall - 生成AI智能体通话实例

更新时间:

创建一个智能体实例,返回智能体所在的频道、频道内名称以及进入频道所需的token。

接口说明

请求说明

通过此 API,您可以根据提供的 AI 智能体 ID(AIAgentId)创建一个智能体实例。您可以通过 API 响应中的信息进入对应房间,与智能体进行对话。

注意: 确保提供的 AI 智能体 ID 有效,并根据实际应用场景适当配置可选参数。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

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

智能体 ID。

39f8e0bc005e4f309379701645f4****
Expirelong

可选参数,表示 token 失效的时间,单位秒,默认 3600 秒。取值范围 0-604800。

3600
UserIdstring

对话频道内用户名称,不输入则系统自动生成。长度不超过 64。

877ae632caae49b1afc81c2e8194ffb4
TemplateConfigAIAgentTemplateConfig

智能体模版配置,填写的配置会和控制台上的智能体模版配置进行合并更新。不填写则使用控制台上智能体的默认配置。

返回参数

名称类型描述示例值
object

Schema of Response

AIAgentUserIdstring

ARTC 频道内智能体的名称。

877ae632caae49b1afc81c2e8194ffb4
ChannelIdstring

ARTC 频道 ID。

70f22d5784194938a7e387052f2b3208
InstanceIdstring

生成的智能体实例 ID。

39f8e0bc005e4f309379701645f4****
RequestIdstring

请求 ID。

7B117AF5-2A16-412C-B127-FA6175ED1AD0
Tokenstring

端侧的 ARTC Token。

eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx
UserIdstring

ARTC 频道内用户名称。

user123

示例

正常返回示例

JSON格式

{
  "AIAgentUserId": "877ae632caae49b1afc81c2e8194ffb4",
  "ChannelId": "70f22d5784194938a7e387052f2b3208",
  "InstanceId": "39f8e0bc005e4f309379701645f4****",
  "RequestId": "7B117AF5-2A16-412C-B127-FA6175ED1AD0",
  "Token": "eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx",
  "UserId": "user123"
}

错误码

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