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 Value	Description
  call	Default response format.
  call_grid	Modern response format that returns various foreign keys for use with other API endpoints.

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.

Return the next page of results.

• Must be a number.

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

• Must be a number.

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

• Must be a String

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

• Must be a String

Search for any record that matches this text

• Must be a String

Date ranges will be parsed using this time zone.

• Must be a valid time zone. See the list of valid time zones.

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

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

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.

Match calls where the Traffic Source had a repeat caller.

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

Match calls where the Buyer had a repeat caller.

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

Did the buyer convert?

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

Did the traffic source convert?

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

Match calls that are on-going

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

Was the call placed on hold?

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

Match calls that have a recording.

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

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

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

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

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

Match calls that didn't connect to a Buyer

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

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

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

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.

Sort results in ascending or descending order.

• Must be one of: desc, asc.

Refer to the number api for details

• Must be a decimal number.

Refer to the offer api for details

• Must be a decimal number.

Schedule internal id.

• Must be a decimal number.

Refer to the traffic source api for details

• Must be a decimal number.

Refer to the buyer api for details

• Must be a decimal number.

Buyer Group Internal ids.

• Must be a decimal number.

Refer to the Number Pool api for details

• Must be a decimal number.

An Integer number eg: 12345

• Must be a decimal number.

Refer to the provider api for details

• Must be a decimal number.

Match calls that were placed by this caller.

• Must be a decimal number.

Match results that have this status.

• Must be a String

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

• Must be a String

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

• Must be a String

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 Value	Description
  call	Default response format.
  call_grid	Modern response format that returns various foreign keys for use with other API endpoints.

The caller number. EG: +17191112222

• Must be a String

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

• Must be a number.

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 Value	Description
  call	Default response format.
  call_grid	Modern response format that returns various foreign keys for use with other API endpoints.

• Must be a String

Return the next page of results.

• Must be a number.

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

• Must be a number.

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

• Must be a String

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

• Must be a String

Search for any record that matches this text

• Must be a String

Date ranges will be parsed using this time zone.

• Must be a valid time zone. See the list of valid time zones.

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

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

Match calls where the Traffic Source had a repeat caller.

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

Match calls where the Buyer had a repeat caller.

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

Did the buyer convert?

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

Did the traffic source convert?

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

Match calls that are on-going

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

Was the call placed on hold?

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

Match calls that have a recording.

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

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

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

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

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

Match calls that didn't connect to a Buyer

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

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

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

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.

Sort results in ascending or descending order.

• Must be one of: desc, asc.

Refer to the number api for details

• Must be a decimal number.

Refer to the offer api for details

• Must be a decimal number.

Schedule internal id.

• Must be a decimal number.

Refer to the traffic source api for details

• Must be a decimal number.

Refer to the buyer api for details

• Must be a decimal number.

Buyer Group Internal ids.

• Must be a decimal number.

Refer to the Number Pool api for details

• Must be a decimal number.

An Integer number eg: 12345

• Must be a decimal number.

Refer to the provider api for details

• Must be a decimal number.

Match calls that were placed by this caller.

• Must be a decimal number.

Match results that have this status.

• Must be a String

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

• Must be a String

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

• Must be a String

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.

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

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

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

• Must be a String

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

• Must be a String

Return the next page of results.

• Must be a number.

Match calls where the Traffic Source had a repeat caller.

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

Match calls where the Buyer had a repeat caller.

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

Did the buyer convert?

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

Did the traffic source convert?

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

Match calls that are on-going

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

Was the call placed on hold?

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

Match calls that have a recording.

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

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

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

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

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

Match calls that didn't connect to a Buyer

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

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

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

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.

Sort results in ascending or descending order.

• Must be one of: desc, asc.

Refer to the number api for details

• Must be a decimal number.

Refer to the offer api for details

• Must be a decimal number.

Schedule internal id.

• Must be a decimal number.

Refer to the traffic source api for details

• Must be a decimal number.

Refer to the buyer api for details

• Must be a decimal number.

Buyer Group Internal ids.

• Must be a decimal number.

Refer to the Number Pool api for details

• Must be a decimal number.

An Integer number eg: 12345

• Must be a decimal number.

Refer to the provider api for details

• Must be a decimal number.

Match calls that were placed by this caller.

• Must be a decimal number.

Match results that have this status.

• Must be a String

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

• Must be a String

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

• Must be a String

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 Value	Description
  call	Default response format.
  call_grid	Modern response format that returns various foreign keys for use with other API endpoints.

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

• Must be a String

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

• Must be a String

Optional. Associate this call with this lead.

• Must be a valid foreign key reference to an Lead. Refer to: /api/docs/1.0/leads

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.

• Must be a valid foreign key reference to an Schedule. Refer to: /api/docs/1.0/schedules

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

• Must be a valid foreign key reference to an Offer. Refer to: /api/docs/1.0/offers

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 Value	Description
  call	Default response format.
  call_grid	Modern response format that returns various foreign keys for use with other API endpoints.

Find the call by Call ID or Call UUID.
Example ID 123895022.
Example UUID c3b20b12-3b3b-4322-b15d-0f1c5f653479

• Must be a String

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 Value	Description
  call	Default response format.
  call_grid	Modern response format that returns various foreign keys for use with other API endpoints.

Find the call by Call ID or Call UUID.
Example ID 123895022.
Example UUID c3b20b12-3b3b-4322-b15d-0f1c5f653479

• Must be a String

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

• Must be a Hash

The revenue paid out for the call.

• Must be a decimal number.

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 this amount to the call's current payout.

• Must be a decimal number.

Did the buyer convert?

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

Update the winning Buyer that is assigned to this call.

• Must be a valid foreign key reference to an Buyer. Refer to: /api/docs/1.0/buyers

The amount paid to the traffic source.

• Must be a decimal number.

Did the traffic source convert?

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

Update the Traffic Source that is assigned to this call.

• Must be a valid foreign key reference to an Traffic Source. Refer to: /api/docs/1.0/traffic_sources

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

• Must be a String

Manually refire the listed outgoing webhook ids against this call.

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

Manually transcribe this call using the default transcription group.

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

Call Disposition

• Must be a valid foreign key reference to an Call Disposition. Refer to: /api/docs/1.0/call_dispositions

Notes

• Must be a String

The caller ID for the call that will be updated.

• Must be a String

The Dynamic Number Insertion token for the offer.

• Must be a String

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.

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 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 this amount to the call's current payout.

• Must be a decimal number.

Call Disposition

• Must be a valid foreign key reference to an Call Disposition. Refer to: /api/docs/1.0/call_dispositions

Notes

• Must be a String

Did the buyer convert?

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

Find the call by Call ID or Call UUID.
Example ID 123895022.
Example UUID c3b20b12-3b3b-4322-b15d-0f1c5f653479

• Must be a String

DTMF digit

• Must be a String

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

• Must be a Hash

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 Value	Description
  call	Default response format.
  call_grid	Modern response format that returns various foreign keys for use with other API endpoints.

Find the call by Call ID or Call UUID.
Example ID 123895022.
Example UUID c3b20b12-3b3b-4322-b15d-0f1c5f653479

• Must be a String