QueryScriptsByStatus - 根据场景状态查询场景信息

更新时间:
复制 MD 格式

根据场景状态查询场景信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

outboundbot:QueryScriptsByStatus

get

*全部资源

*

无 无

请求参数

名称

类型

必填

描述

示例值

InstanceId

string

是

实例 ID

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

PageNumber

integer

是

页号

1

PageSize

integer

是

分页大小

10

StatusList

array

是

状态列表

string

否

场景状态取值范围

  • DRAFTED:草稿态

  • INITIALIZE_IN_PROGRESS:正在初始化

  • PUBLISHED:已发布

  • PUBLISH_IN_PROGRESS:正在发布

  • ROLLBACK_IN_PROGRESS:正在回滚

  • EXAMINE_IN_PROGRESS:待审核

  • PUBLISHED_AND_EXAMINE_IN_PROGRESS:已发布待审核状态

  • PUBLISH_FAILED:已发布待审核状态

  • ROLLBACK_FAILED:回滚失败

  • IMPORT_IN_PROGRESS:正在导入

  • IMPORT_FAILED:导入失败

PUBLISHED

返回参数

名称

类型

描述

示例值

object

HttpStatusCode

integer

HTTP 状态码

200

Code

string

接口状态码

OK

Message

string

接口提示消息

Success

RequestId

string

请求 ID

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

Success

boolean

是否成功

true

Scripts

object

场景列表

PageNumber

integer

页号

1

PageSize

integer

分页大小

10

TotalCount

integer

总计个数

15

List

array<object>

场景信息列表

object

Status

string

应用版本的状态,取值范围

  • DRAFTED:草稿态

  • INITIALIZE_IN_PROGRESS:正在初始化

  • PUBLISHED:已发布

  • PUBLISH_IN_PROGRESS:正在发布

  • ROLLBACK_IN_PROGRESS:正在回滚

  • EXAMINE_IN_PROGRESS:待审核

  • PUBLISHED_AND_EXAMINE_IN_PROGRESS:已发布待审核状态

  • PUBLISH_FAILED:已发布待审核状态

  • ROLLBACK_FAILED:回滚失败

  • IMPORT_IN_PROGRESS:正在导入

  • IMPORT_FAILED:导入失败

PUBLISHED

UpdateTime

integer

更新时间。使用 Unix 时间戳,单位为毫秒。

1579055782000

ScriptId

string

场景 ID

fa0e21e9-caab-4629-9121-1e341243d599

AppliedVersion

string

版本 ID

1579055782000

IsDebugDrafted

boolean

调试版本是否为草稿态

false

Industry

string

⾏业

通用

ScriptDescription

string

话术描述

销售话术

IsDrafted

boolean

版本是否为草稿态

false

DebugStatus

string

调试状态

PUBLISHED

DebugVersion

string

调试版本

01bb2df2-a273-42bb-a214-d3c626b13296

Scene

string

场景

电销

ScriptName

string

场景名称

销售话术

示例

正常返回示例

JSON格式

{
  "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": "销售话术"
      }
    ]
  }
}

错误码

HTTP status code

错误码

错误信息

描述

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. 指定的实例不存在。

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情。