Params

Param name
Description
auth_token
Optional

Authorize requests using your token. Get it from your profile: trackdrive.net/profile/edit

  • Must be String

offer_id
Required

Assign the record to this Offer.

router_type
Required

The type of Call Flow Rule.

  • Must be a value contained in the pick list:
    Acceptable ValueDescription
    no_greeting_is_playedHandle Call When No Keypress Is Requested
    when_answering_machine_detectedWhen an answering machine is detected
    greetingPlay A Greeting Message And Request A Keypress
    off_hook_press_to_acceptWhen Getting Instant Agents On The Phone
    key_press_1When 1 is Pressed
    key_press_2When 2 is pressed
    key_press_3When 3 is pressed
    key_press_4When 4 is pressed
    key_press_5When 5 is pressed
    key_press_6When 6 is pressed
    key_press_7When 7 is pressed
    key_press_8When 8 is pressed
    key_press_9When 9 is pressed
    key_press_#When # is pressed
    key_press_*When * is pressed
    key_press_0When 0 is pressed
    no_key_pressWhen nothing is pressed
    any_other_key_pressWhen anything is pressed
    calling_buyer_musicCalling Buyer Music Played to Caller during Transfers
    whisperWhisper To Buyer that a Call is being Transferred
    enter_extensionEnter Extension
    extension_failedWhen an invalid extension is entered
    zip_code_entryEnter Zip Code
    zip_entry_failedIncorrect Zip Code
    press_1_to_acceptWhisper to Buyer to Press 1 to Accept a Call
    press_1_too_slowWhisper to Buyer that they Pressed 1 Too Slowly
    add_to_hold_queueWhen placed in hold queue
    hold_queue_is_fullWhen the hold queue is full
    no_buyers_have_open_concurrency_capWhen no buyers have open concurrency cap
    all_buyers_closedWhen no buyers are open
    no_buyer_answeredWhen no buyers answer
    no_buyers_matchWhen no buyers have matching filters
    tag_validation_failedToken Entry Failed
    traffic_source_cappedWhen the traffic source is capped
    caller_hang_up_before_conferenceWhen the caller hangs up before being connected to a buyer
message_type
Optional

Play A Message?

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

Choose An Action

  • 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
    block_callerBlock Caller
    end_callHang Up
    noneContinue Offer Routing
description
Optional Blank Value Allowed

Describe the purpose of this call flow rule.

  • Must be String

text_to_speech
Optional Blank Value Allowed

Text To Speech that will be spoken when message_type=speak

  • Must be String

message_loop
Optional Blank Value Allowed

The message will be repeated this many times.

  • Must be a decimal number.

audio_file
Optional Blank Value Allowed

The audio file that will be played when message_type=audio

  • Must be a valid file upload.

schedule_id
Optional Blank Value Allowed

The schedule that will be used when router_action=add_to_schedule

buyer_ids
Optional Blank Value Allowed

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

buyer_group_ids
Optional Blank Value Allowed

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

buyer_offer_ids
Optional Blank Value Allowed

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

hold_queue_caller_limit
Optional Blank Value Allowed

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

  • 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]

  • 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.

  • 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.

  • Must be a decimal number.