{"docs":{"name":"TrackDrive","info":"\n\u003cp\u003eTrackdrive API Reference\u003c/p\u003e\n","copyright":null,"doc_url":"/api/docs/1.0","api_url":"/api","resources":[{"doc_url":"/api/docs/1.0/call_control_actions","id":"call_control_actions","api_url":"/api","name":"Agents: Call Actions","short_description":"A customizable button agents can click during a call to trigger routing, tagging, or other in-call actions.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/call_control_actions/index","name":"index","apis":[{"api_url":"/api/v1/call_control_actions","http_method":"GET","short_description":"List Call Action records.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eReturn records matching these ids.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of decimal values. EG: \u003ccode\u003e[0, 1, 2, 3]\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003eReturn the next page of results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eHow many results to return per page. The default is 25.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_to","full_name":"created_at_to","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"created_at_from","full_name":"created_at_from","description":"\n\u003cp\u003eDate formatted like 2016-01-01 12:25:15 -0500\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"fulltext","full_name":"fulltext","description":"\n\u003cp\u003eSearch for any record that matches this text\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eDate ranges will be parsed using this time zone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid time zone. {See the list of valid time zones.}[/api/v1/collections/time_zone]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"Specify the columns you would like returned by the API for a given resource.\nLimiting the columns can significantly increase API response time since only the requested data will be processed.\ncolumns=uuid,number,created_at\n\u003ch4\u003eMust be any combination of:\u003c/h4\u003e\n\u003cul class='column-attempts'\u003e\n\u003cli class='column-attempt'\u003e\nid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nlegacy_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntype\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuuid\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncreated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nupdated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndeleted_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuser_updated_at\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_show_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nroutes_edit_path\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nexternal_record_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncompany_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nsystem_status\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nkey\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nname\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntext_color\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbackground_color\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nfont_size\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntext_shadow_color\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrequire_live_caller\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nfilter_group_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nsortable_order\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndescription\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncss_styles\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nwebhook_actions_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nopen_link_on_click\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nopen_link_on_click_href\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nwebhook_params_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nwhisper_sound_playlist_enabled\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nwhisper_sound_playlist_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nwhisper_sound_playlist_target\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nmessage_type\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntext_to_speech\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nstop_whisper_sound_playlist\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_additional_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_additional_data_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_additional_data\n\u003c/li\u003e\n\u003c/ul\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"root","full_name":"root","description":"\n\u003cp\u003ePass \u003ccode\u003eroot=false\u003c/code\u003e to return results without a root node and metadata.\u003cbr\u003e For example:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls?root=false\u003c/code\u003e will return \u003ccode\u003e[call1, call2, call3]\u003c/code\u003e\u003cbr\u003e While:\u003cbr\u003e \u003ccode\u003eGET /api/v1/calls\u003c/code\u003e will return \u003ccode\u003e{calls: [call1, call2, call3], metadata: {}}\u003c/code\u003e\u003cbr\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/call_control_actions/new","name":"new","apis":[{"api_url":"/api/v1/call_control_actions/new","http_method":"GET","short_description":"Build Call Action with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"system_status","full_name":"system_status","description":"\n\u003cp\u003eSystem Status\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"key","full_name":"key","description":"\n\u003cp\u003eKey\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eName\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text_color","full_name":"text_color","description":"\n\u003cp\u003eText Color\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"background_color","full_name":"background_color","description":"\n\u003cp\u003eBackground Color\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"font_size","full_name":"font_size","description":"\n\u003cp\u003eFont Size\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text_shadow_color","full_name":"text_shadow_color","description":"\n\u003cp\u003eText Shadow Color\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_id","full_name":"record_token_additional_id","description":"\n\u003cp\u003eRecord Token Additional\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"filter_group_id","full_name":"filter_group_id","description":"\n\u003cp\u003eFilter Group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"external_record_id","full_name":"external_record_id","description":"\n\u003cp\u003eAn external identifier to associate with this Call Action.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"require_live_caller","full_name":"require_live_caller","description":"\n\u003cp\u003eWhen enabled, this action is only available while the caller is still on the line.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"open_link_on_click","full_name":"open_link_on_click","description":"\n\u003cp\u003eWhen enabled, opens open_link_on_click_href in a new tab when an agent clicks this action.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"open_link_on_click_href","full_name":"open_link_on_click_href","description":"\n\u003cp\u003eThe URL to open when an agent clicks this action, used when open_link_on_click is enabled. Token replacement is supported.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"message_type","full_name":"message_type","description":"\n\u003cp\u003eHow the whisper message is delivered. Accepts speak (text to speech) or a sound file playlist.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text_to_speech","full_name":"text_to_speech","description":"\n\u003cp\u003eThe text spoken to whoever this action whispers to, used when message_type is speak. Token replacement is supported.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"whisper_sound_playlist_enabled","full_name":"whisper_sound_playlist_enabled","description":"\n\u003cp\u003eWhen enabled, plays a whisper message when an agent clicks this action.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"whisper_sound_playlist_id","full_name":"whisper_sound_playlist_id","description":"\n\u003cp\u003eThe Sound Playlist to whisper from, used when message_type is not speak.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid foreign key reference to an {Sound Playlist}[/api/docs/1.0/sound_playlists/index.html]. Refer to: {/api/docs/1.0/sound_playlists}[/api/docs/1.0/sound_playlists/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"whisper_sound_playlist_target","full_name":"whisper_sound_playlist_target","description":"\n\u003cp\u003eWho hears the whisper message. Accepts agent, consumer, buyer, or a combination.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"stop_whisper_sound_playlist","full_name":"stop_whisper_sound_playlist","description":"\n\u003cp\u003eWhen enabled, clicking this action stops any audio currently playing on the call instead of whispering a message.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\n\u003cp\u003eAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\u003cbr\u003e\u003ccode\u003e\"interest:auto\", \"loan_amount:\u003e=10000\", \"loan_amount:\u003c=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/call_control_actions/create","name":"create","apis":[{"api_url":"/api/v1/call_control_actions","http_method":"POST","short_description":"Create Call Action.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"system_status","full_name":"system_status","description":"\n\u003cp\u003eSystem Status\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"key","full_name":"key","description":"\n\u003cp\u003eKey\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eName\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text_color","full_name":"text_color","description":"\n\u003cp\u003eText Color\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"background_color","full_name":"background_color","description":"\n\u003cp\u003eBackground Color\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"font_size","full_name":"font_size","description":"\n\u003cp\u003eFont Size\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text_shadow_color","full_name":"text_shadow_color","description":"\n\u003cp\u003eText Shadow Color\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_id","full_name":"record_token_additional_id","description":"\n\u003cp\u003eRecord Token Additional\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"filter_group_id","full_name":"filter_group_id","description":"\n\u003cp\u003eFilter Group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"external_record_id","full_name":"external_record_id","description":"\n\u003cp\u003eAn external identifier to associate with this Call Action.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"require_live_caller","full_name":"require_live_caller","description":"\n\u003cp\u003eWhen enabled, this action is only available while the caller is still on the line.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"open_link_on_click","full_name":"open_link_on_click","description":"\n\u003cp\u003eWhen enabled, opens open_link_on_click_href in a new tab when an agent clicks this action.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"open_link_on_click_href","full_name":"open_link_on_click_href","description":"\n\u003cp\u003eThe URL to open when an agent clicks this action, used when open_link_on_click is enabled. Token replacement is supported.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"message_type","full_name":"message_type","description":"\n\u003cp\u003eHow the whisper message is delivered. Accepts speak (text to speech) or a sound file playlist.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text_to_speech","full_name":"text_to_speech","description":"\n\u003cp\u003eThe text spoken to whoever this action whispers to, used when message_type is speak. Token replacement is supported.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"whisper_sound_playlist_enabled","full_name":"whisper_sound_playlist_enabled","description":"\n\u003cp\u003eWhen enabled, plays a whisper message when an agent clicks this action.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"whisper_sound_playlist_id","full_name":"whisper_sound_playlist_id","description":"\n\u003cp\u003eThe Sound Playlist to whisper from, used when message_type is not speak.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid foreign key reference to an {Sound Playlist}[/api/docs/1.0/sound_playlists/index.html]. Refer to: {/api/docs/1.0/sound_playlists}[/api/docs/1.0/sound_playlists/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"whisper_sound_playlist_target","full_name":"whisper_sound_playlist_target","description":"\n\u003cp\u003eWho hears the whisper message. Accepts agent, consumer, buyer, or a combination.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"stop_whisper_sound_playlist","full_name":"stop_whisper_sound_playlist","description":"\n\u003cp\u003eWhen enabled, clicking this action stops any audio currently playing on the call instead of whispering a message.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\n\u003cp\u003eAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\u003cbr\u003e\u003ccode\u003e\"interest:auto\", \"loan_amount:\u003e=10000\", \"loan_amount:\u003c=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/call_control_actions/show","name":"show","apis":[{"api_url":"/api/v1/call_control_actions/:id","http_method":"GET","short_description":"Get Call Action by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/call_control_actions/update","name":"update","apis":[{"api_url":"/api/v1/call_control_actions/:id","http_method":"PUT","short_description":"Update Call Action by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"system_status","full_name":"system_status","description":"\n\u003cp\u003eSystem Status\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"key","full_name":"key","description":"\n\u003cp\u003eKey\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n\u003cp\u003eName\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text_color","full_name":"text_color","description":"\n\u003cp\u003eText Color\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"background_color","full_name":"background_color","description":"\n\u003cp\u003eBackground Color\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"font_size","full_name":"font_size","description":"\n\u003cp\u003eFont Size\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text_shadow_color","full_name":"text_shadow_color","description":"\n\u003cp\u003eText Shadow Color\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_id","full_name":"record_token_additional_id","description":"\n\u003cp\u003eRecord Token Additional\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"filter_group_id","full_name":"filter_group_id","description":"\n\u003cp\u003eFilter Group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"external_record_id","full_name":"external_record_id","description":"\n\u003cp\u003eAn external identifier to associate with this Call Action.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"require_live_caller","full_name":"require_live_caller","description":"\n\u003cp\u003eWhen enabled, this action is only available while the caller is still on the line.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"open_link_on_click","full_name":"open_link_on_click","description":"\n\u003cp\u003eWhen enabled, opens open_link_on_click_href in a new tab when an agent clicks this action.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"open_link_on_click_href","full_name":"open_link_on_click_href","description":"\n\u003cp\u003eThe URL to open when an agent clicks this action, used when open_link_on_click is enabled. Token replacement is supported.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"message_type","full_name":"message_type","description":"\n\u003cp\u003eHow the whisper message is delivered. Accepts speak (text to speech) or a sound file playlist.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"text_to_speech","full_name":"text_to_speech","description":"\n\u003cp\u003eThe text spoken to whoever this action whispers to, used when message_type is speak. Token replacement is supported.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"whisper_sound_playlist_enabled","full_name":"whisper_sound_playlist_enabled","description":"\n\u003cp\u003eWhen enabled, plays a whisper message when an agent clicks this action.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"whisper_sound_playlist_id","full_name":"whisper_sound_playlist_id","description":"\n\u003cp\u003eThe Sound Playlist to whisper from, used when message_type is not speak.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid foreign key reference to an {Sound Playlist}[/api/docs/1.0/sound_playlists/index.html]. Refer to: {/api/docs/1.0/sound_playlists}[/api/docs/1.0/sound_playlists/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"whisper_sound_playlist_target","full_name":"whisper_sound_playlist_target","description":"\n\u003cp\u003eWho hears the whisper message. Accepts agent, consumer, buyer, or a combination.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"stop_whisper_sound_playlist","full_name":"stop_whisper_sound_playlist","description":"\n\u003cp\u003eWhen enabled, clicking this action stops any audio currently playing on the call instead of whispering a message.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a boolean value: 1, true, yes, on, 0, false, no, off","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_additional_list","full_name":"record_token_additional_list","description":"\n\u003cp\u003eAssign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid list of filters. Example filters:\u003cbr\u003e\u003ccode\u003e\"interest:auto\", \"loan_amount:\u003e=10000\", \"loan_amount:\u003c=50000\", \"geo:!=800\", \"caller_id:!=anonymous\"\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/docs/1.0/call_control_actions/destroy","name":"destroy","apis":[{"api_url":"/api/v1/call_control_actions/:id","http_method":"DELETE","short_description":"Destroy Call Action by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false}]}}