EndUserMessagingSocial / Client / get_whatsapp_flow

get_whatsapp_flow

EndUserMessagingSocial.Client.get_whatsapp_flow(**kwargs)

Retrieves the metadata and status of a WhatsApp Flow, including validation errors, preview information, and health status.

See also: AWS API Documentation

Request Syntax

response = client.get_whatsapp_flow(
    id='string',
    flowId='string'
)
Parameters:

  • id (string) –

    [REQUIRED]

    The ID of the WhatsApp Business Account associated with this Flow.

  • flowId (string) –

    [REQUIRED]

    The unique identifier of the Flow to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    'flowId': 'string',
    'flowName': 'string',
    'flowStatus': 'string',
    'categories': [
        'SIGN_UP'|'SIGN_IN'|'APPOINTMENT_BOOKING'|'LEAD_GENERATION'|'SHOPPING'|'CONTACT_US'|'CUSTOMER_SUPPORT'|'SURVEY'|'OTHER',
    ],
    'validationErrors': [
        'string',
    ],
    'jsonVersion': 'string',
    'dataApiVersion': 'string',
    'endpointUri': 'string',
    'preview': {
        'previewUrl': 'string',
        'expiresAt': 'string'
    },
    'whatsAppBusinessAccount': {
        'id': 'string',
        'name': 'string',
        'currency': 'string',
        'timezoneId': 'string',
        'messageTemplateNamespace': 'string'
    },
    'application': {
        'link': 'string',
        'name': 'string',
        'id': 'string'
    },
    'healthStatus': {
        'canSendMessage': 'string',
        'entities': [
            {
                'entityType': 'string',
                'id': 'string',
                'canSendMessage': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) –

    • flowId (string) –

      The unique identifier of the Flow.

    • flowName (string) –

      The name of the Flow.

    • flowStatus (string) –

      The lifecycle status of the Flow. Valid values are DRAFT, PUBLISHED, DEPRECATED, BLOCKED, and THROTTLED.

    • categories (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) –

    • jsonVersion (string) –

      The version of the Flow JSON schema used by this Flow (for example, 7.3).

    • dataApiVersion (string) –

      The data API version for data exchange endpoint Flows.

    • endpointUri (string) –

      The endpoint URI for data exchange Flows, if configured.

    • preview (dict) –

      The preview URL and its expiration timestamp for testing the Flow.

      • previewUrl (string) –

        The web URL for previewing the Flow. Can be shared with stakeholders for review.

      • expiresAt (string) –

        The timestamp when the preview URL expires.

    • whatsAppBusinessAccount (dict) –

      The WhatsApp Business Account information from Meta associated with this Flow.

      • id (string) –

        The WhatsApp Business Account ID from Meta.

      • name (string) –

        The name of the WhatsApp Business Account.

      • currency (string) –

        The currency code for the WhatsApp Business Account (for example, USD).

      • timezoneId (string) –

        The timezone ID for the WhatsApp Business Account.

      • messageTemplateNamespace (string) –

        The message template namespace for the WhatsApp Business Account.

    • application (dict) –

      The Meta application information associated with this Flow.

      • link (string) –

        The URL link for the Meta application.

      • name (string) –

        The name of the Meta application.

      • id (string) –

        The unique identifier of the Meta application.

    • healthStatus (dict) –

      The health status information for this Flow from Meta.

      • canSendMessage (string) –

        The overall messaging availability status (for example, AVAILABLE, LIMITED, or BLOCKED).

      • entities (list) –

        A list of health status entities with per-entity availability information.

        • (dict) –

          Represents a single entity in the health status check for a WhatsApp Flow.

          • entityType (string) –

            The type of entity (for example, FLOW, WABA, BUSINESS, or APP).

          • id (string) –

            The unique identifier of the entity.

          • canSendMessage (string) –

            The messaging availability status for this entity (for example, AVAILABLE, LIMITED, or BLOCKED).

Exceptions