GetChatFlowMetric - Chat App Message Service - Alibaba Cloud Documentation Center

Operation description

Before calling this operation, make sure that the flow you created is online and has been triggered.
If your flow is not online, go to the Flow Editor page, click the flow name to open the canvas, and manually bring the flow online. Alternatively, call the OnlineFlowVersion operation to bring the flow online.
For flows with a manual trigger type, call the TriggerChatFlow operation to trigger the flow, or go to the Marketing Activity Management page and trigger the flow by associating it with a campaign.
For flows with a non-manual trigger type, you do not need to manually trigger the flow. The flow is automatically triggered when a message is sent to the bound business account.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
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.	{}
From	integer	No	The start time. This value is a UNIX timestamp. Unit: seconds.	1751299200
To	integer	No	The end time. This value is a UNIX timestamp. Unit: seconds.	1751385599
FlowCode	string	No	The flow code. You can view the flow code on the Flow Editor page.	9ccc41**************************
FlowVersion	string	No	The flow version. On the Flow Editor page, click the flow name to open the canvas and view the flow version.	1
MetricName	string	Yes	The metric name. Valid values: nodeUsageStatistics: node usage statistics. nodeErrorDetails: node error details. Valid values: nodeUsageStatistics : nodeUsageStatistics	nodeUsageStatistics
MetricParam	object	No	The extended parameter for the metric query. When MetricName is set to nodeErrorDetails, pass in a JSON string. Valid values for the JSON fields: pageNo: the current page number. pageSize: the number of entries per page. nodeId: the node ID. On the Flow Editor page, click the flow name to open the canvas and copy the node ID.	{ "pageNo": 1, "pageSize": 20, "nodeId": "SendWhatsAppMessage#H7fKq5rM" }

Response elements

Element	Type	Description	Example
	object
AccessDeniedDetail	string	The details about the access denial.	None
Message	string	The error message.	None
RequestId	string	The request ID.	90E63D28-E31D-1EB2-8939-A94866411B2O
Data	object	The returned data object.
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

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.