class Twilio::AvailablePhoneNumbersApi
- Twilio::AvailablePhoneNumbersApi
- Reference
- Object
Defined in:
twilio/api/available_phone_numbers_api.crConstant Summary
-
FETCH_AVAILABLE_PHONE_NUMBER_COUNTRY_MAX_LENGTH_FOR_ACCOUNT_SID =
34
-
FETCH_AVAILABLE_PHONE_NUMBER_COUNTRY_MIN_LENGTH_FOR_ACCOUNT_SID =
34
-
FETCH_AVAILABLE_PHONE_NUMBER_COUNTRY_PATTERN_FOR_ACCOUNT_SID =
/^AC[0-9a-fA-F]{32}$/
-
LIST_AVAILABLE_PHONE_NUMBER_COUNTRY_MAX_FOR_PAGE_SIZE =
Int32.new("1000")
-
LIST_AVAILABLE_PHONE_NUMBER_COUNTRY_MAX_LENGTH_FOR_ACCOUNT_SID =
34
-
LIST_AVAILABLE_PHONE_NUMBER_COUNTRY_MIN_FOR_PAGE_SIZE =
Int32.new("1")
-
LIST_AVAILABLE_PHONE_NUMBER_COUNTRY_MIN_LENGTH_FOR_ACCOUNT_SID =
34
-
LIST_AVAILABLE_PHONE_NUMBER_COUNTRY_PATTERN_FOR_ACCOUNT_SID =
/^AC[0-9a-fA-F]{32}$/
-
LIST_AVAILABLE_PHONE_NUMBER_LOCAL_MAX_FOR_PAGE_SIZE =
Int32.new("1000")
-
LIST_AVAILABLE_PHONE_NUMBER_LOCAL_MAX_LENGTH_FOR_ACCOUNT_SID =
34
-
LIST_AVAILABLE_PHONE_NUMBER_LOCAL_MIN_FOR_PAGE_SIZE =
Int32.new("1")
-
LIST_AVAILABLE_PHONE_NUMBER_LOCAL_MIN_LENGTH_FOR_ACCOUNT_SID =
34
-
LIST_AVAILABLE_PHONE_NUMBER_LOCAL_PATTERN_FOR_ACCOUNT_SID =
/^AC[0-9a-fA-F]{32}$/
-
LIST_AVAILABLE_PHONE_NUMBER_MACHINE_TO_MACHINE_MAX_FOR_PAGE_SIZE =
Int32.new("1000")
-
LIST_AVAILABLE_PHONE_NUMBER_MACHINE_TO_MACHINE_MAX_LENGTH_FOR_ACCOUNT_SID =
34
-
LIST_AVAILABLE_PHONE_NUMBER_MACHINE_TO_MACHINE_MIN_FOR_PAGE_SIZE =
Int32.new("1")
-
LIST_AVAILABLE_PHONE_NUMBER_MACHINE_TO_MACHINE_MIN_LENGTH_FOR_ACCOUNT_SID =
34
-
LIST_AVAILABLE_PHONE_NUMBER_MACHINE_TO_MACHINE_PATTERN_FOR_ACCOUNT_SID =
/^AC[0-9a-fA-F]{32}$/
-
LIST_AVAILABLE_PHONE_NUMBER_MOBILE_MAX_FOR_PAGE_SIZE =
Int32.new("1000")
-
LIST_AVAILABLE_PHONE_NUMBER_MOBILE_MAX_LENGTH_FOR_ACCOUNT_SID =
34
-
LIST_AVAILABLE_PHONE_NUMBER_MOBILE_MIN_FOR_PAGE_SIZE =
Int32.new("1")
-
LIST_AVAILABLE_PHONE_NUMBER_MOBILE_MIN_LENGTH_FOR_ACCOUNT_SID =
34
-
LIST_AVAILABLE_PHONE_NUMBER_MOBILE_PATTERN_FOR_ACCOUNT_SID =
/^AC[0-9a-fA-F]{32}$/
-
LIST_AVAILABLE_PHONE_NUMBER_NATIONAL_MAX_FOR_PAGE_SIZE =
Int32.new("1000")
-
LIST_AVAILABLE_PHONE_NUMBER_NATIONAL_MAX_LENGTH_FOR_ACCOUNT_SID =
34
-
LIST_AVAILABLE_PHONE_NUMBER_NATIONAL_MIN_FOR_PAGE_SIZE =
Int32.new("1")
-
LIST_AVAILABLE_PHONE_NUMBER_NATIONAL_MIN_LENGTH_FOR_ACCOUNT_SID =
34
-
LIST_AVAILABLE_PHONE_NUMBER_NATIONAL_PATTERN_FOR_ACCOUNT_SID =
/^AC[0-9a-fA-F]{32}$/
-
LIST_AVAILABLE_PHONE_NUMBER_SHARED_COST_MAX_FOR_PAGE_SIZE =
Int32.new("1000")
-
LIST_AVAILABLE_PHONE_NUMBER_SHARED_COST_MAX_LENGTH_FOR_ACCOUNT_SID =
34
-
LIST_AVAILABLE_PHONE_NUMBER_SHARED_COST_MIN_FOR_PAGE_SIZE =
Int32.new("1")
-
LIST_AVAILABLE_PHONE_NUMBER_SHARED_COST_MIN_LENGTH_FOR_ACCOUNT_SID =
34
-
LIST_AVAILABLE_PHONE_NUMBER_SHARED_COST_PATTERN_FOR_ACCOUNT_SID =
/^AC[0-9a-fA-F]{32}$/
-
LIST_AVAILABLE_PHONE_NUMBER_TOLL_FREE_MAX_FOR_PAGE_SIZE =
Int32.new("1000")
-
LIST_AVAILABLE_PHONE_NUMBER_TOLL_FREE_MAX_LENGTH_FOR_ACCOUNT_SID =
34
-
LIST_AVAILABLE_PHONE_NUMBER_TOLL_FREE_MIN_FOR_PAGE_SIZE =
Int32.new("1")
-
LIST_AVAILABLE_PHONE_NUMBER_TOLL_FREE_MIN_LENGTH_FOR_ACCOUNT_SID =
34
-
LIST_AVAILABLE_PHONE_NUMBER_TOLL_FREE_PATTERN_FOR_ACCOUNT_SID =
/^AC[0-9a-fA-F]{32}$/
-
LIST_AVAILABLE_PHONE_NUMBER_VOIP_MAX_FOR_PAGE_SIZE =
Int32.new("1000")
-
LIST_AVAILABLE_PHONE_NUMBER_VOIP_MAX_LENGTH_FOR_ACCOUNT_SID =
34
-
LIST_AVAILABLE_PHONE_NUMBER_VOIP_MIN_FOR_PAGE_SIZE =
Int32.new("1")
-
LIST_AVAILABLE_PHONE_NUMBER_VOIP_MIN_LENGTH_FOR_ACCOUNT_SID =
34
-
LIST_AVAILABLE_PHONE_NUMBER_VOIP_PATTERN_FOR_ACCOUNT_SID =
/^AC[0-9a-fA-F]{32}$/
Constructors
Instance Method Summary
- #account_sid : String
- #account_sid=(account_sid : String)
- #api_client : ApiClient
- #api_client=(api_client : ApiClient)
-
#build_api_request_for_fetch_available_phone_number_country(*, account_sid : String | Nil = @account_sid, country_code : String | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_list_available_phone_number_country(*, account_sid : String | Nil = @account_sid, page_size : Int32 | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_list_available_phone_number_local(*, account_sid : String | Nil = @account_sid, country_code : String | Nil = nil, area_code : Int32 | Nil = nil, contains : String | Nil = nil, sms_enabled : Bool | Nil = nil, mms_enabled : Bool | Nil = nil, voice_enabled : Bool | Nil = nil, exclude_all_address_required : Bool | Nil = nil, exclude_local_address_required : Bool | Nil = nil, exclude_foreign_address_required : Bool | Nil = nil, beta : Bool | Nil = nil, near_number : String | Nil = nil, near_lat_long : String | Nil = nil, distance : Int32 | Nil = nil, in_postal_code : String | Nil = nil, in_region : String | Nil = nil, in_rate_center : String | Nil = nil, in_lata : String | Nil = nil, in_locality : String | Nil = nil, fax_enabled : Bool | Nil = nil, page_size : Int32 | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_list_available_phone_number_machine_to_machine(*, account_sid : String | Nil = @account_sid, country_code : String | Nil = nil, area_code : Int32 | Nil = nil, contains : String | Nil = nil, sms_enabled : Bool | Nil = nil, mms_enabled : Bool | Nil = nil, voice_enabled : Bool | Nil = nil, exclude_all_address_required : Bool | Nil = nil, exclude_local_address_required : Bool | Nil = nil, exclude_foreign_address_required : Bool | Nil = nil, beta : Bool | Nil = nil, near_number : String | Nil = nil, near_lat_long : String | Nil = nil, distance : Int32 | Nil = nil, in_postal_code : String | Nil = nil, in_region : String | Nil = nil, in_rate_center : String | Nil = nil, in_lata : String | Nil = nil, in_locality : String | Nil = nil, fax_enabled : Bool | Nil = nil, page_size : Int32 | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_list_available_phone_number_mobile(*, account_sid : String | Nil = @account_sid, country_code : String | Nil = nil, area_code : Int32 | Nil = nil, contains : String | Nil = nil, sms_enabled : Bool | Nil = nil, mms_enabled : Bool | Nil = nil, voice_enabled : Bool | Nil = nil, exclude_all_address_required : Bool | Nil = nil, exclude_local_address_required : Bool | Nil = nil, exclude_foreign_address_required : Bool | Nil = nil, beta : Bool | Nil = nil, near_number : String | Nil = nil, near_lat_long : String | Nil = nil, distance : Int32 | Nil = nil, in_postal_code : String | Nil = nil, in_region : String | Nil = nil, in_rate_center : String | Nil = nil, in_lata : String | Nil = nil, in_locality : String | Nil = nil, fax_enabled : Bool | Nil = nil, page_size : Int32 | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_list_available_phone_number_national(*, account_sid : String | Nil = @account_sid, country_code : String | Nil = nil, area_code : Int32 | Nil = nil, contains : String | Nil = nil, sms_enabled : Bool | Nil = nil, mms_enabled : Bool | Nil = nil, voice_enabled : Bool | Nil = nil, exclude_all_address_required : Bool | Nil = nil, exclude_local_address_required : Bool | Nil = nil, exclude_foreign_address_required : Bool | Nil = nil, beta : Bool | Nil = nil, near_number : String | Nil = nil, near_lat_long : String | Nil = nil, distance : Int32 | Nil = nil, in_postal_code : String | Nil = nil, in_region : String | Nil = nil, in_rate_center : String | Nil = nil, in_lata : String | Nil = nil, in_locality : String | Nil = nil, fax_enabled : Bool | Nil = nil, page_size : Int32 | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_list_available_phone_number_shared_cost(*, account_sid : String | Nil = @account_sid, country_code : String | Nil = nil, area_code : Int32 | Nil = nil, contains : String | Nil = nil, sms_enabled : Bool | Nil = nil, mms_enabled : Bool | Nil = nil, voice_enabled : Bool | Nil = nil, exclude_all_address_required : Bool | Nil = nil, exclude_local_address_required : Bool | Nil = nil, exclude_foreign_address_required : Bool | Nil = nil, beta : Bool | Nil = nil, near_number : String | Nil = nil, near_lat_long : String | Nil = nil, distance : Int32 | Nil = nil, in_postal_code : String | Nil = nil, in_region : String | Nil = nil, in_rate_center : String | Nil = nil, in_lata : String | Nil = nil, in_locality : String | Nil = nil, fax_enabled : Bool | Nil = nil, page_size : Int32 | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_list_available_phone_number_toll_free(*, account_sid : String | Nil = @account_sid, country_code : String | Nil = nil, area_code : Int32 | Nil = nil, contains : String | Nil = nil, sms_enabled : Bool | Nil = nil, mms_enabled : Bool | Nil = nil, voice_enabled : Bool | Nil = nil, exclude_all_address_required : Bool | Nil = nil, exclude_local_address_required : Bool | Nil = nil, exclude_foreign_address_required : Bool | Nil = nil, beta : Bool | Nil = nil, near_number : String | Nil = nil, near_lat_long : String | Nil = nil, distance : Int32 | Nil = nil, in_postal_code : String | Nil = nil, in_region : String | Nil = nil, in_rate_center : String | Nil = nil, in_lata : String | Nil = nil, in_locality : String | Nil = nil, fax_enabled : Bool | Nil = nil, page_size : Int32 | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_list_available_phone_number_voip(*, account_sid : String | Nil = @account_sid, country_code : String | Nil = nil, area_code : Int32 | Nil = nil, contains : String | Nil = nil, sms_enabled : Bool | Nil = nil, mms_enabled : Bool | Nil = nil, voice_enabled : Bool | Nil = nil, exclude_all_address_required : Bool | Nil = nil, exclude_local_address_required : Bool | Nil = nil, exclude_foreign_address_required : Bool | Nil = nil, beta : Bool | Nil = nil, near_number : String | Nil = nil, near_lat_long : String | Nil = nil, distance : Int32 | Nil = nil, in_postal_code : String | Nil = nil, in_region : String | Nil = nil, in_rate_center : String | Nil = nil, in_lata : String | Nil = nil, in_locality : String | Nil = nil, fax_enabled : Bool | Nil = nil, page_size : Int32 | Nil = nil) : Crest::Request
@return Crest::Request
- #client_side_validation?(*args, **options)
- #client_side_validation?(*args, **options, &)
- #debugging?(*args, **options)
- #debugging?(*args, **options, &)
-
#fetch_available_phone_number_country(*, account_sid : String | Nil = @account_sid, country_code : String | Nil = nil) : Twilio::AvailablePhoneNumberCountry
@required @param account_sid [String?] The SID of the Account requesting the available phone number Country resource.
-
#fetch_available_phone_number_country(*, account_sid : String | Nil = @account_sid, country_code : String | Nil = nil, &block : Crest::Response -> ) : Nil
@required @param account_sid [String?] The SID of the Account requesting the available phone number Country resource.
-
#fetch_available_phone_number_country_with_http_info(*, account_sid : String | Nil = @account_sid, country_code : String | Nil = nil) : Tuple(Twilio::AvailablePhoneNumberCountry, Int32, Hash(String, Array(String) | String))
@required @param account_sid [String?] The SID of the Account requesting the available phone number Country resource.
-
#list_available_phone_number_country(*, account_sid : String | Nil = @account_sid, page_size : Int32 | Nil = nil) : Twilio::ListAvailablePhoneNumberCountryResponse
@required @param account_sid [String?] The SID of the Account requesting the available phone number Country resources.
-
#list_available_phone_number_country(*, account_sid : String | Nil = @account_sid, page_size : Int32 | Nil = nil, &block : Crest::Response -> ) : Nil
@required @param account_sid [String?] The SID of the Account requesting the available phone number Country resources.
-
#list_available_phone_number_country_with_http_info(*, account_sid : String | Nil = @account_sid, page_size : Int32 | Nil = nil) : Tuple(Twilio::ListAvailablePhoneNumberCountryResponse, Int32, Hash(String, Array(String) | String))
@required @param account_sid [String?] The SID of the Account requesting the available phone number Country resources.
-
#list_available_phone_number_local(*, account_sid : String | Nil = @account_sid, country_code : String | Nil = nil, area_code : Int32 | Nil = nil, contains : String | Nil = nil, sms_enabled : Bool | Nil = nil, mms_enabled : Bool | Nil = nil, voice_enabled : Bool | Nil = nil, exclude_all_address_required : Bool | Nil = nil, exclude_local_address_required : Bool | Nil = nil, exclude_foreign_address_required : Bool | Nil = nil, beta : Bool | Nil = nil, near_number : String | Nil = nil, near_lat_long : String | Nil = nil, distance : Int32 | Nil = nil, in_postal_code : String | Nil = nil, in_region : String | Nil = nil, in_rate_center : String | Nil = nil, in_lata : String | Nil = nil, in_locality : String | Nil = nil, fax_enabled : Bool | Nil = nil, page_size : Int32 | Nil = nil) : Twilio::ListAvailablePhoneNumberLocalResponse
@required @param account_sid [String?] The SID of the Account requesting the AvailablePhoneNumber resources.
-
#list_available_phone_number_local(*, account_sid : String | Nil = @account_sid, country_code : String | Nil = nil, area_code : Int32 | Nil = nil, contains : String | Nil = nil, sms_enabled : Bool | Nil = nil, mms_enabled : Bool | Nil = nil, voice_enabled : Bool | Nil = nil, exclude_all_address_required : Bool | Nil = nil, exclude_local_address_required : Bool | Nil = nil, exclude_foreign_address_required : Bool | Nil = nil, beta : Bool | Nil = nil, near_number : String | Nil = nil, near_lat_long : String | Nil = nil, distance : Int32 | Nil = nil, in_postal_code : String | Nil = nil, in_region : String | Nil = nil, in_rate_center : String | Nil = nil, in_lata : String | Nil = nil, in_locality : String | Nil = nil, fax_enabled : Bool | Nil = nil, page_size : Int32 | Nil = nil, &block : Crest::Response -> ) : Nil
@required @param account_sid [String?] The SID of the Account requesting the AvailablePhoneNumber resources.
-
#list_available_phone_number_local_with_http_info(*, account_sid : String | Nil = @account_sid, country_code : String | Nil = nil, area_code : Int32 | Nil = nil, contains : String | Nil = nil, sms_enabled : Bool | Nil = nil, mms_enabled : Bool | Nil = nil, voice_enabled : Bool | Nil = nil, exclude_all_address_required : Bool | Nil = nil, exclude_local_address_required : Bool | Nil = nil, exclude_foreign_address_required : Bool | Nil = nil, beta : Bool | Nil = nil, near_number : String | Nil = nil, near_lat_long : String | Nil = nil, distance : Int32 | Nil = nil, in_postal_code : String | Nil = nil, in_region : String | Nil = nil, in_rate_center : String | Nil = nil, in_lata : String | Nil = nil, in_locality : String | Nil = nil, fax_enabled : Bool | Nil = nil, page_size : Int32 | Nil = nil) : Tuple(Twilio::ListAvailablePhoneNumberLocalResponse, Int32, Hash(String, Array(String) | String))
@required @param account_sid [String?] The SID of the Account requesting the AvailablePhoneNumber resources.
-
#list_available_phone_number_machine_to_machine(*, account_sid : String | Nil = @account_sid, country_code : String | Nil = nil, area_code : Int32 | Nil = nil, contains : String | Nil = nil, sms_enabled : Bool | Nil = nil, mms_enabled : Bool | Nil = nil, voice_enabled : Bool | Nil = nil, exclude_all_address_required : Bool | Nil = nil, exclude_local_address_required : Bool | Nil = nil, exclude_foreign_address_required : Bool | Nil = nil, beta : Bool | Nil = nil, near_number : String | Nil = nil, near_lat_long : String | Nil = nil, distance : Int32 | Nil = nil, in_postal_code : String | Nil = nil, in_region : String | Nil = nil, in_rate_center : String | Nil = nil, in_lata : String | Nil = nil, in_locality : String | Nil = nil, fax_enabled : Bool | Nil = nil, page_size : Int32 | Nil = nil) : Twilio::ListAvailablePhoneNumberMachineToMachineResponse
@required @param account_sid [String?] The SID of the Account requesting the AvailablePhoneNumber resources.
-
#list_available_phone_number_machine_to_machine(*, account_sid : String | Nil = @account_sid, country_code : String | Nil = nil, area_code : Int32 | Nil = nil, contains : String | Nil = nil, sms_enabled : Bool | Nil = nil, mms_enabled : Bool | Nil = nil, voice_enabled : Bool | Nil = nil, exclude_all_address_required : Bool | Nil = nil, exclude_local_address_required : Bool | Nil = nil, exclude_foreign_address_required : Bool | Nil = nil, beta : Bool | Nil = nil, near_number : String | Nil = nil, near_lat_long : String | Nil = nil, distance : Int32 | Nil = nil, in_postal_code : String | Nil = nil, in_region : String | Nil = nil, in_rate_center : String | Nil = nil, in_lata : String | Nil = nil, in_locality : String | Nil = nil, fax_enabled : Bool | Nil = nil, page_size : Int32 | Nil = nil, &block : Crest::Response -> ) : Nil
@required @param account_sid [String?] The SID of the Account requesting the AvailablePhoneNumber resources.
-
#list_available_phone_number_machine_to_machine_with_http_info(*, account_sid : String | Nil = @account_sid, country_code : String | Nil = nil, area_code : Int32 | Nil = nil, contains : String | Nil = nil, sms_enabled : Bool | Nil = nil, mms_enabled : Bool | Nil = nil, voice_enabled : Bool | Nil = nil, exclude_all_address_required : Bool | Nil = nil, exclude_local_address_required : Bool | Nil = nil, exclude_foreign_address_required : Bool | Nil = nil, beta : Bool | Nil = nil, near_number : String | Nil = nil, near_lat_long : String | Nil = nil, distance : Int32 | Nil = nil, in_postal_code : String | Nil = nil, in_region : String | Nil = nil, in_rate_center : String | Nil = nil, in_lata : String | Nil = nil, in_locality : String | Nil = nil, fax_enabled : Bool | Nil = nil, page_size : Int32 | Nil = nil) : Tuple(Twilio::ListAvailablePhoneNumberMachineToMachineResponse, Int32, Hash(String, Array(String) | String))
@required @param account_sid [String?] The SID of the Account requesting the AvailablePhoneNumber resources.
-
#list_available_phone_number_mobile(*, account_sid : String | Nil = @account_sid, country_code : String | Nil = nil, area_code : Int32 | Nil = nil, contains : String | Nil = nil, sms_enabled : Bool | Nil = nil, mms_enabled : Bool | Nil = nil, voice_enabled : Bool | Nil = nil, exclude_all_address_required : Bool | Nil = nil, exclude_local_address_required : Bool | Nil = nil, exclude_foreign_address_required : Bool | Nil = nil, beta : Bool | Nil = nil, near_number : String | Nil = nil, near_lat_long : String | Nil = nil, distance : Int32 | Nil = nil, in_postal_code : String | Nil = nil, in_region : String | Nil = nil, in_rate_center : String | Nil = nil, in_lata : String | Nil = nil, in_locality : String | Nil = nil, fax_enabled : Bool | Nil = nil, page_size : Int32 | Nil = nil) : Twilio::ListAvailablePhoneNumberMobileResponse
@required @param account_sid [String?] The SID of the Account requesting the AvailablePhoneNumber resources.
-
#list_available_phone_number_mobile(*, account_sid : String | Nil = @account_sid, country_code : String | Nil = nil, area_code : Int32 | Nil = nil, contains : String | Nil = nil, sms_enabled : Bool | Nil = nil, mms_enabled : Bool | Nil = nil, voice_enabled : Bool | Nil = nil, exclude_all_address_required : Bool | Nil = nil, exclude_local_address_required : Bool | Nil = nil, exclude_foreign_address_required : Bool | Nil = nil, beta : Bool | Nil = nil, near_number : String | Nil = nil, near_lat_long : String | Nil = nil, distance : Int32 | Nil = nil, in_postal_code : String | Nil = nil, in_region : String | Nil = nil, in_rate_center : String | Nil = nil, in_lata : String | Nil = nil, in_locality : String | Nil = nil, fax_enabled : Bool | Nil = nil, page_size : Int32 | Nil = nil, &block : Crest::Response -> ) : Nil
@required @param account_sid [String?] The SID of the Account requesting the AvailablePhoneNumber resources.
-
#list_available_phone_number_mobile_with_http_info(*, account_sid : String | Nil = @account_sid, country_code : String | Nil = nil, area_code : Int32 | Nil = nil, contains : String | Nil = nil, sms_enabled : Bool | Nil = nil, mms_enabled : Bool | Nil = nil, voice_enabled : Bool | Nil = nil, exclude_all_address_required : Bool | Nil = nil, exclude_local_address_required : Bool | Nil = nil, exclude_foreign_address_required : Bool | Nil = nil, beta : Bool | Nil = nil, near_number : String | Nil = nil, near_lat_long : String | Nil = nil, distance : Int32 | Nil = nil, in_postal_code : String | Nil = nil, in_region : String | Nil = nil, in_rate_center : String | Nil = nil, in_lata : String | Nil = nil, in_locality : String | Nil = nil, fax_enabled : Bool | Nil = nil, page_size : Int32 | Nil = nil) : Tuple(Twilio::ListAvailablePhoneNumberMobileResponse, Int32, Hash(String, Array(String) | String))
@required @param account_sid [String?] The SID of the Account requesting the AvailablePhoneNumber resources.
-
#list_available_phone_number_national(*, account_sid : String | Nil = @account_sid, country_code : String | Nil = nil, area_code : Int32 | Nil = nil, contains : String | Nil = nil, sms_enabled : Bool | Nil = nil, mms_enabled : Bool | Nil = nil, voice_enabled : Bool | Nil = nil, exclude_all_address_required : Bool | Nil = nil, exclude_local_address_required : Bool | Nil = nil, exclude_foreign_address_required : Bool | Nil = nil, beta : Bool | Nil = nil, near_number : String | Nil = nil, near_lat_long : String | Nil = nil, distance : Int32 | Nil = nil, in_postal_code : String | Nil = nil, in_region : String | Nil = nil, in_rate_center : String | Nil = nil, in_lata : String | Nil = nil, in_locality : String | Nil = nil, fax_enabled : Bool | Nil = nil, page_size : Int32 | Nil = nil) : Twilio::ListAvailablePhoneNumberNationalResponse
@required @param account_sid [String?] The SID of the Account requesting the AvailablePhoneNumber resources.
-
#list_available_phone_number_national(*, account_sid : String | Nil = @account_sid, country_code : String | Nil = nil, area_code : Int32 | Nil = nil, contains : String | Nil = nil, sms_enabled : Bool | Nil = nil, mms_enabled : Bool | Nil = nil, voice_enabled : Bool | Nil = nil, exclude_all_address_required : Bool | Nil = nil, exclude_local_address_required : Bool | Nil = nil, exclude_foreign_address_required : Bool | Nil = nil, beta : Bool | Nil = nil, near_number : String | Nil = nil, near_lat_long : String | Nil = nil, distance : Int32 | Nil = nil, in_postal_code : String | Nil = nil, in_region : String | Nil = nil, in_rate_center : String | Nil = nil, in_lata : String | Nil = nil, in_locality : String | Nil = nil, fax_enabled : Bool | Nil = nil, page_size : Int32 | Nil = nil, &block : Crest::Response -> ) : Nil
@required @param account_sid [String?] The SID of the Account requesting the AvailablePhoneNumber resources.
-
#list_available_phone_number_national_with_http_info(*, account_sid : String | Nil = @account_sid, country_code : String | Nil = nil, area_code : Int32 | Nil = nil, contains : String | Nil = nil, sms_enabled : Bool | Nil = nil, mms_enabled : Bool | Nil = nil, voice_enabled : Bool | Nil = nil, exclude_all_address_required : Bool | Nil = nil, exclude_local_address_required : Bool | Nil = nil, exclude_foreign_address_required : Bool | Nil = nil, beta : Bool | Nil = nil, near_number : String | Nil = nil, near_lat_long : String | Nil = nil, distance : Int32 | Nil = nil, in_postal_code : String | Nil = nil, in_region : String | Nil = nil, in_rate_center : String | Nil = nil, in_lata : String | Nil = nil, in_locality : String | Nil = nil, fax_enabled : Bool | Nil = nil, page_size : Int32 | Nil = nil) : Tuple(Twilio::ListAvailablePhoneNumberNationalResponse, Int32, Hash(String, Array(String) | String))
@required @param account_sid [String?] The SID of the Account requesting the AvailablePhoneNumber resources.
-
#list_available_phone_number_shared_cost(*, account_sid : String | Nil = @account_sid, country_code : String | Nil = nil, area_code : Int32 | Nil = nil, contains : String | Nil = nil, sms_enabled : Bool | Nil = nil, mms_enabled : Bool | Nil = nil, voice_enabled : Bool | Nil = nil, exclude_all_address_required : Bool | Nil = nil, exclude_local_address_required : Bool | Nil = nil, exclude_foreign_address_required : Bool | Nil = nil, beta : Bool | Nil = nil, near_number : String | Nil = nil, near_lat_long : String | Nil = nil, distance : Int32 | Nil = nil, in_postal_code : String | Nil = nil, in_region : String | Nil = nil, in_rate_center : String | Nil = nil, in_lata : String | Nil = nil, in_locality : String | Nil = nil, fax_enabled : Bool | Nil = nil, page_size : Int32 | Nil = nil) : Twilio::ListAvailablePhoneNumberSharedCostResponse
@required @param account_sid [String?] The SID of the Account requesting the AvailablePhoneNumber resources.
-
#list_available_phone_number_shared_cost(*, account_sid : String | Nil = @account_sid, country_code : String | Nil = nil, area_code : Int32 | Nil = nil, contains : String | Nil = nil, sms_enabled : Bool | Nil = nil, mms_enabled : Bool | Nil = nil, voice_enabled : Bool | Nil = nil, exclude_all_address_required : Bool | Nil = nil, exclude_local_address_required : Bool | Nil = nil, exclude_foreign_address_required : Bool | Nil = nil, beta : Bool | Nil = nil, near_number : String | Nil = nil, near_lat_long : String | Nil = nil, distance : Int32 | Nil = nil, in_postal_code : String | Nil = nil, in_region : String | Nil = nil, in_rate_center : String | Nil = nil, in_lata : String | Nil = nil, in_locality : String | Nil = nil, fax_enabled : Bool | Nil = nil, page_size : Int32 | Nil = nil, &block : Crest::Response -> ) : Nil
@required @param account_sid [String?] The SID of the Account requesting the AvailablePhoneNumber resources.
-
#list_available_phone_number_shared_cost_with_http_info(*, account_sid : String | Nil = @account_sid, country_code : String | Nil = nil, area_code : Int32 | Nil = nil, contains : String | Nil = nil, sms_enabled : Bool | Nil = nil, mms_enabled : Bool | Nil = nil, voice_enabled : Bool | Nil = nil, exclude_all_address_required : Bool | Nil = nil, exclude_local_address_required : Bool | Nil = nil, exclude_foreign_address_required : Bool | Nil = nil, beta : Bool | Nil = nil, near_number : String | Nil = nil, near_lat_long : String | Nil = nil, distance : Int32 | Nil = nil, in_postal_code : String | Nil = nil, in_region : String | Nil = nil, in_rate_center : String | Nil = nil, in_lata : String | Nil = nil, in_locality : String | Nil = nil, fax_enabled : Bool | Nil = nil, page_size : Int32 | Nil = nil) : Tuple(Twilio::ListAvailablePhoneNumberSharedCostResponse, Int32, Hash(String, Array(String) | String))
@required @param account_sid [String?] The SID of the Account requesting the AvailablePhoneNumber resources.
-
#list_available_phone_number_toll_free(*, account_sid : String | Nil = @account_sid, country_code : String | Nil = nil, area_code : Int32 | Nil = nil, contains : String | Nil = nil, sms_enabled : Bool | Nil = nil, mms_enabled : Bool | Nil = nil, voice_enabled : Bool | Nil = nil, exclude_all_address_required : Bool | Nil = nil, exclude_local_address_required : Bool | Nil = nil, exclude_foreign_address_required : Bool | Nil = nil, beta : Bool | Nil = nil, near_number : String | Nil = nil, near_lat_long : String | Nil = nil, distance : Int32 | Nil = nil, in_postal_code : String | Nil = nil, in_region : String | Nil = nil, in_rate_center : String | Nil = nil, in_lata : String | Nil = nil, in_locality : String | Nil = nil, fax_enabled : Bool | Nil = nil, page_size : Int32 | Nil = nil) : Twilio::ListAvailablePhoneNumberTollFreeResponse
@required @param account_sid [String?] The SID of the Account requesting the AvailablePhoneNumber resources.
-
#list_available_phone_number_toll_free(*, account_sid : String | Nil = @account_sid, country_code : String | Nil = nil, area_code : Int32 | Nil = nil, contains : String | Nil = nil, sms_enabled : Bool | Nil = nil, mms_enabled : Bool | Nil = nil, voice_enabled : Bool | Nil = nil, exclude_all_address_required : Bool | Nil = nil, exclude_local_address_required : Bool | Nil = nil, exclude_foreign_address_required : Bool | Nil = nil, beta : Bool | Nil = nil, near_number : String | Nil = nil, near_lat_long : String | Nil = nil, distance : Int32 | Nil = nil, in_postal_code : String | Nil = nil, in_region : String | Nil = nil, in_rate_center : String | Nil = nil, in_lata : String | Nil = nil, in_locality : String | Nil = nil, fax_enabled : Bool | Nil = nil, page_size : Int32 | Nil = nil, &block : Crest::Response -> ) : Nil
@required @param account_sid [String?] The SID of the Account requesting the AvailablePhoneNumber resources.
-
#list_available_phone_number_toll_free_with_http_info(*, account_sid : String | Nil = @account_sid, country_code : String | Nil = nil, area_code : Int32 | Nil = nil, contains : String | Nil = nil, sms_enabled : Bool | Nil = nil, mms_enabled : Bool | Nil = nil, voice_enabled : Bool | Nil = nil, exclude_all_address_required : Bool | Nil = nil, exclude_local_address_required : Bool | Nil = nil, exclude_foreign_address_required : Bool | Nil = nil, beta : Bool | Nil = nil, near_number : String | Nil = nil, near_lat_long : String | Nil = nil, distance : Int32 | Nil = nil, in_postal_code : String | Nil = nil, in_region : String | Nil = nil, in_rate_center : String | Nil = nil, in_lata : String | Nil = nil, in_locality : String | Nil = nil, fax_enabled : Bool | Nil = nil, page_size : Int32 | Nil = nil) : Tuple(Twilio::ListAvailablePhoneNumberTollFreeResponse, Int32, Hash(String, Array(String) | String))
@required @param account_sid [String?] The SID of the Account requesting the AvailablePhoneNumber resources.
-
#list_available_phone_number_voip(*, account_sid : String | Nil = @account_sid, country_code : String | Nil = nil, area_code : Int32 | Nil = nil, contains : String | Nil = nil, sms_enabled : Bool | Nil = nil, mms_enabled : Bool | Nil = nil, voice_enabled : Bool | Nil = nil, exclude_all_address_required : Bool | Nil = nil, exclude_local_address_required : Bool | Nil = nil, exclude_foreign_address_required : Bool | Nil = nil, beta : Bool | Nil = nil, near_number : String | Nil = nil, near_lat_long : String | Nil = nil, distance : Int32 | Nil = nil, in_postal_code : String | Nil = nil, in_region : String | Nil = nil, in_rate_center : String | Nil = nil, in_lata : String | Nil = nil, in_locality : String | Nil = nil, fax_enabled : Bool | Nil = nil, page_size : Int32 | Nil = nil) : Twilio::ListAvailablePhoneNumberVoipResponse
@required @param account_sid [String?] The SID of the Account requesting the AvailablePhoneNumber resources.
-
#list_available_phone_number_voip(*, account_sid : String | Nil = @account_sid, country_code : String | Nil = nil, area_code : Int32 | Nil = nil, contains : String | Nil = nil, sms_enabled : Bool | Nil = nil, mms_enabled : Bool | Nil = nil, voice_enabled : Bool | Nil = nil, exclude_all_address_required : Bool | Nil = nil, exclude_local_address_required : Bool | Nil = nil, exclude_foreign_address_required : Bool | Nil = nil, beta : Bool | Nil = nil, near_number : String | Nil = nil, near_lat_long : String | Nil = nil, distance : Int32 | Nil = nil, in_postal_code : String | Nil = nil, in_region : String | Nil = nil, in_rate_center : String | Nil = nil, in_lata : String | Nil = nil, in_locality : String | Nil = nil, fax_enabled : Bool | Nil = nil, page_size : Int32 | Nil = nil, &block : Crest::Response -> ) : Nil
@required @param account_sid [String?] The SID of the Account requesting the AvailablePhoneNumber resources.
-
#list_available_phone_number_voip_with_http_info(*, account_sid : String | Nil = @account_sid, country_code : String | Nil = nil, area_code : Int32 | Nil = nil, contains : String | Nil = nil, sms_enabled : Bool | Nil = nil, mms_enabled : Bool | Nil = nil, voice_enabled : Bool | Nil = nil, exclude_all_address_required : Bool | Nil = nil, exclude_local_address_required : Bool | Nil = nil, exclude_foreign_address_required : Bool | Nil = nil, beta : Bool | Nil = nil, near_number : String | Nil = nil, near_lat_long : String | Nil = nil, distance : Int32 | Nil = nil, in_postal_code : String | Nil = nil, in_region : String | Nil = nil, in_rate_center : String | Nil = nil, in_lata : String | Nil = nil, in_locality : String | Nil = nil, fax_enabled : Bool | Nil = nil, page_size : Int32 | Nil = nil) : Tuple(Twilio::ListAvailablePhoneNumberVoipResponse, Int32, Hash(String, Array(String) | String))
@required @param account_sid [String?] The SID of the Account requesting the AvailablePhoneNumber resources.
Constructor Detail
Instance Method Detail
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@required @param account_sid [String?] The SID of the Account requesting the available phone number Country resource. @required @param country_code [String?] The ISO-3166-1 country code of the country to fetch available phone number information about. @return [Twilio::AvailablePhoneNumberCountry]
@required @param account_sid [String?] The SID of the Account requesting the available phone number Country resource. @required @param country_code [String?] The ISO-3166-1 country code of the country to fetch available phone number information about. @return nil
@required @param account_sid [String?] The SID of the Account requesting the available phone number Country resource. @required @param country_code [String?] The ISO-3166-1 country code of the country to fetch available phone number information about. @return [Tuple(Twilio::AvailablePhoneNumberCountry, Integer, Hash)] Twilio::AvailablePhoneNumberCountry, response status code and response headers
@required @param account_sid [String?] The SID of the Account requesting the available phone number Country resources. @optional @param page_size [Int32?] How many resources to return in each list page. The default is 50, and the maximum is 1000. @return [Twilio::ListAvailablePhoneNumberCountryResponse]
@required @param account_sid [String?] The SID of the Account requesting the available phone number Country resources. @optional @param page_size [Int32?] How many resources to return in each list page. The default is 50, and the maximum is 1000. @return nil
@required @param account_sid [String?] The SID of the Account requesting the available phone number Country resources. @optional @param page_size [Int32?] How many resources to return in each list page. The default is 50, and the maximum is 1000. @return [Tuple(Twilio::ListAvailablePhoneNumberCountryResponse, Integer, Hash)] Twilio::ListAvailablePhoneNumberCountryResponse, response status code and response headers
@required @param account_sid [String?] The SID of the Account requesting the AvailablePhoneNumber resources.
@required @param country_code [String?] The ISO-3166-1 country code of the country from which to read phone numbers.
@optional @param area_code [Int32?] The area code of the phone numbers to read. Applies to only phone numbers in the US and Canada.
@optional @param contains [String?] The pattern on which to match phone numbers. Valid characters are *
, 0-9
, a-z
, and A-Z
. The *
character matches any single digit. For examples, see Example 2 and Example 3. If specified, this value must have at least two characters.
@optional @param sms_enabled [Bool?] Whether the phone numbers can receive text messages. Can be: true
or false
.
@optional @param mms_enabled [Bool?] Whether the phone numbers can receive MMS messages. Can be: true
or false
.
@optional @param voice_enabled [Bool?] Whether the phone numbers can receive calls. Can be: true
or false
.
@optional @param exclude_all_address_required [Bool?] Whether to exclude phone numbers that require an Address. Can be: true
or false
and the default is false
.
@optional @param exclude_local_address_required [Bool?] Whether to exclude phone numbers that require a local Address. Can be: true
or false
and the default is false
.
@optional @param exclude_foreign_address_required [Bool?] Whether to exclude phone numbers that require a foreign Address. Can be: true
or false
and the default is false
.
@optional @param beta [Bool?] Whether to read phone numbers that are new to the Twilio platform. Can be: true
or false
and the default is true
.
@optional @param near_number [String?] Given a phone number, find a geographically close number within distance
miles. Distance defaults to 25 miles. Applies to only phone numbers in the US and Canada.
@optional @param near_lat_long [String?] Given a latitude/longitude pair lat,long
find geographically close numbers within distance
miles. Applies to only phone numbers in the US and Canada.
@optional @param distance [Int32?] The search radius, in miles, for a near_
query. Can be up to 500
and the default is 25
. Applies to only phone numbers in the US and Canada.
@optional @param in_postal_code [String?] Limit results to a particular postal code. Given a phone number, search within the same postal code as that number. Applies to only phone numbers in the US and Canada.
@optional @param in_region [String?] Limit results to a particular region, state, or province. Given a phone number, search within the same region as that number. Applies to only phone numbers in the US and Canada.
@optional @param in_rate_center [String?] Limit results to a specific rate center, or given a phone number search within the same rate center as that number. Requires in_lata
to be set as well. Applies to only phone numbers in the US and Canada.
@optional @param in_lata [String?] Limit results to a specific local access and transport area (LATA). Given a phone number, search within the same LATA as that number. Applies to only phone numbers in the US and Canada.
@optional @param in_locality [String?] Limit results to a particular locality or city. Given a phone number, search within the same Locality as that number.
@optional @param fax_enabled [Bool?] Whether the phone numbers can receive faxes. Can be: true
or false
.
@optional @param page_size [Int32?] How many resources to return in each list page. The default is 50, and the maximum is 1000.
@return [Twilio::ListAvailablePhoneNumberLocalResponse]
@required @param account_sid [String?] The SID of the Account requesting the AvailablePhoneNumber resources.
@required @param country_code [String?] The ISO-3166-1 country code of the country from which to read phone numbers.
@optional @param area_code [Int32?] The area code of the phone numbers to read. Applies to only phone numbers in the US and Canada.
@optional @param contains [String?] The pattern on which to match phone numbers. Valid characters are *
, 0-9
, a-z
, and A-Z
. The *
character matches any single digit. For examples, see Example 2 and Example 3. If specified, this value must have at least two characters.
@optional @param sms_enabled [Bool?] Whether the phone numbers can receive text messages. Can be: true
or false
.
@optional @param mms_enabled [Bool?] Whether the phone numbers can receive MMS messages. Can be: true
or false
.
@optional @param voice_enabled [Bool?] Whether the phone numbers can receive calls. Can be: true
or false
.
@optional @param exclude_all_address_required [Bool?] Whether to exclude phone numbers that require an Address. Can be: true
or false
and the default is false
.
@optional @param exclude_local_address_required [Bool?] Whether to exclude phone numbers that require a local Address. Can be: true
or false
and the default is false
.
@optional @param exclude_foreign_address_required [Bool?] Whether to exclude phone numbers that require a foreign Address. Can be: true
or false
and the default is false
.
@optional @param beta [Bool?] Whether to read phone numbers that are new to the Twilio platform. Can be: true
or false
and the default is true
.
@optional @param near_number [String?] Given a phone number, find a geographically close number within distance
miles. Distance defaults to 25 miles. Applies to only phone numbers in the US and Canada.
@optional @param near_lat_long [String?] Given a latitude/longitude pair lat,long
find geographically close numbers within distance
miles. Applies to only phone numbers in the US and Canada.
@optional @param distance [Int32?] The search radius, in miles, for a near_
query. Can be up to 500
and the default is 25
. Applies to only phone numbers in the US and Canada.
@optional @param in_postal_code [String?] Limit results to a particular postal code. Given a phone number, search within the same postal code as that number. Applies to only phone numbers in the US and Canada.
@optional @param in_region [String?] Limit results to a particular region, state, or province. Given a phone number, search within the same region as that number. Applies to only phone numbers in the US and Canada.
@optional @param in_rate_center [String?] Limit results to a specific rate center, or given a phone number search within the same rate center as that number. Requires in_lata
to be set as well. Applies to only phone numbers in the US and Canada.
@optional @param in_lata [String?] Limit results to a specific local access and transport area (LATA). Given a phone number, search within the same LATA as that number. Applies to only phone numbers in the US and Canada.
@optional @param in_locality [String?] Limit results to a particular locality or city. Given a phone number, search within the same Locality as that number.
@optional @param fax_enabled [Bool?] Whether the phone numbers can receive faxes. Can be: true
or false
.
@optional @param page_size [Int32?] How many resources to return in each list page. The default is 50, and the maximum is 1000.
@return nil
@required @param account_sid [String?] The SID of the Account requesting the AvailablePhoneNumber resources.
@required @param country_code [String?] The ISO-3166-1 country code of the country from which to read phone numbers.
@optional @param area_code [Int32?] The area code of the phone numbers to read. Applies to only phone numbers in the US and Canada.
@optional @param contains [String?] The pattern on which to match phone numbers. Valid characters are *
, 0-9
, a-z
, and A-Z
. The *
character matches any single digit. For examples, see Example 2 and Example 3. If specified, this value must have at least two characters.
@optional @param sms_enabled [Bool?] Whether the phone numbers can receive text messages. Can be: true
or false
.
@optional @param mms_enabled [Bool?] Whether the phone numbers can receive MMS messages. Can be: true
or false
.
@optional @param voice_enabled [Bool?] Whether the phone numbers can receive calls. Can be: true
or false
.
@optional @param exclude_all_address_required [Bool?] Whether to exclude phone numbers that require an Address. Can be: true
or false
and the default is false
.
@optional @param exclude_local_address_required [Bool?] Whether to exclude phone numbers that require a local Address. Can be: true
or false
and the default is false
.
@optional @param exclude_foreign_address_required [Bool?] Whether to exclude phone numbers that require a foreign Address. Can be: true
or false
and the default is false
.
@optional @param beta [Bool?] Whether to read phone numbers that are new to the Twilio platform. Can be: true
or false
and the default is true
.
@optional @param near_number [String?] Given a phone number, find a geographically close number within distance
miles. Distance defaults to 25 miles. Applies to only phone numbers in the US and Canada.
@optional @param near_lat_long [String?] Given a latitude/longitude pair lat,long
find geographically close numbers within distance
miles. Applies to only phone numbers in the US and Canada.
@optional @param distance [Int32?] The search radius, in miles, for a near_
query. Can be up to 500
and the default is 25
. Applies to only phone numbers in the US and Canada.
@optional @param in_postal_code [String?] Limit results to a particular postal code. Given a phone number, search within the same postal code as that number. Applies to only phone numbers in the US and Canada.
@optional @param in_region [String?] Limit results to a particular region, state, or province. Given a phone number, search within the same region as that number. Applies to only phone numbers in the US and Canada.
@optional @param in_rate_center [String?] Limit results to a specific rate center, or given a phone number search within the same rate center as that number. Requires in_lata
to be set as well. Applies to only phone numbers in the US and Canada.
@optional @param in_lata [String?] Limit results to a specific local access and transport area (LATA). Given a phone number, search within the same LATA as that number. Applies to only phone numbers in the US and Canada.
@optional @param in_locality [String?] Limit results to a particular locality or city. Given a phone number, search within the same Locality as that number.
@optional @param fax_enabled [Bool?] Whether the phone numbers can receive faxes. Can be: true
or false
.
@optional @param page_size [Int32?] How many resources to return in each list page. The default is 50, and the maximum is 1000.
@return [Tuple(Twilio::ListAvailablePhoneNumberLocalResponse, Integer, Hash)] Twilio::ListAvailablePhoneNumberLocalResponse, response status code and response headers
@required @param account_sid [String?] The SID of the Account requesting the AvailablePhoneNumber resources.
@required @param country_code [String?] The ISO-3166-1 country code of the country from which to read phone numbers.
@optional @param area_code [Int32?] The area code of the phone numbers to read. Applies to only phone numbers in the US and Canada.
@optional @param contains [String?] The pattern on which to match phone numbers. Valid characters are *
, 0-9
, a-z
, and A-Z
. The *
character matches any single digit. For examples, see Example 2 and Example 3. If specified, this value must have at least two characters.
@optional @param sms_enabled [Bool?] Whether the phone numbers can receive text messages. Can be: true
or false
.
@optional @param mms_enabled [Bool?] Whether the phone numbers can receive MMS messages. Can be: true
or false
.
@optional @param voice_enabled [Bool?] Whether the phone numbers can receive calls. Can be: true
or false
.
@optional @param exclude_all_address_required [Bool?] Whether to exclude phone numbers that require an Address. Can be: true
or false
and the default is false
.
@optional @param exclude_local_address_required [Bool?] Whether to exclude phone numbers that require a local Address. Can be: true
or false
and the default is false
.
@optional @param exclude_foreign_address_required [Bool?] Whether to exclude phone numbers that require a foreign Address. Can be: true
or false
and the default is false
.
@optional @param beta [Bool?] Whether to read phone numbers that are new to the Twilio platform. Can be: true
or false
and the default is true
.
@optional @param near_number [String?] Given a phone number, find a geographically close number within distance
miles. Distance defaults to 25 miles. Applies to only phone numbers in the US and Canada.
@optional @param near_lat_long [String?] Given a latitude/longitude pair lat,long
find geographically close numbers within distance
miles. Applies to only phone numbers in the US and Canada.
@optional @param distance [Int32?] The search radius, in miles, for a near_
query. Can be up to 500
and the default is 25
. Applies to only phone numbers in the US and Canada.
@optional @param in_postal_code [String?] Limit results to a particular postal code. Given a phone number, search within the same postal code as that number. Applies to only phone numbers in the US and Canada.
@optional @param in_region [String?] Limit results to a particular region, state, or province. Given a phone number, search within the same region as that number. Applies to only phone numbers in the US and Canada.
@optional @param in_rate_center [String?] Limit results to a specific rate center, or given a phone number search within the same rate center as that number. Requires in_lata
to be set as well. Applies to only phone numbers in the US and Canada.
@optional @param in_lata [String?] Limit results to a specific local access and transport area (LATA). Given a phone number, search within the same LATA as that number. Applies to only phone numbers in the US and Canada.
@optional @param in_locality [String?] Limit results to a particular locality or city. Given a phone number, search within the same Locality as that number.
@optional @param fax_enabled [Bool?] Whether the phone numbers can receive faxes. Can be: true
or false
.
@optional @param page_size [Int32?] How many resources to return in each list page. The default is 50, and the maximum is 1000.
@return [Twilio::ListAvailablePhoneNumberMachineToMachineResponse]
@required @param account_sid [String?] The SID of the Account requesting the AvailablePhoneNumber resources.
@required @param country_code [String?] The ISO-3166-1 country code of the country from which to read phone numbers.
@optional @param area_code [Int32?] The area code of the phone numbers to read. Applies to only phone numbers in the US and Canada.
@optional @param contains [String?] The pattern on which to match phone numbers. Valid characters are *
, 0-9
, a-z
, and A-Z
. The *
character matches any single digit. For examples, see Example 2 and Example 3. If specified, this value must have at least two characters.
@optional @param sms_enabled [Bool?] Whether the phone numbers can receive text messages. Can be: true
or false
.
@optional @param mms_enabled [Bool?] Whether the phone numbers can receive MMS messages. Can be: true
or false
.
@optional @param voice_enabled [Bool?] Whether the phone numbers can receive calls. Can be: true
or false
.
@optional @param exclude_all_address_required [Bool?] Whether to exclude phone numbers that require an Address. Can be: true
or false
and the default is false
.
@optional @param exclude_local_address_required [Bool?] Whether to exclude phone numbers that require a local Address. Can be: true
or false
and the default is false
.
@optional @param exclude_foreign_address_required [Bool?] Whether to exclude phone numbers that require a foreign Address. Can be: true
or false
and the default is false
.
@optional @param beta [Bool?] Whether to read phone numbers that are new to the Twilio platform. Can be: true
or false
and the default is true
.
@optional @param near_number [String?] Given a phone number, find a geographically close number within distance
miles. Distance defaults to 25 miles. Applies to only phone numbers in the US and Canada.
@optional @param near_lat_long [String?] Given a latitude/longitude pair lat,long
find geographically close numbers within distance
miles. Applies to only phone numbers in the US and Canada.
@optional @param distance [Int32?] The search radius, in miles, for a near_
query. Can be up to 500
and the default is 25
. Applies to only phone numbers in the US and Canada.
@optional @param in_postal_code [String?] Limit results to a particular postal code. Given a phone number, search within the same postal code as that number. Applies to only phone numbers in the US and Canada.
@optional @param in_region [String?] Limit results to a particular region, state, or province. Given a phone number, search within the same region as that number. Applies to only phone numbers in the US and Canada.
@optional @param in_rate_center [String?] Limit results to a specific rate center, or given a phone number search within the same rate center as that number. Requires in_lata
to be set as well. Applies to only phone numbers in the US and Canada.
@optional @param in_lata [String?] Limit results to a specific local access and transport area (LATA). Given a phone number, search within the same LATA as that number. Applies to only phone numbers in the US and Canada.
@optional @param in_locality [String?] Limit results to a particular locality or city. Given a phone number, search within the same Locality as that number.
@optional @param fax_enabled [Bool?] Whether the phone numbers can receive faxes. Can be: true
or false
.
@optional @param page_size [Int32?] How many resources to return in each list page. The default is 50, and the maximum is 1000.
@return nil
@required @param account_sid [String?] The SID of the Account requesting the AvailablePhoneNumber resources.
@required @param country_code [String?] The ISO-3166-1 country code of the country from which to read phone numbers.
@optional @param area_code [Int32?] The area code of the phone numbers to read. Applies to only phone numbers in the US and Canada.
@optional @param contains [String?] The pattern on which to match phone numbers. Valid characters are *
, 0-9
, a-z
, and A-Z
. The *
character matches any single digit. For examples, see Example 2 and Example 3. If specified, this value must have at least two characters.
@optional @param sms_enabled [Bool?] Whether the phone numbers can receive text messages. Can be: true
or false
.
@optional @param mms_enabled [Bool?] Whether the phone numbers can receive MMS messages. Can be: true
or false
.
@optional @param voice_enabled [Bool?] Whether the phone numbers can receive calls. Can be: true
or false
.
@optional @param exclude_all_address_required [Bool?] Whether to exclude phone numbers that require an Address. Can be: true
or false
and the default is false
.
@optional @param exclude_local_address_required [Bool?] Whether to exclude phone numbers that require a local Address. Can be: true
or false
and the default is false
.
@optional @param exclude_foreign_address_required [Bool?] Whether to exclude phone numbers that require a foreign Address. Can be: true
or false
and the default is false
.
@optional @param beta [Bool?] Whether to read phone numbers that are new to the Twilio platform. Can be: true
or false
and the default is true
.
@optional @param near_number [String?] Given a phone number, find a geographically close number within distance
miles. Distance defaults to 25 miles. Applies to only phone numbers in the US and Canada.
@optional @param near_lat_long [String?] Given a latitude/longitude pair lat,long
find geographically close numbers within distance
miles. Applies to only phone numbers in the US and Canada.
@optional @param distance [Int32?] The search radius, in miles, for a near_
query. Can be up to 500
and the default is 25
. Applies to only phone numbers in the US and Canada.
@optional @param in_postal_code [String?] Limit results to a particular postal code. Given a phone number, search within the same postal code as that number. Applies to only phone numbers in the US and Canada.
@optional @param in_region [String?] Limit results to a particular region, state, or province. Given a phone number, search within the same region as that number. Applies to only phone numbers in the US and Canada.
@optional @param in_rate_center [String?] Limit results to a specific rate center, or given a phone number search within the same rate center as that number. Requires in_lata
to be set as well. Applies to only phone numbers in the US and Canada.
@optional @param in_lata [String?] Limit results to a specific local access and transport area (LATA). Given a phone number, search within the same LATA as that number. Applies to only phone numbers in the US and Canada.
@optional @param in_locality [String?] Limit results to a particular locality or city. Given a phone number, search within the same Locality as that number.
@optional @param fax_enabled [Bool?] Whether the phone numbers can receive faxes. Can be: true
or false
.
@optional @param page_size [Int32?] How many resources to return in each list page. The default is 50, and the maximum is 1000.
@return [Tuple(Twilio::ListAvailablePhoneNumberMachineToMachineResponse, Integer, Hash)] Twilio::ListAvailablePhoneNumberMachineToMachineResponse, response status code and response headers
@required @param account_sid [String?] The SID of the Account requesting the AvailablePhoneNumber resources.
@required @param country_code [String?] The ISO-3166-1 country code of the country from which to read phone numbers.
@optional @param area_code [Int32?] The area code of the phone numbers to read. Applies to only phone numbers in the US and Canada.
@optional @param contains [String?] The pattern on which to match phone numbers. Valid characters are *
, 0-9
, a-z
, and A-Z
. The *
character matches any single digit. For examples, see Example 2 and Example 3. If specified, this value must have at least two characters.
@optional @param sms_enabled [Bool?] Whether the phone numbers can receive text messages. Can be: true
or false
.
@optional @param mms_enabled [Bool?] Whether the phone numbers can receive MMS messages. Can be: true
or false
.
@optional @param voice_enabled [Bool?] Whether the phone numbers can receive calls. Can be: true
or false
.
@optional @param exclude_all_address_required [Bool?] Whether to exclude phone numbers that require an Address. Can be: true
or false
and the default is false
.
@optional @param exclude_local_address_required [Bool?] Whether to exclude phone numbers that require a local Address. Can be: true
or false
and the default is false
.
@optional @param exclude_foreign_address_required [Bool?] Whether to exclude phone numbers that require a foreign Address. Can be: true
or false
and the default is false
.
@optional @param beta [Bool?] Whether to read phone numbers that are new to the Twilio platform. Can be: true
or false
and the default is true
.
@optional @param near_number [String?] Given a phone number, find a geographically close number within distance
miles. Distance defaults to 25 miles. Applies to only phone numbers in the US and Canada.
@optional @param near_lat_long [String?] Given a latitude/longitude pair lat,long
find geographically close numbers within distance
miles. Applies to only phone numbers in the US and Canada.
@optional @param distance [Int32?] The search radius, in miles, for a near_
query. Can be up to 500
and the default is 25
. Applies to only phone numbers in the US and Canada.
@optional @param in_postal_code [String?] Limit results to a particular postal code. Given a phone number, search within the same postal code as that number. Applies to only phone numbers in the US and Canada.
@optional @param in_region [String?] Limit results to a particular region, state, or province. Given a phone number, search within the same region as that number. Applies to only phone numbers in the US and Canada.
@optional @param in_rate_center [String?] Limit results to a specific rate center, or given a phone number search within the same rate center as that number. Requires in_lata
to be set as well. Applies to only phone numbers in the US and Canada.
@optional @param in_lata [String?] Limit results to a specific local access and transport area (LATA). Given a phone number, search within the same LATA as that number. Applies to only phone numbers in the US and Canada.
@optional @param in_locality [String?] Limit results to a particular locality or city. Given a phone number, search within the same Locality as that number.
@optional @param fax_enabled [Bool?] Whether the phone numbers can receive faxes. Can be: true
or false
.
@optional @param page_size [Int32?] How many resources to return in each list page. The default is 50, and the maximum is 1000.
@return [Twilio::ListAvailablePhoneNumberMobileResponse]
@required @param account_sid [String?] The SID of the Account requesting the AvailablePhoneNumber resources.
@required @param country_code [String?] The ISO-3166-1 country code of the country from which to read phone numbers.
@optional @param area_code [Int32?] The area code of the phone numbers to read. Applies to only phone numbers in the US and Canada.
@optional @param contains [String?] The pattern on which to match phone numbers. Valid characters are *
, 0-9
, a-z
, and A-Z
. The *
character matches any single digit. For examples, see Example 2 and Example 3. If specified, this value must have at least two characters.
@optional @param sms_enabled [Bool?] Whether the phone numbers can receive text messages. Can be: true
or false
.
@optional @param mms_enabled [Bool?] Whether the phone numbers can receive MMS messages. Can be: true
or false
.
@optional @param voice_enabled [Bool?] Whether the phone numbers can receive calls. Can be: true
or false
.
@optional @param exclude_all_address_required [Bool?] Whether to exclude phone numbers that require an Address. Can be: true
or false
and the default is false
.
@optional @param exclude_local_address_required [Bool?] Whether to exclude phone numbers that require a local Address. Can be: true
or false
and the default is false
.
@optional @param exclude_foreign_address_required [Bool?] Whether to exclude phone numbers that require a foreign Address. Can be: true
or false
and the default is false
.
@optional @param beta [Bool?] Whether to read phone numbers that are new to the Twilio platform. Can be: true
or false
and the default is true
.
@optional @param near_number [String?] Given a phone number, find a geographically close number within distance
miles. Distance defaults to 25 miles. Applies to only phone numbers in the US and Canada.
@optional @param near_lat_long [String?] Given a latitude/longitude pair lat,long
find geographically close numbers within distance
miles. Applies to only phone numbers in the US and Canada.
@optional @param distance [Int32?] The search radius, in miles, for a near_
query. Can be up to 500
and the default is 25
. Applies to only phone numbers in the US and Canada.
@optional @param in_postal_code [String?] Limit results to a particular postal code. Given a phone number, search within the same postal code as that number. Applies to only phone numbers in the US and Canada.
@optional @param in_region [String?] Limit results to a particular region, state, or province. Given a phone number, search within the same region as that number. Applies to only phone numbers in the US and Canada.
@optional @param in_rate_center [String?] Limit results to a specific rate center, or given a phone number search within the same rate center as that number. Requires in_lata
to be set as well. Applies to only phone numbers in the US and Canada.
@optional @param in_lata [String?] Limit results to a specific local access and transport area (LATA). Given a phone number, search within the same LATA as that number. Applies to only phone numbers in the US and Canada.
@optional @param in_locality [String?] Limit results to a particular locality or city. Given a phone number, search within the same Locality as that number.
@optional @param fax_enabled [Bool?] Whether the phone numbers can receive faxes. Can be: true
or false
.
@optional @param page_size [Int32?] How many resources to return in each list page. The default is 50, and the maximum is 1000.
@return nil
@required @param account_sid [String?] The SID of the Account requesting the AvailablePhoneNumber resources.
@required @param country_code [String?] The ISO-3166-1 country code of the country from which to read phone numbers.
@optional @param area_code [Int32?] The area code of the phone numbers to read. Applies to only phone numbers in the US and Canada.
@optional @param contains [String?] The pattern on which to match phone numbers. Valid characters are *
, 0-9
, a-z
, and A-Z
. The *
character matches any single digit. For examples, see Example 2 and Example 3. If specified, this value must have at least two characters.
@optional @param sms_enabled [Bool?] Whether the phone numbers can receive text messages. Can be: true
or false
.
@optional @param mms_enabled [Bool?] Whether the phone numbers can receive MMS messages. Can be: true
or false
.
@optional @param voice_enabled [Bool?] Whether the phone numbers can receive calls. Can be: true
or false
.
@optional @param exclude_all_address_required [Bool?] Whether to exclude phone numbers that require an Address. Can be: true
or false
and the default is false
.
@optional @param exclude_local_address_required [Bool?] Whether to exclude phone numbers that require a local Address. Can be: true
or false
and the default is false
.
@optional @param exclude_foreign_address_required [Bool?] Whether to exclude phone numbers that require a foreign Address. Can be: true
or false
and the default is false
.
@optional @param beta [Bool?] Whether to read phone numbers that are new to the Twilio platform. Can be: true
or false
and the default is true
.
@optional @param near_number [String?] Given a phone number, find a geographically close number within distance
miles. Distance defaults to 25 miles. Applies to only phone numbers in the US and Canada.
@optional @param near_lat_long [String?] Given a latitude/longitude pair lat,long
find geographically close numbers within distance
miles. Applies to only phone numbers in the US and Canada.
@optional @param distance [Int32?] The search radius, in miles, for a near_
query. Can be up to 500
and the default is 25
. Applies to only phone numbers in the US and Canada.
@optional @param in_postal_code [String?] Limit results to a particular postal code. Given a phone number, search within the same postal code as that number. Applies to only phone numbers in the US and Canada.
@optional @param in_region [String?] Limit results to a particular region, state, or province. Given a phone number, search within the same region as that number. Applies to only phone numbers in the US and Canada.
@optional @param in_rate_center [String?] Limit results to a specific rate center, or given a phone number search within the same rate center as that number. Requires in_lata
to be set as well. Applies to only phone numbers in the US and Canada.
@optional @param in_lata [String?] Limit results to a specific local access and transport area (LATA). Given a phone number, search within the same LATA as that number. Applies to only phone numbers in the US and Canada.
@optional @param in_locality [String?] Limit results to a particular locality or city. Given a phone number, search within the same Locality as that number.
@optional @param fax_enabled [Bool?] Whether the phone numbers can receive faxes. Can be: true
or false
.
@optional @param page_size [Int32?] How many resources to return in each list page. The default is 50, and the maximum is 1000.
@return [Tuple(Twilio::ListAvailablePhoneNumberMobileResponse, Integer, Hash)] Twilio::ListAvailablePhoneNumberMobileResponse, response status code and response headers
@required @param account_sid [String?] The SID of the Account requesting the AvailablePhoneNumber resources.
@required @param country_code [String?] The ISO-3166-1 country code of the country from which to read phone numbers.
@optional @param area_code [Int32?] The area code of the phone numbers to read. Applies to only phone numbers in the US and Canada.
@optional @param contains [String?] The pattern on which to match phone numbers. Valid characters are *
, 0-9
, a-z
, and A-Z
. The *
character matches any single digit. For examples, see Example 2 and Example 3. If specified, this value must have at least two characters.
@optional @param sms_enabled [Bool?] Whether the phone numbers can receive text messages. Can be: true
or false
.
@optional @param mms_enabled [Bool?] Whether the phone numbers can receive MMS messages. Can be: true
or false
.
@optional @param voice_enabled [Bool?] Whether the phone numbers can receive calls. Can be: true
or false
.
@optional @param exclude_all_address_required [Bool?] Whether to exclude phone numbers that require an Address. Can be: true
or false
and the default is false
.
@optional @param exclude_local_address_required [Bool?] Whether to exclude phone numbers that require a local Address. Can be: true
or false
and the default is false
.
@optional @param exclude_foreign_address_required [Bool?] Whether to exclude phone numbers that require a foreign Address. Can be: true
or false
and the default is false
.
@optional @param beta [Bool?] Whether to read phone numbers that are new to the Twilio platform. Can be: true
or false
and the default is true
.
@optional @param near_number [String?] Given a phone number, find a geographically close number within distance
miles. Distance defaults to 25 miles. Applies to only phone numbers in the US and Canada.
@optional @param near_lat_long [String?] Given a latitude/longitude pair lat,long
find geographically close numbers within distance
miles. Applies to only phone numbers in the US and Canada.
@optional @param distance [Int32?] The search radius, in miles, for a near_
query. Can be up to 500
and the default is 25
. Applies to only phone numbers in the US and Canada.
@optional @param in_postal_code [String?] Limit results to a particular postal code. Given a phone number, search within the same postal code as that number. Applies to only phone numbers in the US and Canada.
@optional @param in_region [String?] Limit results to a particular region, state, or province. Given a phone number, search within the same region as that number. Applies to only phone numbers in the US and Canada.
@optional @param in_rate_center [String?] Limit results to a specific rate center, or given a phone number search within the same rate center as that number. Requires in_lata
to be set as well. Applies to only phone numbers in the US and Canada.
@optional @param in_lata [String?] Limit results to a specific local access and transport area (LATA). Given a phone number, search within the same LATA as that number. Applies to only phone numbers in the US and Canada.
@optional @param in_locality [String?] Limit results to a particular locality or city. Given a phone number, search within the same Locality as that number.
@optional @param fax_enabled [Bool?] Whether the phone numbers can receive faxes. Can be: true
or false
.
@optional @param page_size [Int32?] How many resources to return in each list page. The default is 50, and the maximum is 1000.
@return [Twilio::ListAvailablePhoneNumberNationalResponse]
@required @param account_sid [String?] The SID of the Account requesting the AvailablePhoneNumber resources.
@required @param country_code [String?] The ISO-3166-1 country code of the country from which to read phone numbers.
@optional @param area_code [Int32?] The area code of the phone numbers to read. Applies to only phone numbers in the US and Canada.
@optional @param contains [String?] The pattern on which to match phone numbers. Valid characters are *
, 0-9
, a-z
, and A-Z
. The *
character matches any single digit. For examples, see Example 2 and Example 3. If specified, this value must have at least two characters.
@optional @param sms_enabled [Bool?] Whether the phone numbers can receive text messages. Can be: true
or false
.
@optional @param mms_enabled [Bool?] Whether the phone numbers can receive MMS messages. Can be: true
or false
.
@optional @param voice_enabled [Bool?] Whether the phone numbers can receive calls. Can be: true
or false
.
@optional @param exclude_all_address_required [Bool?] Whether to exclude phone numbers that require an Address. Can be: true
or false
and the default is false
.
@optional @param exclude_local_address_required [Bool?] Whether to exclude phone numbers that require a local Address. Can be: true
or false
and the default is false
.
@optional @param exclude_foreign_address_required [Bool?] Whether to exclude phone numbers that require a foreign Address. Can be: true
or false
and the default is false
.
@optional @param beta [Bool?] Whether to read phone numbers that are new to the Twilio platform. Can be: true
or false
and the default is true
.
@optional @param near_number [String?] Given a phone number, find a geographically close number within distance
miles. Distance defaults to 25 miles. Applies to only phone numbers in the US and Canada.
@optional @param near_lat_long [String?] Given a latitude/longitude pair lat,long
find geographically close numbers within distance
miles. Applies to only phone numbers in the US and Canada.
@optional @param distance [Int32?] The search radius, in miles, for a near_
query. Can be up to 500
and the default is 25
. Applies to only phone numbers in the US and Canada.
@optional @param in_postal_code [String?] Limit results to a particular postal code. Given a phone number, search within the same postal code as that number. Applies to only phone numbers in the US and Canada.
@optional @param in_region [String?] Limit results to a particular region, state, or province. Given a phone number, search within the same region as that number. Applies to only phone numbers in the US and Canada.
@optional @param in_rate_center [String?] Limit results to a specific rate center, or given a phone number search within the same rate center as that number. Requires in_lata
to be set as well. Applies to only phone numbers in the US and Canada.
@optional @param in_lata [String?] Limit results to a specific local access and transport area (LATA). Given a phone number, search within the same LATA as that number. Applies to only phone numbers in the US and Canada.
@optional @param in_locality [String?] Limit results to a particular locality or city. Given a phone number, search within the same Locality as that number.
@optional @param fax_enabled [Bool?] Whether the phone numbers can receive faxes. Can be: true
or false
.
@optional @param page_size [Int32?] How many resources to return in each list page. The default is 50, and the maximum is 1000.
@return nil
@required @param account_sid [String?] The SID of the Account requesting the AvailablePhoneNumber resources.
@required @param country_code [String?] The ISO-3166-1 country code of the country from which to read phone numbers.
@optional @param area_code [Int32?] The area code of the phone numbers to read. Applies to only phone numbers in the US and Canada.
@optional @param contains [String?] The pattern on which to match phone numbers. Valid characters are *
, 0-9
, a-z
, and A-Z
. The *
character matches any single digit. For examples, see Example 2 and Example 3. If specified, this value must have at least two characters.
@optional @param sms_enabled [Bool?] Whether the phone numbers can receive text messages. Can be: true
or false
.
@optional @param mms_enabled [Bool?] Whether the phone numbers can receive MMS messages. Can be: true
or false
.
@optional @param voice_enabled [Bool?] Whether the phone numbers can receive calls. Can be: true
or false
.
@optional @param exclude_all_address_required [Bool?] Whether to exclude phone numbers that require an Address. Can be: true
or false
and the default is false
.
@optional @param exclude_local_address_required [Bool?] Whether to exclude phone numbers that require a local Address. Can be: true
or false
and the default is false
.
@optional @param exclude_foreign_address_required [Bool?] Whether to exclude phone numbers that require a foreign Address. Can be: true
or false
and the default is false
.
@optional @param beta [Bool?] Whether to read phone numbers that are new to the Twilio platform. Can be: true
or false
and the default is true
.
@optional @param near_number [String?] Given a phone number, find a geographically close number within distance
miles. Distance defaults to 25 miles. Applies to only phone numbers in the US and Canada.
@optional @param near_lat_long [String?] Given a latitude/longitude pair lat,long
find geographically close numbers within distance
miles. Applies to only phone numbers in the US and Canada.
@optional @param distance [Int32?] The search radius, in miles, for a near_
query. Can be up to 500
and the default is 25
. Applies to only phone numbers in the US and Canada.
@optional @param in_postal_code [String?] Limit results to a particular postal code. Given a phone number, search within the same postal code as that number. Applies to only phone numbers in the US and Canada.
@optional @param in_region [String?] Limit results to a particular region, state, or province. Given a phone number, search within the same region as that number. Applies to only phone numbers in the US and Canada.
@optional @param in_rate_center [String?] Limit results to a specific rate center, or given a phone number search within the same rate center as that number. Requires in_lata
to be set as well. Applies to only phone numbers in the US and Canada.
@optional @param in_lata [String?] Limit results to a specific local access and transport area (LATA). Given a phone number, search within the same LATA as that number. Applies to only phone numbers in the US and Canada.
@optional @param in_locality [String?] Limit results to a particular locality or city. Given a phone number, search within the same Locality as that number.
@optional @param fax_enabled [Bool?] Whether the phone numbers can receive faxes. Can be: true
or false
.
@optional @param page_size [Int32?] How many resources to return in each list page. The default is 50, and the maximum is 1000.
@return [Tuple(Twilio::ListAvailablePhoneNumberNationalResponse, Integer, Hash)] Twilio::ListAvailablePhoneNumberNationalResponse, response status code and response headers
@required @param account_sid [String?] The SID of the Account requesting the AvailablePhoneNumber resources.
@required @param country_code [String?] The ISO-3166-1 country code of the country from which to read phone numbers.
@optional @param area_code [Int32?] The area code of the phone numbers to read. Applies to only phone numbers in the US and Canada.
@optional @param contains [String?] The pattern on which to match phone numbers. Valid characters are *
, 0-9
, a-z
, and A-Z
. The *
character matches any single digit. For examples, see Example 2 and Example 3. If specified, this value must have at least two characters.
@optional @param sms_enabled [Bool?] Whether the phone numbers can receive text messages. Can be: true
or false
.
@optional @param mms_enabled [Bool?] Whether the phone numbers can receive MMS messages. Can be: true
or false
.
@optional @param voice_enabled [Bool?] Whether the phone numbers can receive calls. Can be: true
or false
.
@optional @param exclude_all_address_required [Bool?] Whether to exclude phone numbers that require an Address. Can be: true
or false
and the default is false
.
@optional @param exclude_local_address_required [Bool?] Whether to exclude phone numbers that require a local Address. Can be: true
or false
and the default is false
.
@optional @param exclude_foreign_address_required [Bool?] Whether to exclude phone numbers that require a foreign Address. Can be: true
or false
and the default is false
.
@optional @param beta [Bool?] Whether to read phone numbers that are new to the Twilio platform. Can be: true
or false
and the default is true
.
@optional @param near_number [String?] Given a phone number, find a geographically close number within distance
miles. Distance defaults to 25 miles. Applies to only phone numbers in the US and Canada.
@optional @param near_lat_long [String?] Given a latitude/longitude pair lat,long
find geographically close numbers within distance
miles. Applies to only phone numbers in the US and Canada.
@optional @param distance [Int32?] The search radius, in miles, for a near_
query. Can be up to 500
and the default is 25
. Applies to only phone numbers in the US and Canada.
@optional @param in_postal_code [String?] Limit results to a particular postal code. Given a phone number, search within the same postal code as that number. Applies to only phone numbers in the US and Canada.
@optional @param in_region [String?] Limit results to a particular region, state, or province. Given a phone number, search within the same region as that number. Applies to only phone numbers in the US and Canada.
@optional @param in_rate_center [String?] Limit results to a specific rate center, or given a phone number search within the same rate center as that number. Requires in_lata
to be set as well. Applies to only phone numbers in the US and Canada.
@optional @param in_lata [String?] Limit results to a specific local access and transport area (LATA). Given a phone number, search within the same LATA as that number. Applies to only phone numbers in the US and Canada.
@optional @param in_locality [String?] Limit results to a particular locality or city. Given a phone number, search within the same Locality as that number.
@optional @param fax_enabled [Bool?] Whether the phone numbers can receive faxes. Can be: true
or false
.
@optional @param page_size [Int32?] How many resources to return in each list page. The default is 50, and the maximum is 1000.
@return [Twilio::ListAvailablePhoneNumberTollFreeResponse]
@required @param account_sid [String?] The SID of the Account requesting the AvailablePhoneNumber resources.
@required @param country_code [String?] The ISO-3166-1 country code of the country from which to read phone numbers.
@optional @param area_code [Int32?] The area code of the phone numbers to read. Applies to only phone numbers in the US and Canada.
@optional @param contains [String?] The pattern on which to match phone numbers. Valid characters are *
, 0-9
, a-z
, and A-Z
. The *
character matches any single digit. For examples, see Example 2 and Example 3. If specified, this value must have at least two characters.
@optional @param sms_enabled [Bool?] Whether the phone numbers can receive text messages. Can be: true
or false
.
@optional @param mms_enabled [Bool?] Whether the phone numbers can receive MMS messages. Can be: true
or false
.
@optional @param voice_enabled [Bool?] Whether the phone numbers can receive calls. Can be: true
or false
.
@optional @param exclude_all_address_required [Bool?] Whether to exclude phone numbers that require an Address. Can be: true
or false
and the default is false
.
@optional @param exclude_local_address_required [Bool?] Whether to exclude phone numbers that require a local Address. Can be: true
or false
and the default is false
.
@optional @param exclude_foreign_address_required [Bool?] Whether to exclude phone numbers that require a foreign Address. Can be: true
or false
and the default is false
.
@optional @param beta [Bool?] Whether to read phone numbers that are new to the Twilio platform. Can be: true
or false
and the default is true
.
@optional @param near_number [String?] Given a phone number, find a geographically close number within distance
miles. Distance defaults to 25 miles. Applies to only phone numbers in the US and Canada.
@optional @param near_lat_long [String?] Given a latitude/longitude pair lat,long
find geographically close numbers within distance
miles. Applies to only phone numbers in the US and Canada.
@optional @param distance [Int32?] The search radius, in miles, for a near_
query. Can be up to 500
and the default is 25
. Applies to only phone numbers in the US and Canada.
@optional @param in_postal_code [String?] Limit results to a particular postal code. Given a phone number, search within the same postal code as that number. Applies to only phone numbers in the US and Canada.
@optional @param in_region [String?] Limit results to a particular region, state, or province. Given a phone number, search within the same region as that number. Applies to only phone numbers in the US and Canada.
@optional @param in_rate_center [String?] Limit results to a specific rate center, or given a phone number search within the same rate center as that number. Requires in_lata
to be set as well. Applies to only phone numbers in the US and Canada.
@optional @param in_lata [String?] Limit results to a specific local access and transport area (LATA). Given a phone number, search within the same LATA as that number. Applies to only phone numbers in the US and Canada.
@optional @param in_locality [String?] Limit results to a particular locality or city. Given a phone number, search within the same Locality as that number.
@optional @param fax_enabled [Bool?] Whether the phone numbers can receive faxes. Can be: true
or false
.
@optional @param page_size [Int32?] How many resources to return in each list page. The default is 50, and the maximum is 1000.
@return nil
@required @param account_sid [String?] The SID of the Account requesting the AvailablePhoneNumber resources.
@required @param country_code [String?] The ISO-3166-1 country code of the country from which to read phone numbers.
@optional @param area_code [Int32?] The area code of the phone numbers to read. Applies to only phone numbers in the US and Canada.
@optional @param contains [String?] The pattern on which to match phone numbers. Valid characters are *
, 0-9
, a-z
, and A-Z
. The *
character matches any single digit. For examples, see Example 2 and Example 3. If specified, this value must have at least two characters.
@optional @param sms_enabled [Bool?] Whether the phone numbers can receive text messages. Can be: true
or false
.
@optional @param mms_enabled [Bool?] Whether the phone numbers can receive MMS messages. Can be: true
or false
.
@optional @param voice_enabled [Bool?] Whether the phone numbers can receive calls. Can be: true
or false
.
@optional @param exclude_all_address_required [Bool?] Whether to exclude phone numbers that require an Address. Can be: true
or false
and the default is false
.
@optional @param exclude_local_address_required [Bool?] Whether to exclude phone numbers that require a local Address. Can be: true
or false
and the default is false
.
@optional @param exclude_foreign_address_required [Bool?] Whether to exclude phone numbers that require a foreign Address. Can be: true
or false
and the default is false
.
@optional @param beta [Bool?] Whether to read phone numbers that are new to the Twilio platform. Can be: true
or false
and the default is true
.
@optional @param near_number [String?] Given a phone number, find a geographically close number within distance
miles. Distance defaults to 25 miles. Applies to only phone numbers in the US and Canada.
@optional @param near_lat_long [String?] Given a latitude/longitude pair lat,long
find geographically close numbers within distance
miles. Applies to only phone numbers in the US and Canada.
@optional @param distance [Int32?] The search radius, in miles, for a near_
query. Can be up to 500
and the default is 25
. Applies to only phone numbers in the US and Canada.
@optional @param in_postal_code [String?] Limit results to a particular postal code. Given a phone number, search within the same postal code as that number. Applies to only phone numbers in the US and Canada.
@optional @param in_region [String?] Limit results to a particular region, state, or province. Given a phone number, search within the same region as that number. Applies to only phone numbers in the US and Canada.
@optional @param in_rate_center [String?] Limit results to a specific rate center, or given a phone number search within the same rate center as that number. Requires in_lata
to be set as well. Applies to only phone numbers in the US and Canada.
@optional @param in_lata [String?] Limit results to a specific local access and transport area (LATA). Given a phone number, search within the same LATA as that number. Applies to only phone numbers in the US and Canada.
@optional @param in_locality [String?] Limit results to a particular locality or city. Given a phone number, search within the same Locality as that number.
@optional @param fax_enabled [Bool?] Whether the phone numbers can receive faxes. Can be: true
or false
.
@optional @param page_size [Int32?] How many resources to return in each list page. The default is 50, and the maximum is 1000.
@return [Tuple(Twilio::ListAvailablePhoneNumberTollFreeResponse, Integer, Hash)] Twilio::ListAvailablePhoneNumberTollFreeResponse, response status code and response headers
@required @param account_sid [String?] The SID of the Account requesting the AvailablePhoneNumber resources.
@required @param country_code [String?] The ISO-3166-1 country code of the country from which to read phone numbers.
@optional @param area_code [Int32?] The area code of the phone numbers to read. Applies to only phone numbers in the US and Canada.
@optional @param contains [String?] The pattern on which to match phone numbers. Valid characters are *
, 0-9
, a-z
, and A-Z
. The *
character matches any single digit. For examples, see Example 2 and Example 3. If specified, this value must have at least two characters.
@optional @param sms_enabled [Bool?] Whether the phone numbers can receive text messages. Can be: true
or false
.
@optional @param mms_enabled [Bool?] Whether the phone numbers can receive MMS messages. Can be: true
or false
.
@optional @param voice_enabled [Bool?] Whether the phone numbers can receive calls. Can be: true
or false
.
@optional @param exclude_all_address_required [Bool?] Whether to exclude phone numbers that require an Address. Can be: true
or false
and the default is false
.
@optional @param exclude_local_address_required [Bool?] Whether to exclude phone numbers that require a local Address. Can be: true
or false
and the default is false
.
@optional @param exclude_foreign_address_required [Bool?] Whether to exclude phone numbers that require a foreign Address. Can be: true
or false
and the default is false
.
@optional @param beta [Bool?] Whether to read phone numbers that are new to the Twilio platform. Can be: true
or false
and the default is true
.
@optional @param near_number [String?] Given a phone number, find a geographically close number within distance
miles. Distance defaults to 25 miles. Applies to only phone numbers in the US and Canada.
@optional @param near_lat_long [String?] Given a latitude/longitude pair lat,long
find geographically close numbers within distance
miles. Applies to only phone numbers in the US and Canada.
@optional @param distance [Int32?] The search radius, in miles, for a near_
query. Can be up to 500
and the default is 25
. Applies to only phone numbers in the US and Canada.
@optional @param in_postal_code [String?] Limit results to a particular postal code. Given a phone number, search within the same postal code as that number. Applies to only phone numbers in the US and Canada.
@optional @param in_region [String?] Limit results to a particular region, state, or province. Given a phone number, search within the same region as that number. Applies to only phone numbers in the US and Canada.
@optional @param in_rate_center [String?] Limit results to a specific rate center, or given a phone number search within the same rate center as that number. Requires in_lata
to be set as well. Applies to only phone numbers in the US and Canada.
@optional @param in_lata [String?] Limit results to a specific local access and transport area (LATA). Given a phone number, search within the same LATA as that number. Applies to only phone numbers in the US and Canada.
@optional @param in_locality [String?] Limit results to a particular locality or city. Given a phone number, search within the same Locality as that number.
@optional @param fax_enabled [Bool?] Whether the phone numbers can receive faxes. Can be: true
or false
.
@optional @param page_size [Int32?] How many resources to return in each list page. The default is 50, and the maximum is 1000.
@return [Twilio::ListAvailablePhoneNumberVoipResponse]
@required @param account_sid [String?] The SID of the Account requesting the AvailablePhoneNumber resources.
@required @param country_code [String?] The ISO-3166-1 country code of the country from which to read phone numbers.
@optional @param area_code [Int32?] The area code of the phone numbers to read. Applies to only phone numbers in the US and Canada.
@optional @param contains [String?] The pattern on which to match phone numbers. Valid characters are *
, 0-9
, a-z
, and A-Z
. The *
character matches any single digit. For examples, see Example 2 and Example 3. If specified, this value must have at least two characters.
@optional @param sms_enabled [Bool?] Whether the phone numbers can receive text messages. Can be: true
or false
.
@optional @param mms_enabled [Bool?] Whether the phone numbers can receive MMS messages. Can be: true
or false
.
@optional @param voice_enabled [Bool?] Whether the phone numbers can receive calls. Can be: true
or false
.
@optional @param exclude_all_address_required [Bool?] Whether to exclude phone numbers that require an Address. Can be: true
or false
and the default is false
.
@optional @param exclude_local_address_required [Bool?] Whether to exclude phone numbers that require a local Address. Can be: true
or false
and the default is false
.
@optional @param exclude_foreign_address_required [Bool?] Whether to exclude phone numbers that require a foreign Address. Can be: true
or false
and the default is false
.
@optional @param beta [Bool?] Whether to read phone numbers that are new to the Twilio platform. Can be: true
or false
and the default is true
.
@optional @param near_number [String?] Given a phone number, find a geographically close number within distance
miles. Distance defaults to 25 miles. Applies to only phone numbers in the US and Canada.
@optional @param near_lat_long [String?] Given a latitude/longitude pair lat,long
find geographically close numbers within distance
miles. Applies to only phone numbers in the US and Canada.
@optional @param distance [Int32?] The search radius, in miles, for a near_
query. Can be up to 500
and the default is 25
. Applies to only phone numbers in the US and Canada.
@optional @param in_postal_code [String?] Limit results to a particular postal code. Given a phone number, search within the same postal code as that number. Applies to only phone numbers in the US and Canada.
@optional @param in_region [String?] Limit results to a particular region, state, or province. Given a phone number, search within the same region as that number. Applies to only phone numbers in the US and Canada.
@optional @param in_rate_center [String?] Limit results to a specific rate center, or given a phone number search within the same rate center as that number. Requires in_lata
to be set as well. Applies to only phone numbers in the US and Canada.
@optional @param in_lata [String?] Limit results to a specific local access and transport area (LATA). Given a phone number, search within the same LATA as that number. Applies to only phone numbers in the US and Canada.
@optional @param in_locality [String?] Limit results to a particular locality or city. Given a phone number, search within the same Locality as that number.
@optional @param fax_enabled [Bool?] Whether the phone numbers can receive faxes. Can be: true
or false
.
@optional @param page_size [Int32?] How many resources to return in each list page. The default is 50, and the maximum is 1000.
@return nil
@required @param account_sid [String?] The SID of the Account requesting the AvailablePhoneNumber resources.
@required @param country_code [String?] The ISO-3166-1 country code of the country from which to read phone numbers.
@optional @param area_code [Int32?] The area code of the phone numbers to read. Applies to only phone numbers in the US and Canada.
@optional @param contains [String?] The pattern on which to match phone numbers. Valid characters are *
, 0-9
, a-z
, and A-Z
. The *
character matches any single digit. For examples, see Example 2 and Example 3. If specified, this value must have at least two characters.
@optional @param sms_enabled [Bool?] Whether the phone numbers can receive text messages. Can be: true
or false
.
@optional @param mms_enabled [Bool?] Whether the phone numbers can receive MMS messages. Can be: true
or false
.
@optional @param voice_enabled [Bool?] Whether the phone numbers can receive calls. Can be: true
or false
.
@optional @param exclude_all_address_required [Bool?] Whether to exclude phone numbers that require an Address. Can be: true
or false
and the default is false
.
@optional @param exclude_local_address_required [Bool?] Whether to exclude phone numbers that require a local Address. Can be: true
or false
and the default is false
.
@optional @param exclude_foreign_address_required [Bool?] Whether to exclude phone numbers that require a foreign Address. Can be: true
or false
and the default is false
.
@optional @param beta [Bool?] Whether to read phone numbers that are new to the Twilio platform. Can be: true
or false
and the default is true
.
@optional @param near_number [String?] Given a phone number, find a geographically close number within distance
miles. Distance defaults to 25 miles. Applies to only phone numbers in the US and Canada.
@optional @param near_lat_long [String?] Given a latitude/longitude pair lat,long
find geographically close numbers within distance
miles. Applies to only phone numbers in the US and Canada.
@optional @param distance [Int32?] The search radius, in miles, for a near_
query. Can be up to 500
and the default is 25
. Applies to only phone numbers in the US and Canada.
@optional @param in_postal_code [String?] Limit results to a particular postal code. Given a phone number, search within the same postal code as that number. Applies to only phone numbers in the US and Canada.
@optional @param in_region [String?] Limit results to a particular region, state, or province. Given a phone number, search within the same region as that number. Applies to only phone numbers in the US and Canada.
@optional @param in_rate_center [String?] Limit results to a specific rate center, or given a phone number search within the same rate center as that number. Requires in_lata
to be set as well. Applies to only phone numbers in the US and Canada.
@optional @param in_lata [String?] Limit results to a specific local access and transport area (LATA). Given a phone number, search within the same LATA as that number. Applies to only phone numbers in the US and Canada.
@optional @param in_locality [String?] Limit results to a particular locality or city. Given a phone number, search within the same Locality as that number.
@optional @param fax_enabled [Bool?] Whether the phone numbers can receive faxes. Can be: true
or false
.
@optional @param page_size [Int32?] How many resources to return in each list page. The default is 50, and the maximum is 1000.
@return [Tuple(Twilio::ListAvailablePhoneNumberVoipResponse, Integer, Hash)] Twilio::ListAvailablePhoneNumberVoipResponse, response status code and response headers