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

Params

Param name
Description
auth_token
Optional

Authorize requests using your token. Get it from your profile: trackdrive.net/profile/edit

  • Must be String

ids
Optional

Return records matching these ids.

  • Must be an array of decimal values. EG: [0, 1, 2, 3]

page
Optional

Return the next page of results.

  • Must be a number.

per_page
Optional

How many results to return per page. The default is 25.

  • Must be a number.

created_at_to
Optional

Date formatted like 2016-01-01 12:25:15 -0500

  • Must be String

created_at_from
Optional

Date formatted like 2016-01-01 12:25:15 -0500

  • Must be String

fulltext
Optional

Search for any record that matches this text

  • Must be String

time_zone
Optional

Date ranges will be parsed using this time zone.

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
  • 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
  • Must be 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: {}}

  • 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
auth_token
Optional

Authorize requests using your token. Get it from your profile: trackdrive.net/profile/edit

  • Must be String

offer_id
Optional Blank Value Allowed

Offer

traffic_source_id
Optional Blank Value Allowed

Traffic Source

numbers_count
Optional Blank Value Allowed

Numbers Count

  • Must be a decimal number.

toll_free
Optional Blank Value Allowed

Toll Free

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off

country
Optional Blank Value Allowed

Country

  • Must be String

number_limit
Optional Blank Value Allowed

Number Limit

  • Must be a decimal number.

name
Optional Blank Value Allowed

Name

  • Must be String


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

Params

Param name
Description
auth_token
Optional

Authorize requests using your token. Get it from your profile: trackdrive.net/profile/edit

  • Must be String

offer_id
Optional Blank Value Allowed

Offer

traffic_source_id
Optional Blank Value Allowed

Traffic Source

numbers_count
Optional Blank Value Allowed

Numbers Count

  • Must be a decimal number.

toll_free
Optional Blank Value Allowed

Toll Free

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off

country
Optional Blank Value Allowed

Country

  • Must be String

number_limit
Optional Blank Value Allowed

Number Limit

  • Must be a decimal number.

name
Optional Blank Value Allowed

Name

  • Must be String


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

Params

Param name
Description
auth_token
Optional

Authorize requests using your token. Get it from your profile: trackdrive.net/profile/edit

  • Must be String


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

Params

Param name
Description
auth_token
Optional

Authorize requests using your token. Get it from your profile: trackdrive.net/profile/edit

  • Must be String

offer_id
Optional Blank Value Allowed

Offer

traffic_source_id
Optional Blank Value Allowed

Traffic Source

numbers_count
Optional Blank Value Allowed

Numbers Count

  • Must be a decimal number.

toll_free
Optional Blank Value Allowed

Toll Free

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off

country
Optional Blank Value Allowed

Country

  • Must be String

number_limit
Optional Blank Value Allowed

Number Limit

  • Must be a decimal number.

name
Optional Blank Value Allowed

Name

  • Must be String


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

Params

Param name
Description
auth_token
Optional

Authorize requests using your token. Get it from your profile: trackdrive.net/profile/edit

  • Must be String