QueryAiVoiceAgentDetailNew - 查询通信智能体详情(新模式)

更新时间:
复制为 MD 格式

查询指定智能体的详细信息,包括基础信息、分支信息、版本信息等。

接口说明

请求说明

  • 该接口用于查询通信智能体的详细信息。
  • BranchIdVersionId 均为空时,返回当前生效分支的最新已发布版本配置(如生效分支仅有草稿版本,则不返回)。
  • BranchId 有值时,返回该分支的最新已发布版本配置(如生效分支仅有草稿版本,则不返回)。
  • BranchIdVersionId 均有值时,返回指定版本对应配置。
  • BranchDeployStatus = 1 (分支已部署上线) 且 VersionPublishStatus = 1 (版本已发布) 时,该分支配置是目前导入的外呼任务会使用的配置。

调试

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

授权信息

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

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

请求参数

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

分支 ID。为空时自动定位到当前生效分支。

12
AgentIdstring

智能体 ID。

1234***5678
VersionIdstring

版本 ID。为空时取对应分支的最新发布版本。需与 BranchId 配合使用。

21

返回参数

名称类型描述示例值
object

智能体详情数据。

AccessDeniedDetailstring

访问被拒绝的详细原因。

None
RequestIdstring

请求 ID。

742C9243-2870-B8D6-0C68-C12345AABBCC0
Messagestring

状态码描述。

成功
Dataobject

智能体详情数据。

AgentCallConfigobject

智能外呼语音配置。

StartWordTypelong

开场白类型。0 为文本,1 为录音。

1
Prologuestring

开场白。

你好,这里是******。
VocabIdstring

热词库 ID。

afb2c43**********83e6df30551c11f7
TtsConfigobject

TTS 配置。

VoiceCodestring

音色编码。

V123ABC00
MixingTemplatelong

混音模板 ID。

1
BackgroundEnabledboolean

是否开启背景音。

true
TtsVolumelong

TTS 播放的音量。取值范围:0~100。

88
TtsStylestring

音色风格。

longxiaoxia_v2p1
ResourceIdstring

资源 ID。(仅三方音色需要)

voice-12345
CustomerAccountIdlong

三方音色平台账号

75
VoiceTypeboolean

TTS 音色类型枚举值。

VOICE_TYPE_SYSTEM-系统音色。

VOICE_TYPE_CLONE-克隆音色。

VOICE_TYPE_DOUBAO-豆包音色。

VOICE_TYPE_MINIMAX-Minimax 音色。

VOICE_TYPE_OPENTTS-开放音色。

VOICE_TYPE_BL_CUSTOM-定制精品复刻音色。

VOICE_TYPE_SYSTEM
MixingEnabledboolean

是否开启混音。

true
TtsSpeedlong

TTS 播放时的声音速度。取值范围:-200~200,默认 0。

0
BackgroundSoundlong

背景音 ID。

17
BackgroundVolumelong

背景音音量。0-低、1-中、2-高。

1
EventConfigobject

事件配置

MuteActiveboolean

第一个静音是否唤起模型。

true
SessionTimeoutlong

最大通话时长(秒)。最小 600s,最大 3600s。超时后自动挂断。

1000
CallAssistantHangupboolean

识别到智能接听是否挂断。

false
CallAssistantRecognizeboolean

智能接听识别是否开启。

true
MuteDurationlong

静音时长(秒)。最小 3s,最大 15s。

5
MuteHangupNumlong

连续多少个静音事件主动挂机。最小 1,最大 5。

1
RecordingFilestring

开场白录音音频文件地址。仅 StartWordType=1 时有值。

/oss-file-key
TransferConfigobject

转坐席配置

SeatRouteNamestring

坐席线路名称

人工座席
CalledNumberstring

被叫号码。

123111122222
CustomerRouteCodestring

客户线路编码

123
CallingNumberTypelong

被叫号码类型

1
Enabledboolean

是否启用

false
CallerNumberTypelong

主叫号码类型

48
ExtraInfostring

补充信息。

Additional information for the agent
TransferTypelong

转坐席类型

73
CallingNumberstring

接听方号码。例如用户手机号码、客服坐席号码、机器号码等。

123111122222
CallerNumberstring

主叫号码。

123111122222
TransferBizIdstring

业务 id

123
SeatRouteCodestring

坐席线路编码

SEAT_CTI_A_NET
TransferContentstring

转人工坐席提示语

提示语
FailureContentstring

转人工坐席失败提示

失败说明
AgentModelong

构建方式。枚举值:

  • 0:提示词模式。
  • 1:对话流模式。
1
BranchDescstring

分支描述。

默认分支
BranchDeployStatuslong

部署状态。枚举值:

  • 0:未生效(NOT_EFFECT)。
  • 1:生效中(EFFECT)。
1
BranchIdlong

分支 ID。

18
BranchNamestring

分支名称

默认版本
Scenestring

场景

个人客户线索转化
AgentDemandConfigobject

智能体业务需求配置。

BasicTaskDescriptionstring

基础任务配置。

进行产品营销,介绍优势特点
CoreTargetstring

核心目标

销售线索转化
AiGenerateboolean

是否 AI 辅助构建

false
UserRolestring

用户角色

潜在客户
BusinessTypelong

业务场景。

1
SysRolestring

系统角色。

销售
SummaryConfigobject

通话小记配置

MainPurposeobject

主意图

MainPurposeEnumarray<object>

主意图可取值

mainPurposeEnumobject

主意图可取值枚举

Descriptionstring

可取值说明。

Description of the tag value
Valuestring

可取值。

Tag value example
Idstring

标签唯一 ID。

tag_12345
MainPurposeNamestring

主意图名称。

Customer inquiry handling
MainPurposeTypestring

主意图取值类型。文本类型: TEXT,可取值类型:ENUM

ENUM
MainPurposeDescriptionstring

主意图说明。

Description of the main intent
Idstring

主意图 ID。

123
CallResultTagConfigobject

呼叫结果标签映射配置

MappingTagobject

呼叫结果与标签映射

string

呼叫结果与标签映射

"CANCEL": "{\"tag\":\"test\",\"desc\":\"11\"}"
DefaultTagobject

默认兜底标签信息

Descstring

说明

标签说明
Tagstring

标签

标签1
OutputTagConfigarray<object>

输出标签配置

outputTagConfigobject

输出标签配置

OutputTagDescriptionstring

输出标签描述信息。

用户购买产品的意愿
OutputTagTypestring

输出标签值类型。文本类型: TEXT,可取值类型:ENUM

ENUM
OutputTagEnumarray<object>

输出标签可选项。

outputTagEnumobject

标签枚举值,只有标签值类型为 ENUM 时才有该字段。

Descriptionstring

标签描述

用户有较高购买意愿
Valuestring

标签枚举值。

高意愿
Idstring

标签 ID。

10
OutputTagNamestring

输出标签名称。

购买意愿
Idstring

输出标签 ID

123
PhoneTagConfigarray<object>

通话变量配置

phoneTagConfigobject

通话变量配置

PhoneTagTypestring

通话变量类型。文本类型: TEXT,可取值类型:ENUM

ENUM
PhoneTagNamestring

通话变量说明

用户性别
PhoneTagRequiredboolean

通话变量是否必填

false
Idstring

通话变量 ID

123
PhoneTagSourcestring

通话变量来源

MANUAL_CREATE
PhoneTagKeystring

通话变量键名

gender
PhoneTagEnumarray<object>

通话变量标签可选值

phoneTagEnumobject

通话变量标签可选值

Descriptionstring

说明

gender
Valuestring

标签值

male
Idstring

标签 ID

123
AgentDescstring

智能体描述。

日常测试使用。
AgentIdlong

智能体 ID。

3021893791
AgentNamestring

智能体名称。

测试智能体
KnowledgeConfigobject

知识库配置

KnowledgeIdsarray<object>

知识库集合

knowledgeIdsobject

知识库集合

KnowledgeNamestring

知识库名称。

产品知识库
KnowledgeIdlong

知识库 ID。

68
RagConfigobject

RAG 配置

Descriptionstring

RAG 检索描述

知识库检索
Enabledboolean

是否开启 RAG 检索

false
VersionIdlong

版本 ID。

89
VersionPublishTimestring

版本最近一次发布时间。

2024-01-15 10:30:00
VersionPublishStatuslong

版本发布状态。0 为未发布,1 为已发布,2 为草稿

1
VersionNamestring

版本名称。

测试版本1
VersionDescstring

版本描述

测试第一个版本
Codestring

状态码。

OK
Successboolean

调用接口是否成功。取值:

  • true:成功。
  • false:失败。
true

示例

正常返回示例

JSON格式

{
  "AccessDeniedDetail": "None",
  "RequestId": "742C9243-2870-B8D6-0C68-C12345AABBCC0",
  "Message": "成功",
  "Data": {
    "AgentCallConfig": {
      "StartWordType": 1,
      "Prologue": "你好,这里是******。",
      "VocabId": "afb2c43**********83e6df30551c11f7",
      "TtsConfig": {
        "VoiceCode": "V123ABC00",
        "MixingTemplate": 1,
        "BackgroundEnabled": true,
        "TtsVolume": 88,
        "TtsStyle": "longxiaoxia_v2p1",
        "ResourceId": "voice-12345",
        "CustomerAccountId": 75,
        "VoiceType": true,
        "MixingEnabled": true,
        "TtsSpeed": 0,
        "BackgroundSound": 17,
        "BackgroundVolume": 1
      },
      "EventConfig": {
        "MuteActive": true,
        "SessionTimeout": 1000,
        "CallAssistantHangup": false,
        "CallAssistantRecognize": true,
        "MuteDuration": 5,
        "MuteHangupNum": 1
      },
      "RecordingFile": "/oss-file-key",
      "TransferConfig": {
        "SeatRouteName": "人工座席",
        "CalledNumber": 123111122222,
        "CustomerRouteCode": 123,
        "CallingNumberType": 1,
        "Enabled": false,
        "CallerNumberType": 48,
        "ExtraInfo": "Additional information for the agent",
        "TransferType": 73,
        "CallingNumber": 123111122222,
        "CallerNumber": 123111122222,
        "TransferBizId": 123,
        "SeatRouteCode": "SEAT_CTI_A_NET",
        "TransferContent": "提示语",
        "FailureContent": "失败说明"
      }
    },
    "AgentMode": 1,
    "BranchDesc": "默认分支",
    "BranchDeployStatus": 1,
    "BranchId": 18,
    "BranchName": "默认版本",
    "Scene": "个人客户线索转化",
    "AgentDemandConfig": {
      "BasicTaskDescription": "进行产品营销,介绍优势特点",
      "CoreTarget": "销售线索转化",
      "AiGenerate": false,
      "UserRole": "潜在客户",
      "BusinessType": 1,
      "SysRole": "销售"
    },
    "SummaryConfig": {
      "MainPurpose": {
        "MainPurposeEnum": [
          {
            "Description": "Description of the tag value",
            "Value": "Tag value example",
            "Id": "tag_12345"
          }
        ],
        "MainPurposeName": "Customer inquiry handling",
        "MainPurposeType": "ENUM",
        "MainPurposeDescription": "Description of the main intent",
        "Id": 123
      },
      "CallResultTagConfig": {
        "MappingTag": {
          "key": "\"CANCEL\": \"{\\\"tag\\\":\\\"test\\\",\\\"desc\\\":\\\"11\\\"}\""
        },
        "DefaultTag": {
          "Desc": "标签说明",
          "Tag": "标签1"
        }
      },
      "OutputTagConfig": [
        {
          "OutputTagDescription": "用户购买产品的意愿",
          "OutputTagType": "ENUM",
          "OutputTagEnum": [
            {
              "Description": "用户有较高购买意愿",
              "Value": "高意愿",
              "Id": 10
            }
          ],
          "OutputTagName": "购买意愿",
          "Id": 123
        }
      ]
    },
    "PhoneTagConfig": [
      {
        "PhoneTagType": "ENUM",
        "PhoneTagName": "用户性别",
        "PhoneTagRequired": false,
        "Id": 123,
        "PhoneTagSource": "MANUAL_CREATE",
        "PhoneTagKey": "gender",
        "PhoneTagEnum": [
          {
            "Description": "gender",
            "Value": "male",
            "Id": 123
          }
        ]
      }
    ],
    "AgentDesc": "日常测试使用。",
    "AgentId": 3021893791,
    "AgentName": "测试智能体",
    "KnowledgeConfig": {
      "KnowledgeIds": [
        {
          "KnowledgeName": "产品知识库",
          "KnowledgeId": 68
        }
      ],
      "RagConfig": {
        "Description": "知识库检索",
        "Enabled": false
      }
    },
    "VersionId": 89,
    "VersionPublishTime": "2024-01-15 10:30:00 ",
    "VersionPublishStatus": 1,
    "VersionName": "测试版本1",
    "VersionDesc": "测试第一个版本"
  },
  "Code": "OK",
  "Success": true
}

错误码

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

变更历史

变更时间变更内容概要操作
2026-05-18OpenAPI 返回结构发生变更查看变更详情
2026-05-14新增 OpenAPI查看变更详情