ModifyScript
Updates script information.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
outboundbot:ModifyScript |
update |
*Instance
|
None | None |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| InstanceId |
string |
Yes |
The instance ID. |
c6320d3c-fa45-4011-b3b1-acdfabe3a8c6 |
| ScriptId |
string |
Yes |
The script ID. |
c153d0d8-ba04-41c0-8632-453944c9dd0b |
| ScriptName |
string |
Yes |
The script name. |
Renewal reminder |
| ScriptDescription |
string |
No |
The script description. |
Rework callback script |
| Industry |
string |
Yes |
The industry. |
E-commerce |
| Scene |
string |
Yes |
The scenario information. |
Follow-up visit |
| ChatbotId |
string |
No |
The robot ID. |
chatbot-cn-iFZfi7eq6e |
| AsrConfig |
string |
No |
The ASR configuration. Parameter definitions:
Note
When engine is set to ali and nlsServiceType is set to Authorized, a custom service is used, and the service provider is ali. When engine is set to ali and nlsServiceType is set to Managed, the default service is used. When engine is set to xunfei and nlsServiceType is set to Authorized, the service provider is xunfei, and you must enter the xunfei configuration: {"uuid":"ed2xxxxxxxxx","globalMaxEndSilence":700,"globalMaxEndSilenceEnable":true}.
|
{ "appKey": "oQDVNlE6fZ5mg46X", "engine": "ali", "engineXunfei": "", "globalMaxEndSilence": 700, "globalMaxEndSilenceEnable": true, "maxEndSilence": "500", "nlsServiceType": "Managed", "silenceTimeout": "5000", "speechNoiseThreshold": "0" } |
| TtsConfig |
string |
No |
The TTS configuration. Parameter definitions:
Note
|
{ "appKey": "oQDVNlE6fZ5mg46X", "engine": "ali", "engineXunfei": "", "globalInterruptible": true, "nlsServiceType": "Managed", "pitchRate": "0", "speechRate": "0", "voice": "zhiyuan", "volume": "50" } |
| ScriptContent |
array |
No |
The script list for notification instances. [Deprecated] |
|
|
string |
No |
The script list for notification instances. [Deprecated] |
Hello, you have not yet paid for the 2-pack of Naweishi Coconut Water Gen 2 Essence ordered from Austin Li's livestream last night. Unpaid orders will be automatically closed after the timeout. Do not miss out on this promotion |
|
| ScriptWaveform |
array |
No |
The script voice list for notification instances. [Deprecated] |
|
|
string |
No |
The script voice list for notification instances. [Deprecated] |
None |
|
| NewBargeInEnable |
boolean |
No |
Specifies whether to enable the graceful interruption configuration for small models. |
true |
| LongWaitEnable |
boolean |
No |
Specifies whether to enable the intelligent sentence segmentation configuration for small models. |
true |
| MiniPlaybackEnable |
boolean |
No |
Specifies whether to enable the backchannel configuration for small models. |
true |
| MiniPlaybackConfigListJsonString |
string |
No |
The backchannel configuration. Customization is not supported at the moment. You do not need to pass this parameter by default. [Deprecated] |
None |
| NlsConfig |
string |
No |
[Deprecated] |
None |
| EmotionEnable |
boolean |
No |
Specifies whether to enable the emotion recognition configuration. |
true |
| AgentKey |
string |
No |
The access key for the robot workspace. |
9137ab9c27044921860030adf8590ec4_p_outbound_public |
| AgentLlm |
boolean |
No |
Specifies whether the robot workspace is a large model workspace. |
false |
| AgentId |
integer |
No |
The ID of the robot workspace. |
1198938 |
| NluEngine |
string |
No |
The NLU engine. This parameter is applicable only to large model scenarios. Note
After a scenario is created, the scenario mode cannot be modified. Valid values:
|
Prompts |
| NluAccessType |
string |
No |
The NLU access method. This parameter is applicable only to large model scenarios. Valid values:
|
Managed |
| ChatConfig |
string |
No |
The call configuration.
|
{"silenceConfig":{"silenceReplyTimeout":499,"silenceTimeoutMaxCount":10,"silenceTimeoutMaxCountEnable":true},"hangupConfig":{"aiHangupEnable":false,"delayHangup":0,"hangupMaxRounds":20,"hangupMaxRoundsBroadcast":"Thank you for taking my call. Have a great day. Goodbye!","hangupMaxRoundsEnable":false},"securityInterceptConfig":{"broadcast":"I cannot answer this question. You can try asking other questions."},"specialInterceptConfig":{"specialInterceptEnable":false,"specialIntercepts":[{"code":"voiceAssistant"},{"code":"extensionNumberTransfer"}]},"transitionConfig":{"transitionSwitch":false}} |
| LabelConfig |
string |
No |
The label definition. Note
Used in large model flow canvas scenarios. |
{ "labels": [{ "description": "The customer's final repayment intention after the conversation is completed", "name": "Whether promised to repay", "valueList": "[\"Yes\",\"No\"]" }] } |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| HttpStatusCode |
integer |
The HTTP status code. |
200 |
| RequestId |
string |
The request ID. |
254EB995-DEDF-48A4-9101-9CA5B72FFBCC |
| Success |
boolean |
Indicates whether the request is successful. |
true |
| Code |
string |
The API status. |
OK |
| Message |
string |
The response message. |
Success |
| Script |
object |
The script information. |
|
| Status |
string |
The script status. |
PUBLISHED |
| UpdateTime |
integer |
The update time. |
1578881227000 |
| Industry |
string |
The industry. |
Government |
| ScriptDescription |
string |
The script description. |
Rework callback script |
| IsDrafted |
boolean |
Indicates whether the script is a draft. |
true |
| DebugStatus |
string |
The script debug status. |
DRAFTED |
| ScriptId |
string |
The script ID. |
c153d0d8-ba04-41c0-8632-453944c9dd0b |
| IsDebugDrafted |
boolean |
Indicates whether the script is a debug draft. |
true |
| ScriptName |
string |
The script name. |
Callback script |
| Scene |
string |
The scenario. |
Follow-up visit |
Examples
Success response
JSON format
{
"HttpStatusCode": 200,
"RequestId": "254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
"Success": true,
"Code": "OK",
"Message": "Success",
"Script": {
"Status": "PUBLISHED",
"UpdateTime": 1578881227000,
"Industry": "政务",
"ScriptDescription": "返工回访话术",
"IsDrafted": true,
"DebugStatus": "DRAFTED",
"ScriptId": "c153d0d8-ba04-41c0-8632-453944c9dd0b",
"IsDebugDrafted": true,
"ScriptName": "回访话术",
"Scene": "回访"
}
}
Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | InvalidScriptName.Duplicated | The specified ScriptName already exists. | |
| 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.