Skip to content

SearchAvailablePhoneNumbersRequest

Source code in docs_src/capo_chime_sdk_voice/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
34
35
36
37
38
39
class SearchAvailablePhoneNumbersRequest(TypedDict, closed=True):
    area_code: NotRequired["capo_chime_sdk_voice.types.string.String"]
    """<p>Confines a search to just the phone numbers associated with the specified area code.</p>"""
    city: NotRequired["capo_chime_sdk_voice.types.string.String"]
    """<p>Confines a search to just the phone numbers associated with the specified city.</p>"""
    country: NotRequired[
        "capo_chime_sdk_voice.types.alpha2_country_code.Alpha2CountryCode"
    ]
    """<p>Confines a search to just the phone numbers associated with the specified country.</p>"""
    state: NotRequired["capo_chime_sdk_voice.types.string.String"]
    """<p>Confines a search to just the phone numbers associated with the specified state.</p>"""
    toll_free_prefix: NotRequired[
        "capo_chime_sdk_voice.types.toll_free_prefix.TollFreePrefix"
    ]
    """<p>Confines a search to just the phone numbers associated with the specified toll-free prefix.</p>"""
    phone_number_type: NotRequired[
        "capo_chime_sdk_voice.types.phone_number_type.PhoneNumberType"
    ]
    """<p>Confines a search to just the phone numbers associated with the specified phone number type, either <b>local</b> or <b>toll-free</b>.</p>"""
    max_results: NotRequired[
        "capo_chime_sdk_voice.types.phone_number_max_results.PhoneNumberMaxResults"
    ]
    """<p>The maximum number of results to return.</p>"""
    next_token: NotRequired["capo_chime_sdk_voice.types.string.String"]
    """<p>The token used to return the next page of results.</p>"""

area_code instance-attribute 

area_code: NotRequired[String]

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

city instance-attribute 

city: NotRequired[String]

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

country instance-attribute 

country: NotRequired[Alpha2CountryCode]

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

max_results instance-attribute 

max_results: NotRequired[PhoneNumberMaxResults]

The maximum number of results to return.

next_token instance-attribute 

next_token: NotRequired[String]

The token used to return the next page of results.

phone_number_type instance-attribute 

phone_number_type: NotRequired[PhoneNumberType]

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

state instance-attribute 

state: NotRequired[String]

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

toll_free_prefix instance-attribute 

toll_free_prefix: NotRequired[TollFreePrefix]

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