Method: Phaxio::Resources::PhoneNumber.list

Defined in:
lib/phaxio/resources/phone_number.rb

.list(params = {}) ⇒ Phaxio::Resource::Collection<Phaxio::Resources::PhoneNumber>

Note:

This action accepts paging parameters:

  • per_page [Integer] - The maximum number of results to return per call (i.e. “page”). Max 1000.

  • page [Integer] - The page number to return for the request. 1-based.

Get a list of phone numbers that you currently own on Phaxio.

Parameters:

  • params (Hash) (defaults to: {}) —

    A hash of parameters to send to Phaxio.

    • country_code [Integer] - An E.164 country code that you’d like to filter by.

    • area_code [Integer] - An area code that you’d like to filter by. If an area code is specified, then country_code is required.

Returns:

Raises:

See Also:



106
107
108
109
 
# File 'lib/phaxio/resources/phone_number.rb', line 106

def list params = {}
  response = Client.request :get, phone_numbers_endpoint, params
  response_collection response
end