Skip to content

/AWS1/IF_PPM=>GETWHATSAPPFLOWPREVIEW()

About GetWhatsAppFlowPreview

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.

Method Signature

METHODS /AWS1/IF_PPM~GETWHATSAPPFLOWPREVIEW
  IMPORTING
    !IV_ID TYPE /AWS1/PPMLNKWHATSAPPBUSINESS00 OPTIONAL
    !IV_FLOWID TYPE /AWS1/PPMMETAFLOWID OPTIONAL
    !IV_INVALIDATE TYPE /AWS1/PPMBOOLEAN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ppmgtwhtsappflwprvout
  RAISING
    /AWS1/CX_PPMACCESSDENIEDEX
    /AWS1/CX_PPMVALIDATIONEX
    /AWS1/CX_PPMACCDENIEDBYMETAEX
    /AWS1/CX_PPMDEPENDENCYEX
    /AWS1/CX_PPMINTERNALSERVICEEX
    /AWS1/CX_PPMINVALIDPARAMSEX
    /AWS1/CX_PPMRESOURCENOTFOUNDEX
    /AWS1/CX_PPMTHROTTLEDREQUESTEX
    /AWS1/CX_PPMCLIENTEXC
    /AWS1/CX_PPMSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_id TYPE /AWS1/PPMLNKWHATSAPPBUSINESS00 /AWS1/PPMLNKWHATSAPPBUSINESS00

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

iv_flowid TYPE /AWS1/PPMMETAFLOWID /AWS1/PPMMETAFLOWID

The unique identifier of the Flow to preview.

Optional arguments:

iv_invalidate TYPE /AWS1/PPMBOOLEAN /AWS1/PPMBOOLEAN

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.

RETURNING

oo_output TYPE REF TO /aws1/cl_ppmgtwhtsappflwprvout /AWS1/CL_PPMGTWHTSAPPFLWPRVOUT

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->getwhatsappflowpreview(
  iv_flowid = |string|
  iv_id = |string|
  iv_invalidate = ABAP_TRUE
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_metaflowid = lo_result->get_flowid( ).
  lo_metaflowpreviewinfo = lo_result->get_preview( ).
  IF lo_metaflowpreviewinfo IS NOT INITIAL.
    lv_metaflowpreviewurl = lo_metaflowpreviewinfo->get_previewurl( ).
    lv_metaflowtimestamp = lo_metaflowpreviewinfo->get_expiresat( ).
  ENDIF.
ENDIF.