ChimeSDKVoice / Client / search_available_phone_numbers

search_available_phone_numbers#

ChimeSDKVoice.Client.search_available_phone_numbers(**kwargs)#

Searches the provisioned phone numbers in an organization.

See also: AWS API Documentation

Request Syntax

response = client.search_available_phone_numbers(
    AreaCode='string',
    City='string',
    Country='string',
    State='string',
    TollFreePrefix='string',
    PhoneNumberType='Local'|'TollFree',
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • AreaCode (string) – Confines a search to just the phone numbers associated with the specified area code.

  • City (string) – Confines a search to just the phone numbers associated with the specified city.

  • Country (string) – Confines a search to just the phone numbers associated with the specified country.

  • State (string) – Confines a search to just the phone numbers associated with the specified state.

  • TollFreePrefix (string) – Confines a search to just the phone numbers associated with the specified toll-free prefix.

  • PhoneNumberType (string) – Confines a search to just the phone numbers associated with the specified phone number type, either local or toll-free.

  • MaxResults (integer) – The maximum number of results to return.

  • NextToken (string) – The token used to return the next page of results.

Return type:

dict

Returns:

Response Syntax

{
    'E164PhoneNumbers': [
        'string',
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • E164PhoneNumbers (list) –

      Confines a search to just the phone numbers in the E.164 format.

      • (string) –

    • NextToken (string) –

      The token used to return the next page of results.

Exceptions

  • ChimeSDKVoice.Client.exceptions.BadRequestException

  • ChimeSDKVoice.Client.exceptions.ForbiddenException

  • ChimeSDKVoice.Client.exceptions.AccessDeniedException

  • ChimeSDKVoice.Client.exceptions.UnauthorizedClientException

  • ChimeSDKVoice.Client.exceptions.ThrottledClientException

  • ChimeSDKVoice.Client.exceptions.ServiceUnavailableException

  • ChimeSDKVoice.Client.exceptions.ServiceFailureException