Agents: Call Actions
A customizable button agents can click during a call to trigger routing, tagging, or other in-call actions.
GET /call_control_actions
Authorization Requiredhttps://[your-subdomain].trackdrive.net/api/v1/call_control_actions
List Call Action records.
List the Call Action buttons available to agents in your account, including their styling and any tokens they attach to a call. System default actions are generated automatically for superusers on first load.
Params
| Param name | Description |
|---|---|
|
ids Optional |
Return records matching these ids.
|
|
page Optional |
Return the next page of results.
|
|
per_page Optional |
How many results to return per page. The default is 25.
|
|
created_at_to Optional |
Date formatted like 2016-01-01 12:25:15 -0500
|
|
created_at_from Optional |
Date formatted like 2016-01-01 12:25:15 -0500
|
|
fulltext Optional |
Search for any record that matches this text
|
|
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:
|
|
root Optional |
Pass
|
GET /call_control_actions/new
Authorization Requiredhttps://[your-subdomain].trackdrive.net/api/v1/call_control_actions/new
Build Call Action with defaults.
Return a blank Call Action populated with default attribute values, useful for building a create form.
Params
| Param name | Description |
|---|---|
|
system_status Optional Blank value allowed |
System Status
|
|
key Optional Blank value allowed |
Key
|
|
name Optional Blank value allowed |
Name
|
|
text_color Optional Blank value allowed |
Text Color
|
|
background_color Optional Blank value allowed |
Background Color
|
|
font_size Optional Blank value allowed |
Font Size
|
|
text_shadow_color Optional Blank value allowed |
Text Shadow Color
|
|
record_token_additional_id Optional Blank value allowed |
Record Token Additional
|
|
attribution_token_value_ids Optional Blank value allowed |
Attribution Token Value Ids
|
|
filter_group_id Optional Blank value allowed |
Filter Group
|
|
description Optional Blank value allowed |
Description
|
|
external_record_id Optional Blank value allowed |
An external identifier to associate with this Call Action.
|
|
require_live_caller Optional Blank value allowed |
When enabled, this action is only available while the caller is still on the line.
|
|
open_link_on_click Optional Blank value allowed |
When enabled, opens open_link_on_click_href in a new tab when an agent clicks this action.
|
|
open_link_on_click_href Optional Blank value allowed |
The URL to open when an agent clicks this action, used when open_link_on_click is enabled. Token replacement is supported.
|
|
message_type Optional Blank value allowed |
How the whisper message is delivered. Accepts speak (text to speech) or a sound file playlist.
|
|
text_to_speech Optional Blank value allowed |
The text spoken to whoever this action whispers to, used when message_type is speak. Token replacement is supported.
|
|
whisper_sound_playlist_enabled Optional Blank value allowed |
When enabled, plays a whisper message when an agent clicks this action.
|
|
whisper_sound_playlist_id Optional Blank value allowed |
The Sound Playlist to whisper from, used when message_type is not speak.
|
|
whisper_sound_playlist_target Optional Blank value allowed |
Who hears the whisper message. Accepts agent, consumer, buyer, or a combination.
|
|
stop_whisper_sound_playlist Optional Blank value allowed |
When enabled, clicking this action stops any audio currently playing on the call instead of whispering a message.
|
|
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.
|
POST /call_control_actions
Authorization Requiredhttps://[your-subdomain].trackdrive.net/api/v1/call_control_actions
Create Call Action.
Create a Call Action button that agents can click during a call, optionally applying extra tokens and custom text or background color styling.
Params
| Param name | Description |
|---|---|
|
system_status Optional Blank value allowed |
System Status
|
|
key Optional Blank value allowed |
Key
|
|
name Optional Blank value allowed |
Name
|
|
text_color Optional Blank value allowed |
Text Color
|
|
background_color Optional Blank value allowed |
Background Color
|
|
font_size Optional Blank value allowed |
Font Size
|
|
text_shadow_color Optional Blank value allowed |
Text Shadow Color
|
|
record_token_additional_id Optional Blank value allowed |
Record Token Additional
|
|
attribution_token_value_ids Optional Blank value allowed |
Attribution Token Value Ids
|
|
filter_group_id Optional Blank value allowed |
Filter Group
|
|
description Optional Blank value allowed |
Description
|
|
external_record_id Optional Blank value allowed |
An external identifier to associate with this Call Action.
|
|
require_live_caller Optional Blank value allowed |
When enabled, this action is only available while the caller is still on the line.
|
|
open_link_on_click Optional Blank value allowed |
When enabled, opens open_link_on_click_href in a new tab when an agent clicks this action.
|
|
open_link_on_click_href Optional Blank value allowed |
The URL to open when an agent clicks this action, used when open_link_on_click is enabled. Token replacement is supported.
|
|
message_type Optional Blank value allowed |
How the whisper message is delivered. Accepts speak (text to speech) or a sound file playlist.
|
|
text_to_speech Optional Blank value allowed |
The text spoken to whoever this action whispers to, used when message_type is speak. Token replacement is supported.
|
|
whisper_sound_playlist_enabled Optional Blank value allowed |
When enabled, plays a whisper message when an agent clicks this action.
|
|
whisper_sound_playlist_id Optional Blank value allowed |
The Sound Playlist to whisper from, used when message_type is not speak.
|
|
whisper_sound_playlist_target Optional Blank value allowed |
Who hears the whisper message. Accepts agent, consumer, buyer, or a combination.
|
|
stop_whisper_sound_playlist Optional Blank value allowed |
When enabled, clicking this action stops any audio currently playing on the call instead of whispering a message.
|
|
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.
|
GET /call_control_actions/:id
Authorization Requiredhttps://[your-subdomain].trackdrive.net/api/v1/call_control_actions/:id
Get Call Action by id.
Get the details of a single Call Action by id.
PUT /call_control_actions/:id
Authorization Requiredhttps://[your-subdomain].trackdrive.net/api/v1/call_control_actions/:id
Update Call Action by id.
Update a Call Action, including its key, styling, filter group, or the tokens it applies.
Params
| Param name | Description |
|---|---|
|
system_status Optional Blank value allowed |
System Status
|
|
key Optional Blank value allowed |
Key
|
|
name Optional Blank value allowed |
Name
|
|
text_color Optional Blank value allowed |
Text Color
|
|
background_color Optional Blank value allowed |
Background Color
|
|
font_size Optional Blank value allowed |
Font Size
|
|
text_shadow_color Optional Blank value allowed |
Text Shadow Color
|
|
record_token_additional_id Optional Blank value allowed |
Record Token Additional
|
|
attribution_token_value_ids Optional Blank value allowed |
Attribution Token Value Ids
|
|
filter_group_id Optional Blank value allowed |
Filter Group
|
|
description Optional Blank value allowed |
Description
|
|
external_record_id Optional Blank value allowed |
An external identifier to associate with this Call Action.
|
|
require_live_caller Optional Blank value allowed |
When enabled, this action is only available while the caller is still on the line.
|
|
open_link_on_click Optional Blank value allowed |
When enabled, opens open_link_on_click_href in a new tab when an agent clicks this action.
|
|
open_link_on_click_href Optional Blank value allowed |
The URL to open when an agent clicks this action, used when open_link_on_click is enabled. Token replacement is supported.
|
|
message_type Optional Blank value allowed |
How the whisper message is delivered. Accepts speak (text to speech) or a sound file playlist.
|
|
text_to_speech Optional Blank value allowed |
The text spoken to whoever this action whispers to, used when message_type is speak. Token replacement is supported.
|
|
whisper_sound_playlist_enabled Optional Blank value allowed |
When enabled, plays a whisper message when an agent clicks this action.
|
|
whisper_sound_playlist_id Optional Blank value allowed |
The Sound Playlist to whisper from, used when message_type is not speak.
|
|
whisper_sound_playlist_target Optional Blank value allowed |
Who hears the whisper message. Accepts agent, consumer, buyer, or a combination.
|
|
stop_whisper_sound_playlist Optional Blank value allowed |
When enabled, clicking this action stops any audio currently playing on the call instead of whispering a message.
|
|
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.
|
DELETE /call_control_actions/:id
Authorization Requiredhttps://[your-subdomain].trackdrive.net/api/v1/call_control_actions/:id
Destroy Call Action by id.
Permanently delete a Call Action.