Skip to content

SearchAvailablePhoneNumbersRequest

Source code in docs_src/capo_chime/types/search_available_phone_numbers_request.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
class SearchAvailablePhoneNumbersRequest(TypedDict, closed=True):
    area_code: NotRequired["capo_chime.types.string.String"]
    """<p>The area code used to filter results. Only applies to the US.</p>"""
    city: NotRequired["capo_chime.types.string.String"]
    """<p>The city used to filter results. Only applies to the US.</p>"""
    country: NotRequired["capo_chime.types.alpha2_country_code.Alpha2CountryCode"]
    """<p>The country used to filter results. Defaults to the US Format: ISO 3166-1 alpha-2.</p>"""
    state: NotRequired["capo_chime.types.string.String"]
    """<p>The state used to filter results. Required only if you provide <code>City</code>. Only applies to the US.</p>"""
    toll_free_prefix: NotRequired["capo_chime.types.toll_free_prefix.TollFreePrefix"]
    """<p>The toll-free prefix that you use to filter results. Only applies to the US.</p>"""
    phone_number_type: NotRequired["capo_chime.types.phone_number_type.PhoneNumberType"]
    """<p>The phone number type used to filter results. Required for non-US numbers.</p>"""
    max_results: NotRequired[
        "capo_chime.types.phone_number_max_results.PhoneNumberMaxResults"
    ]
    """<p>The maximum number of results to return in a single call.</p>"""
    next_token: NotRequired["capo_chime.types.string.String"]
    """<p>The token used to retrieve the next page of results.</p>"""

area_code instance-attribute 

area_code: NotRequired[String]

The area code used to filter results. Only applies to the US.

city instance-attribute 

city: NotRequired[String]

The city used to filter results. Only applies to the US.

country instance-attribute 

country: NotRequired[Alpha2CountryCode]

The country used to filter results. Defaults to the US Format: ISO 3166-1 alpha-2.

max_results instance-attribute 

max_results: NotRequired[PhoneNumberMaxResults]

The maximum number of results to return in a single call.

next_token instance-attribute 

next_token: NotRequired[String]

The token used to retrieve the next page of results.

phone_number_type instance-attribute 

phone_number_type: NotRequired[PhoneNumberType]

The phone number type used to filter results. Required for non-US numbers.

state instance-attribute 

state: NotRequired[String]

The state used to filter results. Required only if you provide City. Only applies to the US.

toll_free_prefix instance-attribute 

toll_free_prefix: NotRequired[TollFreePrefix]

The toll-free prefix that you use to filter results. Only applies to the US.