API documentation

GET /api/v1/ring_pools
List Phone Number Pools.

Params

Param name	Description Validations
ids Optional	Return records matching these ids. Validations: Must be an array of decimal values. EG: `[0, 1, 2, 3]`
page Optional	Return the next page of results. Validations: Must be a number.
per_page Optional	How many results to return per page. The default is 25. Validations: Must be a number.
created_at_to Optional	Date formatted like 2016-01-01 12:25:15 -0500 Validations: Must be a String
created_at_from Optional	Date formatted like 2016-01-01 12:25:15 -0500 Validations: Must be a String
fulltext Optional	Search for any record that matches this text Validations: Must be a String
time_zone Optional	Date ranges will be parsed using this time zone. Validations: Must be a valid time zone. See the list of valid time zones.
columns Optional	Specify the columns you would like returned by the API for a given resource. Limiting the columns can significantly increase API response time since only the requested data will be processed. columns=uuid,number,created_at Must be any combination of: id legacy_id type uuid created_at updated_at deleted_at user_updated_at routes_show_path routes_edit_path external_record_id context_menu_name company_id offer_id traffic_source_id numbers_count toll_free country description number_limit campaign_registry_id number_stockpile traffic_source_override_lead_traffic_source per_visitor tracking_type extensions_length extensions_minimum extensions_maximum provider_configuration_id auto_rent_numbers is_active provider name record_token_additional_id record_token_additional_data_count record_token_additional_data Validations: Must be a String
root Optional	Pass `root=false` to return results without a root node and metadata. For example: `GET /api/v1/calls?root=false` will return `[call1, call2, call3]` While: `GET /api/v1/calls` will return `{calls: [call1, call2, call3], metadata: {}}` Validations: Must be a boolean value: 1, true, yes, on, 0, false, no, off

GET /api/v1/ring_pools/new
Build Phone Number Pool with defaults.

Params

Param name	Description Validations
offer_id Optional Blank Value Allowed	Offer Validations: Must be a valid foreign key reference to an Offer. Refer to: /api/docs/1.0/offers
provider_configuration_id Optional Blank Value Allowed	Refer to the provider api for details Validations: Must be a valid foreign key reference to an Provider. Refer to: /api/docs/1.0/provider_configurations
traffic_source_id Optional Blank Value Allowed	Traffic Source Validations: Must be a valid foreign key reference to an Traffic Source. Refer to: /api/docs/1.0/traffic_sources
numbers_count Optional Blank Value Allowed	Numbers Count Validations: Must be a decimal number.
toll_free Optional Blank Value Allowed	Toll Free Validations: Must be a boolean value: 1, true, yes, on, 0, false, no, off
country Optional Blank Value Allowed	Country Validations: Must be a String
number_limit Optional Blank Value Allowed	Number Limit Validations: Must be a decimal number.
name Optional Blank Value Allowed	Name Validations: Must be a String

POST /api/v1/ring_pools
Create Phone Number Pool.

Params

Param name	Description Validations
offer_id Required	Offer Validations: Must be a valid foreign key reference to an Offer. Refer to: /api/docs/1.0/offers
provider_configuration_id Required	Refer to the provider api for details Validations: Must be a valid foreign key reference to an Provider. Refer to: /api/docs/1.0/provider_configurations
traffic_source_id Optional Blank Value Allowed	Traffic Source Validations: Must be a valid foreign key reference to an Traffic Source. Refer to: /api/docs/1.0/traffic_sources
numbers_count Optional Blank Value Allowed	Numbers Count Validations: Must be a decimal number.
toll_free Optional Blank Value Allowed	Toll Free Validations: Must be a boolean value: 1, true, yes, on, 0, false, no, off
country Optional Blank Value Allowed	Country Validations: Must be a String
number_limit Optional Blank Value Allowed	Number Limit Validations: Must be a decimal number.
name Optional Blank Value Allowed	Name Validations: Must be a String

GET /api/v1/ring_pools/:id
Get Phone Number Pool by id.

PUT /api/v1/ring_pools/:id
Update Phone Number Pool by id.

Params

Param name	Description Validations
offer_id Optional Blank Value Allowed	Offer Validations: Must be a valid foreign key reference to an Offer. Refer to: /api/docs/1.0/offers
provider_configuration_id Optional Blank Value Allowed	Refer to the provider api for details Validations: Must be a valid foreign key reference to an Provider. Refer to: /api/docs/1.0/provider_configurations
traffic_source_id Optional Blank Value Allowed	Traffic Source Validations: Must be a valid foreign key reference to an Traffic Source. Refer to: /api/docs/1.0/traffic_sources
numbers_count Optional Blank Value Allowed	Numbers Count Validations: Must be a decimal number.
toll_free Optional Blank Value Allowed	Toll Free Validations: Must be a boolean value: 1, true, yes, on, 0, false, no, off
country Optional Blank Value Allowed	Country Validations: Must be a String
number_limit Optional Blank Value Allowed	Number Limit Validations: Must be a decimal number.
name Optional Blank Value Allowed	Name Validations: Must be a String

DELETE /api/v1/ring_pools/:id
Destroy Phone Number Pool by id.