ListFlowNodePrototypeV2 - Chat App Message Service - Alibaba Cloud ドキュメントセンター

Lists flow component prototypes.

Operation description

You can call this operation to query flow component prototypes. You can also click a flow name in the Flow Editor to go to the canvas orchestration page and view flow component prototypes.
The optional parameters in this operation are filter conditions for flow component prototypes. If you do not specify them, all flow component prototypes are queried.

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

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
PageNo	integer	Yes	The current page number.	1
PageSize	integer	Yes	The number of entries per page.	20
GroupCode	string	No	The component group code. Valid values: Messaging: messaging components. Core: core components. Intelligence: intelligent components. Contact: contact management components.	Core
BizCode	string	Yes	The business tenant code. Default value: ALICOM_OPAAS.	ALICOM_OPAAS
Keyword	string	No	The search keyword. This parameter is used for fuzzy match based on the flow component name.	WhatsApp

Response elements

Element	Type	Description	Example
	object
AccessDeniedDetail	string	The access denied details.	None
Message	string	The error message.	None
RequestId	string	The unique request ID.	90E63D28-E31D-1EB2-8939-A94866411B2O
Data	object	The returned data.
Model	array<object>	The list of request result data.
	object	The request result data.
Status	string	The status of the component prototype. The default value is NORMAL.	NORMAL
GroupCode	string	The code of the component group.	Core
PublicExtend	string	The public extension information. This is a JSON string that contains extension information for the frontend to display the flow component. The fields are described as follows: en: The English information about the flow component. zh: The Chinese information about the flow component. name: The name of the flow component. remark: The remarks on the flow component. order: The display order of the flow component. style: The style of the flow component. svg: The URL of the flow component icon. icon: This field is deprecated. bgcolor: The background color of the icon.	{\"i18n\": {\"en\": {\"name\": \"Send a WhatsApp Message\", \"remark\": \"Send a message with the ability for the user to reply utilizing WhatsApp specific features.\"}, \"zh\": {\"name\": \"Send WhatsApp messages\", \"remark\": \"Send a message that allows users to reply using specific features of WhatsApp\"}}, \"order\": \"9000\", \"style\": {\"svg\": \"https://img.alicdn.com/*********************************\", \"icon\": \"https://img.alicdn.com/*********************************\", \"bgcolor\": \"blue\"}}
Code	string	The code of the component prototype.	SendWhatsAppMessageNode
Code	integer	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

{
  "AccessDeniedDetail": "None",
  "Message": "None",
  "RequestId": "",
  "Data": {
    "Model": [
      {
        "Status": "NORMAL",
        "GroupCode": "Core",
        "PublicExtend": "{\\\"i18n\\\": {\\\"en\\\": {\\\"name\\\": \\\"Send a WhatsApp Message\\\", \\\"remark\\\": \\\"Send a message with the ability for the user to reply utilizing WhatsApp specific features.\\\"}, \\\"zh\\\": {\\\"name\\\": \\\"Send WhatsApp messages\\\", \\\"remark\\\": \\\"Send a message that allows users to reply using specific features of WhatsApp\\\"}}, \\\"order\\\": \\\"9000\\\", \\\"style\\\": {\\\"svg\\\": \\\"https://img.alicdn.com/***********************************\\\", \\\"icon\\\": \\\"https://img.alicdn.com/***********************************\\\", \\\"bgcolor\\\": \\\"blue\\\"}}",
        "Code": "SendWhatsAppMessageNode"
      }
    ]
  },
  "Code": 0,
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.