EndUserMessagingSocial / Client / list_whatsapp_flows

list_whatsapp_flows

EndUserMessagingSocial.Client.list_whatsapp_flows(**kwargs)

Lists all WhatsApp Flows for a WhatsApp Business Account. Returns summary information including Flow ID, name, status, and categories.

See also: AWS API Documentation

Request Syntax

response = client.list_whatsapp_flows(
    id='string',
    nextToken='string',
    maxResults=123
)

Parameters:

• id (string) –

  [REQUIRED]

  The ID of the WhatsApp Business Account to list Flows for.

• nextToken (string) – The token for the next page of results.

• maxResults (integer) – The maximum number of results to return per page.

Return type:

dict

Returns:

Response Syntax

{
    'flows': [
        {
            'flowId': 'string',
            'flowName': 'string',
            'flowStatus': 'string',
            'flowCategories': [
                'SIGN_UP'|'SIGN_IN'|'APPOINTMENT_BOOKING'|'LEAD_GENERATION'|'SHOPPING'|'CONTACT_US'|'CUSTOMER_SUPPORT'|'SURVEY'|'OTHER',
            ],
            'validationErrors': [
                'string',
            ]
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) –

  • flows (list) –

    A list of Flow summaries.

    • (dict) –

      Contains summary information about a WhatsApp Flow, including its ID, name, status, and categories.

      • flowId (string) –

        The unique identifier of the Flow assigned by Meta.

      • flowName (string) –

        The name of the Flow.

      • flowStatus (string) –

        The lifecycle status of the Flow (DRAFT, PUBLISHED, DEPRECATED, BLOCKED, or THROTTLED).

      • flowCategories (list) –

        The categories that classify the business purpose of the Flow.

        • (string) –

          The category that classifies the business purpose of a WhatsApp Flow.

      • validationErrors (list) –

        A list of validation errors from Meta, if any.

        • (string) –

  • nextToken (string) –

    The token to retrieve the next page of results, if any.

Exceptions

• EndUserMessagingSocial.Client.exceptions.ValidationException

• EndUserMessagingSocial.Client.exceptions.AccessDeniedException

• EndUserMessagingSocial.Client.exceptions.ResourceNotFoundException

• EndUserMessagingSocial.Client.exceptions.InvalidParametersException

• EndUserMessagingSocial.Client.exceptions.AccessDeniedByMetaException

• EndUserMessagingSocial.Client.exceptions.ThrottledRequestException

• EndUserMessagingSocial.Client.exceptions.InternalServiceException

• EndUserMessagingSocial.Client.exceptions.DependencyException