search_available_phone_numbers

ChimeSDKVoice.Client.search_available_phone_numbers(**kwargs)

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) --
• City (string) --
• Country (string) --
• State (string) --
• TollFreePrefix (string) --
• PhoneNumberType (string) --
• MaxResults (integer) --
• NextToken (string) --

Return type

dict

Returns

Response Syntax

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

Response Structure

• (dict) --
  • E164PhoneNumbers (list) --
    • (string) --
  • NextToken (string) --

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