DescribeScript-阿里云帮助中心

Returns information about a script.

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

outboundbot:DescribeScript

get

*Instance

acs:outboundbot:{#regionId}:{#accountId}:instance/{#InstanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	Instance ID	38d2e8ed-04e9-4dac-83b5-a8e57642ef13
ScriptId	string	Yes	Script ID	bee7e5b1-5d9a-4389-aa7e-bbbee5353a16

Response elements

Element	Type	Description	Example
	object
HttpStatusCode	integer	HTTP status code	200
RequestId	string	Request ID	254EB995-DEDF-48A4-9101-9CA5B72FFBCC
Success	boolean	Indicates whether the call succeeded	true
Code	string	API status code	OK
Message	string	API message	Success
Script	object	Script details	{}
Status	string	Script status	DRAFTED
UpdateTime	integer	Time when the script was last updated	1578881227000
ChatbotId	string	Chatbot ID	d31794e2a51f47d2901b4094d88311d7
ScriptId	string	Script ID	810b5872-57f0-4b27-80ab-7b3f4d8a6374
IsDebugDrafted	boolean	Indicates whether the debug version is in draft status	true
Industry	string	Industry	金融
ScriptDescription	string	Script description	催收话术
MiniPlaybackEnable	boolean	Enables tone continuity	true
IsDrafted	boolean	Indicates whether the script is in draft status	true
TtsConfig	string	TTS configuration for the script	{ "appKey": "oQDVNlE6fZ5mg46X", "engine": "ali", "engineXunfei": "", "globalInterruptible": true, "nlsServiceType": "Managed", "pitchRate": "0", "speechRate": "0", "voice": "zhiyuan", "volume": "50" }
DebugStatus	string	Status of the debug script	DRAFTED
AsrConfig	string	ASR configuration	{ "appKey": "oQDVNlE6fZ5mg46X", "engine": "ali", "engineXunfei": "", "globalMaxEndSilence": 700, "globalMaxEndSilenceEnable": true, "maxEndSilence": "500", "nlsServiceType": "Managed", "silenceTimeout": "5000", "speechNoiseThreshold": "0" }
Scene	string	Scenario	催收
ScriptName	string	Script name	催收话术
NewBargeInEnable	boolean	Enables graceful barge-in	true
LongWaitEnable	boolean	Enables intelligent sentence break	true
EmotionEnable	boolean	Enables emotion detection	true
AgentId	integer	Robot workspace access key	1218333
AgentKey	string	Robot workspace access key	14791f5f226b4878b3d9b676a0291234
AgentLlm	boolean	Indicates whether the robot workspace uses a Large Language Model (LLM)	true
ChatConfig	string	Call configuration	{"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	string	NLU engine (applies only to LLM scenarios) Prompts — Text entry mode SSE_FUNCTION — Function Compute service mode	Prompts
NluProfile	object	Function Compute service mode configuration
FcFunction	string	Function service name	sanfang_test
FcRegion	string	Function service region	cn-shanghai
FcHttpTriggerUrl	string	Function service trigger URL	http://sanfang_test-xxxxxx.cn-shanghai-vpc.fcapp.run
SupportBeebotPrompts	boolean
LabelConfig	string
NlsConfig	string	Deprecated	none

Examples

Success response

JSON format

{
  "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": "{\n\t\"appKey\": \"oQDVNlE6fZ5mg46X\",\n\t\"engine\": \"ali\",\n\t\"engineXunfei\": \"\",\n\t\"globalInterruptible\": true,\n\t\"nlsServiceType\": \"Managed\",\n\t\"pitchRate\": \"0\",\n\t\"speechRate\": \"0\",\n\t\"voice\": \"zhiyuan\",\n\t\"volume\": \"50\"\n}",
    "DebugStatus": "DRAFTED",
    "AsrConfig": "{\n\t\"appKey\": \"oQDVNlE6fZ5mg46X\",\n\t\"engine\": \"ali\",\n\t\"engineXunfei\": \"\",\n\t\"globalMaxEndSilence\": 700,\n\t\"globalMaxEndSilenceEnable\": true,\n\t\"maxEndSilence\": \"500\",\n\t\"nlsServiceType\": \"Managed\",\n\t\"silenceTimeout\": \"5000\",\n\t\"speechNoiseThreshold\": \"0\"\n}",
    "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": false
    },
    "LabelConfig": ""
  },
  "NlsConfig": "none"
}

Error codes

HTTP status code	Error code	Error message
500	InternalError	An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.
404	NotExist.Instance	The specified Instance does not exist.
404	NotExist.Script	The specified Script does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.