/AWS1/IF_CNT=>LISTPHONENUMBERS()

About ListPhoneNumbers

Provides information about the phone numbers for the specified Amazon Connect instance.

For more information about phone numbers, see Set Up Phone Numbers for Your Contact Center in the Amazon Connect Administrator Guide.

• We recommend using ListPhoneNumbersV2 to return phone number types. ListPhoneNumbers doesn't support number types UIFN, SHARED, THIRD_PARTY_TF, and THIRD_PARTY_DID. While it returns numbers of those types, it incorrectly lists them as TOLL_FREE or DID.

• The phone number Arn value that is returned from each of the items in the PhoneNumberSummaryList cannot be used to tag phone number resources. It will fail with a ResourceNotFoundException. Instead, use the ListPhoneNumbersV2 API. It returns the new phone number ARN that can be used to tag phone number resources.

Method Signature

METHODS /AWS1/IF_CNT~LISTPHONENUMBERS
  IMPORTING
    !IV_INSTANCEID TYPE /AWS1/CNTINSTANCEID OPTIONAL
    !IT_PHONENUMBERTYPES TYPE /AWS1/CL_CNTPHONENUMBERTYPES_W=>TT_PHONENUMBERTYPES OPTIONAL
    !IT_PHONENUMBERCOUNTRYCODES TYPE /AWS1/CL_CNTPHONENOCTRYCODES_W=>TT_PHONENUMBERCOUNTRYCODES OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/CNTNEXTTOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/CNTMAXRESULT1000 OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_cntlistphonenumsrsp
  RAISING
    /AWS1/CX_CNTINTERNALSERVICEEX
    /AWS1/CX_CNTINVALIDPARAMETEREX
    /AWS1/CX_CNTINVALIDREQUESTEX
    /AWS1/CX_CNTRESOURCENOTFOUNDEX
    /AWS1/CX_CNTTHROTTLINGEX
    /AWS1/CX_CNTCLIENTEXC
    /AWS1/CX_CNTSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_instanceid TYPE /AWS1/CNTINSTANCEID /AWS1/CNTINSTANCEID

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Optional arguments:

it_phonenumbertypes TYPE /AWS1/CL_CNTPHONENUMBERTYPES_W=>TT_PHONENUMBERTYPES TT_PHONENUMBERTYPES

The type of phone number.

We recommend using ListPhoneNumbersV2 to return phone number types. While ListPhoneNumbers returns number types UIFN, SHARED, THIRD_PARTY_TF, and THIRD_PARTY_DID, it incorrectly lists them as TOLL_FREE or DID.

it_phonenumbercountrycodes TYPE /AWS1/CL_CNTPHONENOCTRYCODES_W=>TT_PHONENUMBERCOUNTRYCODES TT_PHONENUMBERCOUNTRYCODES

The ISO country code.

iv_nexttoken TYPE /AWS1/CNTNEXTTOKEN /AWS1/CNTNEXTTOKEN

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

iv_maxresults TYPE /AWS1/CNTMAXRESULT1000 /AWS1/CNTMAXRESULT1000

The maximum number of results to return per page. The default MaxResult size is 100.

RETURNING

oo_output TYPE REF TO /aws1/cl_cntlistphonenumsrsp /AWS1/CL_CNTLISTPHONENUMSRSP

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->listphonenumbers(
  it_phonenumbercountrycodes = VALUE /aws1/cl_cntphonenoctrycodes_w=>tt_phonenumbercountrycodes(
    ( new /aws1/cl_cntphonenoctrycodes_w( |string| ) )
  )
  it_phonenumbertypes = VALUE /aws1/cl_cntphonenumbertypes_w=>tt_phonenumbertypes(
    ( new /aws1/cl_cntphonenumbertypes_w( |string| ) )
  )
  iv_instanceid = |string|
  iv_maxresults = 123
  iv_nexttoken = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  LOOP AT lo_result->get_phonenumbersummarylist( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_phonenumberid = lo_row_1->get_id( ).
      lv_arn = lo_row_1->get_arn( ).
      lv_phonenumber = lo_row_1->get_phonenumber( ).
      lv_phonenumbertype = lo_row_1->get_phonenumbertype( ).
      lv_phonenumbercountrycode = lo_row_1->get_phonenumbercountrycode( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.