| Action | Description |
|---|---|
| New SIP peer / New PJSIP peer | Creates a standard phone extension. The visible label follows the tenant's preferred SIP stack. |
| Bulk SIP peers | Opens the bulk creation workflow for adding multiple SIP extensions at once. |
| Custom Extension | Creates an extension that routes to a custom dial string or custom endpoint logic. |
| Virtual Extension | Creates a virtual extension that can group or reference other extension destinations. |
| Change to chan\_sip | Converts selected PJSIP extensions to chan\_sip when the administrator has permission to switch phone technology. |
| Change to PJSIP | Converts selected chan\_sip extensions to PJSIP when the administrator has permission to switch phone technology. |
| Delete Selected | Deletes the selected extensions after a confirmation prompt. This action is shown only when delete permission is available. |
| Display mode toggle | Switches the page between the standard DataTable and jqGrid display modes. |
| CSV/XLS Upload | Opens the import page for uploading extension records from a CSV or XLS file. |
| Column | Description |
|---|---|
| Number | Extension number. When extension status is enabled, an icon indicates registration or device state. |
| Name | Extension display name. Icons can indicate call blocking/filtering, DND, unconditional forwarding, or PIN lock. |
| Description | Free-form extension description. Icons can identify PJSIP, custom, virtual, or recording-related behavior. |
| Tech | Extension technology. SIP entries are chan\_sip peers, PJSIP entries are PJSIP endpoints, CUSTOM entries route to custom dial strings, and VIRTUAL entries group other extensions. |
| Username | SIP/PJSIP username used by the phone or endpoint. The default pattern is ` |
| Password | Endpoint secret when password display is enabled. Depending on settings, the value can be hidden or revealed with an eye icon. |
| Action | Contains quick actions such as showing the extension call flow. Fast provisioning QR code access can also appear when enabled. |
| Action | Description |
|---|---|
| Create | Open Configuration > Extensions and select New SIP peer. Fill the required fields and select Save. |
| Edit | Open an existing extension from the Extensions list. Update the required fields and select Save. |
| Delete | When delete permission is available, open the extension and select Delete. Confirm only after checking routing, phones, queues, and other references. |
| Block | Purpose |
|---|---|
| Number and name | Number is the internal extension number. Name is the display name used in lists, caller ID, and reports. |
| Description and emergency notes | Description is an administrator note. Emergency notes can be used by emergency routing and notification logic. |
| SIP stack | Shows whether the endpoint is using chan\_sip or PJSIP. Users with switch permission can change the stack from this form or from the Extensions list. |
| Username and password | Endpoint credentials used by the phone or softphone. The default username pattern is the extension number followed by the tenant code. |
| Codecs and DTMF | Controls the allowed audio/video codecs and DTMF signaling mode used by the endpoint. |
| Media and groups | Direct media, call groups, pickup groups, spy groups, and message-waiting options control how the endpoint participates in calls and monitoring. |
| Voicemail, DND, and timeout | Voicemail MWI, DND, and inbound dial timeout control how incoming calls are presented and how long the extension rings. |
| Block | Purpose |
|---|---|
| NAT | Defines how MiRTA PBX treats NAT traversal for the endpoint. |
| Qualify and qualify frequency | Controls whether the PBX checks endpoint reachability and how often checks are sent. |
| Keep alive and RTP keep alive | Sends periodic traffic to keep network mappings open and detect unavailable devices. |
| Block | Purpose |
|---|---|
| Fax and volume | Controls T.38 fax behavior and transmit/receive volume adjustments. |
| Music on hold and language | Selects media behavior and the preferred language for prompts played to the extension. |
| Directories and phone books | Controls whether the extension appears in dial-by-name directories and phone book generated lists. |
| Call waiting and autoanswer | Controls second-call handling and optional automatic answer behavior for supported phones. |
| Block | Purpose |
|---|---|
| Inbound recording policy | Controls whether inbound calls are recorded and whether recording privacy behavior is enabled. |
| Recording notifications | When enabled, recordings can be mailed and processed according to tenant recording settings. |
| Block | Purpose |
|---|---|
| Always record | Controls whether outbound calls from this extension are recorded, unless tenant-wide settings force recording. |
| Email recording to | Sends matching recordings to the configured address. Minimum size can suppress very small recordings. |
| Transcript, summary, sentiment | Enables transcript, summary, and sentiment processing when the tenant supports those services. |
| Block | Purpose |
|---|---|
| Authentication and network filters | Controls endpoint trust, allowed IPs, and authentication-related behavior. |
| Abuse detection and cost limits | Locks or warns on suspicious or excessive usage according to tenant policy. |
| Outbound destinations | Allows all calls, blocks calls, or applies a destination regex filter. |
| Lock PIN and max duration | Allows the extension to be locked and caps outbound call duration. |
| Working hours | Restricts outbound calling to the selected weekday condition. |
| Block | Purpose |
|---|---|
| Access toggles | Enables the user panel, web phone, switchboard, and optional custom user application. |
| Web user and password | Sets the login identity and password. If no web user is specified, the endpoint username is used. |
| Password policy and 2FA | Controls expiry, forced change, lock state, LDAP use, and two-factor authentication. |
| Email, profile, and IP filter | Sets the user email, sends account information, assigns a user profile, and optionally restricts web access by IP. |
| Block | Purpose |
|---|---|
| External caller ID | Sets or hides the caller ID number and name sent on outbound calls. |
| SMS and override caller ID | Controls SMS caller ID and optional SIP header based caller ID overrides. |
| Emergency caller ID | Defines the emergency number identity and whether empty emergency caller ID warnings are ignored. |
| Area code and caller ID regex | Applies prefixes and caller ID rewrite rules before routing. |
| Do Not and Only Allow lists | Applies tenant call-list restrictions to this extension. |
| Routing profile and call rate | Selects the routing profile, SMS routing profile, and client rate used by calls. |
| Block | Purpose |
|---|---|
| Block inbound caller ID number | Prevents the caller ID number from being shown to this extension. |
| Block inbound caller ID name | Prevents the caller ID name from being shown to this extension. |
| Inbound Do Not Call lists | Allows external inbound calls from any caller ID except numbers matching the selected lists. Internal calls are always accepted. |
| Inbound Only Allow Call lists | Rejects external inbound calls unless the caller ID number matches one of the selected lists. Internal calls are always accepted. |
| Block | Purpose |
|---|---|
| FMFM number and status | Sets the external follow-me number and enables or disables the feature. |
| Condition and dial method | Limits follow-me behavior to a condition and selects how the alternate number is dialed. |
| Confirmation and messages | Requires answer confirmation and selects confirm/hold messages. |
| Caller ID and timing | Controls caller ID presentation, prefixes, delay, and dial timeout for the follow-me call. |
| Block | Purpose |
|---|---|
| Unconditional | Always routes calls to the selected destination when enabled. |
| On no answer, busy, or offline | Routes calls when the extension does not answer, is busy, or is offline. |
| On condition | Routes calls to a selected destination when the chosen condition matches. |
| Missed call notification | Sends email notifications for missed calls, with options to ignore internal or queue-originated calls. |
| Block | Purpose |
|---|---|
| Branch and department | Classifies the extension for reporting and administration. |
| Reference ID and additional info | Stores external references and notes. |
| Save, delete, and back | Save applies changes, Delete removes the extension when allowed, and Back returns to the Extensions list. |
| Action | Description |
|---|---|
| Create | Open Configuration > Extensions and select New PJSIP peer. Fill the required fields and select Save. |
| Edit | Open an existing extension from the Extensions list. Update the required fields and select Save. |
| Delete | When delete permission is available, open the extension and select Delete. Confirm only after checking routing, phones, queues, and other references. |
| Block | Purpose |
|---|---|
| Number and name | Number is the internal extension number. Name is the display name used in lists, caller ID, and reports. |
| Description and emergency notes | Description is an administrator note. Emergency notes can be used by emergency routing and notification logic. |
| SIP stack | Shows whether the endpoint is using chan\_sip or PJSIP. Users with switch permission can change the stack from this form or from the Extensions list. |
| Username and password | Endpoint credentials used by the phone or softphone. The default username pattern is the extension number followed by the tenant code. |
| Codecs and DTMF | Controls the allowed audio/video codecs and DTMF signaling mode used by the endpoint. |
| Media and groups | Direct media, call groups, pickup groups, spy groups, and message-waiting options control how the endpoint participates in calls and monitoring. |
| Voicemail, DND, and timeout | Voicemail MWI, DND, and inbound dial timeout control how incoming calls are presented and how long the extension rings. |
| Block | Purpose |
|---|---|
| NAT | Defines how MiRTA PBX treats NAT traversal for the endpoint. |
| Qualify and qualify frequency | Controls whether the PBX checks endpoint reachability and how often checks are sent. |
| Keep alive and RTP keep alive | Sends periodic traffic to keep network mappings open and detect unavailable devices. |
| Block | Purpose |
|---|---|
| Fax and volume | Controls T.38 fax behavior and transmit/receive volume adjustments. |
| Music on hold and language | Selects media behavior and the preferred language for prompts played to the extension. |
| Directories and phone books | Controls whether the extension appears in dial-by-name directories and phone book generated lists. |
| Call waiting and autoanswer | Controls second-call handling and optional automatic answer behavior for supported phones. |
| Block | Purpose |
|---|---|
| Inbound recording policy | Controls whether inbound calls are recorded and whether recording privacy behavior is enabled. |
| Recording notifications | When enabled, recordings can be mailed and processed according to tenant recording settings. |
| Block | Purpose |
|---|---|
| Always record | Controls whether outbound calls from this extension are recorded, unless tenant-wide settings force recording. |
| Email recording to | Sends matching recordings to the configured address. Minimum size can suppress very small recordings. |
| Transcript, summary, sentiment | Enables transcript, summary, and sentiment processing when the tenant supports those services. |
| Block | Purpose |
|---|---|
| Authentication and network filters | Controls endpoint trust, allowed IPs, and authentication-related behavior. |
| Abuse detection and cost limits | Locks or warns on suspicious or excessive usage according to tenant policy. |
| Outbound destinations | Allows all calls, blocks calls, or applies a destination regex filter. |
| Lock PIN and max duration | Allows the extension to be locked and caps outbound call duration. |
| Working hours | Restricts outbound calling to the selected weekday condition. |
| Block | Purpose |
|---|---|
| Access toggles | Enables the user panel, web phone, switchboard, and optional custom user application. |
| Web user and password | Sets the login identity and password. If no web user is specified, the endpoint username is used. |
| Password policy and 2FA | Controls expiry, forced change, lock state, LDAP use, and two-factor authentication. |
| Email, profile, and IP filter | Sets the user email, sends account information, assigns a user profile, and optionally restricts web access by IP. |
| Block | Purpose |
|---|---|
| External caller ID | Sets or hides the caller ID number and name sent on outbound calls. |
| SMS and override caller ID | Controls SMS caller ID and optional SIP header based caller ID overrides. |
| Emergency caller ID | Defines the emergency number identity and whether empty emergency caller ID warnings are ignored. |
| Area code and caller ID regex | Applies prefixes and caller ID rewrite rules before routing. |
| Do Not and Only Allow lists | Applies tenant call-list restrictions to this extension. |
| Routing profile and call rate | Selects the routing profile, SMS routing profile, and client rate used by calls. |
| Block | Purpose |
|---|---|
| Block inbound caller ID number | Prevents the caller ID number from being shown to this extension. |
| Block inbound caller ID name | Prevents the caller ID name from being shown to this extension. |
| Inbound Do Not Call lists | Allows external inbound calls from any caller ID except numbers matching the selected lists. Internal calls are always accepted. |
| Inbound Only Allow Call lists | Rejects external inbound calls unless the caller ID number matches one of the selected lists. Internal calls are always accepted. |
| Block | Purpose |
|---|---|
| FMFM number and status | Sets the external follow-me number and enables or disables the feature. |
| Condition and dial method | Limits follow-me behavior to a condition and selects how the alternate number is dialed. |
| Confirmation and messages | Requires answer confirmation and selects confirm/hold messages. |
| Caller ID and timing | Controls caller ID presentation, prefixes, delay, and dial timeout for the follow-me call. |
| Block | Purpose |
|---|---|
| Unconditional | Always routes calls to the selected destination when enabled. |
| On no answer, busy, or offline | Routes calls when the extension does not answer, is busy, or is offline. |
| On condition | Routes calls to a selected destination when the chosen condition matches. |
| Missed call notification | Sends email notifications for missed calls, with options to ignore internal or queue-originated calls. |
| Block | Purpose |
|---|---|
| Branch and department | Classifies the extension for reporting and administration. |
| Reference ID and additional info | Stores external references and notes. |
| Save, delete, and back | Save applies changes, Delete removes the extension when allowed, and Back returns to the Extensions list. |
| Action | Description |
|---|---|
| Open | Open Configuration > Extensions, edit a PJSIP extension, then choose the Endpoint detail link. |
| Edit | Update the required fields and select Save. The form returns to the PJSIP extension after saving. |
| Back | Use Back to return to the PJSIP extension without applying changes. |
| Field or option | Purpose |
|---|---|
| Direct Media | Determines whether media may flow directly between endpoints |
| Rewrite Contact | Allow Contact header to be rewritten with the source IP address-port |
| Connected Line Method | Connected line media type |
| DirectMedia Method | Direct Media method type |
| Direct Media Glare Mitigation | Mitigation of direct media re INVITE glare |
| Disable direct media on NAT | Disable direct media session refreshes when NAT obstructs the media session |
| Force rport | Force use of return port |
| Outbound Proxy | Proxy through which to send requests a full SIP URI must be provided |
| RTP Symmetric | Enforce that RTP must be symmetric |
| T.38 UDPTL NAT | Use the NATTED IP in the UDPTL for T.38 |
| RPID Immediate | Immediately send connected line updates on unanswered incoming calls |
| Use ptime | Use Endpoint's requested packetization interval |
| RTCP Mux | Controls whether RTP and RTCP can be multiplexed on the same transport flow. |
| Notify Ringing when Ring in Use | When an extension is in Ring in Use state, notifies the ringing |
| Field or option | Purpose |
|---|---|
| DTLS certificate file path | Path to certificate file to present to peer |
| DTLS CA certificate file path | Path to certificate authority certificate |
| DTLS Auto generate certificate | Enable ephemeral DTLS certificate generation |
| Field or option | Purpose |
|---|---|
| External Media Address | External IP address to use in RTP handling |
| Action | Description |
|---|---|
| Open | Open Configuration > Extensions, edit a PJSIP extension, then choose the AOR detail link. |
| Edit | Update the required fields and select Save. The form returns to the PJSIP extension after saving. |
| Back | Use Back to return to the PJSIP extension without applying changes. |
| Field or option | Purpose |
|---|---|
| Default Expiration | Default expiration time in seconds for contacts that are dynamically bound to an AoR |
| Minimum Expiration | Minimum expiration time in seconds for contacts that are dynamically bound to an AoR |
| Maximum Expiration | Maximum expiration time in seconds for contacts that are dynamically bound to an AoR |
| Mailboxes | Allow subscriptions for the specified mailbox(es) |
| Max Contacts | Maximum number of contacts that can bind to an AoR |
| Remove Existing | On receiving a new registration to the AoR should it remove enough existing contacts not added or updated by the registration to satisfy Max Contacts? Any removed contacts will expire the soonest. |
| Remove Unavailable | On receiving a new registration to the AoR should it remove unavailable contacts not added or updated by the registration to satisfy Max Contacts? |
| Support Path | Enables Path support for REGISTER requests and Route support for other requests. |
| Action | Description |
|---|---|
| Create | Open Configuration > Extensions and select Custom Extension. Fill the required fields and select Save. |
| Edit | Open an existing extension from the Extensions list. Update the required fields and select Save. |
| Delete | When delete permission is available, open the extension and select Delete. Confirm only after checking routing, phones, queues, and other references. |
| Block | Purpose |
|---|---|
| Number, name, and description | Defines the internal extension number, display name, and administrator description. |
| Call and pickup groups | Controls pickup behavior and group membership for incoming calls. |
| DND and inbound timeout | Controls whether the custom extension is marked DND and how long incoming calls are attempted. |
| Block | Purpose |
|---|---|
| Fax and volume | Controls fax behavior and transmit/receive volume adjustments. |
| Music on hold and language | Selects hold media and prompt language. |
| Directories and phone books | Controls inclusion in dial-by-name and phone book generated lists. |
| Call waiting and autoanswer | Controls second-call handling and autoanswer behavior when supported by the target. |
| Block | Purpose |
|---|---|
| Always record and email recording | Controls outbound recording and optional delivery of recordings by email. |
| Transcript, summary, sentiment | Enables transcript, summary, and sentiment processing when available for the tenant. |
| Block | Purpose |
|---|---|
| Outbound number | Defines the number or dial target used to reach the custom extension. |
| Caller ID and authentication | Controls caller ID use on internal calls and the authentication method expected for inbound matching. |
| Allowed providers and Teams ID | Restricts inbound providers and stores a Teams extension ID when Teams status integration is used. |
| Abuse, cost, and destination limits | Applies abuse detection, call cost limits, outbound destination filters, lock PIN, maximum duration, and working-hours restrictions. |
| Block | Purpose |
|---|---|
| User panel toggle | Enables or disables web access for this extension. |
| Web user and password | Sets the login identity and password. |
| LDAP, 2FA, email, and profile | Controls external authentication, two-factor options, notification email, and user profile. |
| Block | Purpose |
|---|---|
| External caller ID | Sets caller ID number and name used by outbound calls. |
| Caller ID regex and emergency caller ID | Applies rewrite rules and emergency identity settings. |
| Area code and call lists | Applies area-code prefixes and Do Not or Only Allow list restrictions. |
| Routing profile and call rate | Selects the routing profile and call rate used by outbound calls. |
| Block | Purpose |
|---|---|
| Inbound Do Not Call lists | Allows external inbound calls from any caller ID except numbers matching the selected lists. Internal calls are always accepted. |
| Inbound Only Allow Call lists | Rejects external inbound calls unless the caller ID number matches one of the selected lists. Internal calls are always accepted. |
| Block | Purpose |
|---|---|
| FMFM number and dial method | Sets the follow-me target and how it is dialed. |
| Confirmation and caller ID | Controls answer confirmation and caller ID behavior. |
| Delay and timeout | Controls how long to wait before and during follow-me dialing. |
| Block | Purpose |
|---|---|
| Failover destinations | Selects unconditional, no-answer, busy, offline, and conditional destinations. |
| Missed call notifications | Sends notifications and optionally ignores internal or queue-originated missed calls. |
| Block | Purpose |
|---|---|
| Branch, department, reference ID | Classifies the extension and stores external references. |
| Additional info | Stores free-form notes. |
| Save, delete, and back | Save applies changes, Delete removes the extension when allowed, and Back returns to the Extensions list. |
| Action | Description |
|---|---|
| Create | Open Configuration > Extensions and select Virtual Extension. Fill the required fields and select Save. |
| Edit | Open an existing extension from the Extensions list. Update the required fields and select Save. |
| Delete | When delete permission is available, open the extension and select Delete. Confirm only after checking routing, phones, queues, and other references. |
| Block | Purpose |
|---|---|
| Number, name, and description | Defines the internal virtual extension number, display name, and administrator description. |
| Security PIN | Requests a PIN when an extension tries to join the virtual extension. |
| Internal caller ID | Sets the caller ID shown for internal calls, or keeps it automatic. |
| Extensions | Selects the real extensions that belong to the virtual extension. |
| Groups, voicemail, DND, timeout | Controls call/pickup/spy groups, voicemail MWI, DND state, and inbound ring timeout. |
| Block | Purpose |
|---|---|
| Volume and music on hold | Adjusts audio levels and selects hold media. |
| Directories and phone books | Controls inclusion in dial-by-name and phone book generated lists. |
| Call waiting and parking lot | Controls server-side call waiting behavior and parking lot selection. |
| Block | Purpose |
|---|---|
| Always record and email recording | Controls outbound recording and optional delivery of recordings by email. |
| Transcript, summary, sentiment | Enables transcript, summary, and sentiment processing when available for the tenant. |
| Block | Purpose |
|---|---|
| Outbound destinations | Allows all calls, blocks calls, or applies a destination regex filter. |
| Lock PIN and max duration | Allows the virtual extension to be locked and caps outbound call duration. |
| Working hours | Restricts outbound calling to the selected weekday condition. |
| Block | Purpose |
|---|---|
| User panel toggle | Enables or disables web access for this extension. |
| Web user and password | Sets the login identity and password. |
| LDAP, 2FA, email, and profile | Controls external authentication, two-factor options, notification email, and user profile. |
| Block | Purpose |
|---|---|
| External caller ID | Sets caller ID number and name used by outbound calls. |
| Use this caller ID in a virtual extension | Controls whether member extensions use this caller ID when calls originate through the virtual extension. |
| Caller ID regex and area code | Applies rewrite rules and number prefixes before routing. |
| Call lists and routing profile | Applies Do Not or Only Allow lists and selects the routing profile. |
| Block | Purpose |
|---|---|
| Inbound Do Not Call lists | Allows external inbound calls from any caller ID except numbers matching the selected lists. Internal calls are always accepted. |
| Inbound Only Allow Call lists | Rejects external inbound calls unless the caller ID number matches one of the selected lists. Internal calls are always accepted. |
| Block | Purpose |
|---|---|
| FMFM number and condition | Sets the follow-me target and optional condition. |
| Dial method and confirmation | Controls how the follow-me call is dialed and whether answer confirmation is required. |
| Caller ID and timing | Controls caller ID presentation, delay, and timeout. |
| Block | Purpose |
|---|---|
| Failover destinations | Selects unconditional, no-answer, busy, offline, and conditional destinations. |
| Missed call notifications | Sends notifications and optionally ignores internal or queue-originated missed calls. |
| Block | Purpose |
|---|---|
| Branch, department, reference ID | Classifies the extension and stores external references. |
| Additional info | Stores free-form notes. |
| Save, delete, and back | Save applies changes, Delete removes the extension when allowed, and Back returns to the Extensions list. |
| Task | How to do it |
|---|---|
| Add | Select the New DID action, complete the form, and select Save. |
| Edit | Open the DID from the list by selecting its name, number, or row action. Change the form and select Save. |
| Delete | Select the row checkbox and use Delete Selected, or open the DID and select Delete, then confirm. |
| Action | Description |
|---|---|
| Outbound CallerID Regexs | Opens the DID caller ID rewrite rules used for outbound caller ID presentation. |
| Outbound DIDs | Opens the outbound DID management view. |
| New DID | Opens the creation form for a new DID. |
| Bulk DIDs | Opens the bulk DID creation tool. |
| Delete Selected | Deletes selected rows after confirmation. |
| CSV/XLS Upload | Opens import tools for bulk DID data. |
| Enable jqGrid | Switches the table display mode for advanced grid controls. |
| Divert | Opens the divert action for selected DIDs when available. |
| Column | Description |
|---|---|
| Number | The inbound number or matching value. |
| Admin Comment | Internal administrator note for the DID. |
| Comment | Tenant-facing or operational note for the DID. |
| Max Channels | Maximum simultaneous channels allowed for the DID. |
| Recording | Recording policy shown for inbound calls on the DID. |
| CallerID Prefix | Prefix applied to inbound caller ID number or name. |
| Unconditional forward | Destination used when unconditional forwarding is enabled. |
| Inbound Call Rates | Rate profile applied to inbound calls. |
| Action | Row-level actions available for the DID. |
| Action | Description |
|---|---|
| Create | Open **Configuration > DIDs** and select **New DID**. Fill the required fields and select Save. |
| Edit | Open an existing DID from the DIDs list. Update the required fields and select Save. |
| Delete | When delete permission is available, open the DID and select Delete, or delete selected rows from the list. Confirm only after checking destinations and call-flow references. |
| Block | Purpose |
|---|---|
| Number | Sets the DID number. Depending on system format settings, the number can be entered as country, area, and number fields or as a single value. |
| Comment and admin comment | Stores visible and internal notes for list views and administration. |
| Max Channels | Limits simultaneous use of the DID. Empty means unlimited; zero disables usage. |
| CNAM and privacy | Controls caller-name lookup and whether inbound caller ID is hidden. |
| Emergency caller ID | Marks the DID for emergency caller ID use and stores emergency notes when enabled. |
| Branch, department, rate, and provider | Classifies the DID and links it to inbound rating or DID provider data when those options are available. |
| Block | Purpose |
|---|---|
| Unconditional Forward | Routes all inbound calls to the selected destination when enabled. |
| Recording | Controls whether inbound calls are recorded and whether callers or called parties can start or stop recording. |
| Email recording and minimum size | Sends matching recordings to configured recipients and suppresses very small recordings when a minimum size is set. |
| Transcript, summary, and sentiment | Enables AI processing for recorded calls when the tenant supports those services. |
| Caller ID prefixes | Adds prefixes to inbound caller ID number or name before the call is delivered. |
| Destination | Selects the normal inbound destination for calls to the DID. |
| Block | Purpose |
|---|---|
| Receive Fax | Controls whether the DID never receives faxes, autodetects faxes, forces fax handling, stores and forwards, or sends faxes to print/storage. |
| Fax Routing Profile | Selects the routing profile used for outbound faxes when this DID is used as caller ID. |
| Forward or print/storage target | Sets the forwarding number or external print/storage target used by the selected fax mode. |
| Fax station and header | Sets the station ID and header text shown on fax documents. |
| Fax Protocol | Selects T.38, G.711, or mixed fax protocol behavior. |
| Email, store, and success destination | Controls fax delivery by email, whether received faxes are stored, and where the call continues after a successful fax. |
| Block | Purpose |
|---|---|
| Protocol | Selects whether the DID supports SMS and how inbound SMS data is received. |
| IMSI and field mapping | Maps inbound SMS source, destination, body, and MMS link fields for custom payloads. |
| Email and store | Controls notification delivery and whether messages are stored. |
| Destination | Selects the destination used when an inbound SMS is received. |
| Action | Description |
|---|---|
| Standard Message Media Files | Opens the standard prompt assignment page, where predefined system prompts can be associated with existing media files. |
| New Media File | Opens the creation form for a new media file. From that form you can upload an audio file, create a text-to-speech prompt, or record by dialing an extension or external number. |
| Delete Selected | Deletes the selected media files after confirmation. Check IVRs, queues, DISAs, music-on-hold lists, and other call flows before deleting a prompt that may be in use. |
| Search | Filters the visible rows by name, format, size, checksum, date, or other displayed text. |
| Sort | Sorts the table by the selected column. |
| Page size | Changes how many media files are shown per page. |
| Audio download | Downloads the stored media file from the row's Audio column. |
| Audio playback | Opens the in-page media player when the stored format can be played directly by the browser. |
| Column | Description |
|---|---|
| Select | Selects one or more rows for bulk deletion. |
| Name | Display name used when selecting the prompt in IVRs, queues, destinations, and other configuration pages. |
| Format | Stored audio format, or the configured text-to-speech creation mode when no stored audio file exists yet. |
| Size | Stored media size. Dynamic text-to-speech prompts can show zero bytes because audio is generated during the call. |
| MD5 | Checksum of the stored audio file. This is blank when the media file has no stored audio body. |
| Date | Last media-file creation or update timestamp. |
| Audio | Download and playback actions for the media file. |
| Workflow | Use it when |
|---|---|
| Upload a Media File | You already have a WAV, MP3, M4A, or WMA file to use as a prompt. |
| Create a Media File with Text to Speech | You want MiRTA PBX to synthesize the prompt from text, either immediately or dynamically during the call. |
| Record by dialing out | You want MiRTA PBX to call an extension or external number and record the spoken audio from that call. |
| Edit an existing media file | Open the row by selecting its name, format, size, checksum, or date, then update the relevant form blocks and save. |
| Step | Action |
|---|---|
| 1 | Select the correct tenant in the top bar. |
| 2 | Open **Configuration > Media Files**. |
| 3 | Select **New Media File**. |
| 4 | Complete the Information, upload, and transformation blocks, then select **Save**. |
| Field | Description |
|---|---|
| Name | Short display name for the media file. Use a name that describes where the prompt is used, such as **Docs Demo IVR Upload Prompt**. |
| Description | Administrative note for the prompt. Use it to record the script purpose, call flow, or owner. |
| Field | Description |
|---|---|
| File | Select the audio file to store. Use a clear filename, such as **ivr-selection-upload.wav**. MiRTA PBX can process common prompt formats including WAV, MP3, M4A, and WMA. |
| Field or option | Description |
|---|---|
| Volume correction | Applies a linear gain adjustment. Use **1.0** for no change. Values below 1 reduce volume; values above 1 increase it. |
| Automatic | Lets MiRTA PBX choose the stored format based on the uploaded source. |
| WAV mono 8Khz 64kbps | Converts the prompt to an 8 kHz mono WAV format suitable for narrowband telephony prompts. |
| WAV mono 16Khz 128kbps | Converts the prompt to a 16 kHz mono WAV format. |
| SLN 8 khz format | Converts the prompt to 8 kHz signed linear audio. |
| SLN 16 khz format | Converts the prompt to 16 kHz signed linear audio. |
| Leave as is | Stores the uploaded file format without conversion, except for any requested volume correction. |
| Field | Example value |
|---|---|
| Name | Docs Demo IVR Upload Prompt |
| Description | Uploaded prompt for the IVR selection menu |
| File | ivr-selection-upload.wav |
| Volume correction | 1.0 |
| Format conversion | Automatic |
| Step | Action |
|---|---|
| 1 | Select the correct tenant in the top bar. |
| 2 | Open **Configuration > Media Files**. |
| 3 | Select **New Media File**. |
| 4 | Complete the Information, text-to-speech, and transformation blocks, then select **Save**. |
| Field | Description |
|---|---|
| Name | Short display name for the generated prompt. The example uses **Docs Demo IVR Menu TTS**. |
| Description | Administrative note for the generated prompt. Use it to describe the IVR, queue, or call flow that will use the prompt. |
| Field or option | Description |
|---|---|
| Text | Prompt text to synthesize. The field supports runtime variables such as `${INCOMINGDID}` and `${CALLERID(num)}`. When the media file is generated dynamically during the call, any Asterisk channel variable or user-defined variable available in the call can be used in this format. Surround a number with `//` markers when it should be read digit by digit. |
| Engine | Voice engine to use. Leave **Tenant Default** unless this prompt needs a specific configured engine. |
| Voice | Voice to use for the generated prompt. Leave **Tenant Default** unless the prompt requires a specific language, dialect, or voice. |
| Create now | Generates and stores the audio when you save the media file. Use this for fixed prompts that do not need runtime variables. |
| Dynamically during the call | Stores the text and voice settings, then generates the prompt during call execution. Use this when the prompt includes Asterisk channel variables, user-defined variables, or other values that must be read from the active call. |
| Region | Appears for engines that require a regional endpoint, such as Amazon AWS Polly. |
| Voice Engine API username | Optional per-prompt API username when the selected engine requires credentials. Prefer tenant or global defaults when possible. |
| Voice Engine API password | Optional per-prompt API password. Treat it as sensitive. |
| Field or option | Description |
|---|---|
| Volume correction | Applies a linear gain adjustment. Use **1.0** for no change. Values below 1 reduce volume; values above 1 increase it. |
| Automatic | Lets MiRTA PBX choose the stored format. |
| WAV mono 8Khz 64kbps | Converts the generated audio to an 8 kHz mono WAV format suitable for narrowband telephony prompts. |
| WAV mono 16Khz 128kbps | Converts the generated audio to a 16 kHz mono WAV format. |
| SLN 8 khz format | Converts the generated audio to 8 kHz signed linear audio. |
| SLN 16 khz format | Converts the generated audio to 16 kHz signed linear audio. |
| Leave as is | Stores the generated file without conversion, except for any requested volume correction. |
| 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. |
| 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. |
| 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. |
| 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 |
| 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. |
| Field | Example value |
|---|---|
| Name | Docs Condition - Weektime |
| Timeslot | Monday 09:00-17:00 |
| 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. |
| Field | Example value |
|---|---|
| Name | Docs Condition - Calendar |
| Calendar slot | 2026-12-24 09:00 to 2026-12-24 17:00 |
| 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. |
| Field | Example value |
|---|---|
| Name | Docs Condition - Hours |
| From - To | 09:00 to 17:00 |
| 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. |
| Field | Example value |
|---|---|
| Name | Docs Condition - Simple Caller ID |
| Caller ID | ^1555 |
| 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. |
| Field | Example value |
|---|---|
| Name | Docs Condition - Simple Caller ID Name |
| Caller ID Name | Canistracci |
| 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. |
| Field | Example value |
|---|---|
| Name | Docs Condition - Weekday |
| Days | Monday through Friday |
| 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. |
| Field | Example value |
|---|---|
| Name | Docs Condition - Date - Exact Match |
| Date | 2026-12-25 00:00:00 |
| 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. |
| Field | Example value |
|---|---|
| Name | Docs Condition - Date - Lesser Than Date |
| Lesser than Date | 2026-12-31 23:59:59 |
| 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. |
| Field | Example value |
|---|---|
| Name | Docs Condition - Date - Greater Than Date |
| Greater than Date | 2026-01-01 00:00:00 |
| 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. |
| 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 |
| 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. |
| Field | Example value |
|---|---|
| Name | Docs Condition - Day of the Month |
| Day of the month | 15 |
| 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. |
| Field | Example value |
|---|---|
| Name | Docs Condition - Extension Status |
| Extension | 100 - Alex Reed |
| State | Not in use |
| 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. |
| Field | Example value |
|---|---|
| Name | Docs Condition - Variable Value |
| Variable | DEPARTMENT |
| Value | Accounting |
| 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. |
| Field | Example value |
|---|---|
| Name | Docs Condition - Multiple Variable Values |
| Variable | SERVICE |
| Values | billing, support |
| 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. |
| Field | Example value |
|---|---|
| Name | Docs Condition - System Variable Value |
| System variable | CALLERID(num) |
| Value | ^1555 |
| 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. |
| Field | Example value |
|---|---|
| Name | Docs Condition - Multiple Extensions Status |
| Extensions | 100 and 101 |
| State | All users are online |
| 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. |
| Field | Example value |
|---|---|
| Name | Docs Condition - AGI Script |
| AGI Script | Docs Demo AGI 1 |
| 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. |
| Field | Example value |
|---|---|
| Name | Docs Condition - Authenticate |
| PIN | 1234 |
| Max attempts | 3 |
| 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. |
| Field | Example value |
|---|---|
| Name | Docs Condition - Tenant Channels |
| More than | 5 |
| 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. |
| Field | Example value |
|---|---|
| Name | Docs Condition - Tenant Any Channels |
| More than | 10 |
| 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. |
| Field | Example value |
|---|---|
| Name | Docs Condition - DID Channels |
| DID | Docs Demo DID 1 |
| More than | 1 |
| 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. |
| Field | Example value |
|---|---|
| Name | Docs Condition - Channel Group Count |
| Group name | support |
| More than | 2 |
| 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. |
| Field | Example value |
|---|---|
| Name | Docs Condition - Answering Machine Detection |
| Total analysis time | 5000 |
| 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. |
| Field | Example value |
|---|---|
| Name | Docs Condition - SIP Header |
| SIP Header | X-Account |
| Regular Expression | Accounting |
| 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. |
| Field | Example value |
|---|---|
| Name | Docs Condition - Agent Logged In |
| Agent | 100 - Alex Reed |
| Queue | Accounting |
| 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. |
| Field | Example value |
|---|---|
| Name | Docs Condition - Agent Paused |
| Agent | 100 - Alex Reed |
| Queue | Accounting |
| 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. |
| Field | Example value |
|---|---|
| Name | Docs Condition - Caller ID in Phonebook |
| Caller ID | ${CALLERID(num)} |
| Phonebook | Default |
| 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. |
| Field | Example value |
|---|---|
| Name | Docs Condition - Feature Code Parameter |
| Parameter 1 | 42 |
| 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. |
| Field | Example value |
|---|---|
| Name | Docs Condition - All Conditions |
| Conditions | Weektime and Weekday |
| 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. |
| Field | Example value |
|---|---|
| Name | Docs Condition - Any Conditions |
| Conditions | Weektime or Caller ID |
| Field or option | Description |
|---|---|
| Name | Display name used in condition lists and selectors. |
| Type | Select Negate condition result. |
| Condition | Condition whose result is inverted. |
| Field | Example value |
|---|---|
| Name | Docs Condition - Negate Condition |
| Condition | Docs Condition - Weektime |
| 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. |
| Field | Example value |
|---|---|
| Name | Docs Condition - Use Global Condition |
| Global condition | Docs Global Condition - Weektime |
| 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. |
| Field | Example value |
|---|---|
| Name | Docs Condition - Check SMS Message |
| Message content | STOP |
| 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. |
| Field | Example value |
|---|---|
| Name | Docs Condition - Check Channel |
| Channel | PJSIP/100 |
| 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. |
| Field | Example value |
|---|---|
| Name | Docs Condition - Multiple Destination over Weektime |
| Color 1 | Open hours |
| Color 2 | After hours |
| 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. |
| Field | Example value |
|---|---|
| Name | Docs Condition - Call Screening Random PIN |
| PIN length | 4 |
| 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. |
| Field | Example value |
|---|---|
| Name | Docs Condition - Caller Already Called In |
| Lookup hours | 24 |
| At least | 1 time |
| 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. |
| Field | Example value |
|---|---|
| Name | Docs Condition - Caller Already Called Out |
| Lookup hours | 24 |
| Disposition | Answered |
| 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. |
| Field | Example value |
|---|---|
| Name | Docs Condition - Queue Callers More Than |
| Queue | Accounting |
| More than # callers | 3 |
| Task | How to do it |
|---|---|
| Add | Select the New IVR action, complete the form, and select Save. |
| Edit | Open the IVR from the list by selecting its name, number, or row action. Change the form and select Save. |
| Delete | Select the row checkbox and use Delete Selected, or open the IVR and select Delete, then confirm. |
| Action | Description |
|---|---|
| New IVR | Opens the creation form for a new ivr. |
| Delete Selected | Deletes the selected rows after confirmation. |
| Column | Description |
|---|---|
| Name | Display name used in lists and references. |
| Welcome Message | Object setting shown by the form. |
| Allow Dialing Extensions | Target or routing selection used when the object sends a call or message onward. |
| Allow Dialing Feature Codes | Dialed value, identifier, or matching value used by the PBX. |
| Action | Object setting shown by the form. |
| Field | Description |
|---|---|
| Name: | Display name used in lists and references. |
| Type: | Mode selector that changes the behavior of the object. |
| Speech to Text Language: | Language or voice selection used for prompts, transcription, or speech synthesis. |
| Min silence time (ms): | Object setting shown by the form. |
| Silence threshold: | Object setting shown by the form. |
| Messages playback: | Object setting shown by the form. |
| Menu selection timeout: | Timing value used by the service. |
| Digit timeout: | Timing value used by the service. |
| Max loop counts: | Object setting shown by the form. |
| Loop on timeout | Timing value used by the service. |
| Loop on wrong key press/word | Object setting shown by the form. |
| Allow dialing internal numbers | Dialed value, identifier, or matching value used by the PBX. |
| Allowed numbers: | Dialed value, identifier, or matching value used by the PBX. |
| Allow Custom Codes | Dialed value, identifier, or matching value used by the PBX. |
| Allow Dialing Feature Codes | Dialed value, identifier, or matching value used by the PBX. |
| Field | Description |
|---|---|
| Type | Select Voice to hide the fixed DTMF key mappings and use spoken words or phrases as menu choices. |
| Speech to Text Language | Selects the speech-recognition language used to transcribe the caller audio before matching it against the IVR entries. |
| Min silence time (ms) | Amount of silence, in milliseconds, that MiRTA PBX waits before sending the captured speech to the Speech to Text engine. A higher value allows longer pauses inside a phrase; a lower value submits the audio sooner. |
| Silence threshold | Audio level below which the input is considered silence. Increase it in noisy environments; decrease it when quiet speech is being cut too early. |
| Welcome Message | Media played at the beginning of the IVR, normally only on the first pass through the menu. |
| Options Message | Media that explains the available spoken choices to the caller. |
| Messages playback | Controls whether welcome and options media are replayed during loops, only the options media is replayed, or no media is replayed. |
| Menu selection timeout | How long the IVR waits for speech before using the timeout behavior. |
| Loop on timeout | When enabled, the IVR repeats after a timeout instead of immediately following the timeout destination. Max loop counts limits how many retries are allowed. |
| Loop on wrong key press/word | When enabled, the IVR repeats after speech is recognized but does not match any configured word or phrase. |
| Entering | The word or short phrase to match after transcription, such as sales, support, billing, or operator. |
| Action to take | The destination used when the recognized word or phrase matches the Entering value. |
| On wrong key press/word | Fallback destination when the spoken input does not match any configured entry and looping is not used or has reached the maximum loop count. |
| On timeout | Fallback destination when no speech is detected before the menu selection timeout. |
| On hangup | Optional destination or action to run when the caller hangs up while inside the IVR. |
| Task | How to do it |
|---|---|
| Create | Select the new action from the IVRs list, fill the required fields, and select Save. |
| Edit | Open the existing IVR, update the needed fields, and select Save. |
| Delete | Before deleting a IVR, check call-flow, destination, schedule, report, provisioning, or integration references. Use the row delete action or the form delete action when available, then confirm. |
| Task | How to do it |
|---|---|
| Add | Select the New hunt list action, complete the form, and select Save. |
| Edit | Open the hunt list from the list by selecting its name, number, or row action. Change the form and select Save. |
| Delete | Select the row checkbox and use Delete Selected, or open the hunt list and select Delete, then confirm. |
| Action | Description |
|---|---|
| New Hunt List | Opens the creation form for a new hunt list. |
| Delete Selected | Deletes the selected rows after confirmation. |
| Column | Description |
|---|---|
| Name | Display name used in lists and references. |
| Number | Dialed value, identifier, or matching value used by the PBX. |
| Type | Mode selector that changes the behavior of the object. |
| Peer List | Object setting shown by the form. |
| Action | Object setting shown by the form. |
| Field | Description |
|---|---|
| Name: | Display name used in lists and references. |
| Number: | Dialed value, identifier, or matching value used by the PBX. |
| Type: | Mode selector that changes the behavior of the object. |
| Use fast dialing | Dials eligible hunt-list members directly for simple hunt lists. This shortcut is used only when the hunt list is not also allowing FMFM or additional destinations. |
| Use Default Music On Hold instead of ringing | Object setting shown by the form. |
| Skip if exten is in use | Object setting shown by the form. |
| Skip if exten is offline | Object setting shown by the form. |
| Allow extension redirect | Target or routing selection used when the object sends a call or message onward. |
| Allow FMFM | Object setting shown by the form. |
| Allow additional destinations | Target or routing selection used when the object sends a call or message onward. |
| Use Custom Destination details | Target or routing selection used when the object sends a call or message onward. |
| Request confirm to answer | Object setting shown by the form. |
| Confirm message: | Object setting shown by the form. |
| Ring time: | Object setting shown by the form. |
| Dial timeout: | Timing value used by the service. |
| Area | Behavior |
|---|---|
| When the shortcut is active | MiRTA PBX builds the dial string from the destination devices directly. chan\_sip extensions are dialed as their SIP peer, PJSIP extensions are expanded to their registered contacts, custom extensions are dialed through their outbound target, and virtual extensions are expanded to their member devices. |
| Required options | Fast dialing is used only when **Allow FMFM** and **Allow additional destinations** are both disabled. If either option is enabled, the PBX routes the member through normal extension handling so those features can run. |
| Checks that still apply | The hunt list still honors **Skip if exten is in use**, **Skip if exten is offline**, device state checks, and Do Not Disturb checks where they apply. |
| Features bypassed | Member-level Find Me/Follow Me, additional destinations, and other behavior that depends on entering the full extension destination flow can be skipped because the device or endpoint is dialed directly. |
| Request confirm to answer | For **Ring All** and **Ring All over Loop**, enabling **Request confirm to answer** uses the confirmation path for the hunt list, so fast dialing is not the active route for those ring modes. |
| Clustered systems | If the selected extension is registered on another node, the call is sent through the inter-node SIP trunking path instead of a local endpoint contact. |
| Task | How to do it |
|---|---|
| Create | Select the new action from the Hunt Lists list, fill the required fields, and select Save. |
| Edit | Open the existing hunt list, update the needed fields, and select Save. |
| Delete | Before deleting a hunt list, check call-flow, destination, schedule, report, provisioning, or integration references. Use the row delete action or the form delete action when available, then confirm. |
| Task | How to do it |
|---|---|
| Add | Select the New conference room action, complete the form, and select Save. |
| Edit | Open the conference room from the list by selecting its name, number, or row action. Change the form and select Save. |
| Delete | Select the row checkbox and use Delete Selected, or open the conference room and select Delete, then confirm. |
| Action | Description |
|---|---|
| New Conference Room | Opens the creation form for a new conference room. |
| Delete Selected | Deletes the selected rows after confirmation. |
| Column | Description |
|---|---|
| Name | Display name used in lists and references. |
| Number | Dialed value, identifier, or matching value used by the PBX. |
| PIN | Credential or PIN value. Treat it as sensitive. |
| Admin PIN | Credential or PIN value. Treat it as sensitive. |
| Max Allowed | Object setting shown by the form. |
| Field | Description |
|---|---|
| Name: | Display name used in lists and references. |
| Number: | Dialed value, identifier, or matching value used by the PBX. |
| Available from - to: | Object setting shown by the form. |
| PIN: | Credential or PIN value. Treat it as sensitive. |
| Admin PIN: | Credential or PIN value. Treat it as sensitive. |
| Call Rate: | Object setting shown by the form. |
| announcecount | Object setting shown by the form. |
| announcenamereview | Display name used in lists and references. |
| announcenamenoreview | Display name used in lists and references. |
| playmoh | Object setting shown by the form. |
| allowmenu | Object setting shown by the form. |
| allowadminmenu | Object setting shown by the form. |
| donotplaymessage | Object setting shown by the form. |
| startwhenadmin | Object setting shown by the form. |
| joinusermuted | Object setting shown by the form. |
| quiet | Object setting shown by the form. |
| endwhenadmin | Object setting shown by the form. |
| talkeroptimization | Object setting shown by the form. |
| talkeradminoptimization | Object setting shown by the form. |
| record | Recording behavior or recording delivery setting. |
| Request PIN message: | Credential or PIN value. Treat it as sensitive. |
| Correct PIN message: | Credential or PIN value. Treat it as sensitive. |
| Correct admin PIN message: | Credential or PIN value. Treat it as sensitive. |
| Max user allowed: | Object setting shown by the form. |
| Send conference report to: | Object setting shown by the form. |
| Conference Server: | Server, host, or node selection used by the object. |
| Task | How to do it |
|---|---|
| Create | Select the new action from the Conference Rooms list, fill the required fields, and select Save. |
| Edit | Open the existing conference room, update the needed fields, and select Save. |
| Delete | Before deleting a conference room, check call-flow, destination, schedule, report, provisioning, or integration references. Use the row delete action or the form delete action when available, then confirm. |
| Task | How to do it |
|---|---|
| Add | Select the New queue action, complete the form, and select Save. |
| Edit | Open the queue from the list by selecting its name, number, or row action. Change the form and select Save. |
| Delete | Select the row checkbox and use Delete Selected, or open the queue and select Delete, then confirm. |
| Action | Description |
|---|---|
| New Queue | Opens the creation form for a new queue. |
| External Agents | Runs the External Agents action. |
| Queue rules | Runs the Queue rules action. |
| Delete Selected | Deletes the selected rows after confirmation. |
| Assign | Runs the Assign action. |
| Column | Description |
|---|---|
| Name | Display name used in lists and references. |
| Number | Dialed value, identifier, or matching value used by the PBX. |
| Strategy | Object setting shown by the form. |
| Always Record | Recording behavior or recording delivery setting. |
| \# Agents | Object setting shown by the form. |
| \# Callers | Caller ID or caller matching value. |
| Action | Object setting shown by the form. |
| Section | Description |
|---|---|
| Information | Core identity and routing fields for the object. |
| Agents | Agent assignment and queue membership behavior. |
| Periodic Announce | Settings shown in the Periodic Announce block. |
| Queue exit key | Settings shown in the Queue exit key block. |
| Call Back service | Settings shown in the Call Back service block. |
| Abandoned Calls | Settings shown in the Abandoned Calls block. |
| Position/Time Announce | Settings shown in the Position/Time Announce block. |
| API Integrations | API-related credentials, restrictions, and integration controls. |
| Field | Description |
|---|---|
| Name: | Display name used in lists and references. |
| Number: | Dialed value, identifier, or matching value used by the PBX. |
| Always Record: | Recording behavior or recording delivery setting. |
| Email recording to: | Email address used for notifications, delivery, or mailbox access. |
| Minimum Size (bytes): | Object setting shown by the form. |
| Play to the caller: | Caller ID or caller matching value. |
| Queue timeout: | Timing value used by the service. |
| Service level: | Object setting shown by the form. |
| Max Queue Length: | Object setting shown by the form. |
| Weight: | Object setting shown by the form. |
| Auto fill: | Object setting shown by the form. |
| Queue rule: | Object setting shown by the form. |
| Queue min penalty: | Object setting shown by the form. |
| Queue max penalty: | Object setting shown by the form. |
| Queue raise penalty: | Object setting shown by the form. |
| Progress: | Object setting shown by the form. |
| Queue server: | Server, host, or node selection used by the object. |
| Strategy: | Object setting shown by the form. |
| allowoptimization | Object setting shown by the form. |
| Ring when in use: | Object setting shown by the form. |
| Ring when offline: | Object setting shown by the form. |
| Available Agent ringing: | Object setting shown by the form. |
| Report caller's hold time: | Caller ID or caller matching value. |
| Agent timeout: | Timing value used by the service. |
| Wrap-up time: | Object setting shown by the form. |
| Wait time for retry: | Timing value used by the service. |
| Penalty members limit: | Object setting shown by the form. |
| Auto pause: | Object setting shown by the form. |
| Field | How it works |
|---|---|
| Queue rule | Selects the time-based rule used by the queue. The rule rows are maintained from the Queue rules screen linked from the Queues list. |
| Queue min penalty | Sets the starting lower penalty boundary for the caller. Agents with a lower penalty are not considered while this value is active. |
| Queue max penalty | Sets the starting upper penalty boundary for the caller. Agents with a higher penalty are not considered while this value is active. |
| Queue raise penalty | Treats agents below the selected raise value as if they had the raise value for this caller. This can remove the priority advantage of lower-penalty agents without changing the stored member penalty. |
| Penalty members limit | When this queue-level limit is greater than zero and the queue has that number of members or fewer, Asterisk can ignore penalty weighting for availability decisions. |
| Column | Meaning |
|---|---|
| Time | Seconds after the caller entered the queue. When this wait time is reached, the row values are applied to that caller. |
| Min penalty | New lower boundary for eligible agents. |
| Max penalty | New upper boundary for eligible agents. |
| Raise penalty | New raise value used to make lower-penalty agents behave as if they had the configured penalty for the current caller. |
| Wait time | Values | Result |
|---|---|---|
| Queue entry | Min 0, max 0, raise not used | Only primary agents with penalty 0 are considered. |
| After 30 seconds | Min 0, max 1, raise 1 | Agents with penalties 0 and 1 are eligible. Penalty 0 agents are treated as penalty 1, so the first overflow tier is considered evenly with the primary tier. |
| After 60 seconds | Min 0, max 2, raise 2 | Agents with penalties 0, 1, and 2 are eligible, and lower tiers are treated as penalty 2 for this caller. |
| After 90 seconds | Min 1, max 2, raise 2 | Penalty 0 agents are no longer considered. The caller continues with the overflow tiers only. |
| Task | How to do it |
|---|---|
| Create | Select the new action from the Queues list, fill the required fields, and select Save. |
| Edit | Open the existing queue, update the needed fields, and select Save. |
| Delete | Before deleting a queue, check call-flow, destination, schedule, report, provisioning, or integration references. Use the row delete action or the form delete action when available, then confirm. |
| Task | How to do it |
|---|---|
| Add | Select the New custom destination action, complete the form, and select Save. |
| Edit | Open the custom destination from the list by selecting its name, number, or row action. Change the form and select Save. |
| Delete | Select the row checkbox and use Delete Selected, or open the custom destination and select Delete, then confirm. |
| Action | Description |
|---|---|
| New Custom Destination | Opens the creation form for a new custom destination. |
| Delete Selected | Deletes the selected rows after confirmation. |
| Column | Description |
|---|---|
| Type | Mode selector that changes the behavior of the object. |
| Name | Display name used in lists and references. |
| Parameter | Object setting shown by the form. |
| Action | Object setting shown by the form. |
| Field | Description |
|---|---|
| Type: | Mode selector that changes the behavior of the object. |
| Name: | Display name used in lists and references. |
| Queue timeout: | Timeout in seconds to use for the next Queue destination only. Leave the custom destination out of the flow when the queue should use its configured timeout. |
| Phone number: | Dialed value, identifier, or matching value used by the PBX. |
| Dial timeout: | Timing value used by the service. |
| CallerID Number: | Dialed value, identifier, or matching value used by the PBX. |
| CallerID Name: | Display name used in lists and references. |
| Add diversion header: | Object setting shown by the form. |
| Diversion header CallerID Number: | Dialed value, identifier, or matching value used by the PBX. |
| Min silence time (ms): | Object setting shown by the form. |
| Silence threshold: | Object setting shown by the form. |
| Caller buddy language: | Caller ID or caller matching value. |
| Called buddy language: | Language or voice selection used for prompts, transcription, or speech synthesis. |
| Generative Artificial Intelligence: | Object setting shown by the form. |
| API key: | Object setting shown by the form. |
| Model: | Object setting shown by the form. |
| System Content: | Object setting shown by the form. |
| User Content: | Object setting shown by the form. |
| Assistant Content: | Object setting shown by the form. |
| Functions: | Object setting shown by the form. |
| Greeting Message: | Object setting shown by the form. |
| Temperature: | Object setting shown by the form. |
| Max Tokens: | Object setting shown by the form. |
| Realtime Voice: | Language or voice selection used for prompts, transcription, or speech synthesis. |
| Turn Detection: | Object setting shown by the form. |
| Semantic VAD eagerness: | Object setting shown by the form. |
| Server VAD threshold: | Server, host, or node selection used by the object. |
| Prefix padding (ms): | Dialed value, identifier, or matching value used by the PBX. |
| Silence duration (ms): | Object setting shown by the form. |
| Field | Description |
|---|---|
| Queue timeout | Seconds to pass to the next Queue application instead of the selected queue’s stored timeout. |
| Task | How to do it |
|---|---|
| Create | Select the new action from the Custom Destinations list, fill the required fields, and select Save. |
| Edit | Open the existing custom destination, update the needed fields, and select Save. |
| Delete | Before deleting a custom destination, check call-flow, destination, schedule, report, provisioning, or integration references. Use the row delete action or the form delete action when available, then confirm. |
| Task | How to do it |
|---|---|
| Add | Select the New feature code action, complete the form, and select Save. |
| Edit | Open the feature code from the list by selecting its name, number, or row action. Change the form and select Save. |
| Delete | Select the row checkbox and use Delete Selected, or open the feature code and select Delete, then confirm. |
| Action | Description |
|---|---|
| New Feature | Opens the creation form for a new feature. |
| Map Features | Opens a related mapping page. |
| Dynamic Features | Runs the Dynamic Features action. |
| Delete Selected | Deletes the selected rows after confirmation. |
| Column | Description |
|---|---|
| Code | Dialed value, identifier, or matching value used by the PBX. |
| Comment | Administrative note shown in lists and reports. |
| Action | Object setting shown by the form. |
| Field | Description |
|---|---|
| Code: | Dialed value, identifier, or matching value used by the PBX. |
| Comment: | Administrative note shown in lists and reports. |
| Task | How to do it |
|---|---|
| Create | Select the new action from the Feature Codes list, fill the required fields, and select Save. |
| Edit | Open the existing feature code, update the needed fields, and select Save. |
| Delete | Before deleting a feature code, check call-flow, destination, schedule, report, provisioning, or integration references. Use the row delete action or the form delete action when available, then confirm. |
| Code | Description | Parameter use |
|---|---|---|
| `STARTCAMPAIGN-{campaign_id}` | Starts the selected ONDEMAND campaign. Before setting the campaign state to STARTNOW, MiRTA PBX resets the campaign call attempts, last attempt time, bill seconds, and disposition. For FAX campaigns it also clears fields 1, 2, and 3, matching the Reset Calls behavior in the campaigns page. | Campaign selection; ONDEMAND campaigns only |
| `STOPCAMPAIGN-{campaign_id}` | Stops the selected ONDEMAND campaign by setting its state back to READY. | Campaign selection; ONDEMAND campaigns only |
| `RESETCAMPAIGNCALLS-{campaign_id}` | Resets all numbers for the selected campaign without changing the campaign state. It is available for campaigns of any type and performs the same reset as the Reset Calls action in the campaigns page. | Campaign selection |
| Code | Description | Parameter use |
|---|---|---|
| `SETDEFAULTMOH-{music_on_hold_id}` | Sets the selected Music On Hold class as the tenant default by updating the tenant `DEFAULTMOH` setting. It is commonly used in cronjobs to switch the tenant hold music on a schedule. The action does not answer, hang up, or play audio; execution continues to any following destination. | Music On Hold selection; tenant or shared Music On Hold records only |
| Mode | Description |
|---|---|
| Smart match | Compares the rightmost common part of the caller ID and the phone book number. A leading `+` is ignored. For example, an 11 digit caller ID can match a 10 digit phone book number by its last 10 digits, and a 10 digit caller ID can match the last 10 digits of an 11 digit phone book number. |
| Using regex | Allows the phone book `PHONE1` through `PHONE7` value to be used as a regular expression against the caller ID. Normal exact and prefix phone number matching is also retained for these actions. |
| Code | Description | Parameter use |
|---|---|---|
| `EXACTPHONEBOOK-{phone_book_id}` | Routes the call to the `ROUTING` destination configured on the matched entry in the selected phone book, using smart match. The code name is kept for compatibility with older dialplans. | Selected phone book id |
| `PHONEBOOK-{phone_book_id}` | Routes the call to the `ROUTING` destination configured on the matched entry in the selected phone book, allowing regex matching. | Selected phone book id |
| `ROUTEBYANYPHONEBOOK` | Routes the call to the `ROUTING` destination configured on the first smart-matched entry in any tenant phone book. | Uses the current caller ID; no explicit parameter |
| `ROUTEBYANYPHONEBOOKUSINGREGEX` | Routes the call to the `ROUTING` destination configured on the first regex-matched entry in any tenant phone book. | Uses the current caller ID; no explicit parameter |
| Code | Description | Parameter use |
|---|---|---|
| `CLIDNAMEBYPHONEBOOK-{phone_book_id}` | Sets the call caller ID name from the `NAME` field on the matched entry in the selected phone book, using smart match. It does not route the call; execution continues to the next destination. | Selected phone book id |
| `CLIDNAMEBYPHONEBOOKUSINGREGEX-{phone_book_id}` | Sets the call caller ID name from the `NAME` field on the matched entry in the selected phone book, allowing regex matching. It does not route the call; execution continues to the next destination. | Selected phone book id |
| `SETCALLERIDNAMEBYANYPHONEBOOK` | Sets the call caller ID name from the `NAME` field on the first smart-matched entry in any tenant phone book. It does not route the call; execution continues to the next destination. | Uses the current caller ID; no explicit parameter |
| `SETCALLERIDNAMEBYANYPHONEBOOKUSINGREGEX` | Sets the call caller ID name from the `NAME` field on the first regex-matched entry in any tenant phone book. It does not route the call; execution continues to the next destination. | Uses the current caller ID; no explicit parameter |
| Code | Description | Parameter use |
|---|---|---|
| `ADDCALLERIDADEMCO` | Add the CallerID number to Ademco Alarms for this tenant | No explicit parameter |
| `ADDVIRTUALASSIGN` | Add the calling extension to virtual extension \[EXT\] | \[EXT\] parameter required |
| `ADDVIRTUALASSIGNREBOOT` | Add the calling extension to virtual extension \[EXT\] and reboot it | \[EXT\] parameter required |
| `ADDVIRTUALASSIGNRESYNC` | Add the calling extension to virtual extension \[EXT\] and resync it | \[EXT\] parameter required |
| `ALARMRECEIVER` | Receive an Ademco Alarm report | No explicit parameter |
| `ALLOWCALLEDSTARTSTOPRECORDING` | Allow called to start and stop recording the call | No explicit parameter |
| `ALLOWCALLEDTRANSFER` | Allow transfer from called party | No explicit parameter |
| `ALLOWCALLERSTARTSTOPRECORDING` | Allow caller to start and stop recording the call | No explicit parameter |
| `ALLOWCALLERTRANSFER` | Allow transfer from caller party | No explicit parameter |
| `ALWAYSMATCH` | Always follow match destination | No explicit parameter |
| `ALWAYSNOTMATCH` | Always follow to not match destination | No explicit parameter |
| `ANSWER` | Answer the call | No explicit parameter |
| `ANSWEREDELSEWHERE` | Always report calls as answered elsewhere | No explicit parameter |
| `BARGE` | Barge with extension \[EXT\] | \[EXT\] parameter required |
| `BLACKLISTLASTONE` | Blacklist last received caller ID | Uses the current call context |
| `BLACKLISTNUM` | Blacklist number \[NUM\] | \[NUM\] parameter required |
| `BLOCKCID` | Block External Caller ID for dialing extension | Uses the current call context |
| `BUSY` | Busy | No explicit parameter |
| `CALLBACKANYLASTONE` | Callback last received caller ID, any type of call | Uses the current call context |
| `CALLBACKBLIND` | Call back blind transfering extension | No explicit parameter |
| `CALLBACKLASTONE` | Callback last received caller ID, inbound external call | Uses the current call context |
| `CALLBACKONFMFMNUMBER` | Call back on FMFM number and then dial \[NUM\] | \[NUM\] parameter required |
| `CHANGEPINLOCK` | Change the PIN to unlock the phone | No explicit parameter |
| `CHECKSCHEDULEDBYCLID` | Checks for a due scheduled call in READY state where the scheduled destination number matches the current caller ID, plays the scheduled message, marks the scheduled call completed, and then continues the call flow. | Uses the current call context |
| `CLEANVIRTUALASSIGN` | Remove all extensions from virtual extension \[EXT\] | \[EXT\] parameter required |
| `CLEANVIRTUALASSIGNREBOOT` | Remove all extensions from virtual extension \[EXT\] and reboot them | \[EXT\] parameter required |
| `CLEANVIRTUALASSIGNRESYNC` | Remove all extensions from virtual extension \[EXT\] and resync them | \[EXT\] parameter required |
| `CLEARMWI` | Clear MWI for extension \[EXT\] | \[EXT\] parameter required |
| `CLEARMYMWI` | Clear MWI for the calling extension | Uses the current call context |
| `CLEARNOFOLLOWEXTENSION` | Reset following additional destinations for called extension | Uses the current call context |
| `CLEARONANSWER` | Clear On Answer configuration | No explicit parameter |
| `CONGESTION` | Signal congestion to the calling party | No explicit parameter |
| `CONTINUEONHANGUP` | Continue execution when called party hangup | No explicit parameter |
| `DELETEWAKEUPALARM` | Wakeup Alarm - Disable the time set | No explicit parameter |
| `DIALBYNAMEDIRECTORY` | Dial by name directory | No explicit parameter |
| `DIALBYNAMENUMBER` | Dial by name using the \[NUM\] dialed | \[NUM\] parameter required |
| `DIALFMFM` | Dial FMFM number associated to extension \[EXT\] | \[EXT\] parameter required |
| `DIALTHISFMFM` | Dial the FMFM number for this extension | No explicit parameter |
| `DISABLEABUSE` | Disable Abuse Detection | No explicit parameter |
| `DISABLECHECKTEAMSTATUS` | Disable checking the Teams status for extensions | No explicit parameter |
| `DISABLEDND` | Disable DND on the calling extension | Uses the current call context |
| `DISABLEFMFM` | Disable FMFM on the calling extension | Uses the current call context |
| `DISABLEONBUSY` | Disable on busy forwarding for calling extension | Uses the current call context |
| `DISABLEONNOANSWER` | Disable on no answer forwarding for calling extension | Uses the current call context |
| `DISABLEONOFFLINE` | Disable on offline forwarding for calling extension | Uses the current call context |
| `DISABLEREALDND` | Disable DND on the physical phone extension | No explicit parameter |
| `DISABLEUNCONDITIONAL` | Disable unconditional forwarding for calling extension | Uses the current call context |
| `DONTTRANSCRIBETHISCALL` | Do not transcribe this call | No explicit parameter |
| `DUMPCHAN` | Dump channel variables (useful only for debug) | Uses the current call context |
| `ECHOTEST` | Echo test | No explicit parameter |
| `ENABLECHECKTEAMSTATUS` | Enable checking the Teams status for extensions | No explicit parameter |
| `ENABLEDND` | Enable DND on the calling extension | Uses the current call context |
| `ENABLEFMFM` | Enable FMFM on the calling extension | Uses the current call context |
| `ENABLEONBUSY` | Enable on busy forwarding for calling extension | Uses the current call context |
| `ENABLEONNOANSWER` | Enable on no answer forwarding for calling extension | Uses the current call context |
| `ENABLEONOFFLINE` | Enable on offline forwarding for calling extension | Uses the current call context |
| `ENABLEREALDND` | Enable DND on the physical phone extension | No explicit parameter |
| `ENABLEUNCONDITIONAL` | Enable unconditional forwarding for calling extension | Uses the current call context |
| `FORCEMOH` | Generate Music on Hold to the calling party | No explicit parameter |
| `FORCERECORDING` | Force Recording of the call | No explicit parameter |
| `FORCERECORDINGNOB` | Force Recording of the call, even if not bridged | No explicit parameter |
| `FORCERINGING` | Generate a fake ringing tone to the calling party | No explicit parameter |
| `GETBALANCE` | Load the current account balance in variable ACCOUNTBALANCE | No explicit parameter |
| `HANGUP` | Hangup the call | No explicit parameter |
| `INTERCOM` | Intercom with extension \[EXT\] (two way audio) | \[EXT\] parameter required |
| `INVERTMATCH` | Invert condition match | No explicit parameter |
| `LOADVARS` | Load Flow variables | No explicit parameter |
| `LOCKPHONE` | Lock the phone | No explicit parameter |
| `LOGINALLOWEDQUEUEALL` | Login to all Queues, but only if in allowed agents | No explicit parameter |
| `LOGINQUEUEALL` | Login to all Queues | No explicit parameter |
| `LOGINQUEUENUM` | Login caller to Queue \[NUM\] | \[NUM\] parameter required |
| `LOGOUTQUEUEALL` | Logout from all Queues | No explicit parameter |
| `LOGOUTQUEUENUM` | Logout caller from Queue \[NUM\] | \[NUM\] parameter required |
| `MASKDIAL` | Mask the callerID on calling \[NUM\] | \[NUM\] parameter required |
| `NEVERANSWEREDELSEWHERE` | Never report calls as answered elsewhere | No explicit parameter |
| `NOFOLLOWEXTENSION` | Disable following additional destinations for called extension | Uses the current call context |
| `ONBUSYASKRESERVATION` | On internal call busy, ask for reservation | No explicit parameter |
| `ONBUSYCALLWAITING` | On internal call busy, play Call Waiting Tone to caller | No explicit parameter |
| `ONBUSYPLAYANDASKRESERVATION` | On internal call busy, play busy and ask for reservation | No explicit parameter |
| `PAGE` | Page extension \[EXT\] (one way audio) | \[EXT\] parameter required |
| `PARKTHECALL` | Park the call | No explicit parameter |
| `PARKTHECALLMUTE` | Park the call without announce | No explicit parameter |
| `PARKTHECALLNUM` | Park the call in the \[NUM\] parking lot | \[NUM\] parameter required |
| `PAUSEALLCAMPAIGNS` | Pause all running campaigns | No explicit parameter |
| `PAUSEALLQUEUES` | Pause caller from all queues | No explicit parameter |
| `PICKUPEXTEN` | Pickup Extension \[EXT\] | \[EXT\] parameter required |
| `PICKUPGROUP` | Pickup Group | No explicit parameter |
| `PLAYBALANCE` | Play the current account balance | No explicit parameter |
| `PLAYBEEP` | Play Beep | No explicit parameter |
| `PLAYCALLERID` | Play the callerid of the calling party | No explicit parameter |
| `PLAYLASTANDASKDIAL` | Play latest caller ID and ask to dial | Uses the current call context |
| `PLAYLASTWITHTIMEANDASKDIAL` | Play latest caller ID with time and ask to dial | Uses the current call context |
| `PLAYMOH` | Play Music on Hold | No explicit parameter |
| `PLAYWAKEUPALARM` | Wakeup Alarm - Play the time set | No explicit parameter |
| `PROGRESS` | Progress | No explicit parameter |
| `QUEUECALLBACK` | Exit the Queue and call back when it is your turn | No explicit parameter |
| `RECEIVEFAX` | Receive Fax | No explicit parameter |
| `RECORDDIALBYNAME` | Record Dial By Name message | No explicit parameter |
| `RECORDLEG` | Answer and record the call leg | No explicit parameter |
| `RECORDMESSAGE` | Record a Message | No explicit parameter |
| `RECORDMESSAGESILENT` | Record a Message (silent version) | No explicit parameter |
| `REDIAL` | Redial latest outbound dialed number | No explicit parameter |
| `REDIALANY` | Redial latest dialed number, even internal | No explicit parameter |
| `REMOVEANYVIRTUAL` | Remove the calling extension from any virtual extension | Uses the current call context |
| `REMOVEANYVIRTUALREBOOT` | Remove the calling extension from any virtual extension and reboot it | Uses the current call context |
| `REMOVEANYVIRTUALRESYNC` | Remove the calling extension from any virtual extension and resync it | Uses the current call context |
| `REMOVEVIRTUALASSIGN` | Remove the calling extension from virtual extension \[EXT\] | \[EXT\] parameter required |
| `REMOVEVIRTUALASSIGNREBOOT` | Remove the calling extension from virtual extension \[EXT\] and reboot it | \[EXT\] parameter required |
| `REMOVEVIRTUALASSIGNRESYNC` | Remove the calling extension from virtual extension \[EXT\] and resync it | \[EXT\] parameter required |
| `RESETABUSEDETECTION` | Reset calling extension abuse detection history | Uses the current call context |
| `RESETAUTOANSWER` | Clear Auto Answer for the channel | Uses the current call context |
| `RESETDIALOPTIONS` | Reset the Dial Options | No explicit parameter |
| `RESETTTL` | Reset the TTL value | No explicit parameter |
| `RESTOREMATCH` | Restore condition match | No explicit parameter |
| `RETURNTOPREVIVR` | Return to the previous IVR | No explicit parameter |
| `ROUTEBYANYPHONEBOOK` | Route using the first smart-matched entry in any tenant phone book | Uses the current caller ID; no explicit parameter |
| `ROUTEBYANYPHONEBOOKUSINGREGEX` | Route using the first regex-matched entry in any tenant phone book | Uses the current caller ID; no explicit parameter |
| `RINGING` | Send the ringing tone while waiting to be connected | No explicit parameter |
| `RINGWITHMOH` | Play MOH to caller while ringing | No explicit parameter |
| `SAYDATETIME` | Say the date and time | No explicit parameter |
| `SAYPARKEDCALLS` | Say the parked calls extensions | No explicit parameter |
| `SELFVOICEMAILMANAGER` | Retrieve the voicemail of the calling extension | Uses the current call context |
| `SENTIMENTALANALYZETHISCALL` | Sentimental analyze this call | No explicit parameter |
| `SETAUTOANSWER` | Set Auto Answer for the channel | Uses the current call context |
| `SETCALLERIDBYCNAM` | Set the CallerID Name based on the CallerID Number CNAM | No explicit parameter |
| `SETCALLERIDNAMEBYANYPHONEBOOK` | Set the caller ID name using the first smart-matched entry in any tenant phone book | Uses the current caller ID; no explicit parameter |
| `SETCALLERIDNAMEBYANYPHONEBOOKUSINGREGEX` | Set the caller ID name using the first regex-matched entry in any tenant phone book | Uses the current caller ID; no explicit parameter |
| `SETCALLINGEXTINUSE` | Set calling extension state to in use | Uses the current call context |
| `SETEARLYMEDIA` | Send audio playback without answering (Early Media) | No explicit parameter |
| `SETEXTALLALLOWED` | Set calling extension outbound calls to All Allowed | Uses the current call context |
| `SETEXTALLPROHIBITED` | Set calling extension outbound calls to All Prohibited | Uses the current call context |
| `SETFMFMNUMBER` | Set FMFM number to \[NUM\] and enable it | \[NUM\] parameter required |
| `SETINUSE` | Set Extension \[EXT\] state to in use | \[EXT\] parameter required |
| `SETNOTINUSE` | Set Extension \[EXT\] state to not in use | \[EXT\] parameter required |
| `SETONBUSY` | Set on busy forwarding for calling extension to \[NUM\] | \[NUM\] parameter required |
| `SETONNOANSWER` | Set on no answer forwarding for calling extension to \[NUM\] | \[NUM\] parameter required |
| `SETONOFFLINE` | Set on offline forwarding for calling extension to \[NUM\] | \[NUM\] parameter required |
| `SETUNCONDITIONAL` | Set unconditional forwarding for calling extension to \[NUM\] | \[NUM\] parameter required |
| `SETWAKEUPALARM` | Wakeup Alarm - Set the time from DTMF HHMM | No explicit parameter |
| `SIMPLEPLAYCALLERID` | Play just the callerid number and name of the calling party | No explicit parameter |
| `SPY` | Spy extension \[EXT\] | \[EXT\] parameter required |
| `STOPRECORDING` | Stop recording the call | No explicit parameter |
| `STOPTRANSLATIONBUDDY` | Stop translation buddy | No explicit parameter |
| `STOPWARNINGNOTICEFORRECORDING` | Stop the warning notice for recording (only if not recorded) | No explicit parameter |
| `SUMMARIZETHISCALL` | Summarize this call | No explicit parameter |
| `SWB456` | Spy/Whisper/Barge extension \[EXT\] | \[EXT\] parameter required |
| `TOGGLECW` | Toggle Call Waiting on the calling extension | Uses the current call context |
| `TOGGLEDIALEDSTATUS` | Toggle state of dialed extension | No explicit parameter |
| `TOGGLEDND` | Toggle DND for the calling extension | Uses the current call context |
| `TOGGLEFMFM` | Toggle FMFM for the calling extension | Uses the current call context |
| `TOGGLEFMFMEXT` | Toggle FMFM for extension \[EXT\] | \[EXT\] parameter required |
| `TOGGLELOGINQUEUENUM` | Toggle Login/Logout caller to Queue \[NUM\] | \[NUM\] parameter required |
| `TOGGLEPAUSEALLQUEUES` | Toggle pause on all queues | No explicit parameter |
| `TOGGLEPHONELOCK` | Lock/unlock the phone | No explicit parameter |
| `TOGGLESTATE` | Toggle state of extension \[EXT\] | \[EXT\] parameter required |
| `TOGGLEUNCONDITIONAL` | Toggle Unconditional Forward for calling extension | Uses the current call context |
| `TRANSCRIBETHISCALL` | Transcribe this call | No explicit parameter |
| `UNBLACKLISTNUM` | Remove the number \[NUM\] from blacklist | \[NUM\] parameter required |
| `UNBLOCKCID` | Remove Block External Caller ID for dialing extension | Uses the current call context |
| `UNLOCKPHONE` | Unlock the phone | No explicit parameter |
| `UNMASKDIAL` | Unmask the callerID on calling \[NUM\] | \[NUM\] parameter required |
| `UNPAUSEALLQUEUES` | Unpause caller to all queues | No explicit parameter |
| `VOICEMAILEXTEN` | Voicemail for Extension \[EXT\] | \[EXT\] parameter required |
| `VOICEMAILMAIN` | Comedian Voicemail system | No explicit parameter |
| `VOICEMAILMANAGEREXTEN` | Retrieve the voicemail of the \[EXT\] dialed | \[EXT\] parameter required |
| `WAIT1` | Wait one second | No explicit parameter |
| `WAIT10` | Wait ten seconds | No explicit parameter |
| `WAIT15` | Wait fifteen seconds | No explicit parameter |
| `WAIT20` | Wait twenty seconds | No explicit parameter |
| `WAIT5` | Wait five seconds | No explicit parameter |
| `WAITFORCALLERREADY` | Wait for caller execution completed | No explicit parameter |
| `WHISPER` | Whisper to extension \[EXT\] | \[EXT\] parameter required |
| Task | How to do it |
|---|---|
| Add | Use the grid add control to create a new short number. Fill the row editor and save it. |
| Edit | Select an existing short number row and use the grid edit control. Save the edited row. |
| Delete | Select one or more short number rows and use the grid delete control, then confirm. |
| Action | Description |
|---|---|
| CSV Load | Opens import or upload tools for bulk data. |
| Column | Description |
|---|---|
| Short Number | Dialed value, identifier, or matching value used by the PBX. |
| Full Number | Dialed value, identifier, or matching value used by the PBX. |
| Comment | Administrative note shown in lists and reports. |
| No records to view | Recording behavior or recording delivery setting. |
| Task | How to do it |
|---|---|
| Add | Select the New campaign action, complete the form, and select Save. |
| Edit | Open the campaign from the list by selecting its name, number, or row action. Change the form and select Save. |
| Delete | Select the row checkbox and use Delete Selected, or open the campaign and select Delete, then confirm. |
| Action | Description |
|---|---|
| New Campaign | Opens the creation form for a new campaign. |
| Delete Selected | Deletes the selected rows after confirmation. |
| Find | Searches for the number or record entered in the find field. |
| Column | Description |
|---|---|
| Name | Display name used in lists and references. |
| Tech | Object setting shown by the form. |
| Start | Object setting shown by the form. |
| End | Object setting shown by the form. |
| Calls Running / Max | Object setting shown by the form. |
| Max Attempts | Object setting shown by the form. |
| \# Numbers/Max | Dialed value, identifier, or matching value used by the PBX. |
| State | Mode selector that changes the behavior of the object. |
| Section | Description |
|---|---|
| Information | Core identity and routing fields for the object. |
| Voice | Voice calling behavior, caller handling, recording, and voice-specific limits. |
| Parameters | Additional runtime parameters used by the object. |
| Field | Description |
|---|---|
| Name: | Display name used in lists and references. |
| CallerID: | Caller ID or caller matching value. |
| CallerID Name: | Display name used in lists and references. |
| Tech: | Object setting shown by the form. |
| Type: | Mode selector that changes the behavior of the object. |
| Start: | Object setting shown by the form. |
| End: | Object setting shown by the form. |
| Week Time condition: | Object setting shown by the form. |
| Max # of campaign numbers: | Dialed value, identifier, or matching value used by the PBX. |
| Dial timeout: | Timing value used by the service. |
| On connect callerid name: | Display name used in lists and references. |
| confirm | Object setting shown by the form. |
| Confirm message: | Object setting shown by the form. |
| Max Channels: | Object setting shown by the form. |
| Check queue for free agents: | Object setting shown by the form. |
| Allowed channels for each of the free agents: | Object setting shown by the form. |
| Min num of free agents: | Object setting shown by the form. |
| Max Attempts: | Object setting shown by the form. |
| Sum other campaigns | Object setting shown by the form. |
| Delay Between Attempts: | Timing value used by the service. |
| Always Record: | Recording behavior or recording delivery setting. |
| Email recording to: | Email address used for notifications, delivery, or mailbox access. |
| Minimum Size (bytes): | Object setting shown by the form. |
| Fax quality: | Object setting shown by the form. |
| Page size: | Object setting shown by the form. |
| Page rotate: | Object setting shown by the form. |
| File in PDF or TIFF format: | File upload or file name used by the object. |
| Message: | Object setting shown by the form. |
| Task | How to do it |
|---|---|
| Create | Select the new action from the Call, SMS, and Fax Campaigns list, fill the required fields, and select Save. |
| Edit | Open the existing campaign, update the needed fields, and select Save. |
| Delete | Before deleting a campaign, check call-flow, destination, schedule, report, provisioning, or integration references. Use the row delete action or the form delete action when available, then confirm. |
| Task | How to do it |
|---|---|
| Add one number | Use the grid add control, enter the phone number and optional fields, then save. |
| Edit | Select the existing row and use the grid edit control. |
| Delete | Select one or more rows and use the grid delete control, then confirm. |
| Bulk import | Select the paste icon in the bottom grid toolbar, paste the numbers, and select Import. |
| Column | Imported field |
|---|---|
| 1 | Phone number |
| 2 | Description |
| 3 | Disposition |
| 4-13 | Custom fields F1 through F10, when those fields are used by the campaign type. |
| Action | Description |
|---|---|
| CSV/XLS Import | Opens the structured file import workflow for campaign numbers. |
| CSV Export / XLS Export | Exports the current campaign number list when export permissions are enabled. |
| Remove Duplicates | Removes duplicate campaign number entries from the selected campaign. |
| Enable Auto-Refresh | Refreshes the grid periodically while campaign processing is active. |
| Task | How to do it |
|---|---|
| Add | Select the New AGI script action, complete the form, and select Save. |
| Edit | Open the AGI script from the list by selecting its name, number, or row action. Change the form and select Save. |
| Delete | Select the row checkbox and use Delete Selected, or open the AGI script and select Delete, then confirm. |
| Column | Description |
|---|---|
| Name | Display name used in lists and references. |
| Path | Object setting shown by the form. |
| Parameters | Object setting shown by the form. |
| Param. 1 | Object setting shown by the form. |
| Param. 2 | Object setting shown by the form. |
| Param. 3 | Object setting shown by the form. |
| Param. 4 | Object setting shown by the form. |
| Param. 5 | Object setting shown by the form. |
| Task | How to do it |
|---|---|
| Create | Select the new action from the AGI Scripts list, fill the required fields, and select Save. |
| Edit | Open the existing AGI script, update the needed fields, and select Save. |
| Delete | Before deleting a AGI script, check call-flow, destination, schedule, report, provisioning, or integration references. Use the row delete action or the form delete action when available, then confirm. |
| Task | How to do it |
|---|---|
| Add | Select the New voicemail mailbox action, complete the form, and select Save. |
| Edit | Open the voicemail mailbox from the list by selecting its name, number, or row action. Change the form and select Save. |
| Delete | Select the row checkbox and use Delete Selected, or open the voicemail mailbox and select Delete, then confirm. |
| Action | Description |
|---|---|
| New Voicemail | Opens the creation form for a new voicemail. |
| Delete Selected | Deletes the selected rows after confirmation. |
| Enable jqGrid | Switches the table display mode for advanced grid controls. |
| Column | Description |
|---|---|
| Mailbox | Object setting shown by the form. |
| PIN | Credential or PIN value. Treat it as sensitive. |
| Name | Display name used in lists and references. |
| Email address used for notifications, delivery, or mailbox access. | |
| Pager | Object setting shown by the form. |
| Attach | Object setting shown by the form. |
| Language | Language or voice selection used for prompts, transcription, or speech synthesis. |
| Actions | Object setting shown by the form. |
| Section | Description |
|---|---|
| Information | Core identity and routing fields for the object. |
| Messages | Settings shown in the Messages block. |
| Operator/Extras | Settings shown in the Operator/Extras block. |
| Greetings | Settings shown in the Greetings block. |
| Field | Description |
|---|---|
| Mailbox: | Object setting shown by the form. |
| PIN: | Credential or PIN value. Treat it as sensitive. |
| Name: | Display name used in lists and references. |
| Email: | Email address used for notifications, delivery, or mailbox access. |
| Timezone: | Object setting shown by the form. |
| Pager: | Object setting shown by the form. |
| Envelope playback: | Object setting shown by the form. |
| Say Caller ID: | Caller ID or caller matching value. |
| Attach message: | Object setting shown by the form. |
| Store transcript and summary: | Object setting shown by the form. |
| Generate transcript: | Object setting shown by the form. |
| Generate summary: | Object setting shown by the form. |
| Automatic delete: | Object setting shown by the form. |
| Delete older messages: | Object setting shown by the form. |
| Allow review: | Object setting shown by the form. |
| Allow callback: | Object setting shown by the form. |
| Allow dialout: | Object setting shown by the form. |
| Play a message after the other: | Object setting shown by the form. |
| Include in Dial By Name Directory: | Display name used in lists and references. |
| Greeting: | Object setting shown by the form. |
| Language: | Language or voice selection used for prompts, transcription, or speech synthesis. |
| Max number of messages: | Dialed value, identifier, or matching value used by the PBX. |
| Min len of a voicemail message in seconds: | Email address used for notifications, delivery, or mailbox access. |
| Max len of a voicemail message in seconds: | Email address used for notifications, delivery, or mailbox access. |
| Backup messages: | Object setting shown by the form. |
| On new message: | Object setting shown by the form. |
| URL: | Object setting shown by the form. |
| POST data: | Object setting shown by the form. |
| Task | How to do it |
|---|---|
| Create | Select the new action from the Voicemails list, fill the required fields, and select Save. |
| Edit | Open the existing voicemail mailbox, update the needed fields, and select Save. |
| Delete | Before deleting a voicemail mailbox, check call-flow, destination, schedule, report, provisioning, or integration references. Use the row delete action or the form delete action when available, then confirm. |
| Task | How to do it |
|---|---|
| Add | Select the New phone action, complete the form, and select Save. |
| Edit | Open the phone from the list by selecting its name, number, or row action. Change the form and select Save. |
| Delete | Select the row checkbox and use Delete Selected, or open the phone and select Delete, then confirm. |
| Action | Description |
|---|---|
| New Phone | Opens the creation form for a new phone. |
| Resync config | Sends the selected device operation to the selected phones. |
| Reboot | Sends the selected device operation to the selected phones. |
| Delete Selected | Deletes the selected rows after confirmation. |
| Column | Description |
|---|---|
| Name | Display name used in lists and references. |
| Phone Model | Object setting shown by the form. |
| Extensions | Target or routing selection used when the object sends a call or message onward. |
| MAC plain | Object setting shown by the form. |
| Autoprovisioning URL | Object setting shown by the form. |
| Field | Description |
|---|---|
| Name: | Display name used in lists and references. |
| Description: | Free-form notes about the phone, such as physical location, assigned user, install details, or operational comments. This value is informational only and is not used for provisioning generation or call processing. |
| Virtual phone provisioning | Object setting shown by the form. |
| Model: | Object setting shown by the form. |
| MAC Address: | Object setting shown by the form. |
| Secret: | Credential or PIN value. Treat it as sensitive. |
| Accept data from phone | Object setting shown by the form. |
| Optional file name: | Display name used in lists and references. |
| HTTP/S Username: | Display name used in lists and references. |
| HTTP/S Password: | Credential or PIN value. Treat it as sensitive. |
| Line 0: | Object setting shown by the form. |
| Line 1: | Object setting shown by the form. |
| Line 2: | Object setting shown by the form. |
| Line 3: | Object setting shown by the form. |
| Line 4: | Object setting shown by the form. |
| Line 5: | Object setting shown by the form. |
| Task | How to do it |
|---|---|
| Create | Select the new action from the Phones list, fill the required fields, and select Save. |
| Edit | Open the existing phone, update the needed fields, and select Save. |
| Delete | Before deleting a phone, check call-flow, destination, schedule, report, provisioning, or integration references. Use the row delete action or the form delete action when available, then confirm. |
| Task | How to do it |
|---|---|
| Add | Select the New button layout action, complete the form, and select Save. |
| Edit | Open the button layout from the list by selecting its name, number, or row action. Change the form and select Save. |
| Delete | Select the row checkbox and use Delete Selected, or open the button layout and select Delete, then confirm. |
| Action | Description |
|---|---|
| New Button Layout | Opens the creation form for a new button layout. |
| Delete Selected | Deletes the selected rows after confirmation. |
| Column | Description |
|---|---|
| Name | Display name used in lists and references. |
| Template | Object setting shown by the form. |
| Code | Dialed value, identifier, or matching value used by the PBX. |
| Start | Object setting shown by the form. |
| End | Object setting shown by the form. |
| Actions | Object setting shown by the form. |
| Field | Description |
|---|---|
| Name: | Display name used in lists and references. |
| Button Layout Template: | Object setting shown by the form. |
| Code: | Dialed value, identifier, or matching value used by the PBX. |
| usephonebook | Object setting shown by the form. |
| Phone Book: | Object setting shown by the form. |
| Start: | Object setting shown by the form. |
| End: | Object setting shown by the form. |
| Task | How to do it |
|---|---|
| Create | Select the new action from the Button Layouts list, fill the required fields, and select Save. |
| Edit | Open the existing button layout, update the needed fields, and select Save. |
| Delete | Before deleting a button layout, check call-flow, destination, schedule, report, provisioning, or integration references. Use the row delete action or the form delete action when available, then confirm. |
| Task | How to do it |
|---|---|
| Add | Select the New custom file action, complete the form, and select Save. |
| Edit | Open the custom file from the list by selecting its name, number, or row action. Change the form and select Save. |
| Delete | Select the row checkbox and use Delete Selected, or open the custom file and select Delete, then confirm. |
| Action | Description |
|---|---|
| New Custom File | Opens the creation form for a new custom file. |
| Delete Selected | Deletes the selected rows after confirmation. |
| Column | Description |
|---|---|
| Name | Display name used in lists and references. |
| Description | Administrative note shown in lists and reports. |
| User agent regex | Object setting shown by the form. |
| Size | Object setting shown by the form. |
| Field | Description |
|---|---|
| Name: | Display name used in lists and references. |
| Description: | Administrative note shown in lists and reports. |
| User agent regex: | Object setting shown by the form. |
| File: | File upload or file name used by the object. |
| Task | How to do it |
|---|---|
| Create | Select the new action from the Custom Files list, fill the required fields, and select Save. |
| Edit | Open the existing custom file, update the needed fields, and select Save. |
| Delete | Before deleting a custom file, check call-flow, destination, schedule, report, provisioning, or integration references. Use the row delete action or the form delete action when available, then confirm. |
| Task | How to do it |
|---|---|
| Add | Select the New music on hold class action, complete the form, and select Save. |
| Edit | Open the music on hold class from the list by selecting its name, number, or row action. Change the form and select Save. |
| Delete | Select the row checkbox and use Delete Selected, or open the music on hold class and select Delete, then confirm. |
| Action | Description |
|---|---|
| Download | Downloads or exports the currently available data. |
| New Music On Hold | Opens the creation form for a new music on hold. |
| Delete Selected | Deletes the selected rows after confirmation. |
| Column | Description |
|---|---|
| Name | Display name used in lists and references. |
| Media Files | File upload or file name used by the object. |
| Custom | Object setting shown by the form. |
| Randomize order | Object setting shown by the form. |
| Default | Object setting shown by the form. |
| Section | Description |
|---|---|
| Information | Core identity and routing fields for the object. |
| Streaming source | Settings shown in the Streaming source block. |
| Field | Description |
|---|---|
| Name: | Display name used in lists and references. |
| Randomize order | Object setting shown by the form. |
| Use standard application | Object setting shown by the form. |
| MOH application: | Object setting shown by the form. |
| URL / Custom command: | Object setting shown by the form. |
| Volume: | Object setting shown by the form. |
| Format: | Object setting shown by the form. |
| Streaming Engine: | Mode selector that changes the behavior of the object. |
| Default | Object setting shown by the form. |
| Task | How to do it |
|---|---|
| Create | Select the new action from the Music on Hold list, fill the required fields, and select Save. |
| Edit | Open the existing music on hold class, update the needed fields, and select Save. |
| Delete | Before deleting a music on hold class, check call-flow, destination, schedule, report, provisioning, or integration references. Use the row delete action or the form delete action when available, then confirm. |
| Task | How to do it |
|---|---|
| Add | Select the New paging and intercom group action, complete the form, and select Save. |
| Edit | Open the paging and intercom group from the list by selecting its name, number, or row action. Change the form and select Save. |
| Delete | Select the row checkbox and use Delete Selected, or open the paging and intercom group and select Delete, then confirm. |
| Action | Description |
|---|---|
| New Paging and Intercom Group | Opens the creation form for a new paging and intercom group. |
| Delete Selected | Deletes the selected rows after confirmation. |
| Column | Description |
|---|---|
| Number | Dialed value, identifier, or matching value used by the PBX. |
| Name | Display name used in lists and references. |
| Bidirectional | Object setting shown by the form. |
| Peer List | Object setting shown by the form. |
| Field | Description |
|---|---|
| Number: | Dialed value, identifier, or matching value used by the PBX. |
| Name: | Display name used in lists and references. |
| Bidirectional: | Object setting shown by the form. |
| Check if exten are in use | Object setting shown by the form. |
| Set the SIP headers manually | Object setting shown by the form. |
| Announcement: | Object setting shown by the form. |
| Task | How to do it |
|---|---|
| Create | Select the new action from the Paging and Intercoms list, fill the required fields, and select Save. |
| Edit | Open the existing paging or intercom entry, update the needed fields, and select Save. |
| Delete | Before deleting a paging or intercom entry, check call-flow, destination, schedule, report, provisioning, or integration references. Use the row delete action or the form delete action when available, then confirm. |
| Task | How to do it |
|---|---|
| Add | Select the New flow or variable action, complete the form, and select Save. |
| Edit | Open the flow or variable from the list by selecting its name, number, or row action. Change the form and select Save. |
| Delete | Select the row checkbox and use Delete Selected, or open the flow or variable and select Delete, then confirm. |
| Action | Description |
|---|---|
| New Flow/Variable | Opens the creation form for a new flow/variable. |
| Delete Selected | Deletes the selected rows after confirmation. |
| Column | Description |
|---|---|
| Name | Display name used in lists and references. |
| Number | Dialed value, identifier, or matching value used by the PBX. |
| Comment | Administrative note shown in lists and reports. |
| State | Mode selector that changes the behavior of the object. |
| Variable | Object setting shown by the form. |
| Value | Object setting shown by the form. |
| Action | Object setting shown by the form. |
| Section | Description |
|---|---|
| Information | Core identity and routing fields for the object. |
| Settings | Object-specific settings that change runtime behavior. |
| Monitoring | Status monitoring and BLF-related options. |
| Current State | Current value or state controls shown for the object. |
| Field | Description |
|---|---|
| Name: | Display name used in lists and references. |
| Number: | Dialed value, identifier, or matching value used by the PBX. |
| Comment: | Administrative note shown in lists and reports. |
| Variable name: | Display name used in lists and references. |
| Value for Unavailable: | Object setting shown by the form. |
| Value for Not in use: | Object setting shown by the form. |
| Value for In use: | Object setting shown by the form. |
| Value for Ringing: | Object setting shown by the form. |
| Monitor type: | Mode selector that changes the behavior of the object. |
| Queue: | Object setting shown by the form. |
| Extension to monitor: | Target or routing selection used when the object sends a call or message onward. |
| DID to monitor: | Object setting shown by the form. |
| Variable value: | Object setting shown by the form. |
| BLF Status: | Mode selector that changes the behavior of the object. |
| Task | How to do it |
|---|---|
| Create | Select the new action from the Flows and Variables list, fill the required fields, and select Save. |
| Edit | Open the existing flow or variable, update the needed fields, and select Save. |
| Delete | Before deleting a flow or variable, check call-flow, destination, schedule, report, provisioning, or integration references. Use the row delete action or the form delete action when available, then confirm. |
| Task | How to do it |
|---|---|
| Add | Select the New DISA action, complete the form, and select Save. |
| Edit | Open the DISA from the list by selecting its name, number, or row action. Change the form and select Save. |
| Delete | Select the row checkbox and use Delete Selected, or open the DISA and select Delete, then confirm. |
| Action | Description |
|---|---|
| New DISA | Opens the creation form for a new disa. |
| Delete Selected | Deletes the selected rows after confirmation. |
| Column | Description |
|---|---|
| Name | Display name used in lists and references. |
| Recording | Recording behavior or recording delivery setting. |
| PIN | Credential or PIN value. Treat it as sensitive. |
| Outbound | Object setting shown by the form. |
| CallerID | Caller ID or caller matching value. |
| Field | Description |
|---|---|
| Name: | Display name used in lists and references. |
| Welcome Message: | Object setting shown by the form. |
| PIN: | Credential or PIN value. Treat it as sensitive. |
| Digits Timeout: | Timing value used by the service. |
| Response Timeout: | Timing value used by the service. |
| Loop on attempt | Object setting shown by the form. |
| Allow outbound calls | Object setting shown by the form. |
| Block External Caller ID | Caller ID or caller matching value. |
| Use CID Number: | Dialed value, identifier, or matching value used by the PBX. |
| Use CID Name: | Display name used in lists and references. |
| Task | How to do it |
|---|---|
| Create | Select the new action from the DISAs list, fill the required fields, and select Save. |
| Edit | Open the existing DISA, update the needed fields, and select Save. |
| Delete | Before deleting a DISA, check call-flow, destination, schedule, report, provisioning, or integration references. Use the row delete action or the form delete action when available, then confirm. |
| Task | How to do it |
|---|---|
| Add | Use the grid add control to create a new caller ID blacklist entry. Fill the row editor and save it. |
| Edit | Select an existing caller ID blacklist entry row and use the grid edit control. Save the edited row. |
| Delete | Select one or more caller ID blacklist entry rows and use the grid delete control, then confirm. |
| Action | Description |
|---|---|
| CSV Download | Opens import or upload tools for bulk data. |
| CSV/XLS Upload | Opens import or upload tools for bulk data. |
| Column | Description |
|---|---|
| Caller ID | Caller ID or caller matching value. |
| Inserted | Object setting shown by the form. |
| Reason | Object setting shown by the form. |
| No records to view | Recording behavior or recording delivery setting. |
| Task | How to do it |
|---|---|
| Add | Use the grid add control to create a new conduit. Fill the row editor and save it. |
| Edit | Select an existing conduit row and use the grid edit control. Save the edited row. |
| Delete | Select one or more conduit rows and use the grid delete control, then confirm. |
| Column | Description |
|---|---|
| Prefix | Dialed value, identifier, or matching value used by the PBX. |
| Globalemptyempty | Object setting shown by the form. |
| Tenant | Object setting shown by the form. |
| Alter CallerID | Caller ID or caller matching value. |
| emptyx | Object setting shown by the form. |
| No records to view | Recording behavior or recording delivery setting. |
| Task | How to do it |
|---|---|
| Add | Select the New email template action, complete the form, and select Save. |
| Edit | Open the email template from the list by selecting its name, number, or row action. Change the form and select Save. |
| Delete | Select the row checkbox and use Delete Selected, or open the email template and select Delete, then confirm. |
| Action | Description |
|---|---|
| New Email Template | Opens the creation form for a new email template. |
| Delete Selected | Deletes the selected rows after confirmation. |
| Test | Runs a test for the selected configuration. |
| Column | Description |
|---|---|
| Name | Display name used in lists and references. |
| Type | Mode selector that changes the behavior of the object. |
| Active | Object setting shown by the form. |
| Language | Language or voice selection used for prompts, transcription, or speech synthesis. |
| Sender Name | Display name used in lists and references. |
| Sender Email | Email address used for notifications, delivery, or mailbox access. |
| Subject | Object setting shown by the form. |
| Actions | Object setting shown by the form. |
| Template type | Useful variables | Notes |
|---|---|---|
| Recording | `${RE_ID}`, `${START}`, `${SIZEKB}`, `${SOURCE}`, `${REALSRC}`, `${FIRSTDEST}`, `${CLID}`, `${LASTDEST}`, `${TENANTNAME}`, `${DIDCOMMENT}`, `${DIDEMERGENCYNOTES}`, `${WHERELANDED}`, `${SRCNAME}`, `${WHERELANDEDCIDNAME}`, `${TRANSCRIPT}`, `${SUMMARY}`, `${SENTIMENTSCORE}`, `${SENTIMENTBRIEF}`, `${SENTIMENTDETAILS}` | `${RE_ID}` contains the recording ID. The transcript, summary, sentiment score, sentiment brief, and sentiment details are populated only when those AI actions are completed while the recording is uploaded. |
| Transcript notification | `${RE_ID}`, `${TRANSCRIPT}` plus the call and tenant variables listed for Recording. | Used by transcript processing notifications. |
| Summary notification | `${RE_ID}`, `${SUMMARY}` plus the call and tenant variables listed for Recording. | Used by AI summary processing notifications. |
| Sentimental analysis notification | `${RE_ID}`, `${SENTIMENTSCORE}`, `${SENTIMENTBRIEF}`, `${SENTIMENTDETAILS}` plus the call and tenant variables listed for Recording. | `${SENTIMENTDETAILS}` contains the full JSON emotional analysis, including speaker roles, customer sentiment arc, and agent sentiment/tone data when available. |
| Field | Description |
|---|---|
| Name: | Display name used in lists and references. |
| Type: | Mode selector that changes the behavior of the object. |
| Active: | Object setting shown by the form. |
| Language: | Language or voice selection used for prompts, transcription, or speech synthesis. |
| Sender Name: | Display name used in lists and references. |
| Sender Email: | Email address used for notifications, delivery, or mailbox access. |
| Subject: | Object setting shown by the form. |
| Email template: | Email address used for notifications, delivery, or mailbox access. |
| Text to display | Object setting shown by the form. |
| To what URL should this link go? | Object setting shown by the form. |
| Select from files | File upload or file name used by the object. |
| Image URL | Object setting shown by the form. |
| Video URL (YouTube, Google Drive, Vimeo, Vine, Instagram, DailyMotion, Youku, Peertube) | Object setting shown by the form. |
| allowattachment | Object setting shown by the form. |
| Template type | Useful variables | Notes |
|---|---|---|
| Recording | `${RE_ID}`, `${START}`, `${SIZEKB}`, `${SOURCE}`, `${REALSRC}`, `${FIRSTDEST}`, `${CLID}`, `${LASTDEST}`, `${SIMPLEDIRECTION}`, `${SIMPLECALLERIDNUM}`, `${SIMPLECALLERIDNAME}`, `${SIMPLEDIALEDNUM}`, `${SIMPLEWHOANSWERED}`, `${SIMPLEWHENANSWERED}`, `${TENANTNAME}`, `${DIDCOMMENT}`, `${DIDEMERGENCYNOTES}`, `${WHERELANDED}`, `${SRCNAME}`, `${WHERELANDEDCIDNAME}`, `${TRANSCRIPT}`, `${SUMMARY}`, `${SENTIMENTSCORE}`, `${SENTIMENTBRIEF}`, `${SENTIMENTDETAILS}` | `${RE_ID}` contains the recording ID. The Simple CDR variables are loaded from `sc_simplecdr`: `${SIMPLEDIRECTION}` from `sc_direction`, `${SIMPLECALLERIDNUM}` from `sc_calleridnum`, `${SIMPLECALLERIDNAME}` from `sc_calleridname`, `${SIMPLEDIALEDNUM}` from `sc_dialednum`, `${SIMPLEWHOANSWERED}` from `sc_whoanswered`, and `${SIMPLEWHENANSWERED}` from `sc_whenanswered`. The transcript, summary, sentiment score, sentiment brief, and sentiment details are populated only when those AI actions are completed while the recording is uploaded. |
| Transcript notification | `${RE_ID}`, `${TRANSCRIPT}` plus the call, tenant, and Simple CDR variables listed for Recording. | Used by transcript processing notifications. |
| Summary notification | `${RE_ID}`, `${SUMMARY}` plus the call, tenant, and Simple CDR variables listed for Recording. | Used by AI summary processing notifications. |
| Sentimental analysis notification | `${RE_ID}`, `${SENTIMENTSCORE}`, `${SENTIMENTBRIEF}`, `${SENTIMENTDETAILS}` plus the call, tenant, and Simple CDR variables listed for Recording. | `${SENTIMENTDETAILS}` contains the full JSON emotional analysis, including speaker roles, customer sentiment arc, and agent sentiment/tone data when available. |
| Task | How to do it |
|---|---|
| Create | Select the new action from the Email Templates list, fill the required fields, and select Save. |
| Edit | Open the existing email template, update the needed fields, and select Save. |
| Delete | Before deleting a email template, check call-flow, destination, schedule, report, provisioning, or integration references. Use the row delete action or the form delete action when available, then confirm. |
| Task | How to do it |
|---|---|
| Add | Select the New call list action, complete the form, and select Save. |
| Edit | Open the call list from the list by selecting its name, number, or row action. Change the form and select Save. |
| Delete | Select the row checkbox and use Delete Selected, or open the call list and select Delete, then confirm. |
| Action | Description |
|---|---|
| New Do Not / Only Allow Call List | Opens the creation form for a new do not / only allow call list. |
| Delete Selected | Deletes the selected rows after confirmation. |
| Find | Searches for the number or record entered in the find field. |
| Column | Description |
|---|---|
| Name | Display name used in lists and references. |
| Description | Administrative note shown in lists and reports. |
| Numbers | Dialed value, identifier, or matching value used by the PBX. |
| Actions | Object setting shown by the form. |
| Field | Description |
|---|---|
| Name: | Display name used in lists and references. |
| Description: | Administrative note shown in lists and reports. |
| Task | How to do it |
|---|---|
| Create | Select the new action from the Do Not and Only Allow Call Lists list, fill the required fields, and select Save. |
| Edit | Open the existing call list, update the needed fields, and select Save. |
| Delete | Before deleting a call list, check call-flow, destination, schedule, report, provisioning, or integration references. Use the row delete action or the form delete action when available, then confirm. |
| Task | How to do it |
|---|---|
| Add | Select the New report action, complete the form, and select Save. |
| Edit | Open the report from the list by selecting its name, number, or row action. Change the form and select Save. |
| Delete | Select the row checkbox and use Delete Selected, or open the report and select Delete, then confirm. |
| Action | Description |
|---|---|
| Show Reports | Opens a related detail or results view. |
| New Report | Opens the creation form for a new report. |
| Delete Selected | Deletes the selected rows after confirmation. |
| Run | Runs the Run action. |
| Column | Description |
|---|---|
| Name | Display name used in lists and references. |
| Reserved | Object setting shown by the form. |
| Type | Mode selector that changes the behavior of the object. |
| Holding days | Object setting shown by the form. |
| Parameters | Object setting shown by the form. |
| Format | Object setting shown by the form. |
| Actions | Object setting shown by the form. |
| Section | Description |
|---|---|
| Information | Core identity and routing fields for the object. |
| Page | Settings shown in the Page block. |
| Schedule | Scheduling controls for when the object runs. |
| Delivery | Email or output delivery settings. |
| Field | Description |
|---|---|
| Name: | Display name used in lists and references. |
| Active: | Object setting shown by the form. |
| Reserved | Object setting shown by the form. |
| Holding days: | Object setting shown by the form. |
| Type: | Mode selector that changes the behavior of the object. |
| Timeframe: | Object setting shown by the form. |
| Custom timeframe start: | Object setting shown by the form. |
| Custom timeframe end: | Object setting shown by the form. |
| Group by: | Object setting shown by the form. |
| Direction: | Object setting shown by the form. |
| PIN list: | Credential or PIN value. Treat it as sensitive. |
| Report calls with cost: | Object setting shown by the form. |
| Disposition: | Object setting shown by the form. |
| Order by: | Object setting shown by the form. |
| Hourly details: | Object setting shown by the form. |
| Task | How to do it |
|---|---|
| Create | Select the new action from the Reports list, fill the required fields, and select Save. |
| Edit | Open the existing report, update the needed fields, and select Save. |
| Delete | Before deleting a report, check call-flow, destination, schedule, report, provisioning, or integration references. Use the row delete action or the form delete action when available, then confirm. |
| Task | How to do it |
|---|---|
| Add | Select the New response path action, complete the form, and select Save. |
| Edit | Open the response path from the list by selecting its name, number, or row action. Change the form and select Save. |
| Delete | Select the row checkbox and use Delete Selected, or open the response path and select Delete, then confirm. |
| Action | Description |
|---|---|
| New Response Path | Opens the creation form for a new response path. |
| Delete Selected | Deletes the selected rows after confirmation. |
| Column | Description |
|---|---|
| Name | Display name used in lists and references. |
| Hold Days | Object setting shown by the form. |
| Field | Description |
|---|---|
| Name: | Display name used in lists and references. |
| Hold Days: | Object setting shown by the form. |
| XML Output Data: | Object setting shown by the form. |
| Task | How to do it |
|---|---|
| Create | Select the new action from the Response Paths list, fill the required fields, and select Save. |
| Edit | Open the existing response path, update the needed fields, and select Save. |
| Delete | Before deleting a response path, check call-flow, destination, schedule, report, provisioning, or integration references. Use the row delete action or the form delete action when available, then confirm. |
| Task | How to do it |
|---|---|
| Add | Select the New cronjob action, complete the form, and select Save. |
| Edit | Open the cronjob from the list by selecting its name, number, or row action. Change the form and select Save. |
| Delete | Select the row checkbox and use Delete Selected, or open the cronjob and select Delete, then confirm. |
| Action | Description |
|---|---|
| New Cronjob | Opens the creation form for a new cronjob. |
| Delete Selected | Deletes the selected rows after confirmation. |
| Column | Description |
|---|---|
| Name | Display name used in lists and references. |
| Type | Mode selector that changes the behavior of the object. |
| Active | Object setting shown by the form. |
| Minute | Object setting shown by the form. |
| Hour | Object setting shown by the form. |
| Day | Object setting shown by the form. |
| Month | Object setting shown by the form. |
| Year | Object setting shown by the form. |
| Weekday | Object setting shown by the form. |
| Timezone | Object setting shown by the form. |
| Last Started | Object setting shown by the form. |
| Last Ended | Object setting shown by the form. |
| Duration | Object setting shown by the form. |
| Action | Object setting shown by the form. |
| Section | Description |
|---|---|
| Cronjob | Scheduling controls for when the object runs. |
| Schedule | Scheduling controls for when the object runs. |
| Field | Description |
|---|---|
| Name: | Display name used in lists and references. |
| Active: | Object setting shown by the form. |
| Disable once run: | Object setting shown by the form. |
| Run from node: | Object setting shown by the form. |
| Hour: | Object setting shown by the form. |
| Minute: | Object setting shown by the form. |
| Timezone: | Object setting shown by the form. |
| Task | How to do it |
|---|---|
| Create | Select the new action from the Cronjobs list, fill the required fields, and select Save. |
| Edit | Open the existing cronjob, update the needed fields, and select Save. |
| Delete | Before deleting a cronjob, check call-flow, destination, schedule, report, provisioning, or integration references. Use the row delete action or the form delete action when available, then confirm. |
| Task | How to do it |
|---|---|
| Add | Select the New switchboard action, complete the form, and select Save. |
| Edit | Open the switchboard from the list by selecting its name, number, or row action. Change the form and select Save. |
| Delete | Select the row checkbox and use Delete Selected, or open the switchboard and select Delete, then confirm. |
| Action | Description |
|---|---|
| New Switchboard | Opens the creation form for a new switchboard. |
| Autocreate Default | Runs the Autocreate Default action. |
| Delete Selected | Deletes the selected rows after confirmation. |
| Column | Description |
|---|---|
| Name | Display name used in lists and references. |
| Default | Object setting shown by the form. |
| Used By | Object setting shown by the form. |
| Actions | Object setting shown by the form. |
| Field | Description |
|---|---|
| Name: | Display name used in lists and references. |
| default | Object setting shown by the form. |
| Task | How to do it |
|---|---|
| Create | Select the new action from the Switchboards list, fill the required fields, and select Save. |
| Edit | Open the existing switchboard, update the needed fields, and select Save. |
| Delete | Before deleting a switchboard, check call-flow, destination, schedule, report, provisioning, or integration references. Use the row delete action or the form delete action when available, then confirm. |
| Task | How to do it |
|---|---|
| Add | Use the grid add control to create a new phone book entry. Fill the row editor and save it. |
| Edit | Select an existing phone book entry row and use the grid edit control. Save the edited row. |
| Delete | Select one or more phone book entry rows and use the grid delete control, then confirm. |
| Action | Description |
|---|---|
| CSV/XLS Import | Opens import or upload tools for bulk data. |
| CSV Export | Opens import or upload tools for bulk data. |
| XLS Export | Opens import or upload tools for bulk data. |
| New Phone Book/DB | Opens the creation form for a new phone book/db. |
| Column | Description |
|---|---|
| Name | Display name used in lists and references. |
| Phone | Object setting shown by the form. |
| Mobile Phone | Object setting shown by the form. |
| Email address used for notifications, delivery, or mailbox access. | |
| Route to | Object setting shown by the form. |
| No records to view | Recording behavior or recording delivery setting. |
| Field | Description |
|---|---|
| Name: | Display name used in lists and references. |
| Include local extensions: | Target or routing selection used when the object sends a call or message onward. |
| Include short numbers: | Dialed value, identifier, or matching value used by the PBX. |
| Task | How to do it |
|---|---|
| Add | Select the New phone book action, complete the form, and select Save. |
| Edit | Open the phone book from the list by selecting its name, number, or row action. Change the form and select Save. |
| Delete | Select the row checkbox and use Delete Selected, or open the phone book and select Delete, then confirm. |
| Action | Description |
|---|---|
| New Phone Book | Opens the creation form for a new phone book. |
| Delete Selected | Deletes the selected rows after confirmation. |
| Column | Description |
|---|---|
| Name | Display name used in lists and references. |
| Include local extensions | Target or routing selection used when the object sends a call or message onward. |
| Include short numbers | Dialed value, identifier, or matching value used by the PBX. |
| Entries | Object setting shown by the form. |
| Default | Object setting shown by the form. |
| no | Object setting shown by the form. |
| Field | Description |
|---|---|
| Name: | Display name used in lists and references. |
| Include local extensions: | Target or routing selection used when the object sends a call or message onward. |
| Include short numbers: | Dialed value, identifier, or matching value used by the PBX. |
| Task | How to do it |
|---|---|
| Create | Select the new action from the Manage Phone Books and Databases list, fill the required fields, and select Save. |
| Edit | Open the existing phone book or database, update the needed fields, and select Save. |
| Delete | Before deleting a phone book or database, check call-flow, destination, schedule, report, provisioning, or integration references. Use the row delete action or the form delete action when available, then confirm. |
| Task | How to do it |
|---|---|
| Edit | Change the required settings and select Save. The page edits tenant settings directly. |
| Delete | There is no delete action for the Settings page itself. Delete actions are handled on the linked object pages. |
| Action | Description |
|---|---|
| Edit | Runs the Edit action. |
| Speech to Text | Runs the Speech to Text action. |
| Test | Runs a test for the selected configuration. |
| Autofill | Runs the Autofill action. |
| Manage CNAM Cache | Opens the related management page. |
| Generate | Generates a value for the adjacent field. |
| Exceptions | Runs the Exceptions action. |
| Manage IP List | Opens the related management page. |
| Save | Saves the current form. |
| Manager Users | Opens the related management page. |
| Pickup group names | Runs the Pickup group names action. |
| Internal Phone Book | Runs the Internal Phone Book action. |
| Internal Routing Rules | Runs the Internal Routing Rules action. |
| Outbound PIN codes | Runs the Outbound PIN codes action. |
| Section | Description |
|---|---|
| Settings - Canistracci Oil | Object-specific settings that change runtime behavior. |
| Dialing | Settings shown in the Dialing block. |
| Diversion field for External Agents | Agent assignment and queue membership behavior. |
| Autocreated Custom Destination | Settings shown in the Autocreated Custom Destination block. |
| Recording | Recording storage and recording-related options. |
| Voice Synthesizer | Voice calling behavior, caller handling, recording, and voice-specific limits. |
| Speech to Text | Settings shown in the Speech to Text block. |
| Generative Artificial Intelligent chat models | Settings shown in the Generative Artificial Intelligent chat models block. |
| Dial By Name Directory | Settings shown in the Dial By Name Directory block. |
| CNAM service | Settings shown in the CNAM service block. |
| Faxing | Fax handling, quality, storage, delivery, and fax-specific transport settings. |
| MS Teams integration | Settings shown in the MS Teams integration block. |
| API Interface | API-related credentials, restrictions, and integration controls. |
| Default Music On Hold | Settings shown in the Default Music On Hold block. |
| Unassigned DID destination | Settings shown in the Unassigned DID destination block. |
| General DID destination | Settings shown in the General DID destination block. |
| General Outbound destination | Settings shown in the General Outbound destination block. |
| Emergency numbers notification | Settings shown in the Emergency numbers notification block. |
| Security | Tenant security, limits, and access controls. |
| Call Settings | Object-specific settings that change runtime behavior. |
| Outbound Calls | Settings shown in the Outbound Calls block. |
| CSV Exports | Settings shown in the CSV Exports block. |
| Voicemail Settings | Voice calling behavior, caller handling, recording, and voice-specific limits. |
| Voicemail backup | Voice calling behavior, caller handling, recording, and voice-specific limits. |
| Field | Content |
|---|---|
| `data` | A JSON string with recording and call metadata. |
| `file` | The recording file uploaded as `application/octet-stream`. The upload filename is the base name of the recording file. |
| JSON key | Description |
|---|---|
| `filename` | Full local path of the processed recording file on the PBX server at the time of the POST. |
| `format` | Recording format after conversion, such as `wav`, `mp3`, or `ogg`. The current payload can include surrounding single quotes. |
| `uniqueid` | Asterisk/MiRTA PBX recording unique id. The current payload can include surrounding single quotes, so parse it as an opaque string. |
| `tenant` | Tenant code. |
| `tenantid` | Numeric tenant id. |
| `start` | Recording or call start date/time received by the upload process. |
| `emailrecording` | Email recipients configured for recording delivery, including any recipients added while the recording was running. |
| `src` | Original source caller or extension value. |
| `realsrc` | Resolved real source value used by the call flow. |
| `firstdst` | First destination dialed for the call. |
| `lastdst` | Final destination reached by the call. |
| `disposition` | Final call disposition, such as answered, busy, failed, or no answer. |
| `clid` | Caller ID string associated with the call. |
| `size` | Processed recording file size in bytes. |
| `wherelanded` | Destination or extension where the call landed, when available. |
| `whereladedcidname` | Caller ID name for the landing destination, when available. The key is currently spelled `whereladedcidname`; keep this spelling when parsing the payload. |
| Task | How to do it |
|---|---|
| Edit | Change the required tenant settings in the relevant block, then select Save. |
| Linked pages | Use the buttons inside Settings to open related management pages such as CNAM cache, manager users, routing rules, and PIN codes. |
| Delete | Settings itself is not deleted. Delete actions are handled on the linked object pages. |
| Task | How to do it |
|---|---|
| Add | Use the grid add control to create a new CNAM cache entry. Fill the row editor and save it. |
| Edit | Select an existing CNAM cache entry row and use the grid edit control. Save the edited row. |
| Delete | Select one or more CNAM cache entry rows and use the grid delete control, then confirm. |
| Column | Description |
|---|---|
| Number | Dialed value, identifier, or matching value used by the PBX. |
| Name | Display name used in lists and references. |
| Inserted | Object setting shown by the form. |
| Static | Object setting shown by the form. |
| Note | Administrative note shown in lists and reports. |
| Task | How to do it |
|---|---|
| Edit | Change the checkbox matrix to allow or block specific dialing patterns, then save or test the result. |
| Test | Use the test controls to validate how a number is handled for a selected extension. |
| Delete | There is no separate delete action because the page stores rule states, not independent rows. |
| Action | Description |
|---|---|
| Test | Runs a test for the selected configuration. |
| Task | How to do it |
|---|---|
| Add | Select the New manager user action, complete the form, and select Save. |
| Edit | Open the manager user from the list by selecting its name, number, or row action. Change the form and select Save. |
| Delete | Select the row checkbox and use Delete Selected, or open the manager user and select Delete, then confirm. |
| Action | Description |
|---|---|
| New Manager User | Opens the creation form for a new manager user. |
| Delete Selected | Deletes the selected rows after confirmation. |
| Column | Description |
|---|---|
| Username | Display name used in lists and references. |
| Password | Credential or PIN value. Treat it as sensitive. |
| Description | Administrative note shown in lists and reports. |
| Task | How to do it |
|---|---|
| Create | Select the new action from the Manager Users list, fill the required fields, and select Save. |
| Edit | Open the existing manager user, update the needed fields, and select Save. |
| Delete | Before deleting a manager user, check call-flow, destination, schedule, report, provisioning, or integration references. Use the row delete action or the form delete action when available, then confirm. |
| Task | How to do it |
|---|---|
| Add | Use the grid add control to create a new pickup group name. Fill the row editor and save it. |
| Edit | Select an existing pickup group name row and use the grid edit control. Save the edited row. |
| Delete | Select one or more pickup group name rows and use the grid delete control, then confirm. |
| Column | Description |
|---|---|
| Group Number | Dialed value, identifier, or matching value used by the PBX. |
| Group Name | Display name used in lists and references. |
| Task | How to do it |
|---|---|
| View | Use search, sorting, and filtering to inspect records generated from other tenant objects. |
| Add/Edit/Delete | This page is generated from related configuration, so records are changed on their source pages. |
| Action | Description |
|---|---|
| CSV Export | Opens import or upload tools for bulk data. |
| XLS Export | Opens import or upload tools for bulk data. |
| Column | Description |
|---|---|
| Number | Dialed value, identifier, or matching value used by the PBX. |
| Type | Mode selector that changes the behavior of the object. |
| Description | Administrative note shown in lists and reports. |
| Task | How to do it |
|---|---|
| Add | Select the New internal routing rule action, complete the form, and select Save. |
| Edit | Open the internal routing rule from the list by selecting its name, number, or row action. Change the form and select Save. |
| Delete | Select the row checkbox and use Delete Selected, or open the internal routing rule and select Delete, then confirm. |
| Action | Description |
|---|---|
| New Internal Routing Rule | Opens the creation form for a new internal routing rule. |
| Delete Selected | Deletes the selected rows after confirmation. |
| Column | Description |
|---|---|
| Regex | Object setting shown by the form. |
| Extension | Target or routing selection used when the object sends a call or message onward. |
| Digits to add | Object setting shown by the form. |
| Digits to del | Object setting shown by the form. |
| Task | How to do it |
|---|---|
| Create | Select the new action from the Internal Routing Rules list, fill the required fields, and select Save. |
| Edit | Open the existing internal routing rule, update the needed fields, and select Save. |
| Delete | Before deleting a internal routing rule, check call-flow, destination, schedule, report, provisioning, or integration references. Use the row delete action or the form delete action when available, then confirm. |
| Task | How to do it |
|---|---|
| Add | Select the New PIN code action, complete the form, and select Save. |
| Edit | Open the PIN code from the list by selecting its name, number, or row action. Change the form and select Save. |
| Delete | Select the row checkbox and use Delete Selected, or open the PIN code and select Delete, then confirm. |
| Action | Description |
|---|---|
| New Pin Code | Opens the creation form for a new pin code. |
| Delete Selected | Deletes the selected rows after confirmation. |
| CSV Upload | Opens import or upload tools for bulk data. |
| Column | Description |
|---|---|
| Description | Administrative note shown in lists and reports. |
| PIN | Credential or PIN value. Treat it as sensitive. |
| Disabled | Object setting shown by the form. |
| Task | How to do it |
|---|---|
| Create | Select the new action from the Outbound PIN Codes list, fill the required fields, and select Save. |
| Edit | Open the existing outbound PIN code, update the needed fields, and select Save. |
| Delete | Before deleting a outbound PIN code, check call-flow, destination, schedule, report, provisioning, or integration references. Use the row delete action or the form delete action when available, then confirm. |
| Task | How to do it |
|---|---|
| Add | Use the grid add control to create a new parking lot return number. Fill the row editor and save it. |
| Edit | Select an existing parking lot return number row and use the grid edit control. Save the edited row. |
| Delete | Select one or more parking lot return number rows and use the grid delete control, then confirm. |
| Column | Description |
|---|---|
| Parking Lot Number | Dialed value, identifier, or matching value used by the PBX. |
| Dial number On timeout | Dialed value, identifier, or matching value used by the PBX. |
| Comment | Administrative note shown in lists and reports. |
| Task | How to do it |
|---|---|
| Add | Use the grid add control to create a new custom parking lot. Fill the row editor and save it. |
| Edit | Select an existing custom parking lot row and use the grid edit control. Save the edited row. |
| Delete | Select one or more custom parking lot rows and use the grid delete control, then confirm. |
| Column | Description |
|---|---|
| Parking Lot Name | Display name used in lists and references. |
| Start | Object setting shown by the form. |
| End | Object setting shown by the form. |
| Timeout | Timing value used by the service. |
| Parking lot server | Server, host, or node selection used by the object. |
| Default return number | Dialed value, identifier, or matching value used by the PBX. |
| Music on hold | Object setting shown by the form. |
| Task | How to do it |
|---|---|
| Add | Use the grid add control to create a new call privacy rule. Fill the row editor and save it. |
| Edit | Select an existing call privacy rule row and use the grid edit control. Save the edited row. |
| Delete | Select one or more call privacy rule rows and use the grid delete control, then confirm. |
| Column | Description |
|---|---|
| CallerID | Caller ID or caller matching value. |
| Action | Object setting shown by the form. |
| Last seen | Object setting shown by the form. |
| Task | How to do it |
|---|---|
| Add | Use the grid add control to create a new auto-answer header. Fill the row editor and save it. |
| Edit | Select an existing auto-answer header row and use the grid edit control. Save the edited row. |
| Delete | Select one or more auto-answer header rows and use the grid delete control, then confirm. |
| Column | Description |
|---|---|
| Sip header | Object setting shown by the form. |
| Sip header value | Object setting shown by the form. |
| Comment | Administrative note shown in lists and reports. |
| Task | How to do it |
|---|---|
| Add | Select the New dial by name directory action, complete the form, and select Save. |
| Edit | Open the dial by name directory from the list by selecting its name, number, or row action. Change the form and select Save. |
| Delete | Select the row checkbox and use Delete Selected, or open the dial by name directory and select Delete, then confirm. |
| Action | Description |
|---|---|
| New Dial By Name | Opens the creation form for a new dial by name. |
| Delete Selected | Deletes the selected rows after confirmation. |
| Column | Description |
|---|---|
| Name | Display name used in lists and references. |
| Description | Administrative note shown in lists and reports. |
| Numbers | Dialed value, identifier, or matching value used by the PBX. |
| Task | How to do it |
|---|---|
| Create | Select the new action from the Additional Dial By Name Directories list, fill the required fields, and select Save. |
| Edit | Open the existing dial by name directory, update the needed fields, and select Save. |
| Delete | Before deleting a dial by name directory, check call-flow, destination, schedule, report, provisioning, or integration references. Use the row delete action or the form delete action when available, then confirm. |
| Task | How to do it |
|---|---|
| Add | Use the grid add control to create a new digital fax number. Fill the row editor and save it. |
| Edit | Select an existing digital fax number row and use the grid edit control. Save the edited row. |
| Delete | Select one or more digital fax number rows and use the grid delete control, then confirm. |
| Column | Description |
|---|---|
| Number | Dialed value, identifier, or matching value used by the PBX. |
| Comment | Administrative note shown in lists and reports. |
| Task | How to do it |
|---|---|
| Add | Use the grid add control to create a new alarm binding. Fill the row editor and save it. |
| Edit | Select an existing alarm binding row and use the grid edit control. Save the edited row. |
| Delete | Select one or more alarm binding rows and use the grid delete control, then confirm. |
| Column | Description |
|---|---|
| Tenant | Tenant associated with the alarm binding. |
| Caller ID | Caller ID or caller matching value. |
| Notification Email | Email address used for notifications, delivery, or mailbox access. |
| Relay Server | Server, host, or node selection used by the object. |
| Task | How to do it |
|---|---|
| Add | Select the New mail-to-fax mailbox action, complete the form, and select Save. |
| Edit | Open the mail-to-fax mailbox from the list by selecting its name, number, or row action. Change the form and select Save. |
| Delete | Select the row checkbox and use Delete Selected, or open the mail-to-fax mailbox and select Delete, then confirm. |
| Action | Description |
|---|---|
| New Mail to Fax | Opens the creation form for a new mail to fax. |
| Delete Selected | Deletes the selected rows after confirmation. |
| Column | Description |
|---|---|
| Name | Display name used in lists and references. |
| Email address used for notifications, delivery, or mailbox access. | |
| Protocol | Mode selector that changes the behavior of the object. |
| Username | Display name used in lists and references. |
| Server | Server, host, or node selection used by the object. |
| CallerID | Caller ID or caller matching value. |
| Actions | Object setting shown by the form. |
| Task | How to do it |
|---|---|
| Create | Select the new action from the Mail to Fax list, fill the required fields, and select Save. |
| Edit | Open the existing mail to fax rule, update the needed fields, and select Save. |
| Delete | Before deleting a mail to fax rule, check call-flow, destination, schedule, report, provisioning, or integration references. Use the row delete action or the form delete action when available, then confirm. |
| Task | How to do it |
|---|---|
| Add | Select the New mail-to-call mailbox action, complete the form, and select Save. |
| Edit | Open the mail-to-call mailbox from the list by selecting its name, number, or row action. Change the form and select Save. |
| Delete | Select the row checkbox and use Delete Selected, or open the mail-to-call mailbox and select Delete, then confirm. |
| Action | Description |
|---|---|
| New Mail to Call | Opens the creation form for a new mail to call. |
| Delete Selected | Deletes the selected rows after confirmation. |
| Column | Description |
|---|---|
| Name | Display name used in lists and references. |
| Email address used for notifications, delivery, or mailbox access. | |
| Protocol | Mode selector that changes the behavior of the object. |
| Username | Display name used in lists and references. |
| Server | Server, host, or node selection used by the object. |
| CallerID | Caller ID or caller matching value. |
| Actions | Object setting shown by the form. |
| Section | Description |
|---|---|
| Information | Core identity and routing fields for the object. |
| Call details | Settings shown in the Call details block. |
| Text to Voice | Voice calling behavior, caller handling, recording, and voice-specific limits. |
| Task | How to do it |
|---|---|
| Create | Select the new action from the Mail to Call list, fill the required fields, and select Save. |
| Edit | Open the existing mail to call rule, update the needed fields, and select Save. |
| Delete | Before deleting a mail to call rule, check call-flow, destination, schedule, report, provisioning, or integration references. Use the row delete action or the form delete action when available, then confirm. |
| Task | How to do it |
|---|---|
| Add | Select the New XML template action, complete the form, and select Save. |
| Edit | Open the XML template from the list by selecting its name, number, or row action. Change the form and select Save. |
| Delete | Select the row checkbox and use Delete Selected, or open the XML template and select Delete, then confirm. |
| Action | Description |
|---|---|
| New XML Template | Opens the creation form for a new xml template. |
| Delete Selected | Deletes the selected rows after confirmation. |
| Column | Description |
|---|---|
| Name | Display name used in lists and references. |
| Description | Administrative note shown in lists and reports. |
| Task | How to do it |
|---|---|
| Create | Select the new action from the XML Templates list, fill the required fields, and select Save. |
| Edit | Open the existing XML template, update the needed fields, and select Save. |
| Delete | Before deleting a XML template, check call-flow, destination, schedule, report, provisioning, or integration references. Use the row delete action or the form delete action when available, then confirm. |
| Task | How to do it |
|---|---|
| Add | Select the New SIP cause code rule action, complete the form, and select Save. |
| Edit | Open the SIP cause code rule from the list by selecting its name, number, or row action. Change the form and select Save. |
| Delete | Select the row checkbox and use Delete Selected, or open the SIP cause code rule and select Delete, then confirm. |
| Action | Description |
|---|---|
| New SIP Cause Code | Opens the creation form for a new sip cause code. |
| Delete Selected | Deletes the selected rows after confirmation. |
| Column | Description |
|---|---|
| Disposition | Object setting shown by the form. |
| SIP Cause Code | Dialed value, identifier, or matching value used by the PBX. |
| Comment | Administrative note shown in lists and reports. |
| Task | How to do it |
|---|---|
| Create | Select the new action from the SIP Cause Codes list, fill the required fields, and select Save. |
| Edit | Open the existing SIP cause code, update the needed fields, and select Save. |
| Delete | Before deleting a SIP cause code, check call-flow, destination, schedule, report, provisioning, or integration references. Use the row delete action or the form delete action when available, then confirm. |