GET /api/v1/phone_numbers
Get the phone numbers assigned to your account.

Supported Formats

json, csv

Examples

wget "https://[your-subdomain].trackdrive.net/api/v1/phone_numbers?number=+441224980000&auth_token=[your-auth-token]"

Params

Param name
Description
auth_token
optional

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

  • Must be String

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
  • name
  • number
  • offer_id
  • traffic_source_id
  • provider_configuration_id
  • ring_pool_id
  • provider_auth_key
  • last_call_at
  • token_values
  • country
  • area_code_id
  • optimizer_displayed_at
  • optimizer_tokens_changed_at
  • created_at
  • plain_number
  • extension
  • checksum
  • human_number
  • 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

number
optional

The phone number.

  • Must be String

offer_id
optional

Refer to the offer api for details

  • Must be a decimal number.

traffic_source_id
optional

Refer to the traffic source api for details

  • Must be a decimal number.

provider_configuration_id
optional

Refer to the provider api for details

  • Must be a decimal number.

ring_pool_id
optional

Refer to the Number Pool api for details

  • Must be a decimal number.

last_call_at_to
optional

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

  • Must be String

last_call_at_from
optional

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

  • Must be String


POST /api/v1/phone_numbers
Purchase a new phone number using one of your existing provider configurations.

Supported Formats

json

Examples

curl -H "Content-Type: application/json" -X POST -d '{provider_configuration_id: 150, offer_id: 100, toll_free: true, country: 'US'}' https://[your-subdomain].trackdrive.net/api/v1/phone_numbers.json?auth_token=[your-auth-token]

Params

Param name
Description
auth_token
optional

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

  • Must be String

provider_configuration_id
required

Refer to the provider api for details

offer_id
required

Refer to the offer api for details

toll_free
required

Purchase a toll-free or local number? true for toll-free, false for local number.

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

country
required

The country where the number will be purchased.

  • Must be one of: AR, AT, AU, BE, BG, BH, BR, CA, CH, CL, CN, CO, CY, CZ, DE, DK, DO, EE, ES, FI, FR, GB, GE, GR, HK, HR, HU, ID, IE, IL, IT, JP, KR, LT, LU, LV, MT, MX, MY, NL, NO, NZ, PA, PE, PH, PK, PL, PR, PT, RO, RU, SE, SG, SI, SK, SV, TR, US, ZA.

traffic_source_id
optional

Refer to the traffic source api for details

ring_pool_id
optional

Refer to the Number Pool api for details

token_values
optional , nil allowed

Inbound calls will be tagged with these Extra Tokens.

  • Must be a valid list of filters. Example filters:
    ["interest:auto", "loan_amount:>=10000", "loan_amount:<=50000", "geo:!=800", "caller_id:!=anonymous"]


GET /api/v1/phone_numbers/:id
Show the details of phone number

Supported Formats

json

Examples

curl https://[your-subdomain].trackdrive.net/api/v1/phone_numbers/20590?auth_token=[your-auth-token]

Params

Param name
Description
auth_token
optional

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

  • Must be String

id
optional

This can be either the internal trackdrive id or the full phone number beginning with '+'
For example:
To find a number using trackdrive's internal id pass id=185923
To find a number using the phone number pass id=+18005002562"

  • Must be String


PUT /api/v1/phone_numbers/:id
Update a phone number's traffic source or Number Pool

Supported Formats

json

Examples

curl -H "Content-Type: application/json" -X PUT -d '{"traffic_source_id":"1002592"}' https://[your-subdomain].trackdrive.net/api/v1/phone_numbers/:id?auth_token=[your-auth-token]

Params

Param name
Description
auth_token
optional

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

  • Must be String

id
optional

This can be either the internal trackdrive id or the full phone number beginning with '+'
For example:
To find a number using trackdrive's internal id pass id=185923
To find a number using the phone number pass id=+18005002562"

  • Must be String

offer_id
optional

Refer to the offer api for details

traffic_source_id
optional

Refer to the traffic source api for details

ring_pool_id
optional

Refer to the Number Pool api for details

token_values
optional , nil allowed

Inbound calls will be tagged with these Extra Tokens.

  • Must be a valid list of filters. Example filters:
    ["interest:auto", "loan_amount:>=10000", "loan_amount:<=50000", "geo:!=800", "caller_id:!=anonymous"]


DELETE /api/v1/phone_numbers/:id
Unrent a phone number.

Supported Formats

json

Examples

curl -H "Content-Type: application/json" -X DELETE https://[your-subdomain].trackdrive.net/api/v1/phone_numbers/:id?auth_token=[your-auth-token]

Params

Param name
Description
auth_token
optional

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

  • Must be String

id
optional

This can be either the internal trackdrive id or the full phone number beginning with '+'
For example:
To find a number using trackdrive's internal id pass id=185923
To find a number using the phone number pass id=+18005002562"

  • Must be String