QueryAiVoiceAgentDetail - 查询通信智能体详情信息

更新时间:
复制 MD 格式

查询通信智能体详情信息。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

aiccs:QueryAiVoiceAgentDetail

get

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

AgentId

string

智能体 ID。

123123********

返回参数

名称

类型

描述

示例值

object

AccessDeniedDetail

string

访问被拒绝的详细原因。

None

Message

string

状态码描述。

成功

RequestId

string

请求 ID。

742C9243-2870-B8D6-0C68-C60BEB2DF09A

Data

object

智能体详情数据

Status

integer

智能体状态。

枚举值:

  • 1 :

    已上线

  • 2 :

    已下线

  • 3 :

    审核中

  • 4 :

    审核失败

  • 5 :

    构建中

  • 6 :

    调试中

  • 7 :

    可上线

  • 8 :

    构建失败

7

BusinessTypeName

string

业务场景名称

个人线索转化

Description

string

智能体说明。

日常测试使用。

AiVoiceAgentModelConfig

object

智能体模型配置。

BasicTaskDescription

string

基础任务配置。

任务描述。

MainPurpose

object

主意图配置。

MainPurposeEnum

array<object>

主意图可取值列表。

object

Description

string

可取值说明。

意向强烈。

Value

string

可取值。

A

Id

string

可取值唯一 ID。

d5606d80-7625-dcea-xxxx-17f66fbb564a

MainPurposeName

string

主意图名称。

通话效果评级

MainPurposeType

string

主意图取值类型。目前只有 ENUM 类型。

ENUM

MainPurposeDescription

string

主意图说明。

通话效果评级:A、B、C、D,(A最好)

Id

string

主意图 ID。

1ee6e994-08e0-xxxx-f662-1659cc54d409

ChildTaskList

array<object>

子任务配置列表。

object

ChildTaskName

string

子任务名称。

开场与邀约

ChildTaskDescription

string

子任务描述。

新用户邀约: \"喂,家长您好!我是*****的王老师,我们现在有**课程100个试听名额,想帮宝贝安排一下体验,您看什么时候比较方便呢?\

Id

string

子任务唯一 ID。

280cd4bf-*******df472c

CustomExceptionFileName

string

自定义异常文件名称。

异常测试文件.xlsx

StartWordType

integer

1

BusinessType

integer

业务场景。

枚举值:

  • 1 :

    个人客户线索转化

  • 2 :

    企业客户线索转化

  • 3 :

    会员提醒-续费/复购场景

  • 4 :

    会员提醒-促销/赠券场景

  • 5 :

    简单客服-答疑类客服场景

  • 6 :

    其他

1

CustomExceptionUrlPath

string

废弃字段,后续会下掉。

-

KnowledgeId

string

知识库 ID。

1232131*******

KnowledgeDocOriginalNameList

array

知识库文档原始文件名列表。

string

文件名。

**会话引擎测试.xlsx

KnowledgeEnable

boolean

是否关联知识库。

false

CustomExceptionEnable

boolean

是否开启自定义异常处理。

false

Prologue

string

开场白。

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

CustomExceptionFileId

string

自定义异常文件 ID。

OSS文件ID

PhoneTagConfig

array<object>

通话变量配置。

array<object>

PhoneTagType

string

变量值类型。

枚举值:

  • ENUM :

    枚举类型

  • TEXT :

    文本类型

ENUM

PhoneTagName

string

变量中文名称。

意向车系

PhoneTagRequired

boolean

是否必填。

true

Id

string

变量唯一 ID。

280cd4bf-*******df472c

PhoneTagSource

string

示例值

PhoneTagDescription

string

变量描述。

用户感兴趣的车系。

PhoneTagEnum

array<object>

变量枚举值列表。只有变量值类型为 ENUM 时才有该字段。

object

Description

string

枚举值描述。

客户完全不接受挽留

Value

string

枚举值。

完全不接受

Id

string

枚举值唯一 ID。

c3d4ff4e-*********bc26dc044682

PhoneTagKey

string

变量键名。

testParam

FlowDesc

string

高级任务流程描述。

这次外呼通过三个核心步骤与家长沟通,........ 3. 用户需求 > 主动介绍

UserRole

string

用户角色。

急需课程的新用户

TaskType

string

任务类型。

枚举值:

  • BASIC :

    基础任务

  • ADVANCED :

    高级任务

ADVANCED

SysRole

string

系统角色。

课程销售

OutputTagConfig

array<object>

输出标签配置。

array<object>

OutputTagDescription

string

标签描述信息。

记录本次通话的最终状态

OutputTagType

string

标签值类型。

枚举值:

  • ENUM :

    枚举类型

  • TEXT :

    文本类型

ENUM

OutputTagEnum

array<object>

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

object

Description

string

标签枚举值描述。

高(非常积极,大概率转化)

Value

string

标签枚举值。

Id

string

标签枚举值唯一 ID。

8757************2c499fa

OutputTagName

string

标签名称。

客户意向度

Id

string

标签唯一 ID。

8757************2c499fa

CustomExceptionVoiceStyle

integer

语言风格。

枚举值:

  • 1 :

    平实

  • 2 :

    亲切

  • 3 :

    专业

  • 4 :

    严肃

2

RecordingFile

string

示例值

CustomExceptionList

array<object>

废弃字段,后续会下掉。

object

ExceptionType

string

异常类型

-

SupportBreak

boolean

是否支持打断。

false

Reply

string

回复内容。

-

ExceptionSign

boolean

是否作为异常标签输出。

true

KnowledgeDocNameList

array

知识文档名列表。

string

文件名。

117d2********388f2a615be5c0d3546e.xlsx

KnowledgeDocIdList

array

知识文档 ID 列表。

string

知识文档 ID。

12213******

KnowledgeName

string

知识库名称。

测试知识库

VoiceStyleName

string

语言风格名称。

亲切

AgentId

integer

智能体 ID。

12311212******

AgentName

string

智能体名称。

测试智能体

AiVoiceAgentCallConfig

object

智能外呼语音配置。

VocabId

string

热词 ID

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

TtsConfig

object

TTS 配置。

VoiceCode

string

示例值

MixingTemplate

integer

1

BackgroundEnabled

boolean

true

TtsVolume

integer

TTS 播放的音量。

说明
  • 取值范围:0~100,默认值为 0。

  • 不设置值时,默认取大模型应用配置的音量。

72

TtsStyle

string

音色风格。

longxiaoxia_v2p1

VoiceType

string

示例值

MixingEnabled

boolean

true

TtsSpeed

integer

TTS 播放时的声音速度。

说明
  • 取值范围:-200~200,默认值为 0;

  • 不设置值时,默认取大模型应用配置的声音速度;

34

BackgroundSound

integer

1

BackgroundVolume

integer

1

EventConfig

object

通话事件配置。

MuteActive

boolean

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

false

SessionTimeout

integer

最大通话时长,超时后自动挂断。单位:秒。

说明
  • 最大取值:3600s。

  • 最小取值:600s。

600

CallAssistantHangup

boolean

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

false

CallAssistantRecognize

boolean

智能接听识别是否开启。

true

MuteDuration

integer

静音时长。

说明
  • 最大取值:15s。

  • 最小取值:3s。

10

MuteHangupNum

integer

连续多少个静音事件主动挂机。

说明
  • 最大取值:5。

  • 最小取值:1。

1

Code

string

状态码。

OK

Success

boolean

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

  • true:成功。

  • false:失败。

false

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

更多信息,参考变更详情