QueryScriptsByStatus

Updated at:

Queries scenario information based on the scenario status.

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

get

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

InstanceId

string

Yes

The instance ID.

361c8a53-0e29-42f3-8aa7-c7752d010399

PageNumber

integer

Yes

The page number.

1

PageSize

integer

Yes

The page size.

10

StatusList

array

Yes

The list of statuses.

string

No

The valid values of the scenario status:

  • DRAFTED: Draft.

  • INITIALIZE_IN_PROGRESS: Initializing.

  • PUBLISHED: Published.

  • PUBLISH_IN_PROGRESS: Publishing.

  • ROLLBACK_IN_PROGRESS: Rolling back.

  • EXAMINE_IN_PROGRESS: Pending review.

  • PUBLISHED_AND_EXAMINE_IN_PROGRESS: Published and pending review.

  • PUBLISH_FAILED: Publish failed.

  • ROLLBACK_FAILED: Rollback failed.

  • IMPORT_IN_PROGRESS: Importing.

  • IMPORT_FAILED: Import failed.

PUBLISHED

Response elements

Element

Type

Description

Example

object

HttpStatusCode

integer

The HTTP status code.

200

Code

string

The API status code.

OK

Message

string

The response message.

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

PageNumber

integer

The page number.

1

PageSize

integer

The page size.

10

TotalCount

integer

The total count.

15

List

array<object>

The list of scenario details.

object

Status

string

The status of the application version. Valid values:

  • DRAFTED: Draft.

  • INITIALIZE_IN_PROGRESS: Initializing.

  • PUBLISHED: Published.

  • PUBLISH_IN_PROGRESS: Publishing.

  • ROLLBACK_IN_PROGRESS: Rolling back.

  • EXAMINE_IN_PROGRESS: Pending review.

  • PUBLISHED_AND_EXAMINE_IN_PROGRESS: Published and pending review.

  • PUBLISH_FAILED: Publish failed.

  • ROLLBACK_FAILED: Rollback failed.

  • IMPORT_IN_PROGRESS: Importing.

  • IMPORT_FAILED: Import failed.

PUBLISHED

UpdateTime

integer

The update time. The value is a UNIX timestamp in milliseconds.

1579055782000

ScriptId

string

The scenario ID.

fa0e21e9-caab-4629-9121-1e341243d599

AppliedVersion

string

The version ID.

1579055782000

IsDebugDrafted

boolean

Indicates whether the debug version is in the draft state.

false

Industry

string

The industry.

General

ScriptDescription

string

The script description.

Sales script

IsDrafted

boolean

Indicates whether the version is in the draft state.

false

DebugStatus

string

The debug status.

PUBLISHED

DebugVersion

string

The debug version.

01bb2df2-a273-42bb-a214-d3c626b13296

Scene

string

The scenario.

Telemarketing

ScriptName

string

The scenario name.

Sales script

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": "PUBLISHED",
        "UpdateTime": 1579055782000,
        "ScriptId": "fa0e21e9-caab-4629-9121-1e341243d599",
        "AppliedVersion": "1579055782000",
        "IsDebugDrafted": false,
        "Industry": "通用",
        "ScriptDescription": "销售话术",
        "IsDrafted": false,
        "DebugStatus": "PUBLISHED",
        "DebugVersion": "01bb2df2-a273-42bb-a214-d3c626b13296",
        "Scene": "电销",
        "ScriptName": "销售话术"
      }
    ]
  }
}

Error codes

HTTP status code

Error code

Error message

Description

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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.