ModifyTTSConfig-阿里云帮助中心

Update the text-to-speech (TTS) configuration for an existing canvas scenario.

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

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	Instance ID	27244bae-e446-4811-bb1d-f8a07b525af0
ScriptId	string	Yes	Scenario ID	1f1a2ba0-b3e7-4ff9-baf1-6dc8aeac0791
Voice	string	No	Voice model, such as aixia, siyue, or xiaoyun	aixia
SpeechRate	string	No	Speech rate. An integer between -500 and 500. Default is 0. A value greater than 0 increases speech speed. A value less than 0 decreases speech speed.	0
Volume	string	No	Volume. An integer between 0 and 100. Default is 50. A value greater than 50 increases volume. A value less than 50 decreases volume.	100
NlsServiceType	string	No	The service type. Managed: The default public Intelligent Speech Interaction service for Outbound Bot. Authorized: A private Intelligent Speech Interaction service that you have purchased. To grant authorization, navigate to Scenario Management > Edit > Call Service > Custom Service.	Managed
AppKey	string	No	AppKey for your Intelligent Speech Interaction project. Required only when NlsServiceType is Authorized.	99****Aw
PitchRate	string	No	Pitch. An integer between -500 and 500. Default is 0. A value greater than 0 raises pitch. A value less than 0 lowers pitch.	0

Response elements

Element	Type	Description	Example
	object
HttpStatusCode	integer	HTTP status code	200
Code	string	API status code	OK
Message	string	API message	Success
RequestId	string	Request ID	f765d3ee-ec03-4765-b235-6877501d99d1
Success	boolean	Indicates whether the request succeeded	true
TTSConfig	object	TTS configuration
Voice	string	Voice model	xiaoyun
TTSConfigId	string	Configuration ID	2a07b634-e15d-445f-bbcb-fc4ea2df7b87
SpeechRate	string	Speech rate	50
Volume	string	Volume	100
InstanceId	string	Instance ID	291cfc6a-8703-4bdd-a99d-9cba32d5288a
ScriptId	string	Scenario ID	947e0875-b5d4-4b33-b18c-7b2cf85bcb4f
PitchRate	string	Pitch. An integer between -500 and 500. Default is 0. A value greater than 0 raises pitch. A value less than 0 lowers pitch.	0

Examples

Success response

JSON format

{
  "HttpStatusCode": 200,
  "Code": "OK",
  "Message": "Success",
  "RequestId": "f765d3ee-ec03-4765-b235-6877501d99d1",
  "Success": true,
  "TTSConfig": {
    "Voice": "xiaoyun",
    "TTSConfigId": "2a07b634-e15d-445f-bbcb-fc4ea2df7b87",
    "SpeechRate": "50",
    "Volume": "100",
    "InstanceId": "291cfc6a-8703-4bdd-a99d-9cba32d5288a",
    "ScriptId": "947e0875-b5d4-4b33-b18c-7b2cf85bcb4f",
    "PitchRate": "0"
  }
}

Error codes

HTTP status code	Error code	Error message
400	InvalidParameter	The specified parameter %s is invalid.
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.