{"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_routers","id":"call_routers","api_url":"/api","name":"Offers: Call Flow","short_description":"Individual rules in an offer's call flow controlling greetings, IVR menus, dialing, hold queues and exception handling.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/docs/1.0/call_routers/index","name":"index","apis":[{"api_url":"/api/v1/call_routers","http_method":"GET","short_description":"List Call Flow 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":"offer_id","full_name":"offer_id","description":"\n\u003cp\u003eAssign the record to this Offer.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Offer}[/api/docs/1.0/offers/index.html]. Refer to: {/api/docs/1.0/offers}[/api/docs/1.0/offers/index.html]","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\ncategory\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nname\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncontext_menu_name\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\noffer_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nmessage_type\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nmessage_action\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nmessage_loop\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntext_to_speech\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ntext_to_speech_gender\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrouter_action\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\naction_option\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbuyer_ids\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbuyer_offer_ids\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbuyer_group_ids\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nsortable_order\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nschedule_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\noutbound_timeout_seconds\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrouter_type\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ndescription\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nmessage_action_type\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nkey_press_timeout_seconds\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nperform_action_if_buyer_is_available\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ninbound_call_route_async\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbackup_buyer_ids\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nbackup_buyer_group_ids\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuse_sound_playlist\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nsound_playlist_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nhold_music_sound_playlist_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nvoicemail_sound_playlist_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nhas_schedule\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nhas_extension_pool\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nallows_outgoing_webhooks\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuse_with_find_a_buyer\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nuse_with_key_press_flows\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nkey_press_flow_group_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nauto_retry_next_buyer\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nauto_retry_next_buyer_seconds\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nhas_extension_actions\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nhas_schedule_action\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncan_dial\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncan_alter_traffic_source\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nmax_call_disposition_wait_seconds\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nhold_queue_caller_limit\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nhold_queue_percentage_size\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nmax_hold_seconds\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nmax_hold_seconds_average\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nfire_call_router_webhooks_before_action\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\naction_digit\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\noff_hook_calls_per_seat\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\noff_hook_unaccepted_wait\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\noff_hook_leads_needed\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\naudio_file_url\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nvoicemail_file_url\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nhold_music_file_url\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncall_router_hangup_reason\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\ncall_router_answer_group_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\noff_hook_no_lead_timeout\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\noutgoing_webhook_ids\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nafter_action_sound_playlist_enabled\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nafter_action_sound_playlist_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\noff_hook_dropped_call_seconds\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\noff_hook_drop_limit_1\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\noff_hook_drop_cps_1\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\noff_hook_drop_limit_2\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\noff_hook_drop_cps_2\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nenabled\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_data_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_filter_data\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\u003cli class='column-attempt'\u003e\nrecord_token_buyer_id\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_buyer_data_count\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\nrecord_token_buyer_data\n\u003c/li\u003e\n\u003cli class='column-attempt'\u003e\noff_hook_dropped_calls\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_routers/new","name":"new","apis":[{"api_url":"/api/v1/call_routers/new","http_method":"GET","short_description":"Build Call Flow Rule with defaults.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"message_type","full_name":"message_type","description":"\n\u003cp\u003ePlay A Message?\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a value contained in the pick list:\u003cbr\u003e \u003cdiv class=\"pick-list-container\"\u003e\u003ctable class=\"table table-pick-list table-sm table-bordered table-striped\"\u003e\u003cthead\u003e\u003ctr\u003e\u003cth\u003eAcceptable Value\u003c/th\u003e\u003cth\u003eDescription\u003c/th\u003e\u003c/tr\u003e\u003c/thead\u003e\u003ctbody\u003e\u003ctr\u003e\u003cth\u003enone\u003c/th\u003e\u003ctd\u003eNo Message\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003espeak\u003c/th\u003e\u003ctd\u003eSpeak TTS\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eaudio\u003c/th\u003e\u003ctd\u003ePlay Audio\u003c/td\u003e\u003c/tr\u003e\u003c/tbody\u003e\u003c/table\u003e\u003c/div\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"router_action","full_name":"router_action","description":"\n\u003cp\u003eChoose An Action\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a value contained in the pick list:\u003cbr\u003e \u003cdiv class=\"pick-list-container\"\u003e\u003ctable class=\"table table-pick-list table-sm table-bordered table-striped\"\u003e\u003cthead\u003e\u003ctr\u003e\u003cth\u003eAcceptable Value\u003c/th\u003e\u003cth\u003eDescription\u003c/th\u003e\u003c/tr\u003e\u003c/thead\u003e\u003ctbody\u003e\u003ctr\u003e\u003cth\u003edial\u003c/th\u003e\u003ctd\u003eForward To Buyers or Agents\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eredirect\u003c/th\u003e\u003ctd\u003eForward To Offer\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eadd_to_schedule\u003c/th\u003e\u003ctd\u003eAdd To Schedule\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eadd_to_hold_queue\u003c/th\u003e\u003ctd\u003ePlace Caller In Hold Queue\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eremove_from_schedule\u003c/th\u003e\u003ctd\u003eRemove From Schedule\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003erecord_voicemail\u003c/th\u003e\u003ctd\u003eRecord Voicemail\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003erequest_key_press\u003c/th\u003e\u003ctd\u003eRequest Key Press\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eblock_caller\u003c/th\u003e\u003ctd\u003eBlock Caller\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eend_call\u003c/th\u003e\u003ctd\u003eHang Up\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003enone\u003c/th\u003e\u003ctd\u003eContinue Offer Routing\u003c/td\u003e\u003c/tr\u003e\u003c/tbody\u003e\u003c/table\u003e\u003c/div\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n\u003cp\u003eAssign filters to the object by passing an array of key:value pairs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"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},{"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":false,"validator":"Must be a valid list of tokens. Example tokens:\u003cbr\u003e \u003ccode\u003ebuyer_interest:loan,another_token:value\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescribe the purpose of this call flow rule.\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_to_speech","full_name":"text_to_speech","description":"\n\u003cp\u003eText To Speech that will be spoken when \u003ccode\u003emessage_type=speak\u003c/code\u003e\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":"message_loop","full_name":"message_loop","description":"\n\u003cp\u003eThe message will be repeated this many times.\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":"audio_file","full_name":"audio_file","description":"\n\u003cp\u003eThe audio file that will be played when \u003ccode\u003emessage_type=audio\u003c/code\u003e\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid file upload.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_id","full_name":"schedule_id","description":"\n\u003cp\u003eThe schedule that will be used when \u003ccode\u003erouter_action=add_to_schedule\u003c/code\u003e\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Schedule}[/api/docs/1.0/schedules/index.html]. Refer to: {/api/docs/1.0/schedules}[/api/docs/1.0/schedules/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_ids","full_name":"buyer_ids","description":"\n\u003cp\u003eCalls will be forwarded to these buyers when \u003ccode\u003erouter_action=dial\u003c/code\u003e\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Buyer}[/api/docs/1.0/buyers/index.html]. Refer to: {/api/docs/1.0/buyers}[/api/docs/1.0/buyers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_group_ids","full_name":"buyer_group_ids","description":"\n\u003cp\u003eCalls will be forwarded to these buyer groups when \u003ccode\u003erouter_action=dial\u003c/code\u003e\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Buyer Group}[/api/docs/1.0/buyer_groups/index.html]. Refer to: {/api/docs/1.0/buyer_groups}[/api/docs/1.0/buyer_groups/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_offer_ids","full_name":"buyer_offer_ids","description":"\n\u003cp\u003eCalls will be forwarded to this offer when \u003ccode\u003erouter_action=redirect\u003c/code\u003e\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Offer}[/api/docs/1.0/offers/index.html]. Refer to: {/api/docs/1.0/offers}[/api/docs/1.0/offers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hold_queue_caller_limit","full_name":"hold_queue_caller_limit","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=add_to_hold_queue\u003c/code\u003e. How many people can be on hold?\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":"hold_queue_percentage_size","full_name":"hold_queue_percentage_size","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=add_to_hold_queue\u003c/code\u003e. Set the hold queue size automatically by taking [Active CC * This Percentage]\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":"max_hold_seconds","full_name":"max_hold_seconds","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=add_to_hold_queue\u003c/code\u003e. Maximum number of seconds a caller can be on hold.\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":"max_hold_seconds_average","full_name":"max_hold_seconds_average","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=add_to_hold_queue\u003c/code\u003e. Trackdrive will stop adding callers to the hold queue if the average time spent on hold exceeds this number of seconds.\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":"name","full_name":"name","description":"\n\u003cp\u003eA short label for this call flow rule shown in the call flow list.\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_action_type","full_name":"message_action_type","description":"\n\u003cp\u003eThe step this rule performs in the call flow, such as playing a message, dialing buyers, or adding to a hold queue.\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_gender","full_name":"text_to_speech_gender","description":"\n\u003cp\u003eThe voice used for the \u003ccode\u003etext_to_speech\u003c/code\u003e message, \u003ccode\u003eMale\u003c/code\u003e or \u003ccode\u003eFemale\u003c/code\u003e.\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":"key_press_timeout_seconds","full_name":"key_press_timeout_seconds","description":"\n\u003cp\u003eHow many seconds to wait for a key press before continuing when \u003ccode\u003erouter_type=press_1_to_accept\u003c/code\u003e. When \u003ccode\u003erouter_type=before_connecting_instant_agent\u003c/code\u003e, how many seconds (10 to 600) to wait for the consumer to press a key before hanging up.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"traffic_source_action_type","full_name":"traffic_source_action_type","description":"\n\u003cp\u003eHow the traffic source should be altered when this rule runs.\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":"traffic_source_action_id","full_name":"traffic_source_action_id","description":"\n\u003cp\u003eThe traffic source to assign when \u003ccode\u003etraffic_source_action_type\u003c/code\u003e reassigns the traffic source.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an 8-bit integer ID or a 128-bit UUID reference to an object on Trackdrive. Example ID: 289302820, Example UUID: 924c37d5-e70f-42ad-84c2-e85eb0c1bc21","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"traffic_source_action_payout","full_name":"traffic_source_action_payout","description":"\n\u003cp\u003eThe alternate payout applied when \u003ccode\u003etraffic_source_action_type\u003c/code\u003e sets a new payout.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"outbound_timeout_seconds","full_name":"outbound_timeout_seconds","description":"\n\u003cp\u003eHow many seconds an outbound call to an agent is allowed to ring before it is considered unanswered.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"use_with_find_a_buyer","full_name":"use_with_find_a_buyer","description":"\n\u003cp\u003eOnly perform this action when a buyer can be matched for the call.\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":"perform_action_if_buyer_is_available","full_name":"perform_action_if_buyer_is_available","description":"\n\u003cp\u003eOnly perform this action when a buyer is available. Companion setting to \u003ccode\u003euse_with_find_a_buyer\u003c/code\u003e.\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":"auto_retry_next_buyer","full_name":"auto_retry_next_buyer","description":"\n\u003cp\u003eAutomatically dial the next buyer if the current one does not answer.\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":"auto_retry_next_buyer_seconds","full_name":"auto_retry_next_buyer_seconds","description":"\n\u003cp\u003eHow many seconds to wait before dialing the next buyer when \u003ccode\u003eauto_retry_next_buyer\u003c/code\u003e is true.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"inbound_call_route_async","full_name":"inbound_call_route_async","description":"\n\u003cp\u003eRoute the inbound call asynchronously instead of holding the caller while this rule runs.\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":"off_hook_no_lead_timeout","full_name":"off_hook_no_lead_timeout","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=off_hook_press_to_accept\u003c/code\u003e. How many seconds an agent can go without a matching lead before instant agent dialing stops.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"off_hook_calls_per_seat","full_name":"off_hook_calls_per_seat","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=off_hook_press_to_accept\u003c/code\u003e. How many outbound calls to place per available agent seat.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"off_hook_unaccepted_wait","full_name":"off_hook_unaccepted_wait","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=off_hook_press_to_accept\u003c/code\u003e. How many seconds an agent has to accept an offered call before it is considered unaccepted.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"off_hook_leads_needed","full_name":"off_hook_leads_needed","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=off_hook_press_to_accept\u003c/code\u003e. How many matching leads must be available before dialing an agent.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"off_hook_dropped_call_seconds","full_name":"off_hook_dropped_call_seconds","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=off_hook_press_to_accept\u003c/code\u003e. The lookback window, in seconds, used to calculate the dropped call percentage.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"off_hook_drop_limit_1","full_name":"off_hook_drop_limit_1","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=off_hook_press_to_accept\u003c/code\u003e. The first dropped call percentage threshold that throttles outbound dialing.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"off_hook_drop_cps_1","full_name":"off_hook_drop_cps_1","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=off_hook_press_to_accept\u003c/code\u003e. The calls-per-seat rate applied once \u003ccode\u003eoff_hook_drop_limit_1\u003c/code\u003e is exceeded.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"off_hook_drop_limit_2","full_name":"off_hook_drop_limit_2","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=off_hook_press_to_accept\u003c/code\u003e. The second, higher dropped call percentage threshold that throttles outbound dialing further.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"off_hook_drop_cps_2","full_name":"off_hook_drop_cps_2","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=off_hook_press_to_accept\u003c/code\u003e. The calls-per-seat rate applied once \u003ccode\u003eoff_hook_drop_limit_2\u003c/code\u003e is exceeded.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"action_digit","full_name":"action_digit","description":"\n\u003cp\u003eOnly perform this action if the caller pressed this key.\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":"max_call_disposition_wait_seconds","full_name":"max_call_disposition_wait_seconds","description":"\n\u003cp\u003eHow many seconds to wait for an agent to disposition a call before moving on.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"call_router_hangup_reason","full_name":"call_router_hangup_reason","description":"\n\u003cp\u003eThe reason recorded on the call when this rule hangs up the call.\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":"fire_call_router_webhooks_before_action","full_name":"fire_call_router_webhooks_before_action","description":"\n\u003cp\u003eFire this rule’s outgoing webhooks before performing its action instead of after.\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":"backup_buyer_ids","full_name":"backup_buyer_ids","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=off_hook_press_to_accept\u003c/code\u003e. Overflow agents dialed when the primary agents in \u003ccode\u003ebuyer_ids\u003c/code\u003e are unavailable.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":"backup_buyer_group_ids","full_name":"backup_buyer_group_ids","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=off_hook_press_to_accept\u003c/code\u003e. Overflow buyer groups dialed when the primary agents in \u003ccode\u003ebuyer_ids\u003c/code\u003e/\u003ccode\u003ebuyer_group_ids\u003c/code\u003e are unavailable.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":"voicemail_file","full_name":"voicemail_file","description":"\n\u003cp\u003eThe audio file an instant agent can play to a lead’s answering machine when \u003ccode\u003erouter_type=off_hook_press_to_accept\u003c/code\u003e.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid file upload.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"remove_voicemail_file","full_name":"remove_voicemail_file","description":"\n\u003cp\u003eRemove the currently configured \u003ccode\u003evoicemail_file\u003c/code\u003e.\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":"hold_music_file","full_name":"hold_music_file","description":"\n\u003cp\u003eCustom music played to an instant agent while on hold when \u003ccode\u003erouter_type=off_hook_press_to_accept\u003c/code\u003e. Falls back to the default hold music when blank.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid file upload.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"remove_hold_music_file","full_name":"remove_hold_music_file","description":"\n\u003cp\u003eRemove the currently configured \u003ccode\u003ehold_music_file\u003c/code\u003e.\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":"key_press_flow_group_id","full_name":"key_press_flow_group_id","description":"\n\u003cp\u003eThe key press flow group used to process the caller’s key press response for this rule.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid foreign key reference to an {Key Press Flow Group}[/api/docs/1.0/key_press_flow_groups/index.html]. Refer to: {/api/docs/1.0/key_press_flow_groups}[/api/docs/1.0/key_press_flow_groups/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"use_sound_playlist","full_name":"use_sound_playlist","description":"\n\u003cp\u003ePlay a random file from a sound playlist instead of a single uploaded \u003ccode\u003eaudio_file\u003c/code\u003e.\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":"sound_playlist_id","full_name":"sound_playlist_id","description":"\n\u003cp\u003eThe sound playlist to play from when \u003ccode\u003euse_sound_playlist\u003c/code\u003e is true.\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":"hold_music_sound_playlist_id","full_name":"hold_music_sound_playlist_id","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=off_hook_press_to_accept\u003c/code\u003e. The sound playlist played to an instant agent while on hold.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an 8-bit integer ID or a 128-bit UUID reference to an object on Trackdrive. Example ID: 289302820, Example UUID: 924c37d5-e70f-42ad-84c2-e85eb0c1bc21","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"voicemail_sound_playlist_id","full_name":"voicemail_sound_playlist_id","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=off_hook_press_to_accept\u003c/code\u003e. The sound playlist an instant agent can play to a lead’s answering machine.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an 8-bit integer ID or a 128-bit UUID reference to an object on Trackdrive. Example ID: 289302820, Example UUID: 924c37d5-e70f-42ad-84c2-e85eb0c1bc21","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"after_action_sound_playlist_enabled","full_name":"after_action_sound_playlist_enabled","description":"\n\u003cp\u003ePlay a sound playlist after this rule’s action completes.\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":"after_action_sound_playlist_id","full_name":"after_action_sound_playlist_id","description":"\n\u003cp\u003eThe sound playlist played after this rule’s action completes, when \u003ccode\u003eafter_action_sound_playlist_enabled\u003c/code\u003e is true.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an 8-bit integer ID or a 128-bit UUID reference to an object on Trackdrive. Example ID: 289302820, Example UUID: 924c37d5-e70f-42ad-84c2-e85eb0c1bc21","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_routers/create","name":"create","apis":[{"api_url":"/api/v1/call_routers","http_method":"POST","short_description":"Create Call Flow Rule.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"offer_id","full_name":"offer_id","description":"\n\u003cp\u003eAssign the record to this Offer.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Offer}[/api/docs/1.0/offers/index.html]. Refer to: {/api/docs/1.0/offers}[/api/docs/1.0/offers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"router_type","full_name":"router_type","description":"\n\u003cp\u003eThe type of Call Flow Rule.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a value contained in the pick list:\u003cbr\u003e \u003cdiv class=\"pick-list-container\"\u003e\u003ctable class=\"table table-pick-list table-sm table-bordered table-striped\"\u003e\u003cthead\u003e\u003ctr\u003e\u003cth\u003eAcceptable Value\u003c/th\u003e\u003cth\u003eDescription\u003c/th\u003e\u003c/tr\u003e\u003c/thead\u003e\u003ctbody\u003e\u003ctr\u003e\u003cth\u003eask_a_question\u003c/th\u003e\u003ctd\u003eAsk A Question And Request An Answer\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eno_greeting_is_played\u003c/th\u003e\u003ctd\u003eHandle Call When No Keypress Is Requested\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003econnect_ai_voice_agent\u003c/th\u003e\u003ctd\u003eConnect AI Voice Agent\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ewhen_answering_machine_detected\u003c/th\u003e\u003ctd\u003eWhen an answering machine is detected\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ebefore_answering_machine_detected\u003c/th\u003e\u003ctd\u003eBefore an answering machine is detected\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003egreeting\u003c/th\u003e\u003ctd\u003ePlay A Greeting Message And Request A Keypress\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eoff_hook_press_to_accept\u003c/th\u003e\u003ctd\u003eWhen Getting Instant Agents On The Phone\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ekey_press_1\u003c/th\u003e\u003ctd\u003eWhen 1 is Pressed\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ekey_press_2\u003c/th\u003e\u003ctd\u003eWhen 2 is pressed\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ekey_press_3\u003c/th\u003e\u003ctd\u003eWhen 3 is pressed\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ekey_press_4\u003c/th\u003e\u003ctd\u003eWhen 4 is pressed\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ekey_press_5\u003c/th\u003e\u003ctd\u003eWhen 5 is pressed\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ekey_press_6\u003c/th\u003e\u003ctd\u003eWhen 6 is pressed\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ekey_press_7\u003c/th\u003e\u003ctd\u003eWhen 7 is pressed\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ekey_press_8\u003c/th\u003e\u003ctd\u003eWhen 8 is pressed\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ekey_press_9\u003c/th\u003e\u003ctd\u003eWhen 9 is pressed\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ekey_press_#\u003c/th\u003e\u003ctd\u003eWhen # is pressed\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ekey_press_*\u003c/th\u003e\u003ctd\u003eWhen * is pressed\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ekey_press_0\u003c/th\u003e\u003ctd\u003eWhen 0 is pressed\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eno_key_press\u003c/th\u003e\u003ctd\u003eWhen nothing is pressed\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eany_other_key_press\u003c/th\u003e\u003ctd\u003eWhen anything is pressed\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ecalling_buyer_music\u003c/th\u003e\u003ctd\u003eCalling Buyer Music Played to Caller during Transfers\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ewhisper\u003c/th\u003e\u003ctd\u003eWhisper To Buyer that a Call is being Transferred\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eenter_extension\u003c/th\u003e\u003ctd\u003eEnter Extension\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eextension_failed\u003c/th\u003e\u003ctd\u003eWhen an invalid extension is entered\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ezip_code_entry\u003c/th\u003e\u003ctd\u003eEnter Zip Code\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ezip_entry_failed\u003c/th\u003e\u003ctd\u003eIncorrect Zip Code\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003epress_1_to_accept\u003c/th\u003e\u003ctd\u003eWhisper to Buyer to Press 1 to Accept a Call\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003epress_1_too_slow\u003c/th\u003e\u003ctd\u003eWhisper to Buyer that they Pressed 1 Too Slowly\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eadd_to_hold_queue\u003c/th\u003e\u003ctd\u003eWhen placed in hold queue\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ehold_queue_is_full\u003c/th\u003e\u003ctd\u003eWhen the hold queue is full\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ehold_queue_max_seconds_exceeded\u003c/th\u003e\u003ctd\u003eWhen the caller has been on hold for longer than max hold seconds\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eno_instant_agent_available\u003c/th\u003e\u003ctd\u003eWhen no instant agent is available during an inbound call from a consumer\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eno_instant_agent_available_outbound\u003c/th\u003e\u003ctd\u003eWhen no instant agent is available during an outbound call to a consumer\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ebefore_connecting_instant_agent\u003c/th\u003e\u003ctd\u003eBefore Connecting An Instant Agent\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ewhen_instant_agent_transfers_to_buyer\u003c/th\u003e\u003ctd\u003eWhen an instant agent transfers to a buyer\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ewhen_buyer_hangup_before_duration\u003c/th\u003e\u003ctd\u003eWhen A Buyer Hangs Up Before Duration\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eno_buyers_have_open_concurrency_cap\u003c/th\u003e\u003ctd\u003eWhen no buyers have open concurrency cap\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eall_buyers_closed\u003c/th\u003e\u003ctd\u003eWhen no buyers are open\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eno_buyer_answered\u003c/th\u003e\u003ctd\u003eWhen no buyers answer\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eno_buyers_match\u003c/th\u003e\u003ctd\u003eWhen no buyers have matching filters\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003etag_validation_failed\u003c/th\u003e\u003ctd\u003eToken Entry Failed\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003etraffic_source_capped\u003c/th\u003e\u003ctd\u003eWhen the traffic source is capped\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003ecaller_hang_up_before_conference\u003c/th\u003e\u003ctd\u003eWhen the caller hangs up before being connected to a buyer\u003c/td\u003e\u003c/tr\u003e\u003c/tbody\u003e\u003c/table\u003e\u003c/div\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"message_type","full_name":"message_type","description":"\n\u003cp\u003ePlay A Message?\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a value contained in the pick list:\u003cbr\u003e \u003cdiv class=\"pick-list-container\"\u003e\u003ctable class=\"table table-pick-list table-sm table-bordered table-striped\"\u003e\u003cthead\u003e\u003ctr\u003e\u003cth\u003eAcceptable Value\u003c/th\u003e\u003cth\u003eDescription\u003c/th\u003e\u003c/tr\u003e\u003c/thead\u003e\u003ctbody\u003e\u003ctr\u003e\u003cth\u003enone\u003c/th\u003e\u003ctd\u003eNo Message\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003espeak\u003c/th\u003e\u003ctd\u003eSpeak TTS\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eaudio\u003c/th\u003e\u003ctd\u003ePlay Audio\u003c/td\u003e\u003c/tr\u003e\u003c/tbody\u003e\u003c/table\u003e\u003c/div\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"router_action","full_name":"router_action","description":"\n\u003cp\u003eChoose An Action\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a value contained in the pick list:\u003cbr\u003e \u003cdiv class=\"pick-list-container\"\u003e\u003ctable class=\"table table-pick-list table-sm table-bordered table-striped\"\u003e\u003cthead\u003e\u003ctr\u003e\u003cth\u003eAcceptable Value\u003c/th\u003e\u003cth\u003eDescription\u003c/th\u003e\u003c/tr\u003e\u003c/thead\u003e\u003ctbody\u003e\u003ctr\u003e\u003cth\u003edial\u003c/th\u003e\u003ctd\u003eForward To Buyers or Agents\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eredirect\u003c/th\u003e\u003ctd\u003eForward To Offer\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eadd_to_schedule\u003c/th\u003e\u003ctd\u003eAdd To Schedule\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eadd_to_hold_queue\u003c/th\u003e\u003ctd\u003ePlace Caller In Hold Queue\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eremove_from_schedule\u003c/th\u003e\u003ctd\u003eRemove From Schedule\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003erecord_voicemail\u003c/th\u003e\u003ctd\u003eRecord Voicemail\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003erequest_key_press\u003c/th\u003e\u003ctd\u003eRequest Key Press\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eblock_caller\u003c/th\u003e\u003ctd\u003eBlock Caller\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eend_call\u003c/th\u003e\u003ctd\u003eHang Up\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003enone\u003c/th\u003e\u003ctd\u003eContinue Offer Routing\u003c/td\u003e\u003c/tr\u003e\u003c/tbody\u003e\u003c/table\u003e\u003c/div\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n\u003cp\u003eAssign filters to the object by passing an array of key:value pairs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"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},{"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":false,"validator":"Must be a valid list of tokens. Example tokens:\u003cbr\u003e \u003ccode\u003ebuyer_interest:loan,another_token:value\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescribe the purpose of this call flow rule.\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_to_speech","full_name":"text_to_speech","description":"\n\u003cp\u003eText To Speech that will be spoken when \u003ccode\u003emessage_type=speak\u003c/code\u003e\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":"message_loop","full_name":"message_loop","description":"\n\u003cp\u003eThe message will be repeated this many times.\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":"audio_file","full_name":"audio_file","description":"\n\u003cp\u003eThe audio file that will be played when \u003ccode\u003emessage_type=audio\u003c/code\u003e\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid file upload.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_id","full_name":"schedule_id","description":"\n\u003cp\u003eThe schedule that will be used when \u003ccode\u003erouter_action=add_to_schedule\u003c/code\u003e\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Schedule}[/api/docs/1.0/schedules/index.html]. Refer to: {/api/docs/1.0/schedules}[/api/docs/1.0/schedules/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_ids","full_name":"buyer_ids","description":"\n\u003cp\u003eCalls will be forwarded to these buyers when \u003ccode\u003erouter_action=dial\u003c/code\u003e\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Buyer}[/api/docs/1.0/buyers/index.html]. Refer to: {/api/docs/1.0/buyers}[/api/docs/1.0/buyers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_group_ids","full_name":"buyer_group_ids","description":"\n\u003cp\u003eCalls will be forwarded to these buyer groups when \u003ccode\u003erouter_action=dial\u003c/code\u003e\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Buyer Group}[/api/docs/1.0/buyer_groups/index.html]. Refer to: {/api/docs/1.0/buyer_groups}[/api/docs/1.0/buyer_groups/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_offer_ids","full_name":"buyer_offer_ids","description":"\n\u003cp\u003eCalls will be forwarded to this offer when \u003ccode\u003erouter_action=redirect\u003c/code\u003e\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Offer}[/api/docs/1.0/offers/index.html]. Refer to: {/api/docs/1.0/offers}[/api/docs/1.0/offers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hold_queue_caller_limit","full_name":"hold_queue_caller_limit","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=add_to_hold_queue\u003c/code\u003e. How many people can be on hold?\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":"hold_queue_percentage_size","full_name":"hold_queue_percentage_size","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=add_to_hold_queue\u003c/code\u003e. Set the hold queue size automatically by taking [Active CC * This Percentage]\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":"max_hold_seconds","full_name":"max_hold_seconds","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=add_to_hold_queue\u003c/code\u003e. Maximum number of seconds a caller can be on hold.\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":"max_hold_seconds_average","full_name":"max_hold_seconds_average","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=add_to_hold_queue\u003c/code\u003e. Trackdrive will stop adding callers to the hold queue if the average time spent on hold exceeds this number of seconds.\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":"name","full_name":"name","description":"\n\u003cp\u003eA short label for this call flow rule shown in the call flow list.\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_action_type","full_name":"message_action_type","description":"\n\u003cp\u003eThe step this rule performs in the call flow, such as playing a message, dialing buyers, or adding to a hold queue.\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_gender","full_name":"text_to_speech_gender","description":"\n\u003cp\u003eThe voice used for the \u003ccode\u003etext_to_speech\u003c/code\u003e message, \u003ccode\u003eMale\u003c/code\u003e or \u003ccode\u003eFemale\u003c/code\u003e.\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":"key_press_timeout_seconds","full_name":"key_press_timeout_seconds","description":"\n\u003cp\u003eHow many seconds to wait for a key press before continuing when \u003ccode\u003erouter_type=press_1_to_accept\u003c/code\u003e. When \u003ccode\u003erouter_type=before_connecting_instant_agent\u003c/code\u003e, how many seconds (10 to 600) to wait for the consumer to press a key before hanging up.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"traffic_source_action_type","full_name":"traffic_source_action_type","description":"\n\u003cp\u003eHow the traffic source should be altered when this rule runs.\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":"traffic_source_action_id","full_name":"traffic_source_action_id","description":"\n\u003cp\u003eThe traffic source to assign when \u003ccode\u003etraffic_source_action_type\u003c/code\u003e reassigns the traffic source.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an 8-bit integer ID or a 128-bit UUID reference to an object on Trackdrive. Example ID: 289302820, Example UUID: 924c37d5-e70f-42ad-84c2-e85eb0c1bc21","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"traffic_source_action_payout","full_name":"traffic_source_action_payout","description":"\n\u003cp\u003eThe alternate payout applied when \u003ccode\u003etraffic_source_action_type\u003c/code\u003e sets a new payout.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"outbound_timeout_seconds","full_name":"outbound_timeout_seconds","description":"\n\u003cp\u003eHow many seconds an outbound call to an agent is allowed to ring before it is considered unanswered.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"use_with_find_a_buyer","full_name":"use_with_find_a_buyer","description":"\n\u003cp\u003eOnly perform this action when a buyer can be matched for the call.\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":"perform_action_if_buyer_is_available","full_name":"perform_action_if_buyer_is_available","description":"\n\u003cp\u003eOnly perform this action when a buyer is available. Companion setting to \u003ccode\u003euse_with_find_a_buyer\u003c/code\u003e.\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":"auto_retry_next_buyer","full_name":"auto_retry_next_buyer","description":"\n\u003cp\u003eAutomatically dial the next buyer if the current one does not answer.\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":"auto_retry_next_buyer_seconds","full_name":"auto_retry_next_buyer_seconds","description":"\n\u003cp\u003eHow many seconds to wait before dialing the next buyer when \u003ccode\u003eauto_retry_next_buyer\u003c/code\u003e is true.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"inbound_call_route_async","full_name":"inbound_call_route_async","description":"\n\u003cp\u003eRoute the inbound call asynchronously instead of holding the caller while this rule runs.\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":"off_hook_no_lead_timeout","full_name":"off_hook_no_lead_timeout","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=off_hook_press_to_accept\u003c/code\u003e. How many seconds an agent can go without a matching lead before instant agent dialing stops.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"off_hook_calls_per_seat","full_name":"off_hook_calls_per_seat","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=off_hook_press_to_accept\u003c/code\u003e. How many outbound calls to place per available agent seat.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"off_hook_unaccepted_wait","full_name":"off_hook_unaccepted_wait","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=off_hook_press_to_accept\u003c/code\u003e. How many seconds an agent has to accept an offered call before it is considered unaccepted.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"off_hook_leads_needed","full_name":"off_hook_leads_needed","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=off_hook_press_to_accept\u003c/code\u003e. How many matching leads must be available before dialing an agent.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"off_hook_dropped_call_seconds","full_name":"off_hook_dropped_call_seconds","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=off_hook_press_to_accept\u003c/code\u003e. The lookback window, in seconds, used to calculate the dropped call percentage.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"off_hook_drop_limit_1","full_name":"off_hook_drop_limit_1","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=off_hook_press_to_accept\u003c/code\u003e. The first dropped call percentage threshold that throttles outbound dialing.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"off_hook_drop_cps_1","full_name":"off_hook_drop_cps_1","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=off_hook_press_to_accept\u003c/code\u003e. The calls-per-seat rate applied once \u003ccode\u003eoff_hook_drop_limit_1\u003c/code\u003e is exceeded.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"off_hook_drop_limit_2","full_name":"off_hook_drop_limit_2","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=off_hook_press_to_accept\u003c/code\u003e. The second, higher dropped call percentage threshold that throttles outbound dialing further.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"off_hook_drop_cps_2","full_name":"off_hook_drop_cps_2","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=off_hook_press_to_accept\u003c/code\u003e. The calls-per-seat rate applied once \u003ccode\u003eoff_hook_drop_limit_2\u003c/code\u003e is exceeded.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"action_digit","full_name":"action_digit","description":"\n\u003cp\u003eOnly perform this action if the caller pressed this key.\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":"max_call_disposition_wait_seconds","full_name":"max_call_disposition_wait_seconds","description":"\n\u003cp\u003eHow many seconds to wait for an agent to disposition a call before moving on.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"call_router_hangup_reason","full_name":"call_router_hangup_reason","description":"\n\u003cp\u003eThe reason recorded on the call when this rule hangs up the call.\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":"fire_call_router_webhooks_before_action","full_name":"fire_call_router_webhooks_before_action","description":"\n\u003cp\u003eFire this rule’s outgoing webhooks before performing its action instead of after.\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":"backup_buyer_ids","full_name":"backup_buyer_ids","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=off_hook_press_to_accept\u003c/code\u003e. Overflow agents dialed when the primary agents in \u003ccode\u003ebuyer_ids\u003c/code\u003e are unavailable.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":"backup_buyer_group_ids","full_name":"backup_buyer_group_ids","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=off_hook_press_to_accept\u003c/code\u003e. Overflow buyer groups dialed when the primary agents in \u003ccode\u003ebuyer_ids\u003c/code\u003e/\u003ccode\u003ebuyer_group_ids\u003c/code\u003e are unavailable.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":"voicemail_file","full_name":"voicemail_file","description":"\n\u003cp\u003eThe audio file an instant agent can play to a lead’s answering machine when \u003ccode\u003erouter_type=off_hook_press_to_accept\u003c/code\u003e.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid file upload.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"remove_voicemail_file","full_name":"remove_voicemail_file","description":"\n\u003cp\u003eRemove the currently configured \u003ccode\u003evoicemail_file\u003c/code\u003e.\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":"hold_music_file","full_name":"hold_music_file","description":"\n\u003cp\u003eCustom music played to an instant agent while on hold when \u003ccode\u003erouter_type=off_hook_press_to_accept\u003c/code\u003e. Falls back to the default hold music when blank.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid file upload.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"remove_hold_music_file","full_name":"remove_hold_music_file","description":"\n\u003cp\u003eRemove the currently configured \u003ccode\u003ehold_music_file\u003c/code\u003e.\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":"key_press_flow_group_id","full_name":"key_press_flow_group_id","description":"\n\u003cp\u003eThe key press flow group used to process the caller’s key press response for this rule.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid foreign key reference to an {Key Press Flow Group}[/api/docs/1.0/key_press_flow_groups/index.html]. Refer to: {/api/docs/1.0/key_press_flow_groups}[/api/docs/1.0/key_press_flow_groups/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"use_sound_playlist","full_name":"use_sound_playlist","description":"\n\u003cp\u003ePlay a random file from a sound playlist instead of a single uploaded \u003ccode\u003eaudio_file\u003c/code\u003e.\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":"sound_playlist_id","full_name":"sound_playlist_id","description":"\n\u003cp\u003eThe sound playlist to play from when \u003ccode\u003euse_sound_playlist\u003c/code\u003e is true.\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":"hold_music_sound_playlist_id","full_name":"hold_music_sound_playlist_id","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=off_hook_press_to_accept\u003c/code\u003e. The sound playlist played to an instant agent while on hold.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an 8-bit integer ID or a 128-bit UUID reference to an object on Trackdrive. Example ID: 289302820, Example UUID: 924c37d5-e70f-42ad-84c2-e85eb0c1bc21","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"voicemail_sound_playlist_id","full_name":"voicemail_sound_playlist_id","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=off_hook_press_to_accept\u003c/code\u003e. The sound playlist an instant agent can play to a lead’s answering machine.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an 8-bit integer ID or a 128-bit UUID reference to an object on Trackdrive. Example ID: 289302820, Example UUID: 924c37d5-e70f-42ad-84c2-e85eb0c1bc21","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"after_action_sound_playlist_enabled","full_name":"after_action_sound_playlist_enabled","description":"\n\u003cp\u003ePlay a sound playlist after this rule’s action completes.\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":"after_action_sound_playlist_id","full_name":"after_action_sound_playlist_id","description":"\n\u003cp\u003eThe sound playlist played after this rule’s action completes, when \u003ccode\u003eafter_action_sound_playlist_enabled\u003c/code\u003e is true.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an 8-bit integer ID or a 128-bit UUID reference to an object on Trackdrive. Example ID: 289302820, Example UUID: 924c37d5-e70f-42ad-84c2-e85eb0c1bc21","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_routers/show","name":"show","apis":[{"api_url":"/api/v1/call_routers/:id","http_method":"GET","short_description":"Get Call Flow Rule 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_routers/update","name":"update","apis":[{"api_url":"/api/v1/call_routers/:id","http_method":"PUT","short_description":"Update Call Flow Rule by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"offer_id","full_name":"offer_id","description":"\n\u003cp\u003eAssign the record to this Offer.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Offer}[/api/docs/1.0/offers/index.html]. Refer to: {/api/docs/1.0/offers}[/api/docs/1.0/offers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"enabled","full_name":"enabled","description":"\n\u003cp\u003eWhen false, this rule is disabled and skipped. Used to pause a call flow rule, such as an \u003ccode\u003eoff_hook_press_to_accept\u003c/code\u003e flow, without deleting it.\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":"call_router_answer_group_id","full_name":"call_router_answer_group_id","description":"\n\u003cp\u003eThe answer group used to process the caller’s response when \u003ccode\u003erouter_type=ask_a_question\u003c/code\u003e.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid foreign key reference to an {Call Router Answer Group}[/api/docs/1.0/call_router_answer_groups/index.html]. Refer to: {/api/docs/1.0/call_router_answer_groups}[/api/docs/1.0/call_router_answer_groups/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"message_type","full_name":"message_type","description":"\n\u003cp\u003ePlay A Message?\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a value contained in the pick list:\u003cbr\u003e \u003cdiv class=\"pick-list-container\"\u003e\u003ctable class=\"table table-pick-list table-sm table-bordered table-striped\"\u003e\u003cthead\u003e\u003ctr\u003e\u003cth\u003eAcceptable Value\u003c/th\u003e\u003cth\u003eDescription\u003c/th\u003e\u003c/tr\u003e\u003c/thead\u003e\u003ctbody\u003e\u003ctr\u003e\u003cth\u003enone\u003c/th\u003e\u003ctd\u003eNo Message\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003espeak\u003c/th\u003e\u003ctd\u003eSpeak TTS\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eaudio\u003c/th\u003e\u003ctd\u003ePlay Audio\u003c/td\u003e\u003c/tr\u003e\u003c/tbody\u003e\u003c/table\u003e\u003c/div\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"router_action","full_name":"router_action","description":"\n\u003cp\u003eChoose An Action\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a value contained in the pick list:\u003cbr\u003e \u003cdiv class=\"pick-list-container\"\u003e\u003ctable class=\"table table-pick-list table-sm table-bordered table-striped\"\u003e\u003cthead\u003e\u003ctr\u003e\u003cth\u003eAcceptable Value\u003c/th\u003e\u003cth\u003eDescription\u003c/th\u003e\u003c/tr\u003e\u003c/thead\u003e\u003ctbody\u003e\u003ctr\u003e\u003cth\u003edial\u003c/th\u003e\u003ctd\u003eForward To Buyers or Agents\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eredirect\u003c/th\u003e\u003ctd\u003eForward To Offer\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eadd_to_schedule\u003c/th\u003e\u003ctd\u003eAdd To Schedule\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eadd_to_hold_queue\u003c/th\u003e\u003ctd\u003ePlace Caller In Hold Queue\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eremove_from_schedule\u003c/th\u003e\u003ctd\u003eRemove From Schedule\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003erecord_voicemail\u003c/th\u003e\u003ctd\u003eRecord Voicemail\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003erequest_key_press\u003c/th\u003e\u003ctd\u003eRequest Key Press\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eblock_caller\u003c/th\u003e\u003ctd\u003eBlock Caller\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003eend_call\u003c/th\u003e\u003ctd\u003eHang Up\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003cth\u003enone\u003c/th\u003e\u003ctd\u003eContinue Offer Routing\u003c/td\u003e\u003c/tr\u003e\u003c/tbody\u003e\u003c/table\u003e\u003c/div\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"record_token_filter_list","full_name":"record_token_filter_list","description":"\n\u003cp\u003eAssign filters to the object by passing an array of key:value pairs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"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},{"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":false,"validator":"Must be a valid list of tokens. Example tokens:\u003cbr\u003e \u003ccode\u003ebuyer_interest:loan,another_token:value\u003c/code\u003e","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescribe the purpose of this call flow rule.\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_to_speech","full_name":"text_to_speech","description":"\n\u003cp\u003eText To Speech that will be spoken when \u003ccode\u003emessage_type=speak\u003c/code\u003e\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":"message_loop","full_name":"message_loop","description":"\n\u003cp\u003eThe message will be repeated this many times.\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":"audio_file","full_name":"audio_file","description":"\n\u003cp\u003eThe audio file that will be played when \u003ccode\u003emessage_type=audio\u003c/code\u003e\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid file upload.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_id","full_name":"schedule_id","description":"\n\u003cp\u003eThe schedule that will be used when \u003ccode\u003erouter_action=add_to_schedule\u003c/code\u003e\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid foreign key reference to an {Schedule}[/api/docs/1.0/schedules/index.html]. Refer to: {/api/docs/1.0/schedules}[/api/docs/1.0/schedules/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_ids","full_name":"buyer_ids","description":"\n\u003cp\u003eCalls will be forwarded to these buyers when \u003ccode\u003erouter_action=dial\u003c/code\u003e\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Buyer}[/api/docs/1.0/buyers/index.html]. Refer to: {/api/docs/1.0/buyers}[/api/docs/1.0/buyers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_group_ids","full_name":"buyer_group_ids","description":"\n\u003cp\u003eCalls will be forwarded to these buyer groups when \u003ccode\u003erouter_action=dial\u003c/code\u003e\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Buyer Group}[/api/docs/1.0/buyer_groups/index.html]. Refer to: {/api/docs/1.0/buyer_groups}[/api/docs/1.0/buyer_groups/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"buyer_offer_ids","full_name":"buyer_offer_ids","description":"\n\u003cp\u003eCalls will be forwarded to this offer when \u003ccode\u003erouter_action=redirect\u003c/code\u003e\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an {Offer}[/api/docs/1.0/offers/index.html]. Refer to: {/api/docs/1.0/offers}[/api/docs/1.0/offers/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hold_queue_caller_limit","full_name":"hold_queue_caller_limit","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=add_to_hold_queue\u003c/code\u003e. How many people can be on hold?\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":"hold_queue_percentage_size","full_name":"hold_queue_percentage_size","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=add_to_hold_queue\u003c/code\u003e. Set the hold queue size automatically by taking [Active CC * This Percentage]\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":"max_hold_seconds","full_name":"max_hold_seconds","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=add_to_hold_queue\u003c/code\u003e. Maximum number of seconds a caller can be on hold.\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":"max_hold_seconds_average","full_name":"max_hold_seconds_average","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=add_to_hold_queue\u003c/code\u003e. Trackdrive will stop adding callers to the hold queue if the average time spent on hold exceeds this number of seconds.\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":"name","full_name":"name","description":"\n\u003cp\u003eA short label for this call flow rule shown in the call flow list.\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_action_type","full_name":"message_action_type","description":"\n\u003cp\u003eThe step this rule performs in the call flow, such as playing a message, dialing buyers, or adding to a hold queue.\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_gender","full_name":"text_to_speech_gender","description":"\n\u003cp\u003eThe voice used for the \u003ccode\u003etext_to_speech\u003c/code\u003e message, \u003ccode\u003eMale\u003c/code\u003e or \u003ccode\u003eFemale\u003c/code\u003e.\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":"key_press_timeout_seconds","full_name":"key_press_timeout_seconds","description":"\n\u003cp\u003eHow many seconds to wait for a key press before continuing when \u003ccode\u003erouter_type=press_1_to_accept\u003c/code\u003e. When \u003ccode\u003erouter_type=before_connecting_instant_agent\u003c/code\u003e, how many seconds (10 to 600) to wait for the consumer to press a key before hanging up.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"traffic_source_action_type","full_name":"traffic_source_action_type","description":"\n\u003cp\u003eHow the traffic source should be altered when this rule runs.\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":"traffic_source_action_id","full_name":"traffic_source_action_id","description":"\n\u003cp\u003eThe traffic source to assign when \u003ccode\u003etraffic_source_action_type\u003c/code\u003e reassigns the traffic source.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an 8-bit integer ID or a 128-bit UUID reference to an object on Trackdrive. Example ID: 289302820, Example UUID: 924c37d5-e70f-42ad-84c2-e85eb0c1bc21","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"traffic_source_action_payout","full_name":"traffic_source_action_payout","description":"\n\u003cp\u003eThe alternate payout applied when \u003ccode\u003etraffic_source_action_type\u003c/code\u003e sets a new payout.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"outbound_timeout_seconds","full_name":"outbound_timeout_seconds","description":"\n\u003cp\u003eHow many seconds an outbound call to an agent is allowed to ring before it is considered unanswered.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"use_with_find_a_buyer","full_name":"use_with_find_a_buyer","description":"\n\u003cp\u003eOnly perform this action when a buyer can be matched for the call.\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":"perform_action_if_buyer_is_available","full_name":"perform_action_if_buyer_is_available","description":"\n\u003cp\u003eOnly perform this action when a buyer is available. Companion setting to \u003ccode\u003euse_with_find_a_buyer\u003c/code\u003e.\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":"auto_retry_next_buyer","full_name":"auto_retry_next_buyer","description":"\n\u003cp\u003eAutomatically dial the next buyer if the current one does not answer.\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":"auto_retry_next_buyer_seconds","full_name":"auto_retry_next_buyer_seconds","description":"\n\u003cp\u003eHow many seconds to wait before dialing the next buyer when \u003ccode\u003eauto_retry_next_buyer\u003c/code\u003e is true.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"inbound_call_route_async","full_name":"inbound_call_route_async","description":"\n\u003cp\u003eRoute the inbound call asynchronously instead of holding the caller while this rule runs.\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":"off_hook_no_lead_timeout","full_name":"off_hook_no_lead_timeout","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=off_hook_press_to_accept\u003c/code\u003e. How many seconds an agent can go without a matching lead before instant agent dialing stops.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"off_hook_calls_per_seat","full_name":"off_hook_calls_per_seat","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=off_hook_press_to_accept\u003c/code\u003e. How many outbound calls to place per available agent seat.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"off_hook_unaccepted_wait","full_name":"off_hook_unaccepted_wait","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=off_hook_press_to_accept\u003c/code\u003e. How many seconds an agent has to accept an offered call before it is considered unaccepted.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"off_hook_leads_needed","full_name":"off_hook_leads_needed","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=off_hook_press_to_accept\u003c/code\u003e. How many matching leads must be available before dialing an agent.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"off_hook_dropped_call_seconds","full_name":"off_hook_dropped_call_seconds","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=off_hook_press_to_accept\u003c/code\u003e. The lookback window, in seconds, used to calculate the dropped call percentage.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"off_hook_drop_limit_1","full_name":"off_hook_drop_limit_1","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=off_hook_press_to_accept\u003c/code\u003e. The first dropped call percentage threshold that throttles outbound dialing.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"off_hook_drop_cps_1","full_name":"off_hook_drop_cps_1","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=off_hook_press_to_accept\u003c/code\u003e. The calls-per-seat rate applied once \u003ccode\u003eoff_hook_drop_limit_1\u003c/code\u003e is exceeded.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"off_hook_drop_limit_2","full_name":"off_hook_drop_limit_2","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=off_hook_press_to_accept\u003c/code\u003e. The second, higher dropped call percentage threshold that throttles outbound dialing further.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"off_hook_drop_cps_2","full_name":"off_hook_drop_cps_2","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=off_hook_press_to_accept\u003c/code\u003e. The calls-per-seat rate applied once \u003ccode\u003eoff_hook_drop_limit_2\u003c/code\u003e is exceeded.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"action_digit","full_name":"action_digit","description":"\n\u003cp\u003eOnly perform this action if the caller pressed this key.\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":"max_call_disposition_wait_seconds","full_name":"max_call_disposition_wait_seconds","description":"\n\u003cp\u003eHow many seconds to wait for an agent to disposition a call before moving on.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a decimal number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"call_router_hangup_reason","full_name":"call_router_hangup_reason","description":"\n\u003cp\u003eThe reason recorded on the call when this rule hangs up the call.\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":"fire_call_router_webhooks_before_action","full_name":"fire_call_router_webhooks_before_action","description":"\n\u003cp\u003eFire this rule’s outgoing webhooks before performing its action instead of after.\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":"backup_buyer_ids","full_name":"backup_buyer_ids","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=off_hook_press_to_accept\u003c/code\u003e. Overflow agents dialed when the primary agents in \u003ccode\u003ebuyer_ids\u003c/code\u003e are unavailable.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":"backup_buyer_group_ids","full_name":"backup_buyer_group_ids","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=off_hook_press_to_accept\u003c/code\u003e. Overflow buyer groups dialed when the primary agents in \u003ccode\u003ebuyer_ids\u003c/code\u003e/\u003ccode\u003ebuyer_group_ids\u003c/code\u003e are unavailable.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"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":"voicemail_file","full_name":"voicemail_file","description":"\n\u003cp\u003eThe audio file an instant agent can play to a lead’s answering machine when \u003ccode\u003erouter_type=off_hook_press_to_accept\u003c/code\u003e.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid file upload.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"remove_voicemail_file","full_name":"remove_voicemail_file","description":"\n\u003cp\u003eRemove the currently configured \u003ccode\u003evoicemail_file\u003c/code\u003e.\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":"hold_music_file","full_name":"hold_music_file","description":"\n\u003cp\u003eCustom music played to an instant agent while on hold when \u003ccode\u003erouter_type=off_hook_press_to_accept\u003c/code\u003e. Falls back to the default hold music when blank.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid file upload.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"remove_hold_music_file","full_name":"remove_hold_music_file","description":"\n\u003cp\u003eRemove the currently configured \u003ccode\u003ehold_music_file\u003c/code\u003e.\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":"key_press_flow_group_id","full_name":"key_press_flow_group_id","description":"\n\u003cp\u003eThe key press flow group used to process the caller’s key press response for this rule.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be a valid foreign key reference to an {Key Press Flow Group}[/api/docs/1.0/key_press_flow_groups/index.html]. Refer to: {/api/docs/1.0/key_press_flow_groups}[/api/docs/1.0/key_press_flow_groups/index.html]","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"use_sound_playlist","full_name":"use_sound_playlist","description":"\n\u003cp\u003ePlay a random file from a sound playlist instead of a single uploaded \u003ccode\u003eaudio_file\u003c/code\u003e.\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":"sound_playlist_id","full_name":"sound_playlist_id","description":"\n\u003cp\u003eThe sound playlist to play from when \u003ccode\u003euse_sound_playlist\u003c/code\u003e is true.\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":"hold_music_sound_playlist_id","full_name":"hold_music_sound_playlist_id","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=off_hook_press_to_accept\u003c/code\u003e. The sound playlist played to an instant agent while on hold.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an 8-bit integer ID or a 128-bit UUID reference to an object on Trackdrive. Example ID: 289302820, Example UUID: 924c37d5-e70f-42ad-84c2-e85eb0c1bc21","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"voicemail_sound_playlist_id","full_name":"voicemail_sound_playlist_id","description":"\n\u003cp\u003eUsed when \u003ccode\u003erouter_type=off_hook_press_to_accept\u003c/code\u003e. The sound playlist an instant agent can play to a lead’s answering machine.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an 8-bit integer ID or a 128-bit UUID reference to an object on Trackdrive. Example ID: 289302820, Example UUID: 924c37d5-e70f-42ad-84c2-e85eb0c1bc21","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"after_action_sound_playlist_enabled","full_name":"after_action_sound_playlist_enabled","description":"\n\u003cp\u003ePlay a sound playlist after this rule’s action completes.\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":"after_action_sound_playlist_id","full_name":"after_action_sound_playlist_id","description":"\n\u003cp\u003eThe sound playlist played after this rule’s action completes, when \u003ccode\u003eafter_action_sound_playlist_enabled\u003c/code\u003e is true.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":true,"validator":"Must be an 8-bit integer ID or a 128-bit UUID reference to an object on Trackdrive. Example ID: 289302820, Example UUID: 924c37d5-e70f-42ad-84c2-e85eb0c1bc21","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_routers/destroy","name":"destroy","apis":[{"api_url":"/api/v1/call_routers/:id","http_method":"DELETE","short_description":"Destroy Call Flow Rule by id.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false}]}}