Skip to content

/AWS1/IF_CHV=>SEARCHAVAILABLEPHONENUMBERS()

About SearchAvailablePhoneNumbers

Searches the provisioned phone numbers in an organization.

Method Signature

METHODS /AWS1/IF_CHV~SEARCHAVAILABLEPHONENUMBERS
  IMPORTING
    !IV_AREACODE TYPE /AWS1/CHVSTRING OPTIONAL
    !IV_CITY TYPE /AWS1/CHVSTRING OPTIONAL
    !IV_COUNTRY TYPE /AWS1/CHVALPHA2COUNTRYCODE OPTIONAL
    !IV_STATE TYPE /AWS1/CHVSTRING OPTIONAL
    !IV_TOLLFREEPREFIX TYPE /AWS1/CHVTOLLFREEPREFIX OPTIONAL
    !IV_PHONENUMBERTYPE TYPE /AWS1/CHVPHONENUMBERTYPE OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/CHVPHONENUMBERMAXRESULTS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/CHVSTRING OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_chvsrchavailablepho01
  RAISING
    /AWS1/CX_CHVACCESSDENIEDEX
    /AWS1/CX_CHVBADREQUESTEX
    /AWS1/CX_CHVFORBIDDENEXCEPTION
    /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

Optional arguments:

iv_areacode TYPE /AWS1/CHVSTRING /AWS1/CHVSTRING

Confines a search to just the phone numbers associated with the specified area code.

iv_city TYPE /AWS1/CHVSTRING /AWS1/CHVSTRING

Confines a search to just the phone numbers associated with the specified city.

iv_country TYPE /AWS1/CHVALPHA2COUNTRYCODE /AWS1/CHVALPHA2COUNTRYCODE

Confines a search to just the phone numbers associated with the specified country.

iv_state TYPE /AWS1/CHVSTRING /AWS1/CHVSTRING

Confines a search to just the phone numbers associated with the specified state.

iv_tollfreeprefix TYPE /AWS1/CHVTOLLFREEPREFIX /AWS1/CHVTOLLFREEPREFIX

Confines a search to just the phone numbers associated with the specified toll-free prefix.

iv_phonenumbertype TYPE /AWS1/CHVPHONENUMBERTYPE /AWS1/CHVPHONENUMBERTYPE

Confines a search to just the phone numbers associated with the specified phone number type, either local or toll-free.

iv_maxresults TYPE /AWS1/CHVPHONENUMBERMAXRESULTS /AWS1/CHVPHONENUMBERMAXRESULTS

The maximum number of results to return.

iv_nexttoken TYPE /AWS1/CHVSTRING /AWS1/CHVSTRING

The token used to return the next page of results.

RETURNING

oo_output TYPE REF TO /aws1/cl_chvsrchavailablepho01 /AWS1/CL_CHVSRCHAVAILABLEPHO01

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->searchavailablephonenumbers(
  iv_areacode = |string|
  iv_city = |string|
  iv_country = |string|
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_phonenumbertype = |string|
  iv_state = |string|
  iv_tollfreeprefix = |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_e164phonenumbers( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_e164phonenumber = lo_row_1->get_value( ).
    ENDIF.
  ENDLOOP.
  lv_string = lo_result->get_nexttoken( ).
ENDIF.