Retrieve WhatsApp flow details by using GetFlow - Chat App Message Service - Alibaba Cloud - Chat App Message Service

Retrieves the details of a WhatsApp flow.

Operation description

You must create a WhatsApp flow before calling this API.
If you do not have a WhatsApp flow, call the CreateFlow API to create one.

QPS limit

The QPS limit for this API is 5 calls per second per user. Calls that exceed this limit are subject to flow control. Call this API at a reasonable rate to avoid triggering flow control.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
FlowId	string	Yes	The ID of the flow. This value is returned as `FlowId` by the CreateFlow API.	333993838***
CustSpaceId	string	No	The Space ID of the ISV sub-customer, or the instance ID of the direct customer. You can find the Space ID on the Channel Management page.	cams-kei****

Response elements

Element	Type	Description	Example
	object	The data returned by the request.
RequestId	string	The request ID.	DAC72B08-3327-33EF-BEDC-8EC3E83A6575
Code	string	The error code. For more information, see Error Codes.	OK
Message	string	The error message.	None
Data	object	The details of the flow.
Status	string	The status of the flow. Valid values: `PUBLISHED`: Published. `DRAFT`: Draft. `DEPRECATED`: Deprecated. Valid values: PUBLISHED : DRAFT : DEPRECATED :	DRAFT
FlowId	string	The ID of the flow.	92675332812643****
FlowName	string	The flow name.	flow_001
Categories	array	Flow categories.
	string	A category.	SIGN_UP
JSONVersion	string	The JSON version.	2.1
DataApiVersion	string	The API version.	3.0
PreviewUrl	string	The temporary preview URL.	https://pre-url
PreviewUrlExpires	integer	The Unix timestamp, in milliseconds, at which the preview URL expires.	1700617436633

Examples

Success response

JSON format

{
  "RequestId": "DAC72B08-3327-33EF-BEDC-8EC3E83A6575\n",
  "Code": "OK",
  "Message": "None",
  "Data": {
    "Status": "DRAFT",
    "FlowId": "92675332812643****",
    "FlowName": "flow_001",
    "Categories": [
      "SIGN_UP"
    ],
    "JSONVersion": "2.1",
    "DataApiVersion": "3.0",
    "PreviewUrl": "https://pre-url",
    "PreviewUrlExpires": 1700617436633
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	Product.Unsubscript	You have not subscribed to the specified product.	You have not subscribed to the specified product.
400	Ram.PermissionDeny	You are not authorized to perform the operation.
400	System.LimitControl	The system is under flow control.	The system is under flow control.
400	Unknown.ResourceOwnerId	The resource does not belong to the current user.	The resource does not belong to the current user.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.