Agent Wizard

Creates an agent account, including its contact details and call center, through a simplified setup wizard.

GET /schedule_agents

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

List Agent Wizard records.

Lists the agents created via the Agent Wizard, which provisions call-center or quality-assurance agent user accounts along with their supporting records.

Params

Param name Description
ids
Optional

Return records matching these ids.

  • Must be an array of decimal values. EG: [0, 1, 2, 3]
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
  • sortable_order
  • first_name
  • last_name
  • company_name
  • email
  • phone_number
  • address_state
  • address_city
  • address_country
  • address_zip
  • address_line1
  • address_line2
  • collaborator_id
  • buyer_id
  • internal_password
  • profile_image_url
  • buyer_type
  • agent_number
  • number_id
  • is_internal
  • internal_username
  • softphone_sip_url
  • softphone_password
  • softphone_username
  • call_center_id

  • 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 /schedule_agents/new

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

Build Agent Wizard record with defaults.

Builds an Agent Wizard record with default attributes without saving it.

POST /schedule_agents

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

Create Agent with Wizard.

Creates a new agent, and its underlying user account, via the Agent Wizard. Specify buyer_type (quality_assurance or buyer) and whether the agent is internal; internal agents only have access to your company and sign in with a random password. When the caller is an administrator or manager, this response returns it once as internal_password; store it, since no other response includes it.

Params

Param name Description
first_name
Required

First Name

  • Must be a String
email
Optional Blank value allowed

Email

  • Must be a String
is_internal
Optional Blank value allowed

Internal agents only have access to your company. The create response returns the agent’s password once as internal_password to an administrator or manager; an administrator or manager can generate a new one on the agent’s page.

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

What type of Agent is this? Either quality_assurance or buyer

  • Must be a String
internal_username
Optional Blank value allowed

Username

  • Must be a String
last_name
Optional Blank value allowed

Last Name

  • Must be a String
company_name
Optional Blank value allowed

Company Name

  • Must be a String
phone_number
Optional Blank value allowed

Phone Number

  • Must be a String
address_state
Optional Blank value allowed

Address State

  • Must be a String
address_city
Optional Blank value allowed

Address City

  • Must be a String
address_country
Optional Blank value allowed

Address Country

  • Must be a String
address_zip
Optional Blank value allowed

Address Zip

  • Must be a String
address_line1
Optional Blank value allowed

Address Line1

  • Must be a String
address_line2
Optional Blank value allowed

Address Line2

  • Must be a String
call_center_id
Optional Blank value allowed

Does this agent belong to a call center?
profile_image
Optional Blank value allowed

A photo to display on the agent’s profile, 200px by 200px.

  • Must be a valid file upload.
remove_profile_image
Optional Blank value allowed

Set to true to remove the agent’s existing profile photo.

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

The phone number or SIP address calls are forwarded to for this agent.

  • Must be a String
number_id
Optional Blank value allowed

The phone number shown as the caller ID to consumers when this agent places outbound calls.

GET /schedule_agents/:id

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

Get Agent Wizard record by id.

Gets an Agent Wizard record's details by id.

PUT /schedule_agents/:id

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

Update Agent Wizard record by id.

Updates an agent created via the Agent Wizard, such as their contact details or call center assignment.

Params

Param name Description
first_name
Optional Blank value allowed

First Name

  • Must be a String
is_internal
Optional Blank value allowed

Internal agents only have access to your company. The create response returns the agent’s password once as internal_password to an administrator or manager; an administrator or manager can generate a new one on the agent’s page.

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

What type of Agent is this? Either quality_assurance or buyer

  • Must be a String
internal_username
Optional Blank value allowed

Username

  • Must be a String
last_name
Optional Blank value allowed

Last Name

  • Must be a String
company_name
Optional Blank value allowed

Company Name

  • Must be a String
phone_number
Optional Blank value allowed

Phone Number

  • Must be a String
address_state
Optional Blank value allowed

Address State

  • Must be a String
address_city
Optional Blank value allowed

Address City

  • Must be a String
address_country
Optional Blank value allowed

Address Country

  • Must be a String
address_zip
Optional Blank value allowed

Address Zip

  • Must be a String
address_line1
Optional Blank value allowed

Address Line1

  • Must be a String
address_line2
Optional Blank value allowed

Address Line2

  • Must be a String
call_center_id
Optional Blank value allowed

Does this agent belong to a call center?
profile_image
Optional Blank value allowed

A photo to display on the agent’s profile, 200px by 200px.

  • Must be a valid file upload.
remove_profile_image
Optional Blank value allowed

Set to true to remove the agent’s existing profile photo.

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

The phone number or SIP address calls are forwarded to for this agent.

  • Must be a String
number_id
Optional Blank value allowed

The phone number shown as the caller ID to consumers when this agent places outbound calls.

DELETE /schedule_agents/:id

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

Destroy Agent Wizard record by id.

Deletes an agent created via the Agent Wizard.