启动一个RTC互动AI智能体实例,并加入RTC通话。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
ice:StartRtcRobotInstance | none | *全部资源 * |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RobotId | string | 是 | AI 智能体 ID | ca28b08ad3464ebcb42e5c0f7c6d2e89 |
ChannelId | string | 是 | RTC 的频道 ID | testId |
UserId | string | 是 | AI 智能体在频道中的 ID | my-robot |
UserData | string | 否 | 用户自定义信息 | {} |
AuthToken | string | 是 | RTC 的入会凭证,需要用户自己通过 RTC 的 AppKey 生成 | ********** |
Config | object | 否 | 通话高级配置。如果填写,会覆盖 AI 智能体创建时的默认配置;否则使用创建时的默认配置。 | |
EnableVoiceInterrupt | boolean | 否 | 是否允许语音打断 | true |
Greeting | string | 否 | 欢迎语,即 AI 智能体在用户入会后主动说的一句话 | 你好,有什么可以帮助的吗? |
VoiceId | string | 否 | 音色 ID | zhixiaoxia |
返回参数
示例
正常返回示例
JSON
格式
{
"InstanceId": "727dc0e296014bb58670940a3da95592",
"RequestId": "11DE0AB3-603B-5055-8A72-9C424854F983"
}
错误码
访问错误中心查看更多错误码。