ListChatFlow - Chat App Message Service - Alibaba Cloud Documentation Center

Operation description

You can call this operation to query flows, or manually query flows in the Flow Builder console.
Before calling this operation, make sure that you have successfully created flows.
If you do not have any successfully created flows, manually create a flow in the Flow Builder console or call the CreateChatFlow operation to create a flow.
The optional parameters in this operation are filter conditions for querying flows. If you do not specify these parameters, all flows are returned.

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

cams:ListChatFlow

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Status	string	No	The flow status. Default value: NORMAL. Valid values: NORMAL : NORMAL	NORMAL
PageNo	integer	No	The page number.	1
PageSize	integer	No	The number of entries per page.	20
FlowTriggerType	string	No	The flow trigger type. Valid values: TriggeredManually TriggeredByWhatsApp TriggeredByInstagram TriggeredByViber TriggeredByMessenger Valid values: TriggeredManually : TriggeredManually TriggeredByWhatsApp : TriggeredByWhatsApp TriggeredByMessenger : TriggeredByMessenger TriggeredByInstagram : TriggeredByInstagram TriggeredByViber : TriggeredByViber	TriggeredByWhatsApp
ReturnWithOnlineVersion	boolean	No	Specifies whether to return the online status. Valid values: true: Yes. false: No.	true
Keyword	string	No	The search keyword. This parameter is used for fuzzy match of flow names.	LLM
BizCode	string	No	The business tenant code. Default value: ALICOM_OPAAS. Valid values: ALICOM_OPAAS : ALICOM_OPAAS	ALICOM_OPAAS
BizExtend	object	No	The business extension information. Default value: an empty collection.	{}

Response elements

Element	Type	Description	Example
	object
Response	object	The response data.
AccessDeniedDetail	string	The details about the access denial.	None
RequestId	string	The request ID.	90E63D28-E31D-1EB2-8939-A94866411B2O
Message	string	The error message.	None
Code	string	The error code. For more information, see Error codes.	OK
Success	boolean	Indicates whether the operation was successful. Valid values: true: The operation was successful. false: The operation failed.	true

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.