ListScripts
Queries the list of scripts.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
outboundbot:ListScripts |
list |
*Instance
|
None | None |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| InstanceId |
string |
Yes |
The instance ID. |
bdd49242-114c-4045-b1d1-25ccc1756c75 |
| PageNumber |
integer |
Yes |
The page number. |
1 |
| PageSize |
integer |
Yes |
The number of entries per page. |
10 |
| ScriptName |
string |
No |
The script name. |
Course satisfaction follow-up |
| NluEngine |
string |
No |
The NLU robot engine.
|
Prompts |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| HttpStatusCode |
integer |
The HTTP status code. |
200 |
| Code |
string |
The status code. |
OK |
| Message |
string |
The message returned by the API. |
Success |
| RequestId |
string |
The request ID. |
254EB995-DEDF-48A4-9101-9CA5B72FFBCC |
| Success |
boolean |
Indicates whether the request was successful. |
true |
| Scripts |
object |
The list of scripts. |
|
| PageNumber |
integer |
The page number. |
1 |
| PageSize |
integer |
The page size. |
10 |
| TotalCount |
integer |
The total number of entries. |
15 |
| List |
array<object> |
The array of scripts. |
|
|
array<object> |
The array of scripts. |
||
| Status |
string |
The script status. |
DRAFTED |
| UpdateTime |
integer |
The update time. The value is a UNIX timestamp in milliseconds. |
1578965079000 |
| ScriptId |
string |
The script ID. |
8d6a6e41-8093-49af-a9d1-0281878758ac |
| IsDebugDrafted |
boolean |
Indicates whether the debug version is in the draft state. |
true |
| Industry |
string |
The industry. |
Finance |
| ScriptDescription |
string |
The script description. |
Telesales script |
| IsDrafted |
boolean |
Indicates whether the script is a draft. |
true |
| DebugStatus |
string |
The debug status. |
DRAFTED |
| MiniPlaybackEnable |
boolean |
Indicates whether the filler word configuration is enabled. |
false |
| RejectReason |
string |
The reason for rejection. |
Non-compliant script wording |
| Scene |
string |
The scenario. |
Telesales |
| ScriptName |
string |
The script name. |
Telesales script |
| NewBargeInEnable |
boolean |
Indicates whether the graceful barge-in configuration is enabled. This value is always false for large models. |
false |
| LongWaitEnable |
boolean |
Indicates whether the long pause configuration is enabled. This value is always false for large models. |
false |
| EmotionEnable |
boolean |
Indicates whether the emotion recognition configuration is enabled. This value is always false for large models. |
false |
| IsPreset |
boolean |
Indicates whether the scenario is a preset scenario. |
false |
| AgentKey |
string |
The access key of the robot workspace. |
14791f5f226b4878b3d9b676a0291234 |
| AgentLlm |
boolean |
Indicates whether the robot workspace is a large model workspace. |
false |
| agentId |
integer |
The robot workspace ID. |
1160195 |
| NluEngine |
string |
The robot engine. If the scenario is a small model scenario, this field is empty. If the scenario is a large model scenario, this field is Prompts. |
Empty or Prompts |
| NluAccessType |
string |
The robot access type. If the scenario is a small model scenario, this field is empty. If the scenario is a large model scenario, this field is Managed. |
Empty or Managed |
| ChatBotId |
string |
The chatbot ID. |
d31794e2a51f47d2901b4094d88311d7 |
| CreateTime |
integer |
The creation time. The value is a UNIX timestamp in milliseconds. |
1578965079000 |
| NluProfile |
object |
The Function Compute service mode configuration. |
|
| FcFunction |
string |
The function service name. |
sanfang_test |
| FcRegion |
string |
The region of the function service. |
cn-shanghai |
| FcHttpTriggerUrl |
string |
The function service trigger. |
http://sanfang_test-xxxxxx.cn-shanghai-vpc.fcapp.run |
Examples
Success response
JSON format
{
"HttpStatusCode": 200,
"Code": "OK",
"Message": "Success",
"RequestId": "254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
"Success": true,
"Scripts": {
"PageNumber": 1,
"PageSize": 10,
"TotalCount": 15,
"List": [
{
"Status": "DRAFTED",
"UpdateTime": 1578965079000,
"ScriptId": "8d6a6e41-8093-49af-a9d1-0281878758ac",
"IsDebugDrafted": true,
"Industry": "Finance",
"ScriptDescription": "Telesales script",
"IsDrafted": true,
"DebugStatus": "DRAFTED",
"MiniPlaybackEnable": false,
"RejectReason": "Non-compliant script wording",
"Scene": "Telesales",
"ScriptName": "Telesales script",
"NewBargeInEnable": false,
"LongWaitEnable": false,
"EmotionEnable": false,
"IsPreset": false,
"AgentKey": "14791f5f226b4878b3d9b676a0291234",
"AgentLlm": false,
"agentId": 1160195,
"NluEngine": "Empty or Prompts",
"NluAccessType": "Empty or Managed",
"ChatBotId": "d31794e2a51f47d2901b4094d88311d7",
"CreateTime": 1578965079000,
"NluProfile": {
"FcFunction": "sanfang_test",
"FcRegion": "cn-shanghai\n",
"FcHttpTriggerUrl": "http://sanfang_test-xxxxxx.cn-shanghai-vpc.fcapp.run\n"
}
}
]
}
}
Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 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. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.