Supported Formats

json, csv

Examples

wget "https://[your-subdomain].trackdrive.net/api/v1/offers?page=1&order=created_at&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.

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

order
optional

Sort results by this field.

  • Must be one of: name, paused, user_offer_id, calls_count, recent_calls_count, last_call_at, numbers_count, created_at.

order_dir
optional

Sort results in ascending or descending order.

  • Must be one of: asc, desc.

fulltext
optional

Search for any record that matches this text

  • Must be String

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
  • created_at
  • updated_at
  • user_updated_at
  • user_offer_id
  • numbers_api_key
  • leads_api_key
  • max_cc_count
  • active_cc_count
  • in_progress_count
  • call_routers_attributes
  • Must be String


GET /api/v1/offers/:id
Get an offer by id.

Supported Formats

json

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/offers/:id
Update an offer by id.

Supported Formats

json

Params

Param name
Description
auth_token
optional

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

  • Must be String

reset_numbers_api_key
optional
  • Must be a boolean value: true, false, 0, 1

call_routers_attributes
optional

Configure how calls will be routed by this offer. [

{
 message_action_type: 'greeting',
 message_type: 'speak',
 text_to_speech: 'Please Press 1 To Be Connected To An Agent',
 message_loop: 2
},
{
 message_action_type: 'key_press_1',
 action: 'dial',
 buyer_ids: ['1819023']
}

]

  • Must be an Array of nested elements

call_routers_attributes[message_action_type]
required

Define how calls will be routed when they are directed at this offer.

  • Must be one of: greeting, key_press_1, key_press_2, key_press_3, key_press_4, key_press_5, key_press_6, key_press_7, key_press_8, key_press_9, key_press_0, key_press_#, key_press_*, no_key_press, any_other_key_press, all_buyers_closed, enter_extension, extension_failed, zip_code_entry, zip_entry_failed, add_to_hold_queue, hold_queue_is_full, no_buyers_match, no_buyers_have_open_concurrency_cap, caller_hang_up_before_conference, whisper, no_buyer_answered, press_1_to_accept, press_1_too_slow, caller_blocked.

call_routers_attributes[message_type]
optional

Play a text to speech message?

  • Must be one of: none, speak, audio.

call_routers_attributes[text_to_speech]
optional

The text to speech that will be spoken to the caller.

  • Must be String

call_routers_attributes[text_to_speech_gender]
optional

The gender of the TTS speaker.

  • Must be one of: Male, Female.

call_routers_attributes[message_loop]
optional

How many times will the message be repeated?

  • Must be a number.

call_routers_attributes[action]
optional

Choose an action. EG: dial a buyer, forward to an offer, hang up, etc.

  • Must be one of: dial, redirect, add_to_schedule, add_to_hold_queue, remove_from_schedule, block_caller, end_call, none.

call_routers_attributes[buyer_ids]
optional

If the action==dial, then callers will be forwarded to these buyers & buyer groups.

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

call_routers_attributes[buyer_group_ids]
optional

If the action==dial, then callers will be forwarded to these buyers & buyer groups.

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

call_routers_attributes[buyer_offer_ids]
optional

If the action==redirect, then callers will be forwarded to this offer.

  • Must be a number.

call_routers_attributes[schedule_id]
optional

If the action==add_to_schedule, then callers will be added to this schedule.

  • Must be a number.

call_routers_attributes[action_digit]
optional

If the action==add_to_schedule, then callers will be required to press this digit before being added to a schedule.

  • Must be a number.

call_routers_attributes[token_value_ids]
optional

The router will only be used if the caller matches these tokens.

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


DELETE /api/v1/offers/:id
Destroy an offer by id.

Supported Formats

json

Params

Param name
Description
auth_token
optional

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

  • Must be String