Available Numbers

search_available_local_numbers

Client.search_available_local_numbers(city=None, state=None, zip_code=None, area_code=None, local_number=None, in_local_calling_area=None, quantity=None, pattern=None, **kwargs)

Searches for available local or toll free numbers.

Parameters:
  • city (str) – A city name
  • state (str) – A two-letter US state abbreviation
  • zip_code (str) – A 5-digit US ZIP code
  • area_code (str) – A 3-digit telephone area code
  • local_number (str) – It is defined as the first digits of a telephone number inside an area code for filtering the results. It must have at least 3 digits and the areaCode field must be filled.
  • in_local_calling_area (str) – Boolean value to indicate that the search for available numbers must consider overlayed areas.
  • quantity (int) – The maximum number of numbers to return (default 10, maximum 5000)
  • pattern (str) – A number pattern that may include letters, digits, and the wildcard characters
Return type:

list
Returns:

list of numbers

Example: Search for 3 910 numbers:

numbers = api.search_available_local_numbers(area_code = '910', quantity = 3)

print(numbers)

## [   {   'city'          : 'WILMINGTON',
##         'national_number': '(910) 444-0230',
##         'number'        : '+19104440230',
##         'price'         : '0.35',
##         'rate_center'    : 'WILMINGTON',
##         'state'         : 'NC'},
##     {   'city'          : 'WILMINGTON',
##         'national_number': '(910) 444-0263',
##         'number'        : '+19104440263',
##         'price'         : '0.35',
##         'rate_center'    : 'WILMINGTON',
##         'state'         : 'NC'},
##     {   'city'          : 'WILMINGTON',
##         'national_number': '(910) 444-0268',
##         'number'        : '+19104440268',
##         'price'         : '0.35',
##         'rate_center'    : 'WILMINGTON',
##         'state'         : 'NC'}
## ]

print(numbers[0]["number"])
## +19104440230

search_available_toll_free_numbers

Client.search_available_toll_free_numbers(quantity=None, pattern=None, **kwargs)

Searches for available local or toll free numbers.

Parameters:
  • quantity (int) – The maximum number of numbers to return (default 10, maximum 5000)
  • pattern (str) – A number pattern that may include letters, digits, and the wildcard characters
Return type:

list
Returns:

list of numbers

Example: Search for 3 toll free numbers with pattern 456:

numbers = api.search_available_toll_free_numbers(pattern = '*456', quantity = 3)

print(numbers)

## [   {   'national_number': '(844) 489-0456',
##         'number'        : '+18444890456',
##         'pattern_match'  : '           456',
##         'price'         : '0.75'},
##     {   'national_number': '(844) 498-2456',
##         'number'        : '+18444982456',
##         'pattern_match'  : '           456',
##         'price'         : '0.75'},
##     {   'national_number': '(844) 509-4566',
##         'number'        : '+18445094566',
##         'pattern_match'  : '          456 ',
##         'price'         : '0.75'}]

print(numbers[0]["number"])
## +18444890456

search_and_order_local_numbers

Client.search_and_order_local_numbers(city=None, state=None, zip_code=None, area_code=None, local_number=None, in_local_calling_area=None, quantity=None, **kwargs)

Searches and orders for available local numbers.

Parameters:
  • city (str) – A city name
  • state (str) – A two-letter US state abbreviation
  • zip_code (str) – A 5-digit US ZIP code
  • area_code (str) – A 3-digit telephone area code
  • local_number (str) – It is defined as the first digits of a telephone number inside an area code for filtering the results. It must have at least 3 digits and the areaCode field must be filled.
  • in_local_calling_area (str) – Boolean value to indicate that the search for available numbers must consider overlayed areas.
  • quantity (int) – The maximum number of numbers to return (default 10, maximum 5000)
Return type:

list
Returns:

list of ordered numbers

Example: Search _and_ order a single number:

ordered_numbers = api.search_and_order_available_numbers(zip = '27606', quantity = 1)

print(ordered_numbers)

## [   {   'city'          : 'RALEIGH',
##         'id'            : 'n-abc',
##         'location'      : 'https://api.catapult.inetwork.com/v1/users/u-12/phoneNumbers/n-abc',
##         'national_number': '(919) 222-4444',
##         'number'        : '+19192224444',
##         'price'         : '0.35',
##         'state'         : 'NC'}]

search_and_order_toll_free_numbers

Client.search_and_order_toll_free_numbers(quantity, **kwargs)

Searches for available local or toll free numbers.

Query parameters for toll free numbers :param int quantity: The maximum number of numbers to return (default 10, maximum 5000)

Return type:list
Returns:list of numbers

Example: Search then order a single toll-free number:

numbers = api.search_and_order_toll_free_numbers(quantity = 1)

print(numbers)

## [   {   'location'      : 'https://api.catapult.inetwork.com/v1/users/u-123/phoneNumbers/n-abc',
##         'national_number': '(844) 484-1048',
##         'number'        : '+18444841048',
##         'price'         : '0.75'}]

print(numbers[0]["number"])
## +18444841048