DescribeScript - 返回一个话术的信息

返回一个话术的信息。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
outboundbot:DescribeScriptget
*Instance
acs:outboundbot:{#regionId}:{#accountId}:instance/{#InstanceId}

请求参数

名称类型必填描述示例值
InstanceIdstring

实例 ID

38d2e8ed-04e9-4dac-83b5-a8e57642ef13
ScriptIdstring

话术 ID

bee7e5b1-5d9a-4389-aa7e-bbbee5353a16

返回参数

名称类型描述示例值
object
HttpStatusCodeinteger

HTTP 状态码

200
RequestIdstring

请求 ID

254EB995-DEDF-48A4-9101-9CA5B72FFBCC
Successboolean

是否成功

true
Codestring

接口状态码

OK
Messagestring

接口提示消息

Success
Scriptobject

话术

Statusstring

话术状态

DRAFTED
UpdateTimelong

更新时间

1578881227000
ChatbotIdstring

对话机器人 ID

d31794e2a51f47d2901b4094d88311d7
ScriptIdstring

话术 ID

810b5872-57f0-4b27-80ab-7b3f4d8a6374
IsDebugDraftedboolean

调试版本是否为草稿态

true
Industrystring

行业

金融
ScriptDescriptionstring

话术描述

催收话术
MiniPlaybackEnableboolean

语气承接配置开关

true
IsDraftedboolean

是否是草稿状态

true
TtsConfigstring

话术的 TTS 配置

{ "appKey": "oQDVNlE6fZ5mg46X", "engine": "ali", "engineXunfei": "", "globalInterruptible": true, "nlsServiceType": "Managed", "pitchRate": "0", "speechRate": "0", "voice": "zhiyuan", "volume": "50" }
DebugStatusstring

调试话术的状态

DRAFTED
AsrConfigstring

ASR 配置

{ "appKey": "oQDVNlE6fZ5mg46X", "engine": "ali", "engineXunfei": "", "globalMaxEndSilence": 700, "globalMaxEndSilenceEnable": true, "maxEndSilence": "500", "nlsServiceType": "Managed", "silenceTimeout": "5000", "speechNoiseThreshold": "0" }
Scenestring

场景

催收
ScriptNamestring

话术名字

催收话术
NewBargeInEnableboolean

优雅打断配置开关

true
LongWaitEnableboolean

智能断句配置开关

true
EmotionEnableboolean

情绪识别配置开关

true
AgentIdlong

机器人业务空间访问 Key

1218333
AgentKeystring

机器人业务空间访问 Key

14791f5f226b4878b3d9b676a0291234
AgentLlmboolean

机器人业务空间是否大模型业务空间

true
ChatConfigstring

通话配置

{"silenceConfig":{"silenceReplyTimeout":499,"silenceTimeoutMaxCount":10,"silenceTimeoutMaxCountEnable":true},"hangupConfig":{"aiHangupEnable":false,"delayHangup":0,"hangupMaxRounds":20,"hangupMaxRoundsBroadcast":"感谢您的接听,祝您生活愉快,再见!","hangupMaxRoundsEnable":false},"securityInterceptConfig":{"broadcast":"您说的这个问题我不能回答您,您可以尝试询问其他问题。"},"specialInterceptConfig":{"specialInterceptEnable":false,"specialIntercepts":[{"code":"voiceAssistant"},{"code":"extensionNumberTransfer"}]},"transitionConfig":{"transitionSwitch":false}}
NluEnginestring

Nlu 引擎(仅大模型场景适用)

  • Prompts - 文本填写模式,
  • SSE_FUNCTION -函数计算服务模式
Prompts
NluProfileobject

函数计算服务模式配置

FcFunctionstring

函数服务名称

sanfang_test
FcRegionstring

函数服务地域

cn-shanghai
FcHttpTriggerUrlstring

函数服务触发器

http://sanfang_test-xxxxxx.cn-shanghai-vpc.fcapp.run
NlsConfigstring

已作废

none

示例

正常返回示例

JSON格式

{
  "HttpStatusCode": 200,
  "RequestId": "254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
  "Success": true,
  "Code": "OK",
  "Message": "Success",
  "Script": {
    "Status": "DRAFTED",
    "UpdateTime": 1578881227000,
    "ChatbotId": "d31794e2a51f47d2901b4094d88311d7",
    "ScriptId": "810b5872-57f0-4b27-80ab-7b3f4d8a6374",
    "IsDebugDrafted": true,
    "Industry": "金融",
    "ScriptDescription": "催收话术",
    "MiniPlaybackEnable": true,
    "IsDrafted": true,
    "TtsConfig": {
      "appKey": "oQDVNlE6fZ5mg46X",
      "engine": "ali",
      "engineXunfei": "",
      "globalInterruptible": true,
      "nlsServiceType": "Managed",
      "pitchRate": 0,
      "speechRate": 0,
      "voice": "zhiyuan",
      "volume": 50
    },
    "DebugStatus": "DRAFTED",
    "AsrConfig": {
      "appKey": "oQDVNlE6fZ5mg46X",
      "engine": "ali",
      "engineXunfei": "",
      "globalMaxEndSilence": 700,
      "globalMaxEndSilenceEnable": true,
      "maxEndSilence": 500,
      "nlsServiceType": "Managed",
      "silenceTimeout": 5000,
      "speechNoiseThreshold": 0
    },
    "Scene": "催收",
    "ScriptName": "催收话术",
    "NewBargeInEnable": true,
    "LongWaitEnable": true,
    "EmotionEnable": true,
    "AgentId": 1218333,
    "AgentKey": "14791f5f226b4878b3d9b676a0291234",
    "AgentLlm": true,
    "ChatConfig": {
      "silenceConfig": {
        "silenceReplyTimeout": 499,
        "silenceTimeoutMaxCount": 10,
        "silenceTimeoutMaxCountEnable": true
      },
      "hangupConfig": {
        "aiHangupEnable": false,
        "delayHangup": 0,
        "hangupMaxRounds": 20,
        "hangupMaxRoundsBroadcast": "感谢您的接听,祝您生活愉快,再见!",
        "hangupMaxRoundsEnable": false
      },
      "securityInterceptConfig": {
        "broadcast": "您说的这个问题我不能回答您,您可以尝试询问其他问题。"
      },
      "specialInterceptConfig": {
        "specialInterceptEnable": false,
        "specialIntercepts": [
          {
            "code": "voiceAssistant"
          },
          {
            "code": "extensionNumberTransfer"
          }
        ]
      },
      "transitionConfig": {
        "transitionSwitch": false
      }
    },
    "NluEngine": "Prompts",
    "NluProfile": {
      "FcFunction": "sanfang_test",
      "FcRegion": "cn-shanghai",
      "FcHttpTriggerUrl": "http://sanfang_test-xxxxxx.cn-shanghai-vpc.fcapp.run",
      "SupportBeebotPrompts": true
    },
    "LabelConfig": ""
  },
  "NlsConfig": "none"
}

错误码

HTTP status code错误码错误信息描述
404NotExist.InstanceThe specified Instance does not exist.指定的实例不存在。
404NotExist.ScriptThe specified Script does not exist.指定的话术不存在。
500InternalErrorAn error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.内部错误。建议重试,如果多次重试报错请提交工单。

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

变更历史

变更时间变更内容概要操作
2024-08-06OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
2024-04-25OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
2022-06-21OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情