Offers: Call Flow

Return records matching these ids.

• Must be an array of decimal values. EG: [0, 1, 2, 3]

Assign the record to this Offer.

• Must be a valid foreign key reference to an Offer. Refer to: /api/docs/1.0/offers

Return the next page of results.

• Must be a number.

How many results to return per page. The default is 25.

• Must be a number.

Date formatted like 2016-01-01 12:25:15 -0500

• Must be a String

Date formatted like 2016-01-01 12:25:15 -0500

• Must be a String

Search for any record that matches this text

• Must be a String

Date ranges will be parsed using this time zone.

• Must be a valid time zone. See the list of valid time zones.

Must be any combination of:

• id
• legacy_id
• type
• uuid
• created_at
• updated_at
• deleted_at
• user_updated_at
• routes_show_path
• routes_edit_path
• external_record_id
• category
• name
• context_menu_name
• offer_id
• message_type
• message_action
• message_loop
• text_to_speech
• text_to_speech_gender
• router_action
• action_option
• buyer_ids
• buyer_offer_ids
• buyer_group_ids
• sortable_order
• schedule_id
• outbound_timeout_seconds
• router_type
• description
• message_action_type
• key_press_timeout_seconds
• perform_action_if_buyer_is_available
• inbound_call_route_async
• backup_buyer_ids
• backup_buyer_group_ids
• use_sound_playlist
• sound_playlist_id
• hold_music_sound_playlist_id
• voicemail_sound_playlist_id
• has_schedule
• has_extension_pool
• allows_outgoing_webhooks
• use_with_find_a_buyer
• use_with_key_press_flows
• key_press_flow_group_id
• auto_retry_next_buyer
• auto_retry_next_buyer_seconds
• has_extension_actions
• has_schedule_action
• can_dial
• can_alter_traffic_source
• max_call_disposition_wait_seconds
• hold_queue_caller_limit
• hold_queue_percentage_size
• max_hold_seconds
• max_hold_seconds_average
• fire_call_router_webhooks_before_action
• action_digit
• off_hook_calls_per_seat
• off_hook_unaccepted_wait
• off_hook_leads_needed
• audio_file_url
• voicemail_file_url
• hold_music_file_url
• call_router_hangup_reason
• call_router_answer_group_id
• off_hook_no_lead_timeout
• outgoing_webhook_ids
• after_action_sound_playlist_enabled
• after_action_sound_playlist_id
• off_hook_dropped_call_seconds
• off_hook_drop_limit_1
• off_hook_drop_cps_1
• off_hook_drop_limit_2
• off_hook_drop_cps_2
• enabled
• record_token_filter_id
• record_token_filter_data_count
• record_token_filter_data
• record_token_additional_id
• record_token_additional_data_count
• record_token_additional_data
• record_token_buyer_id
• record_token_buyer_data_count
• record_token_buyer_data
• off_hook_dropped_calls

• Must be a String

Pass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}

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

Play A Message?

• Must be a value contained in the pick list:
  

  Acceptable Value	Description
  none	No Message
  speak	Speak TTS
  audio	Play Audio

Choose An Action

• Must be a value contained in the pick list:
  

  Acceptable Value	Description
  dial	Forward To Buyers or Agents
  redirect	Forward To Offer
  add_to_schedule	Add To Schedule
  add_to_hold_queue	Place Caller In Hold Queue
  remove_from_schedule	Remove From Schedule
  record_voicemail	Record Voicemail
  request_key_press	Request Key Press
  block_caller	Block Caller
  end_call	Hang Up
  none	Continue Offer Routing

Assign filters to the object by passing an array of key:value pairs

• Must be a valid list of filters. Example filters:
  "interest:auto", "loan_amount:>=10000", "loan_amount:<=50000", "geo:!=800", "caller_id:!=anonymous"

Assign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.

• Must be a valid list of tokens. Example tokens:
  buyer_interest:loan,another_token:value

Describe the purpose of this call flow rule.

• Must be a String

Text To Speech that will be spoken when message_type=speak

• Must be a String

The message will be repeated this many times.

• Must be a decimal number.

The audio file that will be played when message_type=audio

• Must be a valid file upload.

The schedule that will be used when router_action=add_to_schedule

• Must be a valid foreign key reference to an Schedule. Refer to: /api/docs/1.0/schedules

Calls will be forwarded to these buyers when router_action=dial

• Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an Buyer. Refer to: /api/docs/1.0/buyers

Calls will be forwarded to these buyer groups when router_action=dial

• Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an Buyer Group. Refer to: /api/docs/1.0/buyer_groups

Calls will be forwarded to this offer when router_action=redirect

• Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an Offer. Refer to: /api/docs/1.0/offers

Used when router_type=add_to_hold_queue. How many people can be on hold?

• Must be a decimal number.

Used when router_type=add_to_hold_queue. Set the hold queue size automatically by taking [Active CC * This Percentage]

• Must be a decimal number.

Used when router_type=add_to_hold_queue. Maximum number of seconds a caller can be on hold.

• Must be a decimal number.

Used when router_type=add_to_hold_queue. Trackdrive will stop adding callers to the hold queue if the average time spent on hold exceeds this number of seconds.

• Must be a decimal number.

A short label for this call flow rule shown in the call flow list.

• Must be a String

The step this rule performs in the call flow, such as playing a message, dialing buyers, or adding to a hold queue.

• Must be a String

The voice used for the text_to_speech message, Male or Female.

• Must be a String

How many seconds to wait for a key press before continuing when router_type=press_1_to_accept. When router_type=before_connecting_instant_agent, how many seconds (10 to 600) to wait for the consumer to press a key before hanging up.

• Must be a decimal number.

How the traffic source should be altered when this rule runs.

• Must be a String

The traffic source to assign when traffic_source_action_type reassigns the traffic source.

• 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

The alternate payout applied when traffic_source_action_type sets a new payout.

• Must be a decimal number.

How many seconds an outbound call to an agent is allowed to ring before it is considered unanswered.

• Must be a decimal number.

Only perform this action when a buyer can be matched for the call.

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

Only perform this action when a buyer is available. Companion setting to use_with_find_a_buyer.

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

Automatically dial the next buyer if the current one does not answer.

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

How many seconds to wait before dialing the next buyer when auto_retry_next_buyer is true.

• Must be a decimal number.

Route the inbound call asynchronously instead of holding the caller while this rule runs.

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

Used when router_type=off_hook_press_to_accept. How many seconds an agent can go without a matching lead before instant agent dialing stops.

• Must be a decimal number.

Used when router_type=off_hook_press_to_accept. How many outbound calls to place per available agent seat.

• Must be a decimal number.

Used when router_type=off_hook_press_to_accept. How many seconds an agent has to accept an offered call before it is considered unaccepted.

• Must be a decimal number.

Used when router_type=off_hook_press_to_accept. How many matching leads must be available before dialing an agent.

• Must be a decimal number.

Used when router_type=off_hook_press_to_accept. The lookback window, in seconds, used to calculate the dropped call percentage.

• Must be a decimal number.

Used when router_type=off_hook_press_to_accept. The first dropped call percentage threshold that throttles outbound dialing.

• Must be a decimal number.

Used when router_type=off_hook_press_to_accept. The calls-per-seat rate applied once off_hook_drop_limit_1 is exceeded.

• Must be a decimal number.

Used when router_type=off_hook_press_to_accept. The second, higher dropped call percentage threshold that throttles outbound dialing further.

• Must be a decimal number.

Used when router_type=off_hook_press_to_accept. The calls-per-seat rate applied once off_hook_drop_limit_2 is exceeded.

• Must be a decimal number.

Only perform this action if the caller pressed this key.

• Must be a String

How many seconds to wait for an agent to disposition a call before moving on.

• Must be a decimal number.

The reason recorded on the call when this rule hangs up the call.

• Must be a String

Fire this rule’s outgoing webhooks before performing its action instead of after.

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

Used when router_type=off_hook_press_to_accept. Overflow agents dialed when the primary agents in buyer_ids are unavailable.

• Must be an array of decimal values. EG: [0, 1, 2, 3]

Used when router_type=off_hook_press_to_accept. Overflow buyer groups dialed when the primary agents in buyer_ids/buyer_group_ids are unavailable.

• Must be an array of decimal values. EG: [0, 1, 2, 3]

The audio file an instant agent can play to a lead’s answering machine when router_type=off_hook_press_to_accept.

• Must be a valid file upload.

Remove the currently configured voicemail_file.

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

Custom music played to an instant agent while on hold when router_type=off_hook_press_to_accept. Falls back to the default hold music when blank.

• Must be a valid file upload.

Remove the currently configured hold_music_file.

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

The key press flow group used to process the caller’s key press response for this rule.

• Must be a valid foreign key reference to an Key Press Flow Group. Refer to: /api/docs/1.0/key_press_flow_groups

Play a random file from a sound playlist instead of a single uploaded audio_file.

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

The sound playlist to play from when use_sound_playlist is true.

• Must be a valid foreign key reference to an Sound Playlist. Refer to: /api/docs/1.0/sound_playlists

Used when router_type=off_hook_press_to_accept. The sound playlist played to an instant agent while on hold.

• 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

Used when router_type=off_hook_press_to_accept. The sound playlist an instant agent can play to a lead’s answering machine.

• 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

Play a sound playlist after this rule’s action completes.

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

The sound playlist played after this rule’s action completes, when after_action_sound_playlist_enabled is true.

• 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

Assign the record to this Offer.

• Must be a valid foreign key reference to an Offer. Refer to: /api/docs/1.0/offers

The type of Call Flow Rule.

• Must be a value contained in the pick list:
  

  Acceptable Value	Description
  ask_a_question	Ask A Question And Request An Answer
  no_greeting_is_played	Handle Call When No Keypress Is Requested
  connect_ai_voice_agent	Connect AI Voice Agent
  when_answering_machine_detected	When an answering machine is detected
  before_answering_machine_detected	Before an answering machine is detected
  greeting	Play A Greeting Message And Request A Keypress
  off_hook_press_to_accept	When Getting Instant Agents On The Phone
  key_press_1	When 1 is Pressed
  key_press_2	When 2 is pressed
  key_press_3	When 3 is pressed
  key_press_4	When 4 is pressed
  key_press_5	When 5 is pressed
  key_press_6	When 6 is pressed
  key_press_7	When 7 is pressed
  key_press_8	When 8 is pressed
  key_press_9	When 9 is pressed
  key_press_#	When # is pressed
  key_press_*	When * is pressed
  key_press_0	When 0 is pressed
  no_key_press	When nothing is pressed
  any_other_key_press	When anything is pressed
  calling_buyer_music	Calling Buyer Music Played to Caller during Transfers
  whisper	Whisper To Buyer that a Call is being Transferred
  enter_extension	Enter Extension
  extension_failed	When an invalid extension is entered
  zip_code_entry	Enter Zip Code
  zip_entry_failed	Incorrect Zip Code
  press_1_to_accept	Whisper to Buyer to Press 1 to Accept a Call
  press_1_too_slow	Whisper to Buyer that they Pressed 1 Too Slowly
  add_to_hold_queue	When placed in hold queue
  hold_queue_is_full	When the hold queue is full
  hold_queue_max_seconds_exceeded	When the caller has been on hold for longer than max hold seconds
  no_instant_agent_available	When no instant agent is available during an inbound call from a consumer
  no_instant_agent_available_outbound	When no instant agent is available during an outbound call to a consumer
  before_connecting_instant_agent	Before Connecting An Instant Agent
  when_instant_agent_transfers_to_buyer	When an instant agent transfers to a buyer
  when_buyer_hangup_before_duration	When A Buyer Hangs Up Before Duration
  no_buyers_have_open_concurrency_cap	When no buyers have open concurrency cap
  all_buyers_closed	When no buyers are open
  no_buyer_answered	When no buyers answer
  no_buyers_match	When no buyers have matching filters
  tag_validation_failed	Token Entry Failed
  traffic_source_capped	When the traffic source is capped
  caller_hang_up_before_conference	When the caller hangs up before being connected to a buyer

Play A Message?

• Must be a value contained in the pick list:
  

  Acceptable Value	Description
  none	No Message
  speak	Speak TTS
  audio	Play Audio

Choose An Action

• Must be a value contained in the pick list:
  

  Acceptable Value	Description
  dial	Forward To Buyers or Agents
  redirect	Forward To Offer
  add_to_schedule	Add To Schedule
  add_to_hold_queue	Place Caller In Hold Queue
  remove_from_schedule	Remove From Schedule
  record_voicemail	Record Voicemail
  request_key_press	Request Key Press
  block_caller	Block Caller
  end_call	Hang Up
  none	Continue Offer Routing

Assign filters to the object by passing an array of key:value pairs

• Must be a valid list of filters. Example filters:
  "interest:auto", "loan_amount:>=10000", "loan_amount:<=50000", "geo:!=800", "caller_id:!=anonymous"

Assign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.

• Must be a valid list of tokens. Example tokens:
  buyer_interest:loan,another_token:value

Describe the purpose of this call flow rule.

• Must be a String

Text To Speech that will be spoken when message_type=speak

• Must be a String

The message will be repeated this many times.

• Must be a decimal number.

The audio file that will be played when message_type=audio

• Must be a valid file upload.

The schedule that will be used when router_action=add_to_schedule

• Must be a valid foreign key reference to an Schedule. Refer to: /api/docs/1.0/schedules

Calls will be forwarded to these buyers when router_action=dial

• Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an Buyer. Refer to: /api/docs/1.0/buyers

Calls will be forwarded to these buyer groups when router_action=dial

• Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an Buyer Group. Refer to: /api/docs/1.0/buyer_groups

Calls will be forwarded to this offer when router_action=redirect

• Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an Offer. Refer to: /api/docs/1.0/offers

Used when router_type=add_to_hold_queue. How many people can be on hold?

• Must be a decimal number.

Used when router_type=add_to_hold_queue. Set the hold queue size automatically by taking [Active CC * This Percentage]

• Must be a decimal number.

Used when router_type=add_to_hold_queue. Maximum number of seconds a caller can be on hold.

• Must be a decimal number.

Used when router_type=add_to_hold_queue. Trackdrive will stop adding callers to the hold queue if the average time spent on hold exceeds this number of seconds.

• Must be a decimal number.

A short label for this call flow rule shown in the call flow list.

• Must be a String

The step this rule performs in the call flow, such as playing a message, dialing buyers, or adding to a hold queue.

• Must be a String

The voice used for the text_to_speech message, Male or Female.

• Must be a String

How many seconds to wait for a key press before continuing when router_type=press_1_to_accept. When router_type=before_connecting_instant_agent, how many seconds (10 to 600) to wait for the consumer to press a key before hanging up.

• Must be a decimal number.

How the traffic source should be altered when this rule runs.

• Must be a String

The traffic source to assign when traffic_source_action_type reassigns the traffic source.

• 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

The alternate payout applied when traffic_source_action_type sets a new payout.

• Must be a decimal number.

How many seconds an outbound call to an agent is allowed to ring before it is considered unanswered.

• Must be a decimal number.

Only perform this action when a buyer can be matched for the call.

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

Only perform this action when a buyer is available. Companion setting to use_with_find_a_buyer.

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

Automatically dial the next buyer if the current one does not answer.

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

How many seconds to wait before dialing the next buyer when auto_retry_next_buyer is true.

• Must be a decimal number.

Route the inbound call asynchronously instead of holding the caller while this rule runs.

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

Used when router_type=off_hook_press_to_accept. How many seconds an agent can go without a matching lead before instant agent dialing stops.

• Must be a decimal number.

Used when router_type=off_hook_press_to_accept. How many outbound calls to place per available agent seat.

• Must be a decimal number.

Used when router_type=off_hook_press_to_accept. How many seconds an agent has to accept an offered call before it is considered unaccepted.

• Must be a decimal number.

Used when router_type=off_hook_press_to_accept. How many matching leads must be available before dialing an agent.

• Must be a decimal number.

Used when router_type=off_hook_press_to_accept. The lookback window, in seconds, used to calculate the dropped call percentage.

• Must be a decimal number.

Used when router_type=off_hook_press_to_accept. The first dropped call percentage threshold that throttles outbound dialing.

• Must be a decimal number.

Used when router_type=off_hook_press_to_accept. The calls-per-seat rate applied once off_hook_drop_limit_1 is exceeded.

• Must be a decimal number.

Used when router_type=off_hook_press_to_accept. The second, higher dropped call percentage threshold that throttles outbound dialing further.

• Must be a decimal number.

Used when router_type=off_hook_press_to_accept. The calls-per-seat rate applied once off_hook_drop_limit_2 is exceeded.

• Must be a decimal number.

Only perform this action if the caller pressed this key.

• Must be a String

How many seconds to wait for an agent to disposition a call before moving on.

• Must be a decimal number.

The reason recorded on the call when this rule hangs up the call.

• Must be a String

Fire this rule’s outgoing webhooks before performing its action instead of after.

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

Used when router_type=off_hook_press_to_accept. Overflow agents dialed when the primary agents in buyer_ids are unavailable.

• Must be an array of decimal values. EG: [0, 1, 2, 3]

Used when router_type=off_hook_press_to_accept. Overflow buyer groups dialed when the primary agents in buyer_ids/buyer_group_ids are unavailable.

• Must be an array of decimal values. EG: [0, 1, 2, 3]

The audio file an instant agent can play to a lead’s answering machine when router_type=off_hook_press_to_accept.

• Must be a valid file upload.

Remove the currently configured voicemail_file.

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

Custom music played to an instant agent while on hold when router_type=off_hook_press_to_accept. Falls back to the default hold music when blank.

• Must be a valid file upload.

Remove the currently configured hold_music_file.

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

The key press flow group used to process the caller’s key press response for this rule.

• Must be a valid foreign key reference to an Key Press Flow Group. Refer to: /api/docs/1.0/key_press_flow_groups

Play a random file from a sound playlist instead of a single uploaded audio_file.

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

The sound playlist to play from when use_sound_playlist is true.

• Must be a valid foreign key reference to an Sound Playlist. Refer to: /api/docs/1.0/sound_playlists

Used when router_type=off_hook_press_to_accept. The sound playlist played to an instant agent while on hold.

• 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

Used when router_type=off_hook_press_to_accept. The sound playlist an instant agent can play to a lead’s answering machine.

• 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

Play a sound playlist after this rule’s action completes.

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

The sound playlist played after this rule’s action completes, when after_action_sound_playlist_enabled is true.

• 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

Assign the record to this Offer.

• Must be a valid foreign key reference to an Offer. Refer to: /api/docs/1.0/offers

When false, this rule is disabled and skipped. Used to pause a call flow rule, such as an off_hook_press_to_accept flow, without deleting it.

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

The answer group used to process the caller’s response when router_type=ask_a_question.

• Must be a valid foreign key reference to an Call Router Answer Group. Refer to: /api/docs/1.0/call_router_answer_groups

Play A Message?

• Must be a value contained in the pick list:
  

  Acceptable Value	Description
  none	No Message
  speak	Speak TTS
  audio	Play Audio

Choose An Action

• Must be a value contained in the pick list:
  

  Acceptable Value	Description
  dial	Forward To Buyers or Agents
  redirect	Forward To Offer
  add_to_schedule	Add To Schedule
  add_to_hold_queue	Place Caller In Hold Queue
  remove_from_schedule	Remove From Schedule
  record_voicemail	Record Voicemail
  request_key_press	Request Key Press
  block_caller	Block Caller
  end_call	Hang Up
  none	Continue Offer Routing

Assign filters to the object by passing an array of key:value pairs

• Must be a valid list of filters. Example filters:
  "interest:auto", "loan_amount:>=10000", "loan_amount:<=50000", "geo:!=800", "caller_id:!=anonymous"

Assign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs.

• Must be a valid list of tokens. Example tokens:
  buyer_interest:loan,another_token:value

Describe the purpose of this call flow rule.

• Must be a String

Text To Speech that will be spoken when message_type=speak

• Must be a String

The message will be repeated this many times.

• Must be a decimal number.

The audio file that will be played when message_type=audio

• Must be a valid file upload.

The schedule that will be used when router_action=add_to_schedule

• Must be a valid foreign key reference to an Schedule. Refer to: /api/docs/1.0/schedules

Calls will be forwarded to these buyers when router_action=dial

• Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an Buyer. Refer to: /api/docs/1.0/buyers

Calls will be forwarded to these buyer groups when router_action=dial

• Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an Buyer Group. Refer to: /api/docs/1.0/buyer_groups

Calls will be forwarded to this offer when router_action=redirect

• Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an Offer. Refer to: /api/docs/1.0/offers

Used when router_type=add_to_hold_queue. How many people can be on hold?

• Must be a decimal number.

Used when router_type=add_to_hold_queue. Set the hold queue size automatically by taking [Active CC * This Percentage]

• Must be a decimal number.

Used when router_type=add_to_hold_queue. Maximum number of seconds a caller can be on hold.

• Must be a decimal number.

Used when router_type=add_to_hold_queue. Trackdrive will stop adding callers to the hold queue if the average time spent on hold exceeds this number of seconds.

• Must be a decimal number.

A short label for this call flow rule shown in the call flow list.

• Must be a String

The step this rule performs in the call flow, such as playing a message, dialing buyers, or adding to a hold queue.

• Must be a String

The voice used for the text_to_speech message, Male or Female.

• Must be a String

How many seconds to wait for a key press before continuing when router_type=press_1_to_accept. When router_type=before_connecting_instant_agent, how many seconds (10 to 600) to wait for the consumer to press a key before hanging up.

• Must be a decimal number.

How the traffic source should be altered when this rule runs.

• Must be a String

The traffic source to assign when traffic_source_action_type reassigns the traffic source.

• 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

The alternate payout applied when traffic_source_action_type sets a new payout.

• Must be a decimal number.

How many seconds an outbound call to an agent is allowed to ring before it is considered unanswered.

• Must be a decimal number.

Only perform this action when a buyer can be matched for the call.

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

Only perform this action when a buyer is available. Companion setting to use_with_find_a_buyer.

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

Automatically dial the next buyer if the current one does not answer.

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

How many seconds to wait before dialing the next buyer when auto_retry_next_buyer is true.

• Must be a decimal number.

Route the inbound call asynchronously instead of holding the caller while this rule runs.

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

Used when router_type=off_hook_press_to_accept. How many seconds an agent can go without a matching lead before instant agent dialing stops.

• Must be a decimal number.

Used when router_type=off_hook_press_to_accept. How many outbound calls to place per available agent seat.

• Must be a decimal number.

Used when router_type=off_hook_press_to_accept. How many seconds an agent has to accept an offered call before it is considered unaccepted.

• Must be a decimal number.

Used when router_type=off_hook_press_to_accept. How many matching leads must be available before dialing an agent.

• Must be a decimal number.

Used when router_type=off_hook_press_to_accept. The lookback window, in seconds, used to calculate the dropped call percentage.

• Must be a decimal number.

Used when router_type=off_hook_press_to_accept. The first dropped call percentage threshold that throttles outbound dialing.

• Must be a decimal number.

Used when router_type=off_hook_press_to_accept. The calls-per-seat rate applied once off_hook_drop_limit_1 is exceeded.

• Must be a decimal number.

Used when router_type=off_hook_press_to_accept. The second, higher dropped call percentage threshold that throttles outbound dialing further.

• Must be a decimal number.

Used when router_type=off_hook_press_to_accept. The calls-per-seat rate applied once off_hook_drop_limit_2 is exceeded.

• Must be a decimal number.

Only perform this action if the caller pressed this key.

• Must be a String

How many seconds to wait for an agent to disposition a call before moving on.

• Must be a decimal number.

The reason recorded on the call when this rule hangs up the call.

• Must be a String

Fire this rule’s outgoing webhooks before performing its action instead of after.

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

Used when router_type=off_hook_press_to_accept. Overflow agents dialed when the primary agents in buyer_ids are unavailable.

• Must be an array of decimal values. EG: [0, 1, 2, 3]

Used when router_type=off_hook_press_to_accept. Overflow buyer groups dialed when the primary agents in buyer_ids/buyer_group_ids are unavailable.

• Must be an array of decimal values. EG: [0, 1, 2, 3]

The audio file an instant agent can play to a lead’s answering machine when router_type=off_hook_press_to_accept.

• Must be a valid file upload.

Remove the currently configured voicemail_file.

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

Custom music played to an instant agent while on hold when router_type=off_hook_press_to_accept. Falls back to the default hold music when blank.

• Must be a valid file upload.

Remove the currently configured hold_music_file.

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

The key press flow group used to process the caller’s key press response for this rule.

• Must be a valid foreign key reference to an Key Press Flow Group. Refer to: /api/docs/1.0/key_press_flow_groups

Play a random file from a sound playlist instead of a single uploaded audio_file.

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

The sound playlist to play from when use_sound_playlist is true.

• Must be a valid foreign key reference to an Sound Playlist. Refer to: /api/docs/1.0/sound_playlists

Used when router_type=off_hook_press_to_accept. The sound playlist played to an instant agent while on hold.

• 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

Used when router_type=off_hook_press_to_accept. The sound playlist an instant agent can play to a lead’s answering machine.

• 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

Play a sound playlist after this rule’s action completes.

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

The sound playlist played after this rule’s action completes, when after_action_sound_playlist_enabled is true.

• 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