Skip to content

/AWS1/IF_PPM=>GETWHATSAPPFLOW()

About GetWhatsAppFlow

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

Method Signature

METHODS /AWS1/IF_PPM~GETWHATSAPPFLOW
  IMPORTING
    !IV_ID TYPE /AWS1/PPMLNKWHATSAPPBUSINESS00 OPTIONAL
    !IV_FLOWID TYPE /AWS1/PPMMETAFLOWID OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ppmgetwhatsappflowout
  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 retrieve.

RETURNING

oo_output TYPE REF TO /aws1/cl_ppmgetwhatsappflowout /AWS1/CL_PPMGETWHATSAPPFLOWOUT

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->getwhatsappflow(
  iv_flowid = |string|
  iv_id = |string|
).

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( ).
  lv_metaflowname = lo_result->get_flowname( ).
  lv_metaflowstatus = lo_result->get_flowstatus( ).
  LOOP AT lo_result->get_categories( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_metaflowcategory = lo_row_1->get_value( ).
    ENDIF.
  ENDLOOP.
  LOOP AT lo_result->get_validationerrors( ) into lo_row_2.
    lo_row_3 = lo_row_2.
    IF lo_row_3 IS NOT INITIAL.
      lv_metaflowvalidationerror = lo_row_3->get_value( ).
    ENDIF.
  ENDLOOP.
  lv_metaflowjsonversion = lo_result->get_jsonversion( ).
  lv_metaflowdataapiversion = lo_result->get_dataapiversion( ).
  lv_metaflowendpointuri = lo_result->get_endpointuri( ).
  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.
  lo_metaflowwhatsappbusines = lo_result->get_whatsappbusinessaccount( ).
  IF lo_metaflowwhatsappbusines IS NOT INITIAL.
    lv_whatsappbusinessaccount = lo_metaflowwhatsappbusines->get_id( ).
    lv_whatsappbusinessaccount_1 = lo_metaflowwhatsappbusines->get_name( ).
    lv_metaflowwabacurrency = lo_metaflowwhatsappbusines->get_currency( ).
    lv_metaflowwabatimezoneid = lo_metaflowwhatsappbusines->get_timezoneid( ).
    lv_metaflowwabatemplatenam = lo_metaflowwhatsappbusines->get_messagetemplatenamespace( ).
  ENDIF.
  lo_metaflowapplicationinfo = lo_result->get_application( ).
  IF lo_metaflowapplicationinfo IS NOT INITIAL.
    lv_metaflowapplicationlink = lo_metaflowapplicationinfo->get_link( ).
    lv_metaflowapplicationname = lo_metaflowapplicationinfo->get_name( ).
    lv_metaflowapplicationid = lo_metaflowapplicationinfo->get_id( ).
  ENDIF.
  lo_metaflowhealthstatus = lo_result->get_healthstatus( ).
  IF lo_metaflowhealthstatus IS NOT INITIAL.
    lv_metaflowhealthstatusava = lo_metaflowhealthstatus->get_cansendmessage( ).
    LOOP AT lo_metaflowhealthstatus->get_entities( ) into lo_row_4.
      lo_row_5 = lo_row_4.
      IF lo_row_5 IS NOT INITIAL.
        lv_metaflowhealthentitytyp = lo_row_5->get_entitytype( ).
        lv_string = lo_row_5->get_id( ).
        lv_metaflowhealthstatusava = lo_row_5->get_cansendmessage( ).
      ENDIF.
    ENDLOOP.
  ENDIF.
ENDIF.