QueryAiVoiceAgentDetailNew-阿里云帮助中心

Gets details for a specified agent, including its basic, branch, and version information.

Operation description

Usage notes

This API retrieves the details of a communication agent.
If you do not specify BranchId and VersionId, the API returns the configuration for the latest published version on the effective branch. If the effective branch only contains a draft version, no configuration is returned.
If you specify only BranchId, the API returns the configuration for the latest published version on the specified branch. If the specified branch only contains a draft version, no configuration is returned.
If you specify both BranchId and VersionId, the API returns the configuration for the specified version.
When BranchDeployStatus is 1 (branch deployed) and VersionPublishStatus is 1 (version published), imported outbound tasks use the configuration of this branch.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
BranchId	string	No	The ID of the branch. If you do not specify this parameter, the active branch is used.	12
AgentId	string	Yes	The ID of the agent.	1234***5678
VersionId	string	No	The ID of the version. If you do not specify this parameter, the system uses the latest published version for the specified branch. You must specify BranchId when you use this parameter.	21

Response elements

Element	Type	Description	Example
	object	The details of the agent.
AccessDeniedDetail	string	The reason for the access denial.	None
RequestId	string	The request ID.	742C9243-2870-B8D6-0C68-C12345AABBCC0
Message	string	The message that is associated with the status code.	成功
Data	object	The detailed data of the agent.
AgentCallConfig	object	The voice configuration for intelligent outbound calls.
StartWordType	integer	The type of the prologue. Valid values: `0` (text) and `1` (recording).	1
Prologue	string	The prologue.	你好，这里是******。
VocabId	string	The ID of the hotword vocabulary.	afb2c43**********83e6df30551c11f7
TtsConfig	object	The Text-to-Speech (TTS) configuration.
VoiceCode	string	The voice code.	V123ABC00
MixingTemplate	integer	The ID of the audio mixing template.	1
BackgroundEnabled	boolean	Specifies whether to enable background sound.	true
TtsVolume	integer	The volume of TTS playback. Valid values: 0 to 100.	88
TtsStyle	string	The voice style.	longxiaoxia_v2p1
ResourceId	string	The resource ID. This parameter is required only for third-party voices.	voice-12345
CustomerAccountId	integer	The account of the third-party voice platform.	75
VoiceType	boolean	The type of the TTS voice. Valid values: `VOICE_TYPE_SYSTEM`: a system voice. `VOICE_TYPE_CLONE`: a cloned voice. `VOICE_TYPE_DOUBAO`: a Doubao voice. `VOICE_TYPE_MINIMAX`: a Minimax voice. `VOICE_TYPE_OPENTTS`: an open voice. `VOICE_TYPE_BL_CUSTOM`: a high-quality custom cloned voice.	VOICE_TYPE_SYSTEM
MixingEnabled	boolean	Specifies whether to enable audio mixing.	true
TtsSpeed	integer	The speech rate for TTS playback. Valid values: -200 to 200. Default value: 0.	0
BackgroundSound	integer	The ID of the background sound.	17
BackgroundVolume	integer	The volume of the background sound. Valid values: `0` (low), `1` (medium), and `2` (high).	1
EventConfig	object	The event configuration.
MuteActive	boolean	Specifies whether to wake up the model upon the first mute event.	true
SessionTimeout	integer	The maximum call duration. Unit: seconds. Valid values: 600 to 3600. The call is automatically disconnected if this duration is exceeded.	1000
CallAssistantHangup	boolean	Specifies whether to disconnect the call when an answering machine is detected.	false
CallAssistantRecognize	boolean	Specifies whether to enable answering machine detection.	true
MuteDuration	integer	The mute duration. Unit: seconds. Valid values: 3 to 15.	5
MuteHangupNum	integer	The number of consecutive mute events that trigger an automatic disconnection. Valid values: 1 to 5.	1
RecordingFile	string	The URL of the audio file for the prologue. This parameter is returned only when `StartWordType` is set to `1`.	/oss-file-key
TransferConfig	object	The configuration for transferring the call to a manual agent.
SeatRouteName	string	The name of the agent route.	人工座席
CalledNumber	string	The called number.	123111122222
CustomerRouteCode	string	The customer route code.	123
CallingNumberType	integer	The type of the called number.	1
Enabled	boolean	Specifies whether to enable call transfer.	false
CallerNumberType	integer	The type of the caller number.	48
ExtraInfo	string	The supplementary information.	Additional information for the agent
TransferType	integer	The agent transfer type.	73
CallingNumber	string	The destination number for the transfer, such as the phone number of a customer service agent.	123111122222
CallerNumber	string	The caller number.	123111122222
TransferBizId	string	The business ID.	123
SeatRouteCode	string	The agent route code.	SEAT_CTI_A_NET
TransferContent	string	The prompt that is played when the call is transferred to a manual agent.	提示语
FailureContent	string	The prompt that is played when the transfer to a manual agent fails.	失败说明
AgentMode	integer	The build mode. Valid values: `0`: prompt-based mode. `1`: dialog flow mode.	1
BranchDesc	string	The branch description.	默认分支
BranchDeployStatus	integer	The deployment status. Valid values: `0`: Inactive (NOT_EFFECT). `1`: Active (EFFECT).	1
BranchId	integer	The branch ID.	18
BranchName	string	The branch name.	默认版本
Scene	string	The scenario.	个人客户线索转化
AgentDemandConfig	object	The business requirement configuration for the agent.
BasicTaskDescription	string	The basic task configuration.	进行产品营销，介绍优势特点
CoreTarget	string	The core objective.	销售线索转化
AiGenerate	boolean	Specifies whether the agent was built with AI assistance.	false
UserRole	string	The user role.	潜在客户
BusinessType	integer	The business scenario.	1
SysRole	string	The system role.	销售
SummaryConfig	object	The call summary configuration.
MainPurpose	object	The main intent.
MainPurposeEnum	array<object>	The enumerated values for the main intent.
	object	The enumerated values for the main intent.
Description	string	The description of the value.	Description of the tag value
Value	string	The value.	Tag value example
Id	string	The unique ID of the tag.	tag_12345
MainPurposeName	string	The name of the main intent.	Customer inquiry handling
MainPurposeType	string	The value type of the main intent. Valid values: `TEXT` and `ENUM`.	ENUM
MainPurposeDescription	string	The description of the main intent.	Description of the main intent
Id	string	The ID of the main intent.	123
CallResultTagConfig	object	The configuration for mapping call results to tags.
MappingTag	object	The mapping of call results to tags.
	string	The mapping of call results to tags.	"CANCEL": "{\"tag\":\"test\",\"desc\":\"11\"}"
DefaultTag	object	The default fallback tag information.
Desc	string	The description.	标签说明
Tag	string	The tag.	标签1
OutputTagConfig	array<object>	The output tag configuration.
	array<object>	The output tag configuration.
OutputTagDescription	string	The description of the output tag.	用户购买产品的意愿
OutputTagType	string	The value type of the output tag. Valid values: `TEXT` and `ENUM`.	ENUM
OutputTagEnum	array<object>	The enumerated values for the output tag.
	object	The enumerated values of the tag. This parameter is returned only when the tag value type is `ENUM`.
Description	string	The tag description.	用户有较高购买意愿
Value	string	The enumerated value of the tag.	高意愿
Id	string	The tag ID.	10
OutputTagName	string	The name of the output tag.	购买意愿
Id	string	The ID of the output tag.	123
PhoneTagConfig	array<object>	The call variable configuration.
	array<object>	The call variable configuration.
PhoneTagType	string	The type of the call variable. Valid values: `TEXT` and `ENUM`.	ENUM
PhoneTagName	string	The description of the call variable.	用户性别
PhoneTagRequired	boolean	Specifies whether the call variable is required.	false
Id	string	The ID of the call variable.	123
PhoneTagSource	string	The source of the call variable.	MANUAL_CREATE
PhoneTagKey	string	The key of the call variable.	gender
PhoneTagEnum	array<object>	The enumerated values for the call variable.
	object	The enumerated values for the call variable.
Description	string	The description.	gender
Value	string	The tag value.	male
Id	string	The tag ID.	123
AgentDesc	string	The agent description.	日常测试使用。
AgentId	integer	The agent ID.	3021893791
AgentName	string	The agent name.	测试智能体
KnowledgeConfig	object	The knowledge base configuration.
KnowledgeIds	array<object>	The collection of knowledge bases.
	object	The collection of knowledge bases.
KnowledgeName	string	The name of the knowledge base.	产品知识库
KnowledgeId	integer	The ID of the knowledge base.	68
RagConfig	object	The Retrieval-Augmented Generation (RAG) configuration.
Description	string	RAG retrieval description	知识库检索
Enabled	boolean	Enable RAG retrieval	false
VersionId	integer	Version ID.	89
VersionPublishTime	string	The most recent release time of the version.	2024-01-15 10:30:00
VersionPublishStatus	integer	The release status of the version. 0 indicates Unreleased, 1 indicates Released, and 2 indicates Draft.	1
VersionName	string	Version name.	测试版本1
VersionDesc	string	Version Description	测试第一个版本
Code	string	Status code.	OK
Success	boolean	Indicates whether the API call was successful. Possible values: true: The operation was successful. false: Failure.	true

Examples

Success response

JSON format

{
  "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
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.