ModifyScript

Updated at:

Updates script information.

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:ModifyScript

update

*Instance

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

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:

  • appKey: The appKey of the Alibaba Cloud account.

  • maxEndSilence: The duration of voice endpoint detection.

  • silenceTimeout: The silence timeout in seconds. The timeout occurs after the user is silent for N seconds.

  • engine: The service to call. Valid values: ali and xunfei.

  • nlsServiceType: The type of the service to call. Valid values:

    • Managed: The NLS service on the public cloud.

    • Authorized: The authorized NLS service.

    • Provided: The NLS service provided by the customer through AccessKey ID and AccessKey secret.

    • Apes: The private cloud service.

  • engineXunfei: The configuration required when the caller is xunfei.

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}.

  • globalMaxEndSilence: The silence detection duration in milliseconds.

  • globalMaxEndSilenceEnable: The silence detection switch. Enabled by default.

  • speechNoiseThreshold: The noise filtering threshold.

{ "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:

  • voice: The speaker.

  • volume: The volume. Valid values: 0 to 100. Default value: 50.

  • speechRate: The speech rate. Valid values: -500 to 500. Default value: 0.

  • pitchRate: The pitch. Valid values: -500 to 500. Default value: 0.

  • openingPromptInterruptible: The interruption configuration for the opening prompt.

  • closingStatementInterruptible: The interruption configuration for the closing statement.

  • globalInterruptible: The voice interruption configuration.

  • engine: The service to call. Valid values: ali, volc, and xunfei. xunfei is not supported in large model scenarios.

  • nlsServiceType: The type of the service to call. Valid values:

    • Managed: The NLS service on the public cloud.

    • Authorized: The authorized NLS service.

    • Provided: The NLS service provided by the customer through AccessKey ID and AccessKey secret.

    • Apes: The private cloud service.

  • engineXunfei: The configuration when the service provider is xunfei.

Note
  1. When engine is set to ali and nlsServiceType is set to Authorized, a custom service is used. 2. When the service provider is ali, engine is set to ali, and nlsServiceType is set to Managed, the default service is used. 3. When engine is set to xunfei (applicable to small model scenarios) and nlsServiceType is set to Authorized, the service provider is xunfei, and you must enter the engineXunfei configuration: {"pitchRate":50,"speechRate":50,"voice":"aisjiuxu","volume":50}. 4. When engine is set to volc and nlsServiceType is set to Authorized, the applicable service is doubao.

{ "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: The text input mode.

  • SSE_FUNCTION: The Function Compute mode.

  • Empty: For non-large model scenarios.

Prompts

NluAccessType

string

No

The NLU access method. This parameter is applicable only to large model scenarios.

Valid values:

  • Managed: Uses the Alibaba Cloud public account for access.

  • Empty: For non-large model scenarios.

Managed

ChatConfig

string

No

The call configuration.

  • silenceConfig: The silence configuration.
    • silenceReplyTimeout: The silence reply timeout in milliseconds.

    • silenceTimeoutMaxCount: The maximum number of silence timeout rounds before hanging up.

    • silenceTimeoutMaxCountEnable: Specifies whether to hang up after silence timeouts.

  • hangupConfig: The hang-up configuration.
    • aiHangupEnable: Specifies whether to enable AI hang-up. Valid values: true and false.

    • delayHangup: The delayed hang-up time. Maximum value: 10.

    • hangupMaxRounds: The maximum number of interaction rounds. Maximum value: 100.

    • hangupMaxRoundsBroadcast: The broadcast script for hanging up.

    • hangupMaxRoundsEnable: Specifies whether to enable the maximum interaction rounds check. Valid values: true and false.

  • securityInterceptConfig: The security interception configuration.
    • broadcast: The interception broadcast script.

  • specialInterceptConfig: The special case interception configuration.
    • specialInterceptEnable: Specifies whether to enable special case interception.

    • specialIntercepts: The special cases.
      • voiceAssistant: Voice assistant.

      • extensionNumberTransfer: Extension number transfer.

  • transitionConfig: The backchannel model configuration.
    • transitionSwitch: Specifies whether to enable the backchannel model.

{"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.