QueryAiVoiceAgentDetailNew-Artificial Intelligence Cloud Call Service(AICCS)-阿里云帮助中心

Queries the details of a specified agent, including basic information, branch information, and version information.

Operation description

This operation queries the details of a communication agent.
If both BranchId and VersionId are empty, the latest published version configuration of the current active branch is returned. If the active branch has only a draft version, no configuration is returned.
If only BranchId has a value, the latest published version configuration of the specified branch is returned. If the branch has only a draft version, no configuration is returned.
If both BranchId and VersionId have values, the configuration of the specified version is returned.
When BranchDeployStatus = 1 (branch is deployed and online) and VersionPublishStatus = 1 (version is published), the branch configuration is the one used by currently imported outbound call tasks.

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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

aiccs:QueryAiVoiceAgentDetailNew

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
BranchId	string	No	The branch ID. If this parameter is left empty, the current active branch is automatically used.	12
AgentId	string	Yes	The agent ID.	1234***5678
VersionId	string	No	The version ID. If this parameter is left empty, the latest published version of the corresponding branch is used. This parameter must be used together with BranchId.	21

Response elements

Element	Type	Description	Example
	object	The agent details.
AccessDeniedDetail	string	The detailed reason why access was denied.	None
RequestId	string	The request ID.	742C9243-2870-B8D6-0C68-C12345AABBCC0
Message	string	The description of the status code.	Success
Data	object	The agent details.
AgentCallConfig	object	The intelligent outbound call voice configuration.
StartWordType	integer	The opening statement type. 0 indicates text. 1 indicates recording.	1
Prologue	string	The opening statement.	Hello, this is ******
VocabId	string	The hot word library ID.	afb2c43**********83e6df30551c11f7
TtsConfig	object	The TTS configuration.
VoiceCode	string	The voice code.	V123ABC00
MixingTemplate	integer	The mixing template ID.	1
BackgroundEnabled	boolean	Indicates whether background sound is enabled.	true
TtsVolume	integer	The TTS playback volume. 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 third-party voice platform account.	75
VoiceType	boolean	The TTS voice type. Valid values: `VOICE_TYPE_SYSTEM`: system voice. `VOICE_TYPE_CLONE`: cloned voice. `VOICE_TYPE_DOUBAO`: Doubao voice. `VOICE_TYPE_MINIMAX`: Minimax voice. `VOICE_TYPE_OPENTTS`: open voice. `VOICE_TYPE_BL_CUSTOM`: custom premium cloned voice.	VOICE_TYPE_SYSTEM
MixingEnabled	boolean	Indicates whether audio mixing is enabled.	true
TtsSpeed	integer	The TTS playback speed. Valid values: -200 to 200. Default value: 0.	0
BackgroundSound	integer	The background sound ID.	17
BackgroundVolume	integer	The background sound volume. Valid values: 0: low. 1: medium. 2: high.	1
EventConfig	object	The event configuration.
MuteActive	boolean	Specifies whether the first silence triggers the model.	true
SessionTimeout	integer	The maximum call duration in seconds. Minimum value: 600. Maximum value: 3600. The call is automatically hung up after the timeout.	1000
CallAssistantHangup	boolean	Specifies whether to hang up when an intelligent answering service is detected.	false
CallAssistantRecognize	boolean	Specifies whether intelligent answering recognition is enabled.	true
MuteDuration	integer	The silence duration in seconds. Minimum value: 3. Maximum value: 15.	5
MuteHangupNum	integer	The number of consecutive silence events before the system proactively hangs up. Minimum value: 1. Maximum value: 5.	1
RecordingFile	string	The URL of the opening statement recording audio file. This parameter has a value only when StartWordType is set to 1.	/oss-file-key
TransferConfig	object	The transfer-to-agent configuration.
SeatRouteName	string	The agent route name.	Manual agent
CalledNumber	string	The called number.	123111122222
CustomerRouteCode	string	The customer route code.	123
CallingNumberType	integer	The called number type.	1
Enabled	boolean	Indicates whether the feature is enabled.	false
CallerNumberType	integer	The caller number type.	48
ExtraInfo	string	The supplementary information.	Additional information for the agent
TransferType	integer	The transfer-to-agent type.	73
CallingNumber	string	The answering party number, such as a user mobile number, customer service agent number, or robot number.	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 message for transferring to a human agent.	Prompt message
FailureContent	string	The prompt message when the transfer to a human agent fails.	Failure description
AgentMode	integer	The build mode. Valid values: 0: prompt mode. 1: dialog flow mode.	1
BranchDesc	string	The branch description.	Default branch
BranchDeployStatus	integer	The deployment status. Valid values: 0: not effective (NOT_EFFECT). 1: effective (EFFECT).	1
BranchId	integer	The branch ID.	18
BranchName	string	The branch name.	Default version
Scene	string	The scenario.	Individual customer lead conversion
AgentDemandConfig	object	The agent business requirement configuration.
BasicTaskDescription	string	The basic task configuration.	Conduct product marketing and introduce advantages and features
CoreTarget	string	The core target.	Sales lead conversion
AiGenerate	boolean	Indicates whether AI-assisted building is enabled.	false
UserRole	string	The user role.	Potential customer
BusinessType	integer	The business scenario.	1
SysRole	string	The system role.	Sales
SummaryConfig	object	The call summary configuration.
MainPurpose	object	The main intent.
MainPurposeEnum	array<object>	The valid values for the main intent.
	object	The enumeration of valid values for the main intent.
Description	string	The description of the valid value.	Description of the tag value
Value	string	The valid value.	Tag value example
Id	string	The unique label ID.	tag_12345
MainPurposeName	string	The main intent name.	Customer inquiry handling
MainPurposeType	string	The value type of the main intent. TEXT: text type. ENUM: enumeration type.	ENUM
MainPurposeDescription	string	The description of the main intent.	Description of the main intent
Id	string	The main intent ID.	123
CallResultTagConfig	object	The call result tag mapping configuration.
MappingTag	object	The mapping between call results and tags.
	string	The mapping between call results and tags.	"CANCEL": "{\"tag\":\"test\",\"desc\":\"11\"}"
DefaultTag	object	The default fallback tag information.
Desc	string	The description.	Tag description
Tag	string	The tag.	Tag1
OutputTagConfig	array<object>	The output tag configuration.
	array<object>	The output tag configuration.
OutputTagDescription	string	The output tag description.	The user's willingness to purchase a product
OutputTagType	string	The output tag value type. Valid values: TEXT: text type. ENUM: enumeration type.	ENUM
OutputTagEnum	array<object>	The output tag options.
	object	The tag enumeration value. This field is available only when the tag value type is ENUM.
Description	string	The tag description.	The user has a high willingness to purchase
Value	string	The tag enumeration value.	High willingness
Id	string	The tag ID.	10
OutputTagName	string	The output tag name.	Purchase willingness
Id	string	The output tag ID.	123
PhoneTagConfig	array<object>	The call variable configuration.
	array<object>	The call variable configuration.
PhoneTagType	string	The call variable type. Valid values: TEXT: text type. ENUM: enumeration type.	ENUM
PhoneTagName	string	The call variable description.	User gender
PhoneTagRequired	boolean	Indicates whether the call variable is required.	false
Id	string	The call variable ID.	123
PhoneTagSource	string	The call variable source.	MANUAL_CREATE
PhoneTagKey	string	The call variable key name.	gender
PhoneTagEnum	array<object>	The call variable tag options.
	object	The call variable tag options.
Description	string	The description.	gender
Value	string	The tag value.	male
Id	string	The tag ID.	123
AgentDesc	string	The agent description.	For daily testing
AgentId	integer	The agent ID.	3021893791
AgentName	string	The agent name.	Test agent
KnowledgeConfig	object	The knowledge base configuration.
KnowledgeIds	array<object>	The knowledge base collection.
	object	The knowledge base collection.
KnowledgeName	string	The knowledge base name.	Product knowledge base
KnowledgeId	integer	The knowledge base ID.	68
RagConfig	object	The RAG configuration.
Description	string	The RAG retrieval description.	Knowledge base retrieval
Enabled	boolean	Indicates whether RAG retrieval is enabled.	false
VersionId	integer	The version ID.	89
VersionPublishTime	string	The time when the version was last published. Format: YYYY-MM-DD HH:mm:ss.	2024-01-15 10:30:00
VersionPublishStatus	integer	The version publish status. Valid values: 0: unpublished. 1: published. 2: draft.	1
VersionName	string	The version name.	Test version 1
VersionDesc	string	The version description.	Test first version
Code	string	The status code.	OK
Success	boolean	Indicates whether the call was successful. Valid values: true: Successful. false: Failed.	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.