CreateCustomScriptTemplate

Updated at:

Creates a custom script template for a specified 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:CreateCustomScriptTemplate

create

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

InstanceId

string

No

The instance ID.

0ec0c897-b92c-40e4-9ad7-e6e4f5ce13bb

ScriptId

string

No

The script ID.

43972417-0657-452a-81c2-c59d8245a9b2

PromptJson

string

No

The agent configuration in JSON format.

{"name":"Xiao X","gender":"Male","age":18,"role":"Game Promoter","communicationStyle":["Friendly"],"goals":"Hello","background":"Not very good","openingPrompt":"Hello, I am XXX"}

Prompt

string

No

The prompt for professional mode.

\nName: Annie \nRole: Game Promoter\nBackground: Promote the latest promotional events to players over the phone, ensuring that every player stays informed and enjoys the game.\nSkills: As a game customer service representative, recommend time-limited promotional events to users, highlight the benefits, and explain the participation process.\nConstraints: You must remember that you are Annie,

Model

string

No

The ID of the model used to create the template.

model_002

LabelsJson

string

No

The label descriptions in JSON array format.

[{\"name\":\"Delivered\",\"description\":\"Whether the purchased home appliance has been delivered\",\"valueList\":\"[\\\"Yes\\\",\\\"No\\\"]\"},{\"name\":\"Scheduled on-site service time\",\"description\":\"Collect the customer's preferred time for on-site installation\",\"valueList\":\"[]\"}]

Name

string

No

The name of the custom scenario.

Test scenario

Description

string

No

The description of the custom scenario.

This is a large language model bot

Response elements

Element

Type

Description

Example

object

BaseResponse

Success

boolean

Indicates whether the call was successful.

true

Code

string

The status code.

OK

Message

string

The message returned by the API operation.

Success

Data

string

The ID of the created custom scenario template.

8d6a6e41-8093-49af-a9d1-0281878758ac

HttpStatusCode

integer

The HTTP status code.

200

RequestId

string

The request ID.

254EB995-DEDF-48A4-9101-9CA5B72FFBCC

Examples

Success response

JSON format

{
  "Success": true,
  "Code": "OK",
  "Message": "Success",
  "Data": "8d6a6e41-8093-49af-a9d1-0281878758ac",
  "HttpStatusCode": 200,
  "RequestId": "254EB995-DEDF-48A4-9101-9CA5B72FFBCC"
}

Error codes

HTTP status code

Error code

Error message

Description

404 NotExists.InstanceId The specified instance %s does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.