API documentation

GET /ring_pools/new

Authorization Required

https://[your-subdomain].trackdrive.net/api/v1/ring_pools/new

Build Phone Number Pool with defaults.

Returns a phone number pool built with default attributes for previewing available fields. It is not saved.

Params

Param name	Description
offer_id Optional Blank value allowed	Offer 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 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 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 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 a String
number_limit Optional Blank value allowed	Number Limit Must be a decimal number.
name Optional Blank value allowed	Name Must be a String
description Optional Blank value allowed	A human readable description of this Number Pool. Must be a String
external_record_id Optional Blank value allowed	Your own identifier for this Number Pool, used to correlate it with a record in an external system. Must be a String
is_active Optional Blank value allowed	Use this Number Pool for Dynamic Number Insertion. Only one Number Pool can be active per Offer and Traffic Source. Must be a boolean value: 1, true, yes, on, 0, false, no, off
per_visitor Optional Blank value allowed	Assign each website visitor their own number from the pool, so calls can be attributed to that visitor. Must be a boolean value: 1, true, yes, on, 0, false, no, off
token_hold_time Optional Blank value allowed	How many seconds a number stays assigned to a caller’s token before it can be reassigned. Must be a decimal number.
number_stockpile Optional Blank value allowed	How many numbers to keep in reserve, ready and unassigned, within this pool. Must be a decimal number.
auto_rent_numbers Optional Blank value allowed	Automatically purchase numbers up to the Number Limit as they are needed. Must be a boolean value: 1, true, yes, on, 0, false, no, off
area_code_id Optional Blank value allowed	The preferred area code to purchase numbers from when Auto Rent Numbers is enabled. Must be an 8-bit integer ID or a 128-bit UUID reference to an object on Trackdrive. Example ID: 289302820, Example UUID: 924c37d5-e70f-42ad-84c2-e85eb0c1bc21
hide_embedded_access Optional Blank value allowed	Prevent this Number Pool from being used for embedded Dynamic Number Insertion access on more than one Traffic Source per Offer. Must be a boolean value: 1, true, yes, on, 0, false, no, off
google_analytics Optional Blank value allowed	Track calls from this Number Pool with Google Analytics. Must be a boolean value: 1, true, yes, on, 0, false, no, off
google_analytics_account Optional Blank value allowed	Your Google Analytics account id used when Google Analytics is enabled. Must be a String
maximum_ping_time Optional Blank value allowed	The maximum number of seconds a browser will wait for a number to be returned before giving up. Must be a decimal number.
extensions_length Optional Blank value allowed	The number of digits used for extensions when Extensions are enabled on this Number Pool. Must be a decimal number.
extensions_minimum Optional Blank value allowed	The lowest extension number that can be assigned. Must be a decimal number.
extensions_maximum Optional Blank value allowed	The highest extension number that can be assigned. Must be a decimal number.
campaign_registry_id Optional Blank value allowed	The Campaign Registry ID applied to every number in this pool for SMS compliance. Must be a String
campaign_registry_approve Optional Blank value allowed	Manually mark every number in this pool as Campaign Registry approved. Must be a boolean value: 1, true, yes, on, 0, false, no, off
campaign_registry_unapprove Optional Blank value allowed	Manually mark every number in this pool as Campaign Registry unapproved. Must be a boolean value: 1, true, yes, on, 0, false, no, off
fill_pool Optional Blank value allowed	Immediately purchase numbers until this pool reaches its Number Limit. Must be a boolean value: 1, true, yes, on, 0, false, no, off
traffic_source_override_lead_traffic_source Optional Blank value allowed	Force calls placed to this Number Pool’s numbers to credit this pool’s Traffic Source, even when the lead’s Traffic Source is different. Must be a boolean value: 1, true, yes, on, 0, false, no, off
dial_with_area_codes Optional Blank value allowed	When placing outbound calls, prefer a number from the pool matching the consumer’s area code. If none is available, an area code match from area_code_maps or any toll free number in the pool is used instead. Must be a boolean value: 1, true, yes, on, 0, false, no, off
dial_with_any_state_area_code Optional Blank value allowed	When Dial With Area Codes is enabled and no matching area code is available, allow dialing with any area code in the consumer’s state. Must be a boolean value: 1, true, yes, on, 0, false, no, off
attribution_token_value_ids Optional Blank value allowed	The ids of the Token Values whose tokens will be additionally applied to calls handled by this Number Pool. Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an Token Value. Refer to: /api/docs/1.0/token_values
record_token_additional_list Optional Blank value allowed	Assign additional tokens that will be applied to calls handled by this Number Pool by passing a comma separated string of key:value pairs. Must be a valid list of tokens. Example tokens: `buyer_interest:loan,another_token:value`
cid Optional Blank value allowed	Alternative to offer_id. Matches an Offer by your own external Offer identifier instead. Must be a String
afid Optional Blank value allowed	Alternative to traffic_source_id. Matches a Traffic Source by your own external Traffic Source identifier instead. Must be a String
number_type Optional Blank value allowed	The type of Number Pool, such as RingPool for phone tracking numbers or SmsNumberGroup for SMS sending numbers. Must be a String

Example Request

curl 'https://[your-subdomain].trackdrive.net/api/v1/ring_pools/new' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "ring_pool": {
    "id": null,
    "type": "RingPool",
    "uuid": null,
    "created_at": null,
    "updated_at": null,
    "deleted_at": null,
    "user_updated_at": null,
    "routes_show_path": "/ring_pools/new",
    "routes_edit_path": "/ring_pools/new",
    "external_record_id": null,
    "context_menu_name": "Phone Numbers",
    "company_id": 10001,
    "offer_id": null,
    "traffic_source_id": null,
    "numbers_count": 0,
    "toll_free": true,
    "country": "US",
    "description": null,
    "number_limit": 10,
    "campaign_registry_id": null,
    "number_stockpile": 1,
    "traffic_source_override_lead_traffic_source": null,
    "per_visitor": false,
    "tracking_type": null,
    "extensions_length": null,
    "extensions_minimum": null,
    "extensions_maximum": null,
    "provider_configuration_id": null,
    "auto_rent_numbers": true,
    "is_active": null,
    "provider": null,
    "name": "Phone Numbers",
    "record_token_additional_id": null,
    "record_token_additional_data_count": 0,
    "record_token_additional_data": []
  },
  "metadata": {
    "root": "ring_pool"
  }
}