QueryAiVoiceAgentDetailNew - 查询通信智能体详情（新模式）-智能联络中心(AICCS)-阿里云帮助中心

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

接口说明

请求说明

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

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

aiccs:QueryAiVoiceAgentDetailNew

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
BranchId	string	否	分支 ID。为空时自动定位到当前生效分支。	12
AgentId	string	是	智能体 ID。	1234***5678
VersionId	string	否	版本 ID。为空时取对应分支的最新发布版本。需与 BranchId 配合使用。	21

返回参数

名称	类型	描述	示例值
	object	智能体详情数据。
AccessDeniedDetail	string	访问被拒绝的详细原因。	None
Code	string	状态码。	OK
Data	object	智能体详情数据。
AgentCallConfig	object	智能外呼语音配置。
EventConfig	object	事件配置
CallAssistantHangup	boolean	识别到智能接听是否挂断。	false
CallAssistantRecognize	boolean	智能接听识别是否开启。	true
MuteActive	boolean	第一个静音是否唤起模型。	true
MuteDuration	integer	静音时长（秒）。最小 3s，最大 15s。	5
MuteHangupNum	integer	连续多少个静音事件主动挂机。最小 1，最大 5。	1
SessionTimeout	integer	最大通话时长（秒）。最小 600s，最大 3600s。超时后自动挂断。	1000
Prologue	string	开场白。	你好，这里是******。
RecordingFile	string	开场白录音音频文件地址。仅 StartWordType=1 时有值。	/oss-file-key
StartWordType	integer	开场白类型。0 为文本，1 为录音。	1
TransferConfig	object	转坐席配置
CalledNumber	string	被叫号码。	123111122222
CallerNumber	string	主叫号码。	123111122222
CallerNumberType	integer	主叫号码类型	48
CallingNumber	string	接听方号码。例如用户手机号码、客服坐席号码、机器号码等。	123111122222
CallingNumberType	integer	被叫号码类型	1
CustomerRouteCode	string	客户线路编码	123
Enabled	boolean	是否启用	false
ExtraInfo	string	补充信息。	Additional information for the agent
FailureContent	string	转人工坐席失败提示	失败说明
SeatRouteCode	string	坐席线路编码	SEAT_CTI_A_NET
SeatRouteName	string	坐席线路名称	人工座席
TransferBizId	string	业务 id	123
TransferContent	string	转人工坐席提示语	提示语
TransferType	integer	转坐席类型	73
TtsConfig	object	TTS 配置。
BackgroundEnabled	boolean	是否开启背景音。	true
BackgroundSound	integer	背景音 ID。	17
BackgroundVolume	integer	背景音音量。0-低、1-中、2-高。	1
CustomerAccountId	integer	三方音色平台账号	75
MixingEnabled	boolean	是否开启混音。	true
MixingTemplate	integer	混音模板 ID。	1
ResourceId	string	资源 ID。（仅三方音色需要）	voice-12345
TtsSpeed	integer	TTS 播放时的声音速度。取值范围：-200~200，默认 0。	0
TtsStyle	string	音色风格。	longxiaoxia_v2p1
TtsVolume	integer	TTS 播放的音量。取值范围：0~100。	88
VoiceCode	string	音色编码。	V123ABC00
VoiceType	boolean	TTS 音色类型枚举值。 `VOICE_TYPE_SYSTEM`-系统音色。 `VOICE_TYPE_CLONE`-克隆音色。 `VOICE_TYPE_DOUBAO`-豆包音色。 `VOICE_TYPE_MINIMAX`-Minimax 音色。 `VOICE_TYPE_OPENTTS`-开放音色。 `VOICE_TYPE_BL_CUSTOM`-定制精品复刻音色。	VOICE_TYPE_SYSTEM
VocabId	string	热词库 ID。	afb2c43**********83e6df30551c11f7
AgentDemandConfig	object	智能体业务需求配置。
AiGenerate	boolean	是否 AI 辅助构建	false
BasicTaskDescription	string	基础任务配置。	进行产品营销，介绍优势特点
BusinessType	integer	业务场景。	1
CoreTarget	string	核心目标	销售线索转化
SysRole	string	系统角色。	销售
UserRole	string	用户角色	潜在客户
AgentDesc	string	智能体描述。	日常测试使用。
AgentId	integer	智能体 ID。	3021893791
AgentMode	integer	构建方式。枚举值： 0：提示词模式。 1：对话流模式。	1
AgentName	string	智能体名称。	测试智能体
BranchDeployStatus	integer	部署状态。枚举值： 0：未生效（NOT_EFFECT）。 1：生效中（EFFECT）。	1
BranchDesc	string	分支描述。	默认分支
BranchId	integer	分支 ID。	18
BranchName	string	分支名称	默认版本
KnowledgeConfig	object	知识库配置
KnowledgeIds	array<object>	知识库集合
	object	知识库集合
KnowledgeId	integer	知识库 ID。	68
KnowledgeName	string	知识库名称。	产品知识库
RagConfig	object	RAG 配置
Description	string	RAG 检索描述	知识库检索
Enabled	boolean	是否开启 RAG 检索	false
PhoneTagConfig	array<object>	通话变量配置
	array<object>	通话变量配置
Id	string	通话变量 ID	123
PhoneTagEnum	array<object>	通话变量标签可选值
	object	通话变量标签可选值
Description	string	说明	gender
Id	string	标签 ID	123
Value	string	标签值	male
PhoneTagKey	string	通话变量键名	gender
PhoneTagName	string	通话变量说明	用户性别
PhoneTagRequired	boolean	通话变量是否必填	false
PhoneTagSource	string	通话变量来源	MANUAL_CREATE
PhoneTagType	string	通话变量类型。文本类型: TEXT，可取值类型：ENUM	ENUM
Scene	string	场景	个人客户线索转化
ServiceDirection	string	服务方向	示例值示例值
SummaryConfig	object	通话小记配置
CallResultTagConfig	object	呼叫结果标签映射配置
DefaultTag	object	默认兜底标签信息
Desc	string	说明	标签说明
Tag	string	标签	标签1
MappingTag	object	呼叫结果与标签映射
	string	呼叫结果与标签映射	"CANCEL": "{\"tag\":\"test\",\"desc\":\"11\"}"
MainPurpose	object	主意图
Id	string	主意图 ID。	123
MainPurposeDescription	string	主意图说明。	Description of the main intent
MainPurposeEnum	array<object>	主意图可取值
	object	主意图可取值枚举
Description	string	可取值说明。	Description of the tag value
Id	string	标签唯一 ID。	tag_12345
Value	string	可取值。	Tag value example
MainPurposeName	string	主意图名称。	Customer inquiry handling
MainPurposeType	string	主意图取值类型。文本类型: TEXT，可取值类型：ENUM	ENUM
OutputTagConfig	array<object>	输出标签配置
	array<object>	输出标签配置
Id	string	输出标签 ID	123
OutputTagDescription	string	输出标签描述信息。	用户购买产品的意愿
OutputTagEnum	array<object>	输出标签可选项。
	object	标签枚举值，只有标签值类型为 ENUM 时才有该字段。
Description	string	标签描述	用户有较高购买意愿
Id	string	标签 ID。	10
Value	string	标签枚举值。	高意愿
OutputTagName	string	输出标签名称。	购买意愿
OutputTagType	string	输出标签值类型。文本类型: TEXT，可取值类型：ENUM	ENUM
VersionDesc	string	版本描述	测试第一个版本
VersionId	integer	版本 ID。	89
VersionName	string	版本名称。	测试版本1
VersionPublishStatus	integer	版本发布状态。0 为未发布，1 为已发布，2 为草稿	1
VersionPublishTime	string	版本最近一次发布时间，格式：YYYY-MM-DD HH:mm:ss。	2024-01-15 10:30:00
Message	string	状态码描述。	成功
RequestId	string	请求 ID。	742C9243-2870-B8D6-0C68-C12345AABBCC0
Success	boolean	调用接口是否成功。取值： true：成功。 false：失败。	true

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

更多信息，参考变更详情。