/AWS1/IF_CHV=>CREATEPROXYSESSION()

About CreateProxySession

Creates a proxy session for the specified Amazon Chime SDK Voice Connector for the specified participant phone numbers.

Method Signature

METHODS /AWS1/IF_CHV~CREATEPROXYSESSION
  IMPORTING
    !IV_VOICECONNECTORID TYPE /AWS1/CHVNONEMPTYSTRING128 OPTIONAL
    !IT_PARTICIPANTPHONENUMBERS TYPE /AWS1/CL_CHVPARTICIPANTPHONE00=>TT_PARTICIPANTPHONENUMBERLIST OPTIONAL
    !IV_NAME TYPE /AWS1/CHVPROXYSESSNAMESTRING OPTIONAL
    !IV_EXPIRYMINUTES TYPE /AWS1/CHVPOSITIVEINTEGER OPTIONAL
    !IT_CAPABILITIES TYPE /AWS1/CL_CHVCAPABILITYLIST_W=>TT_CAPABILITYLIST OPTIONAL
    !IV_NUMBERSELECTIONBEHAVIOR TYPE /AWS1/CHVNUMBERSELECTIONBEHAV OPTIONAL
    !IV_GEOMATCHLEVEL TYPE /AWS1/CHVGEOMATCHLEVEL OPTIONAL
    !IO_GEOMATCHPARAMS TYPE REF TO /AWS1/CL_CHVGEOMATCHPARAMS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_chvcreateproxysessrsp
  RAISING
    /AWS1/CX_CHVBADREQUESTEX
    /AWS1/CX_CHVFORBIDDENEXCEPTION
    /AWS1/CX_CHVNOTFOUNDEXCEPTION
    /AWS1/CX_CHVSERVICEFAILUREEX
    /AWS1/CX_CHVSERVICEUNAVAILEX
    /AWS1/CX_CHVTHROTTLEDCLIENTEX
    /AWS1/CX_CHVUNAUTHDCLIENTEX
    /AWS1/CX_CHVCLIENTEXC
    /AWS1/CX_CHVSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_voiceconnectorid TYPE /AWS1/CHVNONEMPTYSTRING128 /AWS1/CHVNONEMPTYSTRING128

The Voice Connector ID.

it_participantphonenumbers TYPE /AWS1/CL_CHVPARTICIPANTPHONE00=>TT_PARTICIPANTPHONENUMBERLIST TT_PARTICIPANTPHONENUMBERLIST

The participant phone numbers.

it_capabilities TYPE /AWS1/CL_CHVCAPABILITYLIST_W=>TT_CAPABILITYLIST TT_CAPABILITYLIST

The proxy session's capabilities.

Optional arguments:

iv_name TYPE /AWS1/CHVPROXYSESSNAMESTRING /AWS1/CHVPROXYSESSNAMESTRING

The name of the proxy session.

iv_expiryminutes TYPE /AWS1/CHVPOSITIVEINTEGER /AWS1/CHVPOSITIVEINTEGER

The number of minutes allowed for the proxy session.

iv_numberselectionbehavior TYPE /AWS1/CHVNUMBERSELECTIONBEHAV /AWS1/CHVNUMBERSELECTIONBEHAV

The preference for proxy phone number reuse, or stickiness, between the same participants across sessions.

iv_geomatchlevel TYPE /AWS1/CHVGEOMATCHLEVEL /AWS1/CHVGEOMATCHLEVEL

The preference for matching the country or area code of the proxy phone number with that of the first participant.

io_geomatchparams TYPE REF TO /AWS1/CL_CHVGEOMATCHPARAMS /AWS1/CL_CHVGEOMATCHPARAMS

The country and area code for the proxy phone number.

RETURNING

oo_output TYPE REF TO /aws1/cl_chvcreateproxysessrsp /AWS1/CL_CHVCREATEPROXYSESSRSP

Domain	/AWS1/RT_ACCOUNT_ID
Primitive Type	NUMC

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->createproxysession(
  io_geomatchparams = new /aws1/cl_chvgeomatchparams(
    iv_areacode = |string|
    iv_country = |string|
  )
  it_capabilities = VALUE /aws1/cl_chvcapabilitylist_w=>tt_capabilitylist(
    ( new /aws1/cl_chvcapabilitylist_w( |string| ) )
  )
  it_participantphonenumbers = VALUE /aws1/cl_chvparticipantphone00=>tt_participantphonenumberlist(
    ( new /aws1/cl_chvparticipantphone00( |string| ) )
  )
  iv_expiryminutes = 123
  iv_geomatchlevel = |string|
  iv_name = |string|
  iv_numberselectionbehavior = |string|
  iv_voiceconnectorid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_proxysession = lo_result->get_proxysession( ).
  IF lo_proxysession IS NOT INITIAL.
    lv_nonemptystring128 = lo_proxysession->get_voiceconnectorid( ).
    lv_nonemptystring128 = lo_proxysession->get_proxysessionid( ).
    lv_string128 = lo_proxysession->get_name( ).
    lv_proxysessionstatus = lo_proxysession->get_status( ).
    lv_positiveinteger = lo_proxysession->get_expiryminutes( ).
    LOOP AT lo_proxysession->get_capabilities( ) into lo_row.
      lo_row_1 = lo_row.
      IF lo_row_1 IS NOT INITIAL.
        lv_capability = lo_row_1->get_value( ).
      ENDIF.
    ENDLOOP.
    lv_iso8601timestamp = lo_proxysession->get_createdtimestamp( ).
    lv_iso8601timestamp = lo_proxysession->get_updatedtimestamp( ).
    lv_iso8601timestamp = lo_proxysession->get_endedtimestamp( ).
    LOOP AT lo_proxysession->get_participants( ) into lo_row_2.
      lo_row_3 = lo_row_2.
      IF lo_row_3 IS NOT INITIAL.
        lv_e164phonenumber = lo_row_3->get_phonenumber( ).
        lv_e164phonenumber = lo_row_3->get_proxyphonenumber( ).
      ENDIF.
    ENDLOOP.
    lv_numberselectionbehavior = lo_proxysession->get_numberselectionbehavior( ).
    lv_geomatchlevel = lo_proxysession->get_geomatchlevel( ).
    lo_geomatchparams = lo_proxysession->get_geomatchparams( ).
    IF lo_geomatchparams IS NOT INITIAL.
      lv_country = lo_geomatchparams->get_country( ).
      lv_areacode = lo_geomatchparams->get_areacode( ).
    ENDIF.
  ENDIF.
ENDIF.