Agents: Call Centers

A group of agents who share softphone settings and can be assigned to handle calls together.

GET /call_centers

Authorization Required
https://[your-subdomain].trackdrive.net/api/v1/call_centers

List Call Center records.

List the call centers configured in your account, used to group agents under a shared softphone provider.

Params

Param name Description
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
  • company_id
  • user_id
  • sortable_order
  • name
  • description
  • user_call_center_id
  • context_menu_name
  • softphone_host
  • record_token_additional_id
  • record_token_additional_data_count
  • record_token_additional_data
  • 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

GET /call_centers/new

Authorization Required
https://[your-subdomain].trackdrive.net/api/v1/call_centers/new

Build Call Center with defaults.

Return a new, unsaved call center pre-filled with defaults.

Params

Param name Description
name
Optional Blank value allowed

Name

  • Must be a String

description
Optional Blank value allowed

Description

  • Must be a String

user_call_center_id
Optional Blank value allowed

Your external ID for this call center.

  • Must be a String

record_token_additional_id
Optional Blank value allowed

Record Token Additional

  • Must be a String

external_record_id
Optional Blank value allowed

Your own identifier for this call center, used to correlate it with a record in an external system.

  • Must be a String

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 call center.

record_token_additional_list
Optional Blank value allowed

Assign additional tokens that will be applied to leads and calls 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

POST /call_centers

Authorization Required
https://[your-subdomain].trackdrive.net/api/v1/call_centers

Create Call Center.

Create a call center with a name and your own external identifier (user_call_center_id), and choose the softphone provider its agents will connect through.

Params

Param name Description
name
Optional Blank value allowed

Name

  • Must be a String

description
Optional Blank value allowed

Description

  • Must be a String

user_call_center_id
Optional Blank value allowed

Your external ID for this call center.

  • Must be a String

record_token_additional_id
Optional Blank value allowed

Record Token Additional

  • Must be a String

external_record_id
Optional Blank value allowed

Your own identifier for this call center, used to correlate it with a record in an external system.

  • Must be a String

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 call center.

record_token_additional_list
Optional Blank value allowed

Assign additional tokens that will be applied to leads and calls 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

GET /call_centers/:id

Authorization Required
https://[your-subdomain].trackdrive.net/api/v1/call_centers/:id

Get Call Center by id.

Retrieve a single call center by id.

PUT /call_centers/:id

Authorization Required
https://[your-subdomain].trackdrive.net/api/v1/call_centers/:id

Update Call Center by id.

Rename a call center or change its softphone provider. Changing the provider re-applies it to the softphone URLs of the call center's agents.

Params

Param name Description
name
Optional Blank value allowed

Name

  • Must be a String

description
Optional Blank value allowed

Description

  • Must be a String

user_call_center_id
Optional Blank value allowed

Your external ID for this call center.

  • Must be a String

record_token_additional_id
Optional Blank value allowed

Record Token Additional

  • Must be a String

external_record_id
Optional Blank value allowed

Your own identifier for this call center, used to correlate it with a record in an external system.

  • Must be a String

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 call center.

record_token_additional_list
Optional Blank value allowed

Assign additional tokens that will be applied to leads and calls 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

DELETE /call_centers/:id

Authorization Required
https://[your-subdomain].trackdrive.net/api/v1/call_centers/:id

Destroy Call Center by id.

Permanently delete a call center.