Param name |
Description
Validations
|
---|---|
ids Optional |
Return records matching these ids.
|
offer_id Optional |
Assign the record to this Offer.
|
page Optional |
Return the next page of results.
|
per_page Optional |
How many results to return per page. The default is 25.
|
created_at_to Optional |
Date formatted like 2016-01-01 12:25:15 -0500
|
created_at_from Optional |
Date formatted like 2016-01-01 12:25:15 -0500
|
fulltext Optional |
Search for any record that matches this text
|
time_zone Optional |
Date ranges will be parsed using this time zone.
|
columns Optional |
Specify the columns you would like returned by the API for a given resource.
Limiting the columns can significantly increase API response time since only the requested data will be processed.
columns=uuid,number,created_at
Must be any combination of:
|
root Optional |
Pass
|
Param name |
Description
Validations
|
||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
message_type Optional |
Play A Message?
|
||||||||||||||||||||||
router_action Optional |
Choose An Action
|
||||||||||||||||||||||
record_token_filter_list Optional Blank Value Allowed |
Assign filters to the object by passing an array of key:value pairs
|
||||||||||||||||||||||
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.
|
||||||||||||||||||||||
description Optional Blank Value Allowed |
Describe the purpose of this call flow rule.
|
||||||||||||||||||||||
text_to_speech Optional Blank Value Allowed |
Text To Speech that will be spoken when
|
||||||||||||||||||||||
message_loop Optional Blank Value Allowed |
The message will be repeated this many times.
|
||||||||||||||||||||||
audio_file Optional Blank Value Allowed |
The audio file that will be played when
|
||||||||||||||||||||||
schedule_id Optional Blank Value Allowed |
The schedule that will be used when
|
||||||||||||||||||||||
buyer_ids Optional Blank Value Allowed |
Calls will be forwarded to these buyers when
|
||||||||||||||||||||||
buyer_group_ids Optional Blank Value Allowed |
Calls will be forwarded to these buyer groups when
|
||||||||||||||||||||||
buyer_offer_ids Optional Blank Value Allowed |
Calls will be forwarded to this offer when
|
||||||||||||||||||||||
hold_queue_caller_limit Optional Blank Value Allowed |
Used when
|
||||||||||||||||||||||
hold_queue_percentage_size Optional Blank Value Allowed |
Used when
|
||||||||||||||||||||||
max_hold_seconds Optional Blank Value Allowed |
Used when
|
||||||||||||||||||||||
max_hold_seconds_average Optional Blank Value Allowed |
Used when
|
Param name |
Description
Validations
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
offer_id Required |
Assign the record to this Offer.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
router_type Required |
The type of Call Flow Rule.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
message_type Optional |
Play A Message?
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
router_action Optional |
Choose An Action
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
record_token_filter_list Optional Blank Value Allowed |
Assign filters to the object by passing an array of key:value pairs
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
description Optional Blank Value Allowed |
Describe the purpose of this call flow rule.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
text_to_speech Optional Blank Value Allowed |
Text To Speech that will be spoken when
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
message_loop Optional Blank Value Allowed |
The message will be repeated this many times.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
audio_file Optional Blank Value Allowed |
The audio file that will be played when
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
schedule_id Optional Blank Value Allowed |
The schedule that will be used when
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
buyer_ids Optional Blank Value Allowed |
Calls will be forwarded to these buyers when
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
buyer_group_ids Optional Blank Value Allowed |
Calls will be forwarded to these buyer groups when
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
buyer_offer_ids Optional Blank Value Allowed |
Calls will be forwarded to this offer when
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
hold_queue_caller_limit Optional Blank Value Allowed |
Used when
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
hold_queue_percentage_size Optional Blank Value Allowed |
Used when
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
max_hold_seconds Optional Blank Value Allowed |
Used when
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
max_hold_seconds_average Optional Blank Value Allowed |
Used when
|
Param name |
Description
Validations
|
||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
offer_id Optional |
Assign the record to this Offer.
|
||||||||||||||||||||||
message_type Optional |
Play A Message?
|
||||||||||||||||||||||
router_action Optional |
Choose An Action
|
||||||||||||||||||||||
record_token_filter_list Optional Blank Value Allowed |
Assign filters to the object by passing an array of key:value pairs
|
||||||||||||||||||||||
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.
|
||||||||||||||||||||||
description Optional Blank Value Allowed |
Describe the purpose of this call flow rule.
|
||||||||||||||||||||||
text_to_speech Optional Blank Value Allowed |
Text To Speech that will be spoken when
|
||||||||||||||||||||||
message_loop Optional Blank Value Allowed |
The message will be repeated this many times.
|
||||||||||||||||||||||
audio_file Optional Blank Value Allowed |
The audio file that will be played when
|
||||||||||||||||||||||
schedule_id Optional Blank Value Allowed |
The schedule that will be used when
|
||||||||||||||||||||||
buyer_ids Optional Blank Value Allowed |
Calls will be forwarded to these buyers when
|
||||||||||||||||||||||
buyer_group_ids Optional Blank Value Allowed |
Calls will be forwarded to these buyer groups when
|
||||||||||||||||||||||
buyer_offer_ids Optional Blank Value Allowed |
Calls will be forwarded to this offer when
|
||||||||||||||||||||||
hold_queue_caller_limit Optional Blank Value Allowed |
Used when
|
||||||||||||||||||||||
hold_queue_percentage_size Optional Blank Value Allowed |
Used when
|
||||||||||||||||||||||
max_hold_seconds Optional Blank Value Allowed |
Used when
|
||||||||||||||||||||||
max_hold_seconds_average Optional Blank Value Allowed |
Used when
|