Conditions
- Overview
- Weektime
- Calendar
- Hours
- Simple Caller ID
- Simple Caller ID Name
- Weekday
- Date - exact match
- Date - lesser than date
- Date - greater than date
- Date - between dates
- Day of the month
- Extension status
- Variable value
- Multiple variable values
- System variable value
- Multiple extensions status
- AGI Script
- Authenticate
- Tenant - number of I/O channels (external)
- Tenant - number of any channels (internal and external)
- DID - number of inbound channels
- Number of custom group channels
- Answering Machine Detection
- SIP Header
- Agent logged in a queue
- Agent paused from queue
- Caller ID in Phonebook
- Feature code parameter
- All conditions listed satisfied
- Any conditions listed satisfied
- Negate condition result
- Use a Global Condition
- Check SMS message
- Check if a specific channel is running
- Multiple destination over weektime
- Call Screening using a random PIN
- Caller has already called in
- Caller has been called out
- Queue Callers, more than
Overview
The Conditions page defines reusable tests for schedules, caller identity, channel usage, queue state, variables, authentication, and other routing decisions. Open it from Configuration > Conditions.
The page works against the tenant currently selected in the top bar. The screenshots and demo rows were captured in the Canistracci OIL tenant.
Working with conditions
| Task | How to do it |
|---|---|
| Add | Select New Condition, enter a name, choose the condition type, complete the type-specific fields, and select Save. |
| Edit | Open a condition by selecting its name in the list, change the fields, and select Save. |
| Duplicate | Use the duplicate action in the Actions column to copy an existing condition before changing it. |
| Delete | Select one or more rows and use Delete Selected, or open a condition and delete it after checking references. |
| Show flow | Use the flow action in the Actions column to inspect where the condition routes calls. |
Page functions
| Action | Description |
|---|---|
| New Condition | Opens the creation form for a new condition. |
| Delete Selected | Deletes selected conditions after confirmation. |
| Search | Filters the visible rows by name, type, condition summary, or action text. |
| Sort | Sorts the list by the selected column. |
| Page size | Changes how many conditions are shown per page. |
List columns
| Column | Description |
|---|---|
| Select | Selects a condition for bulk deletion. |
| Name | Condition display name. Select it to edit the condition. |
| Type | Condition type code used by MiRTA PBX. |
| Condition | Human-readable summary of the configured match rule. |
| Actions | Duplicate and flow-inspection actions for the row. |
Condition types
| Type | Purpose | Example record |
|---|---|---|
| Weektime | Matches weekly recurring time slots, such as business hours or after-hours periods. | Docs Condition - Weektime |
| Calendar | Matches absolute date and time ranges for holidays, maintenance windows, and one-off closures. | Docs Condition - Calendar |
| Hours | Matches one or more daily time ranges without selecting specific weekdays. | Docs Condition - Hours |
| Simple Caller ID | Matches the caller number against one or more literal values or regular expressions. | Docs Condition - Simple Caller ID |
| Simple Caller ID Name | Matches the caller name against one or more literal values or regular expressions. | Docs Condition - Simple Caller ID Name |
| Weekday | Matches selected days of the week. | Docs Condition - Weekday |
| Date - exact match | Matches one or more exact dates or date/time values. | Docs Condition - Date - exact match |
| Date - lesser than date | Matches when the current date/time is earlier than the configured date/time. | Docs Condition - Date - lesser than date |
| Date - greater than date | Matches when the current date/time is later than the configured date/time. | Docs Condition - Date - greater than date |
| Date - between dates | Matches when the current date/time is between a configured start and end value. | Docs Condition - Date - between dates |
| Day of the month | Matches a specific day number in the month. | Docs Condition - Day of the month |
| Extension status | Matches the state of one selected extension or numbered flow. | Docs Condition - Extension status |
| Variable value | Matches a tenant user variable value. | Docs Condition - Variable value |
| Multiple variable values | Matches one variable against multiple possible values, each with its own destination path. | Docs Condition - Multiple variable values |
| System variable value | Matches an Asterisk or system channel variable value. | Docs Condition - System variable value |
| Multiple extensions status | Checks the combined state of multiple selected extensions. | Docs Condition - Multiple extensions status |
| AGI Script | Runs an AGI script and compares the AGIRESULT variable with TRUE. | Docs Condition - AGI Script |
| Authenticate | Prompts the caller for a PIN and matches when authentication succeeds. | Docs Condition - Authenticate |
| Tenant - number of I/O channels (external) | Matches when the tenant has more than the configured number of external channels in use. | Docs Condition - Tenant - number of I/O channels (external) |
| Tenant - number of any channels (internal and external) | Matches when the tenant has more than the configured number of total channels in use. | Docs Condition - Tenant - number of any channels (internal and external) |
| DID - number of inbound channels | Matches when a selected DID has more than the configured number of inbound channels in use. | Docs Condition - DID - number of inbound channels |
| Number of custom group channels | Matches when a custom channel group has more than the configured number of active channels. | Docs Condition - Number of custom group channels |
| Answering Machine Detection | Runs answering machine detection and matches according to the analysis result. | Docs Condition - Answering Machine Detection |
| SIP Header | Matches a SIP header against a regular expression. | Docs Condition - SIP Header |
| Agent logged in a queue | Matches when the selected agent is logged in to the selected queue. | Docs Condition - Agent logged in a queue |
| Agent paused from queue | Matches when the selected agent is paused in the selected queue. | Docs Condition - Agent paused from queue |
| Caller ID in Phonebook | Matches when caller ID is found in a selected phone book. | Docs Condition - Caller ID in Phonebook |
| Feature code parameter | Matches parameters collected by a feature code. | Docs Condition - Feature code parameter |
| All conditions listed satisfied | Matches only when every selected condition is satisfied. | Docs Condition - All conditions listed satisfied |
| Any conditions listed satisfied | Matches when at least one selected condition is satisfied. | Docs Condition - Any conditions listed satisfied |
| Negate condition result | Matches when the selected condition does not match. | Docs Condition - Negate condition result |
| Use a Global Condition | References a global condition from the tenant configuration. | Docs Condition - Use a Global Condition |
| Check SMS message | Matches SMS message content. | Docs Condition - Check SMS message |
| Check if a specific channel is running | Checks whether a channel matching the configured attributes is currently running. | Docs Condition - Check if a specific channel is running |
| Multiple destination over weektime | Routes to different destinations based on a color-coded weekly timetable. | Docs Condition - Multiple destination over weektime |
| Call Screening using a random PIN | Screens a call by playing a prompt and asking the caller to enter a generated PIN. | Docs Condition - Call Screening using a random PIN |
| Caller has already called in | Checks recent inbound call history for the current caller. | Docs Condition - Caller has already called in |
| Caller has been called out | Checks recent outbound call history for the current caller. | Docs Condition - Caller has been called out |
| Queue Callers, more than | Matches when a selected queue has more than the configured number of callers waiting. | Docs Condition - Queue Callers, more than |
Demo records
The Canistracci OIL tenant contains one documentation example for each available condition type: 39 records with names beginning with Docs Condition -. A global example named Docs Global Condition - Weektime is also available for the Use a Global Condition type.
Deleting records
Before deleting a condition, check call flows, destinations, schedules, IVRs, feature codes, and reports that may reference it. MiRTA PBX asks for confirmation before the delete is submitted.
Weektime
The Weektime type matches weekly recurring time slots, such as business hours or after-hours periods.
Open Configuration > Conditions, select New Condition, enter a name, choose Weektime in the Type field, complete the type-specific fields, and select Save.
Fields
| Field or option | Description |
|---|---|
| Name | Display name used in condition lists and selectors. |
| Type | Select Weektime. |
| Timezone | Timezone used to evaluate the weekly schedule. Leave it empty to use the tenant default. |
| Select timeslots | Weekly calendar where matching time blocks are drawn. |
Example
| Field | Example value |
|---|---|
| Name | Docs Condition - Weektime |
| Timeslot | Monday 09:00-17:00 |
Destinations
For tenant conditions, select the destinations that should run when the condition matches and when it does not match. Global conditions are referenced by tenant-level Use a Global Condition records.
Editing and deleting
To edit this condition, open Docs Condition - Weektime from the Conditions list, adjust the fields, and select Save. Before deleting it, check IVRs, schedules, routes, feature codes, and other call-flow objects that may reference it.
Calendar
The Calendar type matches absolute date and time ranges for holidays, maintenance windows, and one-off closures.
Open Configuration > Conditions, select New Condition, enter a name, choose Calendar in the Type field, complete the type-specific fields, and select Save.
Fields
| Field or option | Description |
|---|---|
| Name | Display name used in condition lists and selectors. |
| Type | Select Calendar. |
| Timezone | Timezone used to evaluate the calendar entries. |
| Select timeslots | Calendar where date and time blocks are entered. |
Example
| Field | Example value |
|---|---|
| Name | Docs Condition - Calendar |
| Calendar slot | 2026-12-24 09:00 to 2026-12-24 17:00 |
Destinations
For tenant conditions, select the destinations that should run when the condition matches and when it does not match. Global conditions are referenced by tenant-level Use a Global Condition records.
Editing and deleting
To edit this condition, open Docs Condition - Calendar from the Conditions list, adjust the fields, and select Save. Before deleting it, check IVRs, schedules, routes, feature codes, and other call-flow objects that may reference it.
Hours
The Hours type matches one or more daily time ranges without selecting specific weekdays.
Open Configuration > Conditions, select New Condition, enter a name, choose Hours in the Type field, complete the type-specific fields, and select Save.
Fields
| Field or option | Description |
|---|---|
| Name | Display name used in condition lists and selectors. |
| Type | Select Hours. |
| Timezone | Timezone used to evaluate the time ranges. |
| From - To | Up to three daily start and end ranges. |
Example
| Field | Example value |
|---|---|
| Name | Docs Condition - Hours |
| From - To | 09:00 to 17:00 |
Destinations
For tenant conditions, select the destinations that should run when the condition matches and when it does not match. Global conditions are referenced by tenant-level Use a Global Condition records.
Editing and deleting
To edit this condition, open Docs Condition - Hours from the Conditions list, adjust the fields, and select Save. Before deleting it, check IVRs, schedules, routes, feature codes, and other call-flow objects that may reference it.
Simple Caller ID
The Simple Caller ID type matches the caller number against one or more literal values or regular expressions.
Open Configuration > Conditions, select New Condition, enter a name, choose Simple Caller ID in the Type field, complete the type-specific fields, and select Save.
Fields
| Field or option | Description |
|---|---|
| Name | Display name used in condition lists and selectors. |
| Type | Select Simple Caller ID. |
| Caller ID | Caller number value or regular expression to match. Multiple rows can be used. |
Example
| Field | Example value |
|---|---|
| Name | Docs Condition - Simple Caller ID |
| Caller ID | ^1555 |
Destinations
For tenant conditions, select the destinations that should run when the condition matches and when it does not match. Global conditions are referenced by tenant-level Use a Global Condition records.
Editing and deleting
To edit this condition, open Docs Condition - Simple Caller ID from the Conditions list, adjust the fields, and select Save. Before deleting it, check IVRs, schedules, routes, feature codes, and other call-flow objects that may reference it.
Simple Caller ID Name
The Simple Caller ID Name type matches the caller name against one or more literal values or regular expressions.
Open Configuration > Conditions, select New Condition, enter a name, choose Simple Caller ID Name in the Type field, complete the type-specific fields, and select Save.
Fields
| Field or option | Description |
|---|---|
| Name | Display name used in condition lists and selectors. |
| Type | Select Simple Caller ID Name. |
| Caller ID Name | Caller name value or regular expression to match. Multiple rows can be used. |
Example
| Field | Example value |
|---|---|
| Name | Docs Condition - Simple Caller ID Name |
| Caller ID Name | Canistracci |
Destinations
For tenant conditions, select the destinations that should run when the condition matches and when it does not match. Global conditions are referenced by tenant-level Use a Global Condition records.
Editing and deleting
To edit this condition, open Docs Condition - Simple Caller ID Name from the Conditions list, adjust the fields, and select Save. Before deleting it, check IVRs, schedules, routes, feature codes, and other call-flow objects that may reference it.
Weekday
The Weekday type matches selected days of the week.
Open Configuration > Conditions, select New Condition, enter a name, choose Weekday in the Type field, complete the type-specific fields, and select Save.
Fields
| Field or option | Description |
|---|---|
| Name | Display name used in condition lists and selectors. |
| Type | Select Weekday. |
| Timezone | Timezone used to determine the current weekday. |
| Sunday through Saturday | Checkboxes for the days that should match. |
Example
| Field | Example value |
|---|---|
| Name | Docs Condition - Weekday |
| Days | Monday through Friday |
Destinations
For tenant conditions, select the destinations that should run when the condition matches and when it does not match. Global conditions are referenced by tenant-level Use a Global Condition records.
Editing and deleting
To edit this condition, open Docs Condition - Weekday from the Conditions list, adjust the fields, and select Save. Before deleting it, check IVRs, schedules, routes, feature codes, and other call-flow objects that may reference it.
Date - exact match
The Date - exact match type matches one or more exact dates or date/time values.
Open Configuration > Conditions, select New Condition, enter a name, choose Date - exact match in the Type field, complete the type-specific fields, and select Save.
Fields
| Field or option | Description |
|---|---|
| Name | Display name used in condition lists and selectors. |
| Type | Select Date - exact match. |
| Timezone | Timezone used to evaluate the date. |
| Date | Exact date or date/time value to match. |
| Recurring | Treats the date as recurring instead of a one-time date. |
Example
| Field | Example value |
|---|---|
| Name | Docs Condition - Date - Exact Match |
| Date | 2026-12-25 00:00:00 |
Destinations
For tenant conditions, select the destinations that should run when the condition matches and when it does not match. Global conditions are referenced by tenant-level Use a Global Condition records.
Editing and deleting
To edit this condition, open Docs Condition - Date - exact match from the Conditions list, adjust the fields, and select Save. Before deleting it, check IVRs, schedules, routes, feature codes, and other call-flow objects that may reference it.
Date - lesser than date
The Date - lesser than date type matches when the current date/time is earlier than the configured date/time.
Open Configuration > Conditions, select New Condition, enter a name, choose Date - lesser than date in the Type field, complete the type-specific fields, and select Save.
Fields
| Field or option | Description |
|---|---|
| Name | Display name used in condition lists and selectors. |
| Type | Select Date - lesser than date. |
| Lesser than Date | Date or date/time threshold used by the comparison. |
| Recurring | Treats the threshold as a recurring date value. |
| Custom | Uses a custom date expression instead of the date picker value. |
Example
| Field | Example value |
|---|---|
| Name | Docs Condition - Date - Lesser Than Date |
| Lesser than Date | 2026-12-31 23:59:59 |
Destinations
For tenant conditions, select the destinations that should run when the condition matches and when it does not match. Global conditions are referenced by tenant-level Use a Global Condition records.
Editing and deleting
To edit this condition, open Docs Condition - Date - lesser than date from the Conditions list, adjust the fields, and select Save. Before deleting it, check IVRs, schedules, routes, feature codes, and other call-flow objects that may reference it.
Date - greater than date
The Date - greater than date type matches when the current date/time is later than the configured date/time.
Open Configuration > Conditions, select New Condition, enter a name, choose Date - greater than date in the Type field, complete the type-specific fields, and select Save.
Fields
| Field or option | Description |
|---|---|
| Name | Display name used in condition lists and selectors. |
| Type | Select Date - greater than date. |
| Greater than Date | Date or date/time threshold used by the comparison. |
| Recurring | Treats the threshold as a recurring date value. |
| Custom | Uses a custom date expression instead of the date picker value. |
Example
| Field | Example value |
|---|---|
| Name | Docs Condition - Date - Greater Than Date |
| Greater than Date | 2026-01-01 00:00:00 |
Destinations
For tenant conditions, select the destinations that should run when the condition matches and when it does not match. Global conditions are referenced by tenant-level Use a Global Condition records.
Editing and deleting
To edit this condition, open Docs Condition - Date - greater than date from the Conditions list, adjust the fields, and select Save. Before deleting it, check IVRs, schedules, routes, feature codes, and other call-flow objects that may reference it.
Date - between dates
The Date - between dates type matches when the current date/time is between a configured start and end value.
Open Configuration > Conditions, select New Condition, enter a name, choose Date - between dates in the Type field, complete the type-specific fields, and select Save.
Fields
| Field or option | Description |
|---|---|
| Name | Display name used in condition lists and selectors. |
| Type | Select Date - between dates. |
| Between Date/Time | Start and end values for a matching window. Multiple windows can be configured. |
| Recurring | Treats the date window as recurring. |
Example
| Field | Example value |
|---|---|
| Name | Docs Condition - Date - Between Dates |
| Between Date/Time | 2026-12-24 09:00:00 and 2026-12-24 17:00:00 |
Destinations
For tenant conditions, select the destinations that should run when the condition matches and when it does not match. Global conditions are referenced by tenant-level Use a Global Condition records.
Editing and deleting
To edit this condition, open Docs Condition - Date - between dates from the Conditions list, adjust the fields, and select Save. Before deleting it, check IVRs, schedules, routes, feature codes, and other call-flow objects that may reference it.
Day of the month
The Day of the month type matches a specific day number in the month.
Open Configuration > Conditions, select New Condition, enter a name, choose Day of the month in the Type field, complete the type-specific fields, and select Save.
Fields
| Field or option | Description |
|---|---|
| Name | Display name used in condition lists and selectors. |
| Type | Select Day of the month. |
| Timezone | Timezone used to evaluate the month day. |
| Day of the month | Day number from 1 to 31. |
Example
| Field | Example value |
|---|---|
| Name | Docs Condition - Day of the Month |
| Day of the month | 15 |
Destinations
For tenant conditions, select the destinations that should run when the condition matches and when it does not match. Global conditions are referenced by tenant-level Use a Global Condition records.
Editing and deleting
To edit this condition, open Docs Condition - Day of the month from the Conditions list, adjust the fields, and select Save. Before deleting it, check IVRs, schedules, routes, feature codes, and other call-flow objects that may reference it.
Extension status
The Extension status type matches the state of one selected extension or numbered flow.
Open Configuration > Conditions, select New Condition, enter a name, choose Extension status in the Type field, complete the type-specific fields, and select Save.
Fields
| Field or option | Description |
|---|---|
| Name | Display name used in condition lists and selectors. |
| Type | Select Extension status. |
| Extension | Extension or flow whose state is checked. |
| State | State to match: in use, not in use, or DND active. |
Example
| Field | Example value |
|---|---|
| Name | Docs Condition - Extension Status |
| Extension | 100 - Alex Reed |
| State | Not in use |
Destinations
For tenant conditions, select the destinations that should run when the condition matches and when it does not match. Global conditions are referenced by tenant-level Use a Global Condition records.
Editing and deleting
To edit this condition, open Docs Condition - Extension status from the Conditions list, adjust the fields, and select Save. Before deleting it, check IVRs, schedules, routes, feature codes, and other call-flow objects that may reference it.
Variable value
The Variable value type matches a tenant user variable value.
Open Configuration > Conditions, select New Condition, enter a name, choose Variable value in the Type field, complete the type-specific fields, and select Save.
Fields
| Field or option | Description |
|---|---|
| Name | Display name used in condition lists and selectors. |
| Type | Select Variable value. |
| Variable | User variable name. The form prefixes the value with USR-. |
| Value | Value to compare against. |
| Use as Regex | Treats the value as a regular expression. |
Example
| Field | Example value |
|---|---|
| Name | Docs Condition - Variable Value |
| Variable | DEPARTMENT |
| Value | Accounting |
Destinations
For tenant conditions, select the destinations that should run when the condition matches and when it does not match. Global conditions are referenced by tenant-level Use a Global Condition records.
Editing and deleting
To edit this condition, open Docs Condition - Variable value from the Conditions list, adjust the fields, and select Save. Before deleting it, check IVRs, schedules, routes, feature codes, and other call-flow objects that may reference it.
Multiple variable values
The Multiple variable values type matches one variable against multiple possible values, each with its own destination path.
Open Configuration > Conditions, select New Condition, enter a name, choose Multiple variable values in the Type field, complete the type-specific fields, and select Save.
Fields
| Field or option | Description |
|---|---|
| Name | Display name used in condition lists and selectors. |
| Type | Select Multiple variable values. |
| Variable | User variable name. The form prefixes the value with USR-. |
| Value rows | Values to compare against. |
| Destination rows | Destination selected for each matching value. |
Example
| Field | Example value |
|---|---|
| Name | Docs Condition - Multiple Variable Values |
| Variable | SERVICE |
| Values | billing, support |
Destinations
This type hides the standard single match destination and shows destination rows for each configured variable value.
Editing and deleting
To edit this condition, open Docs Condition - Multiple variable values from the Conditions list, adjust the fields, and select Save. Before deleting it, check IVRs, schedules, routes, feature codes, and other call-flow objects that may reference it.
System variable value
The System variable value type matches an Asterisk or system channel variable value.
Open Configuration > Conditions, select New Condition, enter a name, choose System variable value in the Type field, complete the type-specific fields, and select Save.
Fields
| Field or option | Description |
|---|---|
| Name | Display name used in condition lists and selectors. |
| Type | Select System variable value. |
| System variable | Variable name available in the call, such as CALLERID(num). |
| Value | Value to compare against. |
| Use as Regex | Treats the value as a regular expression. |
Example
| Field | Example value |
|---|---|
| Name | Docs Condition - System Variable Value |
| System variable | CALLERID(num) |
| Value | ^1555 |
Destinations
For tenant conditions, select the destinations that should run when the condition matches and when it does not match. Global conditions are referenced by tenant-level Use a Global Condition records.
Editing and deleting
To edit this condition, open Docs Condition - System variable value from the Conditions list, adjust the fields, and select Save. Before deleting it, check IVRs, schedules, routes, feature codes, and other call-flow objects that may reference it.
Multiple extensions status
The Multiple extensions status type checks the combined state of multiple selected extensions.
Open Configuration > Conditions, select New Condition, enter a name, choose Multiple extensions status in the Type field, complete the type-specific fields, and select Save.
Fields
| Field or option | Description |
|---|---|
| Name | Display name used in condition lists and selectors. |
| Type | Select Multiple extensions status. |
| Extensions | Extensions or numbered flows included in the check. |
| State | Combined state rule that must match. |
Example
| Field | Example value |
|---|---|
| Name | Docs Condition - Multiple Extensions Status |
| Extensions | 100 and 101 |
| State | All users are online |
Destinations
For tenant conditions, select the destinations that should run when the condition matches and when it does not match. Global conditions are referenced by tenant-level Use a Global Condition records.
Editing and deleting
To edit this condition, open Docs Condition - Multiple extensions status from the Conditions list, adjust the fields, and select Save. Before deleting it, check IVRs, schedules, routes, feature codes, and other call-flow objects that may reference it.
AGI Script
The AGI Script type runs an AGI script and compares the AGIRESULT variable with TRUE.
Open Configuration > Conditions, select New Condition, enter a name, choose AGI Script in the Type field, complete the type-specific fields, and select Save.
Fields
| Field or option | Description |
|---|---|
| Name | Display name used in condition lists and selectors. |
| Type | Select AGI Script. |
| AGI Script | Script to execute. |
| Parameter 1-5 | Optional script parameters, depending on the selected script definition. |
| AGIRESULT | The script result variable must evaluate to TRUE for the condition to match. |
Example
| Field | Example value |
|---|---|
| Name | Docs Condition - AGI Script |
| AGI Script | Docs Demo AGI 1 |
Destinations
For tenant conditions, select the destinations that should run when the condition matches and when it does not match. Global conditions are referenced by tenant-level Use a Global Condition records.
Editing and deleting
To edit this condition, open Docs Condition - AGI Script from the Conditions list, adjust the fields, and select Save. Before deleting it, check IVRs, schedules, routes, feature codes, and other call-flow objects that may reference it.
Authenticate
The Authenticate type prompts the caller for a PIN and matches when authentication succeeds.
Open Configuration > Conditions, select New Condition, enter a name, choose Authenticate in the Type field, complete the type-specific fields, and select Save.
Fields
| Field or option | Description |
|---|---|
| Name | Display name used in condition lists and selectors. |
| Type | Select Authenticate. |
| Welcome Message | Prompt played before PIN entry. |
| PIN | Valid PIN value. Additional PIN fields can define more accepted values. |
| Maximum digits | Maximum number of digits the caller can enter. |
| Wrong PIN Message | Prompt played after an invalid PIN. |
| Max attempts | How many failed attempts are allowed. |
| Timeout | How long to wait for digits. |
Example
| Field | Example value |
|---|---|
| Name | Docs Condition - Authenticate |
| PIN | 1234 |
| Max attempts | 3 |
Destinations
For tenant conditions, select the destinations that should run when the condition matches and when it does not match. Global conditions are referenced by tenant-level Use a Global Condition records.
Editing and deleting
To edit this condition, open Docs Condition - Authenticate from the Conditions list, adjust the fields, and select Save. Before deleting it, check IVRs, schedules, routes, feature codes, and other call-flow objects that may reference it.
Tenant - number of I/O channels (external)
The Tenant - number of I/O channels (external) type matches when the tenant has more than the configured number of external channels in use.
Open Configuration > Conditions, select New Condition, enter a name, choose Tenant - number of I/O channels (external) in the Type field, complete the type-specific fields, and select Save.
Fields
| Field or option | Description |
|---|---|
| Name | Display name used in condition lists and selectors. |
| Type | Select Tenant - number of I/O channels (external). |
| More than # of I/O channels used | External channel threshold. |
Example
| Field | Example value |
|---|---|
| Name | Docs Condition - Tenant Channels |
| More than | 5 |
Destinations
For tenant conditions, select the destinations that should run when the condition matches and when it does not match. Global conditions are referenced by tenant-level Use a Global Condition records.
Editing and deleting
To edit this condition, open Docs Condition - Tenant - number of I/O channels (external) from the Conditions list, adjust the fields, and select Save. Before deleting it, check IVRs, schedules, routes, feature codes, and other call-flow objects that may reference it.
Tenant - number of any channels (internal and external)
The Tenant - number of any channels (internal and external) type matches when the tenant has more than the configured number of total channels in use.
Open Configuration > Conditions, select New Condition, enter a name, choose Tenant - number of any channels (internal and external) in the Type field, complete the type-specific fields, and select Save.
Fields
| Field or option | Description |
|---|---|
| Name | Display name used in condition lists and selectors. |
| Type | Select Tenant - number of any channels (internal and external). |
| More than # of any type of channels used | Total channel threshold, including internal and external channels. |
Example
| Field | Example value |
|---|---|
| Name | Docs Condition - Tenant Any Channels |
| More than | 10 |
Destinations
For tenant conditions, select the destinations that should run when the condition matches and when it does not match. Global conditions are referenced by tenant-level Use a Global Condition records.
Editing and deleting
To edit this condition, open Docs Condition - Tenant - number of any channels (internal and external) from the Conditions list, adjust the fields, and select Save. Before deleting it, check IVRs, schedules, routes, feature codes, and other call-flow objects that may reference it.
DID - number of inbound channels
The DID - number of inbound channels type matches when a selected DID has more than the configured number of inbound channels in use.
Open Configuration > Conditions, select New Condition, enter a name, choose DID - number of inbound channels in the Type field, complete the type-specific fields, and select Save.
Fields
| Field or option | Description |
|---|---|
| Name | Display name used in condition lists and selectors. |
| Type | Select DID - number of inbound channels. |
| DID to monitor | DID whose inbound channel usage is checked. |
| More than # of channels used | Inbound channel threshold. |
Example
| Field | Example value |
|---|---|
| Name | Docs Condition - DID Channels |
| DID | Docs Demo DID 1 |
| More than | 1 |
Destinations
For tenant conditions, select the destinations that should run when the condition matches and when it does not match. Global conditions are referenced by tenant-level Use a Global Condition records.
Editing and deleting
To edit this condition, open Docs Condition - DID - number of inbound channels from the Conditions list, adjust the fields, and select Save. Before deleting it, check IVRs, schedules, routes, feature codes, and other call-flow objects that may reference it.
Number of custom group channels
The Number of custom group channels type matches when a custom channel group has more than the configured number of active channels.
Open Configuration > Conditions, select New Condition, enter a name, choose Number of custom group channels in the Type field, complete the type-specific fields, and select Save.
Fields
| Field or option | Description |
|---|---|
| Name | Display name used in condition lists and selectors. |
| Type | Select Number of custom group channels. |
| Group name | Custom group name to count. |
| More than # of channels used | Channel count threshold. |
Example
| Field | Example value |
|---|---|
| Name | Docs Condition - Channel Group Count |
| Group name | support |
| More than | 2 |
Destinations
For tenant conditions, select the destinations that should run when the condition matches and when it does not match. Global conditions are referenced by tenant-level Use a Global Condition records.
Editing and deleting
To edit this condition, open Docs Condition - Number of custom group channels from the Conditions list, adjust the fields, and select Save. Before deleting it, check IVRs, schedules, routes, feature codes, and other call-flow objects that may reference it.
Answering Machine Detection
The Answering Machine Detection type runs answering machine detection and matches according to the analysis result.
Open Configuration > Conditions, select New Condition, enter a name, choose Answering Machine Detection in the Type field, complete the type-specific fields, and select Save.
Fields
| Field or option | Description |
|---|---|
| Name | Display name used in condition lists and selectors. |
| Type | Select Answering Machine Detection. |
| Initial silence | Maximum initial silence before greeting detection. |
| Greeting | Maximum greeting duration. |
| After greeting, silence | Silence duration after greeting. |
| Total analysis time | Maximum analysis window. |
| Word settings | Minimum and maximum word lengths, silence between words, and maximum word count. |
| Silence threshold | Audio threshold used for silence detection. |
Example
| Field | Example value |
|---|---|
| Name | Docs Condition - Answering Machine Detection |
| Total analysis time | 5000 |
Destinations
For tenant conditions, select the destinations that should run when the condition matches and when it does not match. Global conditions are referenced by tenant-level Use a Global Condition records.
Editing and deleting
To edit this condition, open Docs Condition - Answering Machine Detection from the Conditions list, adjust the fields, and select Save. Before deleting it, check IVRs, schedules, routes, feature codes, and other call-flow objects that may reference it.
SIP Header
The SIP Header type matches a SIP header against a regular expression.
Open Configuration > Conditions, select New Condition, enter a name, choose SIP Header in the Type field, complete the type-specific fields, and select Save.
Fields
| Field or option | Description |
|---|---|
| Name | Display name used in condition lists and selectors. |
| Type | Select SIP Header. |
| SIP Header | Header name to inspect. |
| Regular Expression | Expression used to match the header value. |
Example
| Field | Example value |
|---|---|
| Name | Docs Condition - SIP Header |
| SIP Header | X-Account |
| Regular Expression | Accounting |
Destinations
For tenant conditions, select the destinations that should run when the condition matches and when it does not match. Global conditions are referenced by tenant-level Use a Global Condition records.
Editing and deleting
To edit this condition, open Docs Condition - SIP Header from the Conditions list, adjust the fields, and select Save. Before deleting it, check IVRs, schedules, routes, feature codes, and other call-flow objects that may reference it.
Agent logged in a queue
The Agent logged in a queue type matches when the selected agent is logged in to the selected queue.
Open Configuration > Conditions, select New Condition, enter a name, choose Agent logged in a queue in the Type field, complete the type-specific fields, and select Save.
Fields
| Field or option | Description |
|---|---|
| Name | Display name used in condition lists and selectors. |
| Type | Select Agent logged in a queue. |
| Agent | Agent extension or external agent to check. |
| Queue | Queue where login state is checked. |
Example
| Field | Example value |
|---|---|
| Name | Docs Condition - Agent Logged In |
| Agent | 100 - Alex Reed |
| Queue | Accounting |
Destinations
For tenant conditions, select the destinations that should run when the condition matches and when it does not match. Global conditions are referenced by tenant-level Use a Global Condition records.
Editing and deleting
To edit this condition, open Docs Condition - Agent logged in a queue from the Conditions list, adjust the fields, and select Save. Before deleting it, check IVRs, schedules, routes, feature codes, and other call-flow objects that may reference it.
Agent paused from queue
The Agent paused from queue type matches when the selected agent is paused in the selected queue.
Open Configuration > Conditions, select New Condition, enter a name, choose Agent paused from queue in the Type field, complete the type-specific fields, and select Save.
Fields
| Field or option | Description |
|---|---|
| Name | Display name used in condition lists and selectors. |
| Type | Select Agent paused from queue. |
| Agent | Agent extension or external agent to check. |
| Queue | Queue where pause state is checked. |
Example
| Field | Example value |
|---|---|
| Name | Docs Condition - Agent Paused |
| Agent | 100 - Alex Reed |
| Queue | Accounting |
Destinations
For tenant conditions, select the destinations that should run when the condition matches and when it does not match. Global conditions are referenced by tenant-level Use a Global Condition records.
Editing and deleting
To edit this condition, open Docs Condition - Agent paused from queue from the Conditions list, adjust the fields, and select Save. Before deleting it, check IVRs, schedules, routes, feature codes, and other call-flow objects that may reference it.
Caller ID in Phonebook
The Caller ID in Phonebook type matches when caller ID is found in a selected phone book.
Open Configuration > Conditions, select New Condition, enter a name, choose Caller ID in Phonebook in the Type field, complete the type-specific fields, and select Save.
Fields
| Field or option | Description |
|---|---|
| Name | Display name used in condition lists and selectors. |
| Type | Select Caller ID in Phonebook. |
| Caller ID | Caller number to look up, usually provided dynamically during a call. |
| Phonebook | Phone book used for the lookup. |
Example
| Field | Example value |
|---|---|
| Name | Docs Condition - Caller ID in Phonebook |
| Caller ID | ${CALLERID(num)} |
| Phonebook | Default |
Destinations
For tenant conditions, select the destinations that should run when the condition matches and when it does not match. Global conditions are referenced by tenant-level Use a Global Condition records.
Editing and deleting
To edit this condition, open Docs Condition - Caller ID in Phonebook from the Conditions list, adjust the fields, and select Save. Before deleting it, check IVRs, schedules, routes, feature codes, and other call-flow objects that may reference it.
Feature code parameter
The Feature code parameter type matches parameters collected by a feature code.
Open Configuration > Conditions, select New Condition, enter a name, choose Feature code parameter in the Type field, complete the type-specific fields, and select Save.
Fields
| Field or option | Description |
|---|---|
| Name | Display name used in condition lists and selectors. |
| Type | Select Feature code parameter. |
| Parameter | Parameter value to compare. Multiple parameter rows can be used. |
Example
| Field | Example value |
|---|---|
| Name | Docs Condition - Feature Code Parameter |
| Parameter 1 | 42 |
Destinations
For tenant conditions, select the destinations that should run when the condition matches and when it does not match. Global conditions are referenced by tenant-level Use a Global Condition records.
Editing and deleting
To edit this condition, open Docs Condition - Feature code parameter from the Conditions list, adjust the fields, and select Save. Before deleting it, check IVRs, schedules, routes, feature codes, and other call-flow objects that may reference it.
All conditions listed satisfied
The All conditions listed satisfied type matches only when every selected condition is satisfied.
Open Configuration > Conditions, select New Condition, enter a name, choose All conditions listed satisfied in the Type field, complete the type-specific fields, and select Save.
Fields
| Field or option | Description |
|---|---|
| Name | Display name used in condition lists and selectors. |
| Type | Select All conditions listed satisfied. |
| Conditions | Conditions that must all match. |
Example
| Field | Example value |
|---|---|
| Name | Docs Condition - All Conditions |
| Conditions | Weektime and Weekday |
Destinations
For tenant conditions, select the destinations that should run when the condition matches and when it does not match. Global conditions are referenced by tenant-level Use a Global Condition records.
Editing and deleting
To edit this condition, open Docs Condition - All conditions listed satisfied from the Conditions list, adjust the fields, and select Save. Before deleting it, check IVRs, schedules, routes, feature codes, and other call-flow objects that may reference it.
Any conditions listed satisfied
The Any conditions listed satisfied type matches when at least one selected condition is satisfied.
Open Configuration > Conditions, select New Condition, enter a name, choose Any conditions listed satisfied in the Type field, complete the type-specific fields, and select Save.
Fields
| Field or option | Description |
|---|---|
| Name | Display name used in condition lists and selectors. |
| Type | Select Any conditions listed satisfied. |
| Conditions | Conditions where any one match is enough. |
Example
| Field | Example value |
|---|---|
| Name | Docs Condition - Any Conditions |
| Conditions | Weektime or Caller ID |
Destinations
For tenant conditions, select the destinations that should run when the condition matches and when it does not match. Global conditions are referenced by tenant-level Use a Global Condition records.
Editing and deleting
To edit this condition, open Docs Condition - Any conditions listed satisfied from the Conditions list, adjust the fields, and select Save. Before deleting it, check IVRs, schedules, routes, feature codes, and other call-flow objects that may reference it.
Negate condition result
The Negate condition result type matches when the selected condition does not match.
Open Configuration > Conditions, select New Condition, enter a name, choose Negate condition result in the Type field, complete the type-specific fields, and select Save.
Fields
| Field or option | Description |
|---|---|
| Name | Display name used in condition lists and selectors. |
| Type | Select Negate condition result. |
| Condition | Condition whose result is inverted. |
Example
| Field | Example value |
|---|---|
| Name | Docs Condition - Negate Condition |
| Condition | Docs Condition - Weektime |
Destinations
For tenant conditions, select the destinations that should run when the condition matches and when it does not match. Global conditions are referenced by tenant-level Use a Global Condition records.
Editing and deleting
To edit this condition, open Docs Condition - Negate condition result from the Conditions list, adjust the fields, and select Save. Before deleting it, check IVRs, schedules, routes, feature codes, and other call-flow objects that may reference it.
Use a Global Condition
The Use a Global Condition type references a global condition from the tenant configuration.
Open Configuration > Conditions, select New Condition, enter a name, choose Use a Global Condition in the Type field, complete the type-specific fields, and select Save.
Fields
| Field or option | Description |
|---|---|
| Name | Display name used in condition lists and selectors. |
| Type | Select Use a Global Condition. |
| Condition | Global condition to evaluate from this tenant. |
Example
| Field | Example value |
|---|---|
| Name | Docs Condition - Use Global Condition |
| Global condition | Docs Global Condition - Weektime |
Destinations
The global condition supplies the test. The tenant condition still defines the destinations that should run when the global test matches or does not match.
Editing and deleting
To edit this condition, open Docs Condition - Use a Global Condition from the Conditions list, adjust the fields, and select Save. Before deleting it, check IVRs, schedules, routes, feature codes, and other call-flow objects that may reference it.
Check SMS message
The Check SMS message type matches SMS message content.
Open Configuration > Conditions, select New Condition, enter a name, choose Check SMS message in the Type field, complete the type-specific fields, and select Save.
Fields
| Field or option | Description |
|---|---|
| Name | Display name used in condition lists and selectors. |
| Type | Select Check SMS message. |
| Message content | Text or expression used to match the SMS body. |
| Case sensitive | Requires exact case matching. |
| Exact Match | Compares exact content without filtering characters. |
| Use regex | Treats message content as a regular expression. |
Example
| Field | Example value |
|---|---|
| Name | Docs Condition - Check SMS Message |
| Message content | STOP |
Destinations
For tenant conditions, select the destinations that should run when the condition matches and when it does not match. Global conditions are referenced by tenant-level Use a Global Condition records.
Editing and deleting
To edit this condition, open Docs Condition - Check SMS message from the Conditions list, adjust the fields, and select Save. Before deleting it, check IVRs, schedules, routes, feature codes, and other call-flow objects that may reference it.
Check if a specific channel is running
The Check if a specific channel is running type checks whether a channel matching the configured attributes is currently running.
Open Configuration > Conditions, select New Condition, enter a name, choose Check if a specific channel is running in the Type field, complete the type-specific fields, and select Save.
Fields
| Field or option | Description |
|---|---|
| Name | Display name used in condition lists and selectors. |
| Type | Select Check if a specific channel is running. |
| Channel | Channel name or pattern. |
| Context | Dialplan context to match. |
| Extension | Dialplan extension to match. |
| State | Channel state to match. |
| CallerID | Caller ID value to match. |
Example
| Field | Example value |
|---|---|
| Name | Docs Condition - Check Channel |
| Channel | PJSIP/100 |
Destinations
For tenant conditions, select the destinations that should run when the condition matches and when it does not match. Global conditions are referenced by tenant-level Use a Global Condition records.
Editing and deleting
To edit this condition, open Docs Condition - Check if a specific channel is running from the Conditions list, adjust the fields, and select Save. Before deleting it, check IVRs, schedules, routes, feature codes, and other call-flow objects that may reference it.
Multiple destination over weektime
The Multiple destination over weektime type routes to different destinations based on a color-coded weekly timetable.
Open Configuration > Conditions, select New Condition, enter a name, choose Multiple destination over weektime in the Type field, complete the type-specific fields, and select Save.
Fields
| Field or option | Description |
|---|---|
| Name | Display name used in condition lists and selectors. |
| Type | Select Multiple destination over weektime. |
| Color names | Labels for each timetable color. |
| Timetable | Weekly grid where time blocks are assigned to colors. |
| Destinations | Destination selected for each color. |
Example
| Field | Example value |
|---|---|
| Name | Docs Condition - Multiple Destination over Weektime |
| Color 1 | Open hours |
| Color 2 | After hours |
Destinations
This type uses one destination group for each color in the weekly timetable.
Editing and deleting
To edit this condition, open Docs Condition - Multiple destination over weektime from the Conditions list, adjust the fields, and select Save. Before deleting it, check IVRs, schedules, routes, feature codes, and other call-flow objects that may reference it.
Call Screening using a random PIN
The Call Screening using a random PIN type screens a call by playing a prompt and asking the caller to enter a generated PIN.
Open Configuration > Conditions, select New Condition, enter a name, choose Call Screening using a random PIN in the Type field, complete the type-specific fields, and select Save.
Fields
| Field or option | Description |
|---|---|
| Name | Display name used in condition lists and selectors. |
| Type | Select Call Screening using a random PIN. |
| Welcome Message | Prompt played before PIN entry. |
| Wrong PIN Message | Prompt played after an invalid PIN. |
| Max attempts | How many failed attempts are allowed. |
| Timeout | How long to wait for digits. |
| PIN length | Length of the generated PIN. |
Example
| Field | Example value |
|---|---|
| Name | Docs Condition - Call Screening Random PIN |
| PIN length | 4 |
Destinations
For tenant conditions, select the destinations that should run when the condition matches and when it does not match. Global conditions are referenced by tenant-level Use a Global Condition records.
Editing and deleting
To edit this condition, open Docs Condition - Call Screening using a random PIN from the Conditions list, adjust the fields, and select Save. Before deleting it, check IVRs, schedules, routes, feature codes, and other call-flow objects that may reference it.
Caller has already called in
The Caller has already called in type checks recent inbound call history for the current caller.
Open Configuration > Conditions, select New Condition, enter a name, choose Caller has already called in in the Type field, complete the type-specific fields, and select Save.
Fields
| Field or option | Description |
|---|---|
| Name | Display name used in condition lists and selectors. |
| Type | Select Caller has already called in. |
| Lookup days | How many days back to search. |
| Lookup hours | How many hours back to search. |
| Match number of digits | How many rightmost caller ID digits to compare. |
| Disposition | Call result filter. |
| At least | Minimum call count and optional duration rule. |
Example
| Field | Example value |
|---|---|
| Name | Docs Condition - Caller Already Called In |
| Lookup hours | 24 |
| At least | 1 time |
Destinations
For tenant conditions, select the destinations that should run when the condition matches and when it does not match. Global conditions are referenced by tenant-level Use a Global Condition records.
Editing and deleting
To edit this condition, open Docs Condition - Caller has already called in from the Conditions list, adjust the fields, and select Save. Before deleting it, check IVRs, schedules, routes, feature codes, and other call-flow objects that may reference it.
Caller has been called out
The Caller has been called out type checks recent outbound call history for the current caller.
Open Configuration > Conditions, select New Condition, enter a name, choose Caller has been called out in the Type field, complete the type-specific fields, and select Save.
Fields
| Field or option | Description |
|---|---|
| Name | Display name used in condition lists and selectors. |
| Type | Select Caller has been called out. |
| Lookup days | How many days back to search. |
| Lookup hours | How many hours back to search. |
| Match number of digits | How many rightmost caller ID digits to compare. |
| Disposition | Call result filter. |
Example
| Field | Example value |
|---|---|
| Name | Docs Condition - Caller Already Called Out |
| Lookup hours | 24 |
| Disposition | Answered |
Destinations
For tenant conditions, select the destinations that should run when the condition matches and when it does not match. Global conditions are referenced by tenant-level Use a Global Condition records.
Editing and deleting
To edit this condition, open Docs Condition - Caller has been called out from the Conditions list, adjust the fields, and select Save. Before deleting it, check IVRs, schedules, routes, feature codes, and other call-flow objects that may reference it.
Queue Callers, more than
The Queue Callers, more than type matches when a selected queue has more than the configured number of callers waiting.
Open Configuration > Conditions, select New Condition, enter a name, choose Queue Callers, more than in the Type field, complete the type-specific fields, and select Save.
Fields
| Field or option | Description |
|---|---|
| Name | Display name used in condition lists and selectors. |
| Type | Select Queue Callers, more than. |
| Queue | Queue to monitor. |
| More than # callers | Waiting caller threshold. |
Example
| Field | Example value |
|---|---|
| Name | Docs Condition - Queue Callers More Than |
| Queue | Accounting |
| More than # callers | 3 |
Destinations
For tenant conditions, select the destinations that should run when the condition matches and when it does not match. Global conditions are referenced by tenant-level Use a Global Condition records.
Editing and deleting
To edit this condition, open Docs Condition - Queue Callers, more than from the Conditions list, adjust the fields, and select Save. Before deleting it, check IVRs, schedules, routes, feature codes, and other call-flow objects that may reference it.