GetScript - 获取场景脚本配置

更新时间:
复制为 MD 格式

用于获取指定场景的草稿版本和已发布版本的详细配置信息。

接口说明

请求说明

  • 该 API 主要用于查询特定场景下的脚本配置详情,包括 ASR、TTS 和对话能力等多方面的设置。
  • 请求时无需提供额外参数,响应将包含草稿版与正式发布的配置数据。
  • 注意检查返回的 Data 字段以获取详细的配置信息。

调试

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

授权信息

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

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

请求参数

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

实例 ID

8a503680-815d-473e-a9b0-e010f47a64d2
ScriptIdstring

场景 ID

ac6db76a-bbe7-4a2c-b7cc-7f62da7bb4c6

返回参数

名称类型描述示例值
object

Schema of Response

Codestring

内部错误码

OK
HttpStatusCodeinteger

http 状态码

200
Messagestring

错误信息

Instance af81a389-91f0-4157-8d82-720edd02b66a does not exist.
RequestIdstring

请求 ID

51E08AA9-8D1F-55F8-84A3-40635E2F0806
Dataobject

场景对象信息

ScriptIdstring

场景 ID

64241e64-190c-45d1-af66-06f51c07b090
Namestring

场景名称

测试场景
Descriptionstring

描述

test script
Concurrencyinteger

并发数

10
CreatedTimelong

创建时间

1773228988000
UpdatedTimelong

更新时间

1773228988000
NluEnginestring

Nlu 引擎

枚举值:
  • PROMPTSPROMPTS
  • BEEBOTBEEBOT
  • FUNCTIONFUNCTION
BEEBOT
Statusstring

状态

枚举值:
  • PUBLISHEDPUBLISHED
  • DRAFTDRAFT
  • PUBLISHED_DRAFTPUBLISHED_DRAFT
DRAFT
DraftVersionobject

草稿版本信息

VersionIdstring

版本 ID

0c4f978a-73bb-4841-bd84-75c0398edd4e
TranscriberConfigobject

ASR 配置

NlsEnginestring

ASR 引擎

枚举值:
  • IFLYTEKIFLYTEK
  • VOLCVOLC
  • BAILIANBAILIAN
BAILIAN
NlsAccessTypestring

ASR 调用方式

枚举值:
  • PROVIDEDPROVIDED
  • MANAGEDMANAGED
MANAGED
NlsAccessProfileobject

访问账号配置

AccessProfileIdstring

三方语音配置 ID

0c4f978a-73bb-4841-bd84-75c0398edd4f
VocabularyIdstring

热词 ID

0c4f978a-73bb-4841-bd84-75c0398edd5f
EndSilenceTimeoutinteger

VAD 断句

500
CustomizationIdstring

自学习语言模型 ID(暂不支持)

0c4f978a-73bb-4841-bd84-75c0398edd6f
SpeechNoiseThresholdstring

噪音阈值

0
Modelstring

ASR 模型

枚举值:
  • ParaformerParaformer
  • QwenQwen
  • FunFun
Paraformer
SynthesizerConfigobject

TTS 配置

NlsEnginestring

TTS 引擎

枚举值:
  • IFLYTEKIFLYTEK
  • VOLCVOLC
  • BAILIANBAILIAN
BAILIAN
NlsAccessTypestring

TTS 调用方式

枚举值:
  • PROVIDEDPROVIDED
  • MANAGEDMANAGED
MANAGED
Modelstring

TTS 模型

CosyVoice
Voicestring

发音人

longanyang
SpeechRateinteger

语速

0
Volumeinteger

音量

50
PitchRateinteger

语调

0
NlsAccessProfileobject

访问账号配置

AccessProfileIdstring

三方语音配置

0c4f978a-73bb-4841-bd84-75c0398edd4f
PronRulesarray<object>

TTS 纠错词典列表

pronRuleobject

TTS 纠错词典对象

Patternstring

易错词

还钱
Replacementstring

替换词

环钱
ScriptProfileobject

对话能力配置

ChatbotIdstring

对话机器人 ID

chatbot-cn-MQuyjjb666
AgentKeystring

对话机器人 AgentKey

1309723684579735_p_beebot_public
FunctionMetaobject

函数计算配置

RegionIdstring

函数服务所在地域

cn-hangzhou
FunctionIdstring

函数服务 ID

9b752bbb-805a-4d3e-9013-eab5555c3fef
FunctionNamestring

函数服务名称

my_funciton
HttpTriggerUrlstring

函数触发器 URL

http://chat-xxxxx-v-yewiundukb.cn-hangzhou-xxx.run
HttpTriggerNamestring

函数触发器名称

defaultTrigger
Modelstring

对话模型

qwen-plus
AgentProfileobject

对话 Agent 配置

ScriptProfileTemplateIdstring

场景模版 ID

CCC_PROMPTS_DEFAULT
PromptsJsonstring

提示词 json

{\"prompts\":\"我是一个聊天机器人。\"}
NluAccessProfileobject

关联配置

AccessProfileIdstring

三方对话模型配置 ID

c2c9baae-9351-4c49-a8cb-6f24a83a8718
OmniModelboolean

是否为 Omni 模型

true
NluAccessTypestring

对话模型调用方式

MANAGED
NluEnginestring

Nlu 引擎

BEEBOT
InteractionConfigobject

交互配置

SilenceDetectionConfigobject

静默检测配置

Timeoutinteger

静默超时时间,单位毫秒。用户静默超过设定值时,播报静默超时话术。范围 2000~10000。

5000
MaxRepeatsinteger

连续静默轮次挂机 当前场景 NluEngine=PROMPTS 时生效

3
EndConversationConfigobject

挂机配置

Delayinteger

挂机话术播报完成 x 秒后,执行挂机动作。 范围 0~5

1
Triggersarray<object>

特殊情况拦截列表

triggerobject

特殊情况拦截对象

TriggerTypestring

TurnLimit:最多交互轮次判断; IntelligentVoiceAssistant:语音助手; InteractiveVoiceResponse:分机号转接; KeyWords:自定义拦截

TurnLimit
TurnLimitinteger

当交互轮次超过 x 轮时,执行挂机。 范围 0~100。 等于 0 表示不开启超出轮次挂机。

20
ClosingStatementstring

达到轮次上限,执行挂机时的播报话术。

感谢您的接听,祝您生活愉快,再见!
KeyWordsarray

自定义拦截关键词列表

keyWordstring

自定义拦截关键词

机器人助理
InitialGreetingDelayMillisecondsinteger

接通后,延迟放音时间 单位毫秒

2000
BackgroundMusicIdstring

背景音 ID

office-ambience
LabelConfigarray<object>

标签对象列表

labelConfigobject

标签对象

Namestring

标签名称

是否同意还款
Descriptionstring

标签描述

用户是否同意于还款截止日期前还款
CandidateValuesarray

标签可选值列表

candidateValuestring

标签可选值

同意
PublishedVersionobject

发布版本信息

VersionIdstring

版本 ID

8b77ff09-6a90-4784-8560-fdc2b860dc68
TranscriberConfigobject

ASR 配置

NlsEnginestring

ASR 引擎

BAILIAN
NlsAccessTypestring

ASR 调用方式

MANAGED
NlsAccessProfileobject

关联配置

AccessProfileIdstring

三方语音配置 ID(使用豆包、科大等三方 ASR 服务时需配置)

c2c9baae-9351-4c49-a8cb-6f24a83a8718
VocabularyIdstring

热词表 ID(热词管理页面获取)

cd97223f-42f2-4cd9-95af-e734e2fe1fe3
EndSilenceTimeoutinteger

静音检测(说话间隔超过 x 毫秒时触发断句,即 VAD)

700
CustomizationIdstring

ASR 的定制语言模型 ID

cd97223f-42f2-4cd9-95af-e734e2fe1fe4
SpeechNoiseThresholdstring

噪音参数阈值,参数范围:[-100,100]。取值说明如下:

取值越趋于-100,噪音被判定为语音的概率越大。

取值越趋于+100,语音被判定为噪音的概率越大。

0
Modelstring

ASR 模型

Paraformer
SynthesizerConfigobject

TTS 配置

NlsEnginestring

TTS 引擎

BAILIAN
NlsAccessTypestring

TTS 调用方式

MANAGED
Modelstring

TTS 模型

CosyVoice
Voicestring

发音人

longanyang
SpeechRateinteger

语速 取值范围-500~500 默认值 0

0
Volumeinteger

音量 取值范围 0~100 默认值 50

50
PitchRateinteger

语调 取值范围 -500~500 默认值 0

0
NlsAccessProfileobject

关联配置

AccessProfileIdstring

三方语音配置 ID(使用豆包、科大等三方 ASR 服务时需配置)

c2c9baae-9351-4c49-a8cb-6f24a83a8718
PronRulesarray<object>

TTS 纠错列表

pronRuleobject

TTS 纠错对象

Patternstring

易错词

还钱
Replacementstring

同音词

环钱
ScriptProfileobject

对话能力配置

ChatbotIdstring

对话机器人 ID 当前场景 NluEngine=BEEBOT 时必填

chatbot-cn-MQuyjjb666
AgentKeystring

对话机器人 AgentKey 当前场景 NluEngine=BEEBOT 时必填

1309723684579735_p_beebot_public
FunctionMetaobject

函数计算配置

RegionIdstring

函数服务所在地域 当前场景 NluEngine=FUNCTION 时必填

cn-hangzhou
FunctionIdstring

函数服务 ID 当前场景 NluEngine=FUNCTION 时必填

9b752bbb-805a-4d3e-9013-eab5555c3fef
FunctionNamestring

函数服务名称 当前场景 NluEngine=FUNCTION 时必填

my_function
HttpTriggerUrlstring

函数触发器 URL 当前场景 NluEngine=FUNCTION 时必填

http://chat-xxxxx-v-yewiundukb.cn-hangzhou-xxx.run
HttpTriggerNamestring

函数触发器名称 当前场景 NluEngine=FUNCTION 时必填

defaultTrigger
Modelstring

对话模型 当前场景 NluEngine=PROMPTS 时必填

qwen-plus
AgentProfileobject

对话 Agent 配置

ScriptProfileTemplateIdstring

场景模版 ID

CCC_PROMPTS_DEFAULT
PromptsJsonstring

提示词 json

{\"prompts\":\"我是一个聊天机器人。\"}
Namestring

对话 Agent 名称

test agent
Descriptionstring

对话 Agent 描述

用于测试
NluAccessProfileobject

关联配置

AccessProfileIdstring

三方对话模型配置 ID

c2c9baae-9351-4c49-a8cb-6f24a83a8718
OmniModelboolean

是否为 Omni 模型

true
NluAccessTypestring

对话模型调用方式

MANAGED
NluEnginestring

Nlu 引擎

BEEBOT
InteractionConfigobject

交互配置

SilenceDetectionConfigobject

静默检测配置

Timeoutinteger

静默超时时间,单位毫秒。
用户静默超过设定值时,播报静默超时话术。
范围 2000~10000。

5000
MaxRepeatsinteger

连续静默轮次挂机
当前场景 NluEngine=PROMPTS 时生效

3
EndConversationConfigobject

挂机配置

Delayinteger

挂机话术播报完成 x 秒后,执行挂机动作。 范围 0~5

1
Triggersarray<object>

特殊情况拦截

triggerobject
TriggerTypestring
  • TurnLimit:最多交互轮次判断;
  • IntelligentVoiceAssistant:语音助手;
  • InteractiveVoiceResponse:分机号转接;
  • KeyWords:自定义拦截
TurnLimit
TurnLimitinteger
  • 当交互轮次超过 x 轮时,执行挂机。
  • 范围 0~100。
  • 等于 0 表示不开启超出轮次挂机。
20
ClosingStatementstring
  • 达到轮次上限,执行挂机时的播报话术。
感谢您的接听,祝您生活愉快,再见!
KeyWordsarray
  • 自定义拦截关键词列表
keyWordstring

自定义拦截关键词

机器人助理
InitialGreetingDelayMillisecondsinteger
  • 接通后,延迟放音时间
  • 单位毫秒
2000
BackgroundMusicIdstring

背景音 ID

office-ambience
LabelConfigarray<object>

自定义标签配置

labelConfigobject
Namestring

标签名称

是否同意还款
Descriptionstring

标签描述

用户是否同意于还款截止日期前还款
CandidateValuesarray

标签可选值列表

candidateValuestring

标签可选值

同意
Paramsarray

动态错误参数列表

paramstring

动态错误参数

af81a389-91f0-4157-8d82-720edd02b66a

示例

正常返回示例

JSON格式

{
  "Code": "OK",
  "HttpStatusCode": 200,
  "Message": "Instance af81a389-91f0-4157-8d82-720edd02b66a\n does not exist.",
  "RequestId": "51E08AA9-8D1F-55F8-84A3-40635E2F0806",
  "Data": {
    "ScriptId": "64241e64-190c-45d1-af66-06f51c07b090",
    "Name": "测试场景",
    "Description": "test script",
    "Concurrency": 10,
    "CreatedTime": 1773228988000,
    "UpdatedTime": 1773228988000,
    "NluEngine": "BEEBOT",
    "Status": "DRAFT",
    "DraftVersion": {
      "VersionId": "0c4f978a-73bb-4841-bd84-75c0398edd4e",
      "TranscriberConfig": {
        "NlsEngine": "BAILIAN",
        "NlsAccessType": "MANAGED",
        "NlsAccessProfile": {
          "AccessProfileId": "0c4f978a-73bb-4841-bd84-75c0398edd4f"
        },
        "VocabularyId": "0c4f978a-73bb-4841-bd84-75c0398edd5f",
        "EndSilenceTimeout": 500,
        "CustomizationId": "0c4f978a-73bb-4841-bd84-75c0398edd6f",
        "SpeechNoiseThreshold": 0,
        "Model": "Paraformer",
        "CorrectionRules": [
          {
            "Pattern": "",
            "Replacement": ""
          }
        ]
      },
      "SynthesizerConfig": {
        "NlsEngine": "BAILIAN",
        "NlsAccessType": "MANAGED",
        "Model": "CosyVoice",
        "Voice": "longanyang",
        "SpeechRate": 0,
        "Volume": 50,
        "PitchRate": 0,
        "NlsAccessProfile": {
          "AccessProfileId": "0c4f978a-73bb-4841-bd84-75c0398edd4f"
        },
        "PronRules": [
          {
            "Pattern": "还钱",
            "Replacement": "环钱"
          }
        ]
      },
      "ScriptProfile": {
        "ChatbotId": "chatbot-cn-MQuyjjb666",
        "AgentKey": "1309723684579735_p_beebot_public",
        "FunctionMeta": {
          "RegionId": "cn-hangzhou",
          "FunctionId": "9b752bbb-805a-4d3e-9013-eab5555c3fef",
          "FunctionName": "my_funciton",
          "HttpTriggerUrl": "http://chat-xxxxx-v-yewiundukb.cn-hangzhou-xxx.run",
          "HttpTriggerName": "defaultTrigger"
        },
        "Model": "qwen-plus",
        "AgentProfile": {
          "ScriptProfileTemplateId": "CCC_PROMPTS_DEFAULT",
          "PromptsJson": "{\\\"prompts\\\":\\\"我是一个聊天机器人。\\\"}"
        },
        "NluAccessProfile": {
          "AccessProfileId": "c2c9baae-9351-4c49-a8cb-6f24a83a8718"
        },
        "OmniModel": true,
        "NluAccessType": "MANAGED",
        "NluEngine": "BEEBOT"
      },
      "InteractionConfig": {
        "SilenceDetectionConfig": {
          "Timeout": 5000,
          "MaxRepeats": 3
        },
        "EndConversationConfig": {
          "Delay": 1,
          "Triggers": [
            {
              "TriggerType": "TurnLimit",
              "TurnLimit": 20,
              "ClosingStatement": "感谢您的接听,祝您生活愉快,再见!",
              "KeyWords": [
                "机器人助理"
              ]
            }
          ]
        },
        "InitialGreetingDelayMilliseconds": 2000,
        "BackgroundMusicId": "office-ambience"
      },
      "LabelConfig": [
        {
          "Name": "是否同意还款",
          "Description": "用户是否同意于还款截止日期前还款",
          "CandidateValues": [
            "同意"
          ]
        }
      ]
    },
    "PublishedVersion": {
      "VersionId": "8b77ff09-6a90-4784-8560-fdc2b860dc68",
      "TranscriberConfig": {
        "NlsEngine": "BAILIAN",
        "NlsAccessType": "MANAGED",
        "NlsAccessProfile": {
          "AccessProfileId": "c2c9baae-9351-4c49-a8cb-6f24a83a8718"
        },
        "VocabularyId": "cd97223f-42f2-4cd9-95af-e734e2fe1fe3",
        "EndSilenceTimeout": 700,
        "CustomizationId": "cd97223f-42f2-4cd9-95af-e734e2fe1fe4",
        "SpeechNoiseThreshold": 0,
        "Model": "Paraformer",
        "CorrectionRules": [
          {
            "Pattern": "",
            "Replacement": ""
          }
        ]
      },
      "SynthesizerConfig": {
        "NlsEngine": "BAILIAN",
        "NlsAccessType": "MANAGED",
        "Model": "CosyVoice",
        "Voice": "longanyang",
        "SpeechRate": 0,
        "Volume": 50,
        "PitchRate": 0,
        "NlsAccessProfile": {
          "AccessProfileId": "c2c9baae-9351-4c49-a8cb-6f24a83a8718"
        },
        "PronRules": [
          {
            "Pattern": "还钱",
            "Replacement": "环钱"
          }
        ]
      },
      "ScriptProfile": {
        "ChatbotId": "chatbot-cn-MQuyjjb666",
        "AgentKey": "1309723684579735_p_beebot_public",
        "FunctionMeta": {
          "RegionId": "cn-hangzhou",
          "FunctionId": "9b752bbb-805a-4d3e-9013-eab5555c3fef",
          "FunctionName": "my_function",
          "HttpTriggerUrl": "http://chat-xxxxx-v-yewiundukb.cn-hangzhou-xxx.run",
          "HttpTriggerName": "defaultTrigger"
        },
        "Model": "qwen-plus",
        "AgentProfile": {
          "ScriptProfileTemplateId": "CCC_PROMPTS_DEFAULT",
          "PromptsJson": "{\\\"prompts\\\":\\\"我是一个聊天机器人。\\\"}",
          "Name": "test agent",
          "Description": "用于测试"
        },
        "NluAccessProfile": {
          "AccessProfileId": "c2c9baae-9351-4c49-a8cb-6f24a83a8718"
        },
        "OmniModel": true,
        "NluAccessType": "MANAGED",
        "NluEngine": "BEEBOT"
      },
      "InteractionConfig": {
        "SilenceDetectionConfig": {
          "Timeout": 5000,
          "MaxRepeats": 3
        },
        "EndConversationConfig": {
          "Delay": 1,
          "Triggers": [
            {
              "TriggerType": "TurnLimit",
              "TurnLimit": 20,
              "ClosingStatement": "感谢您的接听,祝您生活愉快,再见!",
              "KeyWords": [
                "机器人助理"
              ]
            }
          ]
        },
        "InitialGreetingDelayMilliseconds": 2000,
        "BackgroundMusicId": "office-ambience"
      },
      "LabelConfig": [
        {
          "Name": "是否同意还款",
          "Description": "用户是否同意于还款截止日期前还款",
          "CandidateValues": [
            "同意"
          ]
        }
      ]
    }
  },
  "Params": [
    "af81a389-91f0-4157-8d82-720edd02b66a"
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2026-04-20OpenAPI 返回结构发生变更查看变更详情
2026-04-07新增 OpenAPI查看变更详情