All Products
Search

This Product

    Chat App Message Service:GetFlow

    Document Center

    Chat App Message Service:GetFlow

    Last Updated:Jul 30, 2026

    Retrieves the details of a Flow.

    Operation description

    • Before calling this operation, make sure that you have successfully created a WhatsApp Flow.

    • If you do not have a successfully created WhatsApp Flow, call the CreateFlow operation to create one.

    QPS limit

    The single-user QPS limit for this operation is 5 calls per second. If this limit is exceeded, the API calls are throttled, which may affect your business. Call this operation as appropriate.

    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 None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    FlowId

    string

    Yes

    The flow ID, which is the FlowId returned by the CreateFlow operation when you create a WhatsApp Flow.

    333993838***

    CustSpaceId

    string

    No

    The space ID of the ISV sub-customer or the instance ID of the direct customer. You can view the Space ID on the Channel Management page.

    cams-kei****

    Response elements

    Element

    Type

    Description

    Example

    object

    The response parameters.

    AccessDeniedDetail

    string

    The details about the access denial.

    None
    RequestId

    string

    The request ID.

    DAC72B08-3327-33EF-BEDC-8EC3E83A6575

    Message

    string

    The error message.

    None
    Data

    object

    The returned data.

    Status

    string

    The status of the Flow. Valid values:

    • PUBLISHED: Published.

    • DRAFT: Draft.

    • DEPRECATED: Deprecated.

    Valid values:

    • PUBLISHED :
    • DRAFT :
    • DEPRECATED :

    DRAFT
    FlowId

    string

    Flow ID。

    92675332812643****
    PreviewUrl

    string

    The temporary preview URL.

    https://pre-url
    EndpointUri

    string

    The URL of the WA Flow Endpoint

    http://abc.com
    JSONVersion

    string

    The JSON version information.

    2.1
    Categories

    array

    The list of categories.

    string

    The category.

    SIGN_UP
    FlowName

    string

    The Flow name.

    flow_001
    DataApiVersion

    string

    The API version information.

    3.0
    PreviewUrlExpires

    integer

    The expiration time of the preview URL.

    1700617436633

    Code

    string

    The error code. For more information, see Error codes.

    OK

    Examples

    Success response

    JSON format

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

    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.