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

Queries the details of a communication agent.

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:QueryAiVoiceAgentDetail

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
AgentId	string	No	The agent ID.	123123********

Response elements

Element	Type	Description	Example
	object
AccessDeniedDetail	string	The detailed reason why access was denied.	None
Message	string	The status code description.	Success
RequestId	string	The request ID.	742C9243-2870-B8D6-0C68-C60BEB2DF09A
Data	object	The agent details.
Status	integer	The agent status. Valid values: 1 : Published. 2 : Unpublished. 3 : Under review. 4 : Review failed. 5 : Building. 6 : Debugging. 7 : Ready to publish. 8 : Build failed.	7
BusinessTypeName	string	The business scenario name.	Personal lead conversion
Description	string	The agent description.	Used for daily testing
AiVoiceAgentModelConfig	object	The agent model configuration.
BasicTaskDescription	string	The basic task configuration.	Task description
MainPurpose	object	The main intent configuration.
MainPurposeEnum	array<object>	The list of valid values for the main intent.
	object	The enumeration of valid values for the main intent.
Description	string	The description of the valid value.	Strong intent
Value	string	The valid value.	A
Id	string	The unique ID of the valid value.	d5606d80-7625-dcea-xxxx-17f66fbb564a
MainPurposeName	string	The main intent name.	Call effectiveness rating
MainPurposeType	string	The value type of the main intent. Currently, only the ENUM type is supported.	ENUM
MainPurposeDescription	string	The description of the main intent.	Call effectiveness rating: A, B, C, D (A is the best)
Id	string	The main intent ID.	1ee6e994-08e0-xxxx-f662-1659cc54d409
ChildTaskList	array<object>	The list of subtask configurations.
	object	The subtask configuration.
ChildTaskName	string	The subtask name.	Opening and invitation
ChildTaskDescription	string	The subtask description.	新用户邀约: \"喂，家长您好！我是***的王老师，我们现在有课程100个试听名额，想帮宝贝安排一下体验，您看什么时候比较方便呢？\
Id	string	The unique ID of the subtask.	280cd4bf-*******df472c
CustomExceptionFileName	string	The name of the custom exception file.	异常测试文件.xlsx
StartWordType	integer	The opening statement type. Valid values: 0: text. 1: recording.	1
BusinessType	integer	The business scenario. Valid values: 1 : Personal customer lead conversion. 2 : Enterprise customer lead conversion. 3 : Member reminder - renewal/repurchase scenario. 4 : Member reminder - promotion/coupon scenario. 5 : Simple customer service - FAQ scenario. 6 : Other.	1
CustomExceptionUrlPath	string	[Deprecated] This field is deprecated and will be removed in the future.	-
KnowledgeId	string	The knowledge base ID.	1232131*******
KnowledgeDocOriginalNameList	array	The list of original file names of knowledge base documents.
	string	The file name.	**会话引擎测试.xlsx
KnowledgeEnable	boolean	Indicates whether a knowledge base is associated.	false
CustomExceptionEnable	boolean	Indicates whether custom exception handling is enabled.	false
Prologue	string	The opening statement.	Hello, this is ******
CustomExceptionFileId	string	The custom exception file ID.	OSS文件ID
PhoneTagConfig	array<object>	The call variable configuration.
	array<object>	The call variable configuration.
PhoneTagType	string	The variable value type. Valid values: ENUM : Enumeration type. TEXT : Text type.	ENUM
PhoneTagName	string	The Chinese name of the variable.	意向车系
PhoneTagRequired	boolean	Indicates whether the variable is required.	true
Id	string	The unique ID of the variable.	280cd4bf-*******df472c
PhoneTagSource	string	The source of the call variable.	Sample value
PhoneTagDescription	string	The variable description.	The car series the user is interested in
PhoneTagEnum	array<object>	The list of enumeration values for the variable. This field is present only when the variable value type is ENUM.
	object	The selectable value of the call variable tag.
Description	string	The description of the enumeration value.	The customer completely rejects retention
Value	string	The enumeration value.	Completely unacceptable
Id	string	The unique ID of the enum value.	c3d4ff4e-*********bc26dc044682
PhoneTagKey	string	The variable key name.	testParam
FlowDesc	string	The description of the advanced task flow.	This outbound call communicates with parents through three core steps, ........ 3. User needs > Proactive introduction
UserRole	string	The user role.	New user in urgent need of courses
TaskType	string	The task type. Valid values: BASIC : basic task. ADVANCED : advanced task.	ADVANCED
SysRole	string	The system role.	Course sales
OutputTagConfig	array<object>	The output tag configurations.
	array<object>	The output tag configurations.
OutputTagDescription	string	The tag description.	Records the final status of this call
OutputTagType	string	The tag value type. Valid values: ENUM : Enumeration type. TEXT : Text type.	ENUM
OutputTagEnum	array<object>	The tag enum values. This field is available only when the tag value type is ENUM.
	object	The tag enum values. This field is available only when the tag value type is ENUM.
Description	string	The description of the tag enum value.	High (very positive, high probability of conversion)
Value	string	The tag enum value.	High
Id	string	The unique ID of the tag enum value.	8757************2c499fa
OutputTagName	string	The tag name.	Customer intent level
Id	string	The unique ID of the tag.	8757************2c499fa
CustomExceptionVoiceStyle	integer	The language style. Valid values: 1 : plain. 2 : friendly. 3 : professional. 4 : formal.	2
RecordingFile	string	The URL of the opening greeting recording audio file. This field has a value only when StartWordType is set to 1.	Sample value
CustomExceptionList	array<object>	[Deprecated] This field is deprecated and will be removed in the future.
	object	The custom exception configuration.
ExceptionType	string	The exception type.	-
SupportBreak	boolean	Specifies whether interruption is supported.	false
Reply	string	The reply content.	-
ExceptionSign	boolean	Specifies whether to output as an exception tag.	true
KnowledgeDocNameList	array	The list of knowledge document names.
	string	The file name.	117d2********388f2a615be5c0d3546e.xlsx
KnowledgeDocIdList	array	The list of knowledge document IDs.
	string	The knowledge document ID.	12213******
KnowledgeName	string	The knowledge base name.	Test knowledge base
VoiceStyleName	string	The language style name.	Friendly
AgentId	integer	The agent ID.	12311212******
AgentName	string	The agent name.	Test agent
AiVoiceAgentCallConfig	object	The intelligent outbound call voice configuration.
VocabId	string	The hot word ID.	afb2c43**********83e6df30551c11f7
TtsConfig	object	The TTS configuration.
VoiceCode	string	The voice code.	Sample value
MixingTemplate	integer	The mixing template ID.	1
BackgroundEnabled	boolean	Indicates whether background sound is enabled.	true
TtsVolume	integer	The TTS playback volume. Note Valid values: 0 to 100. Default value: 0. If no value is specified, the volume configured in the large model application is used by default.	72
TtsStyle	string	The voice style.	longxiaoxia_v2p1
VoiceType	string	The voice type. Valid values: SYSTEM: system voice. COSYCLONE: cloned voice. BL-CUSTOM: custom premium cloned voice.	Sample value
MixingEnabled	boolean	Indicates whether audio mixing is enabled.	true
TtsSpeed	integer	The voice speed during TTS playback. Note Valid values: -200 to 200. Default value: 0. If no value is specified, the voice speed configured in the large model application is used by default.	34
BackgroundSound	integer	The background sound ID.	1
BackgroundVolume	integer	The background sound volume. Valid values: 0: low. 1: medium. 2: high.	1
EventConfig	object	The call event configuration.
MuteActive	boolean	Specifies whether the first silence triggers the model.	false
SessionTimeout	integer	The maximum call duration. The call is automatically hung up after the timeout. Unit: seconds. Note Maximum value: 3600. Minimum value: 600.	600
CallAssistantHangup	boolean	Specifies whether to hang up when an intelligent answering service is detected.	false
CallAssistantRecognize	boolean	Specifies whether intelligent answering service detection is enabled.	true
MuteDuration	integer	The silence duration. Note Maximum value: 15s. Minimum value: 3s.	10
MuteHangupNum	integer	The number of consecutive silence events before the system proactively hangs up. Note Maximum value: 5. Minimum value: 1.	1
Code	string	The status code.	OK
Success	boolean	Indicates whether the API call is successful. Valid values: true: Successful. false: Failed.	false

Examples

Success response

JSON format

{
  "AccessDeniedDetail": "None",
  "Message": "成功",
  "RequestId": "742C9243-2870-B8D6-0C68-C60BEB2DF09A",
  "Data": {
    "Status": 7,
    "BusinessTypeName": "个人线索转化",
    "Description": "日常测试使用。",
    "AiVoiceAgentModelConfig": {
      "BasicTaskDescription": "任务描述。",
      "MainPurpose": {
        "MainPurposeEnum": [
          {
            "Description": "意向强烈。",
            "Value": "A",
            "Id": "d5606d80-7625-dcea-xxxx-17f66fbb564a"
          }
        ],
        "MainPurposeName": "通话效果评级",
        "MainPurposeType": "ENUM",
        "MainPurposeDescription": "通话效果评级：A、B、C、D，（A最好）",
        "Id": "1ee6e994-08e0-xxxx-f662-1659cc54d409"
      },
      "ChildTaskList": [
        {
          "ChildTaskName": "开场与邀约",
          "ChildTaskDescription": "新用户邀约: \\\"喂，家长您好！我是*****的王老师，我们现在有**课程100个试听名额，想帮宝贝安排一下体验，您看什么时候比较方便呢？\\",
          "Id": "280cd4bf-*******df472c"
        }
      ],
      "CustomExceptionFileName": "异常测试文件.xlsx",
      "StartWordType": 1,
      "BusinessType": 1,
      "CustomExceptionUrlPath": "-",
      "KnowledgeId": "1232131*******",
      "KnowledgeDocOriginalNameList": [
        "**会话引擎测试.xlsx"
      ],
      "KnowledgeEnable": false,
      "CustomExceptionEnable": false,
      "Prologue": "你好，这里是******。",
      "CustomExceptionFileId": "OSS文件ID",
      "PhoneTagConfig": [
        {
          "PhoneTagType": "ENUM",
          "PhoneTagName": "意向车系",
          "PhoneTagRequired": true,
          "Id": "280cd4bf-*******df472c\n",
          "PhoneTagSource": "示例值",
          "PhoneTagDescription": "用户感兴趣的车系。",
          "PhoneTagEnum": [
            {
              "Description": "客户完全不接受挽留",
              "Value": "完全不接受",
              "Id": "c3d4ff4e-*********bc26dc044682"
            }
          ],
          "PhoneTagKey": "testParam"
        }
      ],
      "FlowDesc": "这次外呼通过三个核心步骤与家长沟通，........ 3. 用户需求 > 主动介绍",
      "UserRole": "急需课程的新用户",
      "TaskType": "ADVANCED",
      "SysRole": "课程销售",
      "OutputTagConfig": [
        {
          "OutputTagDescription": "记录本次通话的最终状态",
          "OutputTagType": "ENUM",
          "OutputTagEnum": [
            {
              "Description": "高（非常积极，大概率转化）",
              "Value": "高",
              "Id": "8757************2c499fa"
            }
          ],
          "OutputTagName": "客户意向度",
          "Id": "8757************2c499fa\n"
        }
      ],
      "CustomExceptionVoiceStyle": 2,
      "RecordingFile": "示例值",
      "CustomExceptionList": [
        {
          "ExceptionType": "-",
          "SupportBreak": false,
          "Reply": "-",
          "ExceptionSign": true
        }
      ],
      "KnowledgeDocNameList": [
        "117d2********388f2a615be5c0d3546e.xlsx"
      ],
      "KnowledgeDocIdList": [
        "12213******"
      ]
    },
    "KnowledgeName": "测试知识库",
    "VoiceStyleName": "亲切",
    "AgentId": 0,
    "AgentName": "测试智能体",
    "AiVoiceAgentCallConfig": {
      "VocabId": "afb2c43**********83e6df30551c11f7",
      "TtsConfig": {
        "VoiceCode": "示例值",
        "MixingTemplate": 1,
        "BackgroundEnabled": true,
        "TtsVolume": 72,
        "TtsStyle": "longxiaoxia_v2p1",
        "VoiceType": "示例值",
        "MixingEnabled": true,
        "TtsSpeed": 34,
        "BackgroundSound": 1,
        "BackgroundVolume": 1
      },
      "EventConfig": {
        "MuteActive": false,
        "SessionTimeout": 600,
        "CallAssistantHangup": false,
        "CallAssistantRecognize": true,
        "MuteDuration": 10,
        "MuteHangupNum": 1
      }
    }
  },
  "Code": "OK",
  "Success": false
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.