Skip to content

get_whats_app_flow_preview

get_whats_app_flow_preview(
    id: LinkedWhatsAppBusinessAccountId,
    flow_id: MetaFlowId,
    *,
    config_overrides: Optional[SocialMessagingClientConfig] = None,
    invalidate: Optional[bool] = None,
) -> GetWhatsAppFlowPreviewOutput

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.

Parameters:

  • id (LinkedWhatsAppBusinessAccountId) –

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

  • flow_id (MetaFlowId) –

    The unique identifier of the Flow to preview.

  • invalidate (Optional[bool], default: None ) –

    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.

Raises:

Source code in docs_src/capo_socialmessaging/_services/social_messaging.py
def get_whats_app_flow_preview(
    self,
    id: "capo_socialmessaging.types.linked_whats_app_business_account_id.LinkedWhatsAppBusinessAccountId",
    flow_id: "capo_socialmessaging.types.meta_flow_id.MetaFlowId",
    *,
    config_overrides: Optional[SocialMessagingClientConfig] = None,
    invalidate: Optional[bool] = None,
) -> "capo_socialmessaging.types.get_whats_app_flow_preview_output.GetWhatsAppFlowPreviewOutput":
    """<p>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.</p>

    Args:
        id: <p>The ID of the WhatsApp Business Account associated with this Flow.</p>
        flow_id: <p>The unique identifier of the Flow to preview.</p>
        invalidate: <p>Set to <code>true</code> to force generation of a new preview URL. Use this if the previous URL has been compromised or you want a fresh expiration period.</p>

    Raises:
        capo_socialmessaging.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_socialmessaging.errors.validation_exception.ValidationException: <p>The request contains an invalid parameter value. </p>
        capo_socialmessaging.errors.access_denied_by_meta_exception.AccessDeniedByMetaException: <p>You do not have sufficient access to perform this action.</p>
        capo_socialmessaging.errors.dependency_exception.DependencyException: <p>Thrown when performing an action because a dependency would be broken.</p>
        capo_socialmessaging.errors.internal_service_exception.InternalServiceException: <p>The request processing has failed because of an unknown error, exception, or failure.</p>
        capo_socialmessaging.errors.invalid_parameters_exception.InvalidParametersException: <p>One or more parameters provided to the action are not valid.</p>
        capo_socialmessaging.errors.resource_not_found_exception.ResourceNotFoundException: <p>The resource was not found.</p>
        capo_socialmessaging.errors.throttled_request_exception.ThrottledRequestException: <p>The request was denied due to request throttling.</p>
        capo_socialmessaging.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_socialmessaging.types.get_whats_app_flow_preview_input.GetWhatsAppFlowPreviewInput]",
    ) -> OperationResponse[
        "capo_socialmessaging.types.get_whats_app_flow_preview_output.GetWhatsAppFlowPreviewOutput"
    ]:
        import capo_socialmessaging._operations.social_messaging.get_whats_app_flow_preview

        output, http_response = (
            capo_socialmessaging._operations.social_messaging.get_whats_app_flow_preview.get_whats_app_flow_preview(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetWhatsAppFlowPreview")
    )
    input_: capo_socialmessaging.types.get_whats_app_flow_preview_input.GetWhatsAppFlowPreviewInput = {
        "id": id,
        "flow_id": flow_id,
    }
    if invalidate is not None:
        input_["invalidate"] = invalidate

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output