ListChatFlow - 列举流程-Chat App 消息服务(Chat App)-阿里云帮助中心

列举流程。

接口说明

您可调用此接口查询流程，也可在流程编辑器界面手动查询流程。
在调用此接口前，请确保您已有创建成功的流程。
若您没有创建成功的流程，可在流程编辑器界面手动创建流程或通过 CreateChatFlow 接口创建流程。
此接口中的非必填参数为查询流程的筛选条件，若不填写，则查询所有的流程。

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

cams:ListChatFlow

list

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
Status	string	否	流程状态。默认值：NORMAL。	NORMAL
PageNo	integer	否	页码。	1
PageSize	integer	否	每页显示记录条数。	20
FlowTriggerType	string	否	流程触发类型。取值： TriggeredManually TriggeredByWhatsApp TriggeredByInstagram TriggeredByViber TriggeredByMessenger	TriggeredByWhatsApp
ReturnWithOnlineVersion	boolean	否	是否返回在线状态。取值： true：是。 false：否。	true
Keyword	string	否	搜索关键字。即为模糊查询流程名称。	LLM
BizCode	string	否	业务租户编码，默认：ALICOM_OPAAS。	ALICOM_OPAAS
BizExtend	object	否	业务扩展信息，默认为一个空集合。	{}
FlowCode	string	否	flowCode	示例值示例值
Title	string	否	标题	示例值示例值
FlowStatus	string	否	流程状态	示例值示例值
PhoneNumber	string	否	号码	示例值

返回参数

名称	类型	描述	示例值
	object
Response	object	响应数据
AccessDeniedDetail	string	访问被拒绝详细信息。	None
RequestId	string	请求 ID。	90E63D28-E31D-1EB2-8939-A94866411B2O
Message	string	错误描述信息。	None
Code	string	错误码。更多详情请参见错误码。	OK
Success	boolean	操作是否成功。取值： true：成功。 false：失败。	true

示例

正常返回示例

JSON格式

{
  "Response": {
    "test": "test",
    "test2": 1
  },
  "AccessDeniedDetail": "None",
  "RequestId": "90E63D28-E31D-1EB2-8939-A94866411B2O",
  "Message": "None",
  "Code": "OK",
  "Success": true
}

错误码

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

变更历史

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