DescribeScript - 返回一个话术的信息_智能外呼机器人(Outbound Bot)-阿里云帮助中心

返回一个话术的信息。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
outboundbot:DescribeScript	get	*Instance `acs:outboundbot:{#regionId}:{#accountId}:instance/{#InstanceId}`	无	无

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	实例 ID	38d2e8ed-04e9-4dac-83b5-a8e57642ef13
ScriptId	string	是	话术 ID	bee7e5b1-5d9a-4389-aa7e-bbbee5353a16

返回参数

名称	类型	描述	示例值
	object
HttpStatusCode	integer	HTTP 状态码	200
RequestId	string	请求 ID	254EB995-DEDF-48A4-9101-9CA5B72FFBCC
Success	boolean	是否成功	true
Code	string	接口状态码	OK
Message	string	接口提示消息	Success
Script	object	话术
Status	string	话术状态	DRAFTED
UpdateTime	long	更新时间	1578881227000
ChatbotId	string	对话机器人 ID	d31794e2a51f47d2901b4094d88311d7
ScriptId	string	话术 ID	810b5872-57f0-4b27-80ab-7b3f4d8a6374
IsDebugDrafted	boolean	调试版本是否为草稿态	true
Industry	string	行业	金融
ScriptDescription	string	话术描述	催收话术
MiniPlaybackEnable	boolean	语气承接配置开关	true
IsDrafted	boolean	是否是草稿状态	true
TtsConfig	string	话术的 TTS 配置	{\"voice\":\"xiaobei\",\"volume\":\"50\",\"speechRate\":\"-150\",\"pitchRate\":\"0\"}
DebugStatus	string	调试话术的状态	DRAFTED
AsrConfig	string	ASR 配置	{\"AppKey\":\"3GHttnsvir1FeWWb\"}
Scene	string	场景	催收
ScriptName	string	话术名字	催收话术
NewBargeInEnable	boolean	优雅打断配置开关	true
LongWaitEnable	boolean	智能断句配置开关	true
EmotionEnable	boolean	情绪识别配置开关	true
AgentId	long	机器人业务空间访问 Key	1218333
AgentKey	string	机器人业务空间访问 Key	14791f5f226b4878b3d9b676a0291234
AgentLlm	boolean	机器人业务空间是否大模型业务空间	true
ChatConfig	string	通话配置	{\"noAnswerConfig\":{\"finalAction\":\"noAction\",\"noAnswerMessages\":[\"。\"]},\"silenceConfig\":{\"finalAction\":\"noAction\",\"silenceReplyTimeout\":5,\"silenceTimeoutMessages\":[\"。\"]}}
NlsConfig	string	已作废	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": "{\\\"voice\\\":\\\"xiaobei\\\",\\\"volume\\\":\\\"50\\\",\\\"speechRate\\\":\\\"-150\\\",\\\"pitchRate\\\":\\\"0\\\"}",
    "DebugStatus": "DRAFTED",
    "AsrConfig": "{\\\"AppKey\\\":\\\"3GHttnsvir1FeWWb\\\"}",
    "Scene": "催收",
    "ScriptName": "催收话术",
    "NewBargeInEnable": true,
    "LongWaitEnable": true,
    "EmotionEnable": true,
    "AgentId": 1218333,
    "AgentKey": "14791f5f226b4878b3d9b676a0291234",
    "AgentLlm": true,
    "ChatConfig": "{\\\"noAnswerConfig\\\":{\\\"finalAction\\\":\\\"noAction\\\",\\\"noAnswerMessages\\\":[\\\"。\\\"]},\\\"silenceConfig\\\":{\\\"finalAction\\\":\\\"noAction\\\",\\\"silenceReplyTimeout\\\":5,\\\"silenceTimeoutMessages\\\":[\\\"。\\\"]}}"
  },
  "NlsConfig": "none"
}

错误码

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

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

变更历史

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