GET /api/v1/call_routers/new
Build Call Flow Rule with defaults.

Params

Param name
Description
Validations
message_type
Optional

Play A Message?

Validations:

  • Must be a value contained in the pick list:
    Acceptable ValueDescription
    noneNo Message
    speakSpeak TTS
    audioPlay Audio
router_action
Optional

Choose An Action

Validations:

  • Must be a value contained in the pick list:
    Acceptable ValueDescription
    dialForward To Buyers
    redirectForward To Offer
    add_to_scheduleAdd To Schedule
    add_to_hold_queuePlace Caller In Hold Queue
    remove_from_scheduleRemove From Schedule
    record_voicemailRecord Voicemail
    request_key_pressRequest Key Press
    block_callerBlock Caller
    end_callHang Up
    noneContinue Offer Routing
record_token_filter_list
Optional Blank Value Allowed

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

Validations:

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

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

Validations:

  • Must be a valid list of tokens. Example tokens:
    buyer_interest:loan,another_token:value
description
Optional Blank Value Allowed

Describe the purpose of this call flow rule.

Validations:

  • Must be a String
text_to_speech
Optional Blank Value Allowed

Text To Speech that will be spoken when message_type=speak

Validations:

  • Must be a String
message_loop
Optional Blank Value Allowed

The message will be repeated this many times.

Validations:

  • Must be a decimal number.
audio_file
Optional Blank Value Allowed

The audio file that will be played when message_type=audio

Validations:

  • Must be a valid file upload.
schedule_id
Optional Blank Value Allowed

The schedule that will be used when router_action=add_to_schedule

Validations:
buyer_ids
Optional Blank Value Allowed

Calls will be forwarded to these buyers when router_action=dial

Validations:

  • 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
buyer_group_ids
Optional Blank Value Allowed

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

Validations:
buyer_offer_ids
Optional Blank Value Allowed

Calls will be forwarded to this offer when router_action=redirect

Validations:

  • 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
hold_queue_caller_limit
Optional Blank Value Allowed

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

Validations:

  • Must be a decimal number.
hold_queue_percentage_size
Optional Blank Value Allowed

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

Validations:

  • Must be a decimal number.
max_hold_seconds
Optional Blank Value Allowed

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

Validations:

  • Must be a decimal number.
max_hold_seconds_average
Optional Blank Value Allowed

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.

Validations:

  • Must be a decimal number.