Calls

The phone calls that have been made to and from your account.

GET /calls

Authorization Required
https://[your-subdomain].trackdrive.com/api/v1/calls

List calls.

Search and list calls in your account with filters and pagination, or request the CSV format for bulk export. Returns computed call statistics as metadata for superusers. Superuser-restricted result sets are further limited to permitted stats and page size.

Supported Formats

json, csv

Params

Param name Description
serializer
Optional Blank value allowed

This endpoint supports multiple response formats. Pass serializer=name to retrieve data in an alternate format.

  • Must be a value contained in the pick list:
    Acceptable ValueDescription
    callDefault response format.
    call_gridModern response format that returns various foreign keys for use with other API endpoints.
page
Optional

Return the next page of results. A per_page request parameter > 10 is not allowed, cursor must be used instead.

  • Must be a number.
cursor
Optional

The API provides a technique called ‘cursoring’ to paginate large result sets. Cursoring separates results into pages (the size of which are defined by the per_page request parameter) and provides a means to move backwards and forwards through these pages. To retrieve cursored results, you initially pass a cursor with a value of -1 to the endpoint. By default, an API endpoint that supports cursoring will assume -1 was passed as cursor if you do not provide one. The response to a cursored request will contain metadata.next_cursor. The next_cursor is the cursor that you should send to the endpoint to receive the next batch of responses. You will know that you have requested the last available page of results when the API responds with a next_cursor = 0.

  • Must be a decimal 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 a String
created_at_from
Optional

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

  • Must be a String
fulltext
Optional

Search for any record that matches this text

  • Must be a 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
  • external_record_id
  • name
  • recording_url
  • category
  • number_called
  • number_id
  • connected_to
  • caller_number
  • offer
  • user_offer_id
  • offer_id
  • quality_assurance_user_id
  • quality_assurance_name
  • quality_assurance_id
  • agent_id
  • traffic_source
  • user_traffic_source_id
  • traffic_source_id
  • buyer
  • user_buyer_id
  • buyer_id
  • obfuscated_caller_number
  • caller_city
  • caller_country
  • token_values
  • total_duration
  • hold_duration
  • ivr_duration
  • attempted_duration
  • answered_duration
  • agent_duration
  • sub_id
  • schedule_id
  • schedule_name
  • ring_pool_id
  • status
  • buyer_converted
  • buyer_repeat_caller
  • buyer_revenue
  • revenue
  • traffic_source_converted
  • traffic_source_repeat_caller
  • traffic_source_payout
  • payout
  • trackdrive_cost
  • provider_cost
  • call_sid
  • provider
  • outgoing_webhooks_count
  • ended_at
  • contact_field_type
  • disposition_id
  • disposition_key
  • disposition_name
  • disposition_notes
  • hangup_cause

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

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

Dynamic Date String such as “Today” or “This Year”

  • Must be one of: Last 5 Min, Last 15 Min, Last 30 Min, Last Hour, Last 4 Hours, Last 6 Hours, Last 12 Hours, Last Day, Last 2 Days, Today, Yesterday, This Week, Last Week, This Month, Last Month, This Quarter, Last Quarter, Last 6 Months, This Year, Last Year, Lifetime, Custom Range.
offer_repeat_caller
Optional

Match calls where the Traffic Source had a repeat caller.

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

Match calls where the Buyer had a repeat caller.

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

Did the buyer convert?

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

Did the traffic source convert?

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

Match calls that are on-going

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

Was the call placed on hold?

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

Match calls that have a recording.

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

Whether this call’s buyer or traffic source has converted.

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

Match calls where the callerID was a duplicate against the Buyer’s conversion settings.

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

Match calls where the callerID was a duplicate against the Traffic Source’s conversion settings.

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

Match calls that didn’t connect to a Buyer

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

Calls that are tagged with this token will be matched. EG: token_key=buyer_id will return all calls that have a buyer_id token.

  • Must be a String
token_value
Optional

Will match calls that are tagged with a token:value. EG: token_key=buyer_id:12345 will return all calls that have a buyer_id token with the value set to 12345.

  • Must be a String
order
Optional

Sort results by this field.

  • Must be one of: direction, updated_at, start_app_duration, number_id, offer_id, traffic_source_id, sub_id, buyer_id, caller_number, updated_at, total_duration, hold_duration, ivr_duration, third_party_cost, charge_total, answered_duration, agent_duration, status, buyer_converted, revenue, offer_converted, payout, outgoing_webhooks_count, created_at, end_time, lead_id.
order_dir
Optional

Sort results in ascending or descending order.

  • Must be one of: desc, asc.
number_id
Optional

Refer to the number api for details

  • Must be a decimal number.
offer_id
Optional

Refer to the offer api for details

  • Must be a decimal number.
schedule_id
Optional

Schedule internal id.

  • Must be a decimal number.
traffic_source_id
Optional

Refer to the traffic source api for details

  • Must be a decimal number.
buyer_id
Optional

Refer to the buyer api for details

  • Must be a decimal number.
buyer_group_ids
Optional

Buyer Group Internal ids.

  • Must be a decimal number.
ring_pool_id
Optional

Refer to the Number Pool api for details

  • Must be a decimal number.
id
Optional

An Integer number eg: 12345

  • Must be a decimal number.
provider_configuration_id
Optional

Refer to the provider api for details

  • Must be a decimal number.
contact_id
Optional

Match calls that were placed by this caller.

  • Must be a decimal number.
status
Optional

Match results that have this status.

  • Must be a String
ended_at_to
Optional

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

  • Must be a String
ended_at_from
Optional

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

  • Must be a String

GET /calls/:caller_number/by_caller_number

Authorization Required
https://[your-subdomain].trackdrive.com/api/v1/calls/:caller_number/by_caller_number

List calls by caller number.

List the most recent calls placed by a specific caller number, newest first. Useful for looking up a caller without knowing the call id or uuid. Returns a 404 if no calls match that number.

Params

Param name Description
serializer
Optional Blank value allowed

This endpoint supports multiple response formats. Pass serializer=name to retrieve data in an alternate format.

  • Must be a value contained in the pick list:
    Acceptable ValueDescription
    callDefault response format.
    call_gridModern response format that returns various foreign keys for use with other API endpoints.
caller_number
Required

The caller number. EG: +17191112222

  • Must be a String
per_page
Optional

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

  • Must be a number.

GET /calls/live_calls

Authorization Required
https://[your-subdomain].trackdrive.com/api/v1/calls/live_calls

List ongoing live calls.

List calls that are currently in progress. Results are cached for a couple of seconds and limited to the calls the current user is permitted to see, so this is safe to poll for a live calls dashboard.

Supported Formats

json, csv

Params

Param name Description
serializer
Optional Blank value allowed

This endpoint supports multiple response formats. Pass serializer=name to retrieve data in an alternate format.

  • Must be a value contained in the pick list:
    Acceptable ValueDescription
    callDefault response format.
    call_gridModern response format that returns various foreign keys for use with other API endpoints.

GET /calls/reports

Authorization Required
https://[your-subdomain].trackdrive.com/api/v1/calls/reports

Get statistics on calls by category.

Get aggregate call statistics grouped by a category such as buyer, offer, or disposition, for a date range. Supports CSV output, and results can be limited to the stat types your permissions allow.

Supported Formats

json, csv

Params

Param name Description
category
Required

  • Must be a 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 a String
created_at_from
Optional

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

  • Must be a String
fulltext
Optional

Search for any record that matches this text

  • Must be a 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
  • external_record_id
  • name
  • recording_url
  • category
  • number_called
  • number_id
  • connected_to
  • caller_number
  • offer
  • user_offer_id
  • offer_id
  • quality_assurance_user_id
  • quality_assurance_name
  • quality_assurance_id
  • agent_id
  • traffic_source
  • user_traffic_source_id
  • traffic_source_id
  • buyer
  • user_buyer_id
  • buyer_id
  • obfuscated_caller_number
  • caller_city
  • caller_country
  • token_values
  • total_duration
  • hold_duration
  • ivr_duration
  • attempted_duration
  • answered_duration
  • agent_duration
  • sub_id
  • schedule_id
  • schedule_name
  • ring_pool_id
  • status
  • buyer_converted
  • buyer_repeat_caller
  • buyer_revenue
  • revenue
  • traffic_source_converted
  • traffic_source_repeat_caller
  • traffic_source_payout
  • payout
  • trackdrive_cost
  • provider_cost
  • call_sid
  • provider
  • outgoing_webhooks_count
  • ended_at
  • contact_field_type
  • disposition_id
  • disposition_key
  • disposition_name
  • disposition_notes
  • hangup_cause

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

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

Match calls where the Traffic Source had a repeat caller.

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

Match calls where the Buyer had a repeat caller.

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

Did the buyer convert?

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

Did the traffic source convert?

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

Match calls that are on-going

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

Was the call placed on hold?

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

Match calls that have a recording.

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

Whether this call’s buyer or traffic source has converted.

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

Match calls where the callerID was a duplicate against the Buyer’s conversion settings.

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

Match calls where the callerID was a duplicate against the Traffic Source’s conversion settings.

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

Match calls that didn’t connect to a Buyer

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

Calls that are tagged with this token will be matched. EG: token_key=buyer_id will return all calls that have a buyer_id token.

  • Must be a String
token_value
Optional

Will match calls that are tagged with a token:value. EG: token_key=buyer_id:12345 will return all calls that have a buyer_id token with the value set to 12345.

  • Must be a String
order
Optional

Sort results by this field.

  • Must be one of: direction, updated_at, start_app_duration, number_id, offer_id, traffic_source_id, sub_id, buyer_id, caller_number, updated_at, total_duration, hold_duration, ivr_duration, third_party_cost, charge_total, answered_duration, agent_duration, status, buyer_converted, revenue, offer_converted, payout, outgoing_webhooks_count, created_at, end_time, lead_id.
order_dir
Optional

Sort results in ascending or descending order.

  • Must be one of: desc, asc.
number_id
Optional

Refer to the number api for details

  • Must be a decimal number.
offer_id
Optional

Refer to the offer api for details

  • Must be a decimal number.
schedule_id
Optional

Schedule internal id.

  • Must be a decimal number.
traffic_source_id
Optional

Refer to the traffic source api for details

  • Must be a decimal number.
buyer_id
Optional

Refer to the buyer api for details

  • Must be a decimal number.
buyer_group_ids
Optional

Buyer Group Internal ids.

  • Must be a decimal number.
ring_pool_id
Optional

Refer to the Number Pool api for details

  • Must be a decimal number.
id
Optional

An Integer number eg: 12345

  • Must be a decimal number.
provider_configuration_id
Optional

Refer to the provider api for details

  • Must be a decimal number.
contact_id
Optional

Match calls that were placed by this caller.

  • Must be a decimal number.
status
Optional

Match results that have this status.

  • Must be a String
ended_at_to
Optional

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

  • Must be a String
ended_at_from
Optional

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

  • Must be a String

GET /calls/stats

Authorization Required
https://[your-subdomain].trackdrive.com/api/v1/calls/stats

Get call statistics by category and interval

Get call counts and statistics broken out by category and by time interval (for example hourly or daily buckets), suitable for charting call volume over time. The group_by category must be one your account is permitted to use.

Params

Param name Description
group_by
Required

Group calls by one of these attributes.

  • Must be one of: buyer_converted, offer_converted, status, created_at_five_minutes, created_at_day, created_at_week, created_at_month.
stat
Required

Return statistics on the grouped calls by one of these numeric columns.

  • Must be one of: count, revenue, profit, cost.
created_at_to
Required

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

  • Must be a String
created_at_from
Required

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

  • Must be a String
page
Optional

Return the next page of results.

  • Must be a number.
offer_repeat_caller
Optional

Match calls where the Traffic Source had a repeat caller.

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

Match calls where the Buyer had a repeat caller.

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

Did the buyer convert?

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

Did the traffic source convert?

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

Match calls that are on-going

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

Was the call placed on hold?

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

Match calls that have a recording.

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

Whether this call’s buyer or traffic source has converted.

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

Match calls where the callerID was a duplicate against the Buyer’s conversion settings.

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

Match calls where the callerID was a duplicate against the Traffic Source’s conversion settings.

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

Match calls that didn’t connect to a Buyer

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

Calls that are tagged with this token will be matched. EG: token_key=buyer_id will return all calls that have a buyer_id token.

  • Must be a String
token_value
Optional

Will match calls that are tagged with a token:value. EG: token_key=buyer_id:12345 will return all calls that have a buyer_id token with the value set to 12345.

  • Must be a String
order
Optional

Sort results by this field.

  • Must be one of: direction, updated_at, start_app_duration, number_id, offer_id, traffic_source_id, sub_id, buyer_id, caller_number, updated_at, total_duration, hold_duration, ivr_duration, third_party_cost, charge_total, answered_duration, agent_duration, status, buyer_converted, revenue, offer_converted, payout, outgoing_webhooks_count, created_at, end_time, lead_id.
order_dir
Optional

Sort results in ascending or descending order.

  • Must be one of: desc, asc.
number_id
Optional

Refer to the number api for details

  • Must be a decimal number.
offer_id
Optional

Refer to the offer api for details

  • Must be a decimal number.
schedule_id
Optional

Schedule internal id.

  • Must be a decimal number.
traffic_source_id
Optional

Refer to the traffic source api for details

  • Must be a decimal number.
buyer_id
Optional

Refer to the buyer api for details

  • Must be a decimal number.
buyer_group_ids
Optional

Buyer Group Internal ids.

  • Must be a decimal number.
ring_pool_id
Optional

Refer to the Number Pool api for details

  • Must be a decimal number.
id
Optional

An Integer number eg: 12345

  • Must be a decimal number.
provider_configuration_id
Optional

Refer to the provider api for details

  • Must be a decimal number.
contact_id
Optional

Match calls that were placed by this caller.

  • Must be a decimal number.
status
Optional

Match results that have this status.

  • Must be a String
ended_at_to
Optional

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

  • Must be a String
ended_at_from
Optional

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

  • Must be a String

POST /calls

Authorization Required
https://[your-subdomain].trackdrive.com/api/v1/calls

Make an outbound phone call.

Place an outbound call from a phone number in your account. If no lead or schedule is specified, a lead is created or matched automatically; the call fails if the schedule or offer cannot be resolved from the from number.

Params

Param name Description
serializer
Optional

This endpoint supports multiple response formats. Pass serializer=name to retrieve data in an alternate format.

  • Must be a value contained in the pick list:
    Acceptable ValueDescription
    callDefault response format.
    call_gridModern response format that returns various foreign keys for use with other API endpoints.
from
Required

The call will originate from this address (+E.164 formatted phone number.) Example: +18665550001

  • Must be a String
to
Required

The call will be placed to this receiving address (+E.164 formatted phone number.) Example: +18665550001

  • Must be a String
lead_id
Optional

Optional. Associate this call with this lead.
schedule_id
Optional

Optional. If a lead exists on this schedule, this call will be associated with it. If no lead currently exists, one will be created, and it will be added to this schedule.
offer_id
Optional

Optional. Associate this call with a matching lead on this offer. If no lead currently exists, one will be created on this offer.

GET /calls/:id

Authorization Required
https://[your-subdomain].trackdrive.com/api/v1/calls/:id

Get a call by id or uuid.

Get the full details of a single call by its internal id or uuid.

Params

Param name Description
serializer
Optional Blank value allowed

This endpoint supports multiple response formats. Pass serializer=name to retrieve data in an alternate format.

  • Must be a value contained in the pick list:
    Acceptable ValueDescription
    callDefault response format.
    call_gridModern response format that returns various foreign keys for use with other API endpoints.
id
Optional

Find the call by Call ID or Call UUID.

Example ID 123895022.

Example UUID c3b20b12-3b3b-4322-b15d-0f1c5f653479

  • Must be a String

GET /calls/:id/events

Authorization Required
https://[your-subdomain].trackdrive.com/api/v1/calls/:id/events

Get a call's event log

Advanced Call Analysis provides detailed event logs of telephonic interactions. This feature captures an array of events including call channels, agent interactions, outgoing HTTP requests, buyer pings, call recordings, and more. Each advanced call analysis request incurs a usage charge billed at your account’s Per Advanced Call Analysis Rate, shown on your Rate Sheet. The default rate is 0.0002/request.

POST /calls/:id

Authorization Required
https://[your-subdomain].trackdrive.com/api/v1/calls/:id

Update a call by ID or UUID

Update a call by Call ID or Call UUID with contact fields, revenue, payout, and more.

Params

Param name Description
serializer
Optional Blank value allowed

This endpoint supports multiple response formats. Pass serializer=name to retrieve data in an alternate format.

  • Must be a value contained in the pick list:
    Acceptable ValueDescription
    callDefault response format.
    call_gridModern response format that returns various foreign keys for use with other API endpoints.
id
Optional

Find the call by Call ID or Call UUID.

Example ID 123895022.

Example UUID c3b20b12-3b3b-4322-b15d-0f1c5f653479

  • Must be a String
post_call_tokens
Optional

Custom contact fields defined on the offer.
EG: {first_name: "John", last_name: "Smith", zip_code: "90210"}

  • Must be a Hash
revenue
Optional

The revenue paid out for the call.

  • Must be a decimal number.
add_revenue
Optional

Add this amount to the call’s current revenue. For example pass 2.5 to add 2.5 to the current call revenue. If the call revenue is currently 10.50, the revenue would become 13 (10.50 + 2.50)

  • Must be a decimal number.
add_payout
Optional

Add this amount to the call’s current payout.

  • Must be a decimal number.
buyer_converted
Optional

Did the buyer convert?

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

Update the winning Buyer that is assigned to this call.
payout
Optional

The amount paid to the traffic source.

  • Must be a decimal number.
offer_converted
Optional

Did the traffic source convert?

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

Update the Traffic Source that is assigned to this call.
contact_field_type
Optional

Pass an ID belonging to an Agent Script & Field Type to select that Custom Contact Field Type for this call.

  • Must be a String
fire_outgoing_webhook_ids
Optional

Manually refire the listed outgoing webhook ids against this call.

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

Manually transcribe this call using the default transcription group.

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

Call Disposition
agent_call_disposition_notes
Optional Blank value allowed

Notes

  • Must be a String
blocked
Optional Blank value allowed

Block or unblock this caller’s number. Blocking prevents outbound calls, SMS, and email to them, and blocks their inbound calls and SMS too.

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

The Agent Script this call is showing to the agent, which controls its custom fields and instructions.

  • 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
description
Optional Blank value allowed

A human readable description of the record.

  • Must be a String
hang_up
Optional Blank value allowed

Set to true to immediately hang up this call.

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

The externally hosted recording URL for this call, before it is copied to Trackdrive’s own storage.

  • Must be a String
reapply_conversions
Optional Blank value allowed

Set to true to reapply this call’s buyer and offer conversion logic using its current revenue and payout.

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

Manually refire the webhooks associated with this call.

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

Schedule an immediate callback.

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

Schedule a callback sometime in the next hour.

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

POST /calls/update_by_caller_id/:caller_id

Authorization Required
https://[your-subdomain].trackdrive.com/api/v1/calls/update_by_caller_id/:caller_id

Update a call's revenue by caller ID

Update a call’s revenue and buyer_converted using the call’s caller_id and offer_token

Params

Param name Description
caller_id
Required

The caller ID for the call that will be updated.

  • Must be a String
offer_token
Required

The Dynamic Number Insertion token for the offer.

  • Must be a String
call_timeframe
Optional

Pass this optional parameter to restrict the call update to calls made in the last call_timeframe minutes. For Example: Pass 120 if you’d like to only update calls made in the last 2 hours. This is useful if you only want to update a call that happened recently.

  • Must be a number.
revenue
Optional

Set the call’s revenue to this amount. For example pass 10.50 to set the revenue to 10.50

  • Must be a decimal number.
add_revenue
Optional

Add this amount to the call’s current revenue. For example pass 2.5 to add 2.5 to the current call revenue. If the call revenue is currently 10.50, the revenue would become 13 (10.50 + 2.50)

  • Must be a decimal number.
add_payout
Optional

Add this amount to the call’s current payout.

  • Must be a decimal number.
call_disposition_id
Optional Blank value allowed

Call Disposition
agent_call_disposition_notes
Optional Blank value allowed

Notes

  • Must be a String
buyer_converted
Optional

Did the buyer convert?

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

POST /calls/send_key_press

Authorization Required
https://[your-subdomain].trackdrive.com/api/v1/calls/send_key_press

Trigger a key press flow

Simulate a caller pressing DTMF digits on a live call, triggering whatever key-press flow is currently listening on that call leg. Optionally updates the call data at the same time.

Params

Param name Description
id
Required

Find the call by Call ID or Call UUID.

Example ID 123895022.

Example UUID c3b20b12-3b3b-4322-b15d-0f1c5f653479

  • Must be a String
digits
Required

DTMF digit

  • Must be a String
data
Optional Blank value allowed

Update the call with this data. {interest: 'kittens', source: 'google', first_name: 'John', last_name: 'Smith'}

  • Must be a Hash

DELETE /calls/:id

Authorization Required
https://[your-subdomain].trackdrive.com/api/v1/calls/:id

Hang up an ongoing call.

Hang up an ongoing call immediately. This is a superuser-only, irreversible action that ends the call for all parties on the line.

Params

Param name Description
serializer
Optional Blank value allowed

This endpoint supports multiple response formats. Pass serializer=name to retrieve data in an alternate format.

  • Must be a value contained in the pick list:
    Acceptable ValueDescription
    callDefault response format.
    call_gridModern response format that returns various foreign keys for use with other API endpoints.
id
Optional

Find the call by Call ID or Call UUID.

Example ID 123895022.

Example UUID c3b20b12-3b3b-4322-b15d-0f1c5f653479

  • Must be a String