listPhoneNumbers method

Future<ListPhoneNumbersResponse> listPhoneNumbers({
  1. required String instanceId,
  2. int? maxResults,
  3. String? nextToken,
  4. List<PhoneNumberCountryCode>? phoneNumberCountryCodes,
  5. List<PhoneNumberType>? phoneNumberTypes,
})

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.

May throw InvalidRequestException. May throw InvalidParameterException. May throw ResourceNotFoundException. May throw ThrottlingException. May throw InternalServiceException.

Parameter instanceId : The identifier of the Amazon Connect instance.

Parameter maxResults : The maximimum number of results to return per page.

Parameter nextToken : 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.

Parameter phoneNumberCountryCodes : The ISO country code.

Parameter phoneNumberTypes : The type of phone number.

Implementation

Future<ListPhoneNumbersResponse> listPhoneNumbers({
  required String instanceId,
  int? maxResults,
  String? nextToken,
  List<PhoneNumberCountryCode>? phoneNumberCountryCodes,
  List<PhoneNumberType>? phoneNumberTypes,
}) async {
  ArgumentError.checkNotNull(instanceId, 'instanceId');
  _s.validateStringLength(
    'instanceId',
    instanceId,
    1,
    100,
    isRequired: true,
  );
  _s.validateNumRange(
    'maxResults',
    maxResults,
    1,
    1000,
  );
  final $query = <String, List<String>>{
    if (maxResults != null) 'maxResults': [maxResults.toString()],
    if (nextToken != null) 'nextToken': [nextToken],
    if (phoneNumberCountryCodes != null)
      'phoneNumberCountryCodes':
          phoneNumberCountryCodes.map((e) => e.toValue()).toList(),
    if (phoneNumberTypes != null)
      'phoneNumberTypes': phoneNumberTypes.map((e) => e.toValue()).toList(),
  };
  final response = await _protocol.send(
    payload: null,
    method: 'GET',
    requestUri: '/phone-numbers-summary/${Uri.encodeComponent(instanceId)}',
    queryParams: $query,
    exceptionFnMap: _exceptionFns,
  );
  return ListPhoneNumbersResponse.fromJson(response);
}