EndUserMessagingSocial / Client / get_whatsapp_flow_preview

get_whatsapp_flow_preview

EndUserMessagingSocial.Client.get_whatsapp_flow_preview(**kwargs)

Generates a web preview URL for testing a WhatsApp Flow before publishing. Preview URLs expire in 30 days and can be shared with stakeholders for review.

See also: AWS API Documentation

Request Syntax

response = client.get_whatsapp_flow_preview(
    id='string',
    flowId='string',
    invalidate=True|False
)
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 preview.

  • invalidate (boolean) – Set to true to force generation of a new preview URL. Use this if the previous URL has been compromised or you want a fresh expiration period.

Return type:

dict

Returns:

Response Syntax

{
    'flowId': 'string',
    'preview': {
        'previewUrl': 'string',
        'expiresAt': 'string'
    }
}

Response Structure

  • (dict) –

    • flowId (string) –

      The unique identifier of the Flow.

    • preview (dict) –

      The preview URL and its expiration timestamp.

      • 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.

Exceptions