Thank you for purchasing the Grandstream UCM630X series IP PBX appliance. The UCM6300 series allows businesses to build powerful and scalable unified communication and collaboration solutions. This series of IP PBXs provide a platform that unifies all business communication on one centralized network, including voice, video calling, video conferencing, video surveillance, web meetings, data, analytics, mobility, facility access, intercoms, and more. The UCM6300 Series supports up to 3000 users and includes a built-in web meetings and video conferencing solution that allows employees to connect from the desktop, mobile, GVC series devices, and IP phones. It can be paired with the UCM6300 ecosystem to offer a hybrid platform that combines the control of an on-premises IP PBX with the remote access of a cloud solution. The UCM6300 ecosystem consists of the Wave app for desktop and mobile, which provides a hub for collaborating remotely, and UCM RemoteConnect, a cloud NAT traversal service for ensuring secure remote connections. The UCM6300 series also offers cloud setup and management through GDMS and an API for integration with third-party platforms. By offering a high-end unified communications and collaboration solution packed with a suite of mobility, security, meeting, and collaboration tools, the UCM6300 series provides a powerful platform for any organization.
Caution
Changes or modifications to this product not expressly approved by Grandstream, or operation of this product in any way other than as detailed by this User Manual, could void your manufacturer warranty.
Warning
Please do not use a different power adaptor with the UCM630X as it may cause damage to the product and void the manufacturer warranty.
Alert
Reproduction or transmittal of the entire or any part, in any form or by any means, electronic or print, for any purpose without the express written permission of Grandstream Networks, Inc. is not permitted.
PRODUCT OVERVIEW
Technical Specifications
The following table resumes all the technical specifications including the protocols/standards supported, voice codecs, telephony features, languages, and upgrade/provisioning settings for the UCM630X series.
Interfaces
Analog Telephone FXS Ports
UCM6301: 1 RJ11 port
UCM6302: 2 RJ11 ports
UCM6304: 4 RJ11 ports
UCM6308: 8 RJ11 ports
All ports have lifeline capability in case of a power outage; number of ports can be expanded by peering an FXS gateway
PSTN Line FXO Ports
UCM6301: 1 RJ11 port
UCM6302: 2 RJ11 ports
UCM6304: 4 RJ11 ports
UCM6308: 8 RJ11 ports
All ports have lifeline capability in case of a power outage; number of ports can be expanded by peering with an FXO gateway
Network Interfaces
Three self-adaptive Gigabit ports (switched, routed, or dual card mode) with PoE+
NAT Router
Yes (supports router mode and switch mode)
Peripheral Ports
UCM6301: 1x USB 3.0, and 1x SD card interface
UCM6302: 1x USB 2.0, 1x USB 3.0, and 1x SD card interface
UCM6304/6308: 2x USB 3.0 and 1x SD card interface
LED Indicators
UCM6301/UCM6302: None
UCM6304/6308: Power 1/2, FXS, FXO, LAN, WAN, Heartbeat
LCD Display
UCM6301/UCM6302: 320*240 LCD with touch screen for Shortcut Keys and Scroll Bar
UCM6304/6308: 128x32 dot matrix graphic LCD with DOWN and OK buttons
Reset Switch
Yes, long press for factory reset and short press for reboot
Voice/Video Capabilities
Voice-over-Packet
Capabilities
LEC with NLP Packetized Voice Protocol Unit, 128ms-tail-length carrier grade Line Echo Cancellation, Dynamic Jitter Buffer, Modem detection & auto-switch to G.711, NetEQ, FEC 2.0, jitter resilience up to 50% audio packet loss
Mass provisioning using AES encrypted XML configuration file, auto-discovery & auto-provisioning of Grandstream IP endpoints via ZeroConfig (DHCP Option 66 multicast SIP SUBSCRIBE mDNS), eventlist between the local and remote trunk
Customizable language pack to support any other languages
Caller ID
Bellcore/Telcordia, ETSI-FSK, ETSI-DTMF, SIN 227 – BT, NTT
Polarity Reversal/ Wink
Yes, with enable/disable option upon call establishment and termination
Call Center
Multiple configurable call queues, automatic call distribution (ACD) based on agent skills/availability/workload, in-queue announcement
Customizable Auto Attendant
Up to 5 layers of IVR (Interactive Voice Response) in multiple languages
Telephony Operating System
Based on Asterisk version 16
Maximum Call Capacity
UCM6301:
Users: 500
Concurrent calls (G.711): 75
Max concurrent SRTP calls (G.711): 50
UCM6302:
Users: 1000
Concurrent calls (G.711): 150
Max concurrent SRTP calls (G.711): 100
UCM6304:
Users: 2000
Concurrent calls (G.711): 300
Max concurrent SRTP calls (G.711): 200
UCM6308:
Users: 3000
Concurrent calls (G.711): 450
Max concurrent SRTP calls (G.711): 300
Maximum Attendees of Conference Bridges
UCM6301:
Up to 4 simultaneous video conference rooms, up to 75 simultaneous participants in all rooms combined, up to 9 video feeds in all the conference rooms
UCM6302:
Up to 8 simultaneous video conference rooms, up to 150 simultaneous participants in all rooms combined, up to 9 video feeds in all conference rooms
UCM6304:
Up to 15 simultaneous video conference rooms, up to 200 simultaneous participants in all rooms combined, up to 9 video feeds in all conference rooms
UCM6308:
Up to 25 simultaneous video conference rooms, up to 300 simultaneous participants in all rooms combined, up to 9 video feeds in all conference rooms.
Call Features
Call park, call forward, call transfer, call waiting, caller ID, call record, call history, ringtone, IVR, music on hold, call routes, DID, DOD, DND, DISA, ring group, ring simultaneously, time schedule, PIN groups, call queue, pickup group, paging/intercom, voicemail, call wakeup, SCA, BLF, voicemail to email, fax to email, speed dial, call back, dial by name, emergency call, call follow me, blacklist/whitelist, voice conference, video conference, eventlist, feature codes, busy camp-on/ call completion, voice control, post-meeting reports, virtual fax sending/receiving, email to fax
Wave App
Free; Available for desktop (Windows 10+, Mac OS 10+), web (Firefox and Chrome Browsers) and mobile (Android & iOS), allows users to join UCM-hosted meetings, communicate with other users/solutions and make/receive calls using SIP accounts registered to a UCM6300 Audio series IP PBX
Firmware Upgrade
Supported by Grandstream Device Management System (GDMS), a zero-touch cloud provisioning and management system, It provides a centralized interface to provision, manage, monitor, and troubleshoot Grandstream products
UCM630X FXS ports lifeline functionality: The UCM630X FXS interfaces are metallic through to the FXO interfaces. If there is a power outage, the FXS1 port will fail over to FXO 1 port, FXS 2 port will fail over to FXO 2 port. The user can still access the PSTN connected with the FXO interfaces from FXS interfaces.
INSTALLATION
Before deploying and configuring the UCM630X series, the device needs to be properly powered up and connected to a network. This section describes detailed information on the installation, connection, and warranty policy of the UCM630X series.
Equipment Packaging
Main Case
1
Power Adaptor
1
Ethernet Cable
1
Quick Installation Guide
1
UCM630X Equipment Packaging
Connect Your UCM630X (UCM6301 as an example)
UCM6301 Top View
UCM6301 Back View
UCM6301 Front View
To set up the UCM6301, follow the steps below:
Connect one end of an RJ-45 Ethernet cable into the WAN port of the UCM6301.
Connect the other end of the Ethernet cable into the uplink port of an Ethernet switch/hub.
Connect the 12V DC power adapter into the 12V DC power jack on the back of the UCM6301. Insert the main plug of the power adapter into a surge-protected power outlet.
Wait for the UCM6301 to boot up. The LCD in the front will show the device hardware information when the boot process is done.
Once the UCM6301 is successfully connected to the network, press the Home button to display the IP address.
(Optional) Connect PSTN lines from the wall jack to the FXO ports; connect analog lines (phone and Fax) to the FXS ports.
The ground screw needs to be connected.
The same steps will be used to connect UCM6302/6304/6308.
UCM6302 front and back view
UCM6302 Back View
UCM6302 Front View
UCM6304 front and back view
UCM6304 Front View
UCM6304 Back View
UCM6308 front and back view
UCM6308 Front View
UCM6308 Back View
Safety Compliances
The UCM630X series IP PBX complies with FCC/CE and various safety standards. The UCM630X power adapter is compliant with the UL standard. Use the universal power adapter provided with the UCM630X package only. The manufacturer’s warranty does not cover damages to the device caused by unsupported power adapters.
Warranty
If the UCM630X series IP PBX was purchased from a reseller, please contact the company where the device was purchased for replacement, repair, or refund. If the device was purchased directly from Grandstream, contact our Technical Support Team for an RMA (Return Materials Authorization) number before the product is returned. Grandstream reserves the right to remedy the warranty policy without prior notification.
Warning
Use the power adapter provided with the UCM630X series IP PBX. Do not use a different power adapter as this may damage the device. This type of damage is not covered under warranty.
GETTING STARTED
To get started with the UCM630X setup process, use the following available interfaces: LCD display, and web portal.
The LCD display shows hardware, software, interface status, and network information and can be navigated via the Slide control and Touch keys. From here, users can configure basic network settings, run diagnostic tests, and factory reset.
The web portal (may also be referred to as web UI in this guide) is the primary method of configuring the UCM.
This section will provide step-by-step instructions on how to use these interfaces to quickly set up the UCM and start making and receiving calls with it.
Use the LCD Menu
Idle Screen
Once the device has booted up completely, the LCD will show the UCM model, hardware version, and IP address. Upon menu key press timeout (30 seconds), the screen will default back to this information.
Menu
Pressing the Home button will show the main menu. All available menu options are found in [LCD Menu Options].
Menu Navigation
Scrolling down using slide control through the menu options. Press the OK button to select an option.
Exit
Selecting the Back option will return to the previous menu. For the Device Info, Network Info, and Web Info screens that have no Back option, pressing the OK button will return to the previous menu.
LCD Backlight
The LCD backlight will turn on upon button press and will go off when idle for 30 seconds.
The following table summarizes the layout of the LCD menu of UCM630x.
View Events
Critical Events
Other Events
Device Info
Hardware: Hardware version number
Software: Software version number
P/N: Part number
WAN MAC: WAN side MAC address
LAN MAC: LAN side MAC address
Uptime: System uptime
Network Info
WAN Mode: DHCP, Static IP, or PPPoE
WAN IP: IP address
WAN Subnet Mask
LAN IP: IP address
LAN Subnet Mask
Network Menu
WAN Mode: Select WAN mode as DHCP, Static IP, or PPPoE
Static Route Reset: Select this to reset static route settings.
Factory Menu
Reboot
Factory Reset
LCD Test Patterns: Press DOWN and OK buttons to scroll through and select different LCD patterns to test. Once a test is done, press the OK button to return to the previous menu.
Fan Mode: Select Auto or On.
LED Test Patterns: All On, All Off, and Blinking are the available options. Selecting Back in the menu will revert the LED indicators to their actual status.
RTC Test Patterns: Select either 2022-02-22 22:22 or 2011-01-11 11:11 to start the RTC (Real-Time Clock) test pattern. Check the system time from either the LCD idle screen or in the web portal System Status🡪System Information🡪General page. To revert to the correct time, manually reboot the device.
Hardware Testing: Select Test SVIP to verify hardware connections within the device. The result will display on the LCD when the test is complete.
Web Info
Protocol: Web access protocol (HTTP/ HTTPS). HTTPS is used by default.
Port: Web access port number, which is 8089 by default.
SSH Switch
Enable SSH
Disable SSH
SSH access is disabled by default
Use the LED Indicators
The UCM6301/6302 has LED indicators on the network port to display connection status and the following picture shows the other ports’ status.
Ports Status
The UCM6304/6308 has LED indicators in the front to display the connection status. The following table shows the status definitions.
LED Indicator
LED Status
Power 1/Power 2
PoE
LAN
WAN
USB
SD
FXS ports
FXO ports
Solid: Connected
Fast Blinking: Data Transferring
Slow Blinking: Trying to connect
OFF: Not Connected
UCM6304/6308 LED Indicators
Using the Web UI
Accessing the Web UI
The UCM’s web server responds to HTTP/HTTPS GET/POST requests. Embedded HTML pages allow users to configure the device through a web browser such as Microsoft IE (version 8+), Mozilla Firefox, Google Chrome, etc. To access the UCM’s web portal, follow the steps below:
UCM6302 Web GUI Login Page
Make sure your computer is on the same network as the UCM.
Make sure that the UCM’s IP address is displayed on its LCD.
Enter the UCM’s IP address into a web browsers’ address bar. The login page should appear (please see the above image).
Enter default administrator username “admin” and password can be found on the sticker at the back of the UCM.
By default, the UCM630X has Redirect From Port 80 enabled. As such, if users type in the UCM630X IP address in the web browser, the web page will be automatically redirected to the page using HTTPS and port 8089. For example, if the LCD shows 192.168.40.167, and 192.168.40.167 is entered into the web browser, the web page will be redirected to: https://192.168.40.167:8089
The option Redirect From Port 80 can be found under the UCM630X SystemSettings > HTTP Server.
Login Failed Attempt
If the user enters a wrong username or password, they will be prompted to resolve a captcha. To resolve the captcha, enter the characters shown in the image.
Note
Captchas are not case sensitive, therefore, there is no need to consider whether the letters need to be upper case or lower case.
Setup Wizard
When you log in to the UCM Web GUI interface for the first time, the system will automatically start the setup wizard and expand the description of the instant messaging soft terminal supporting system ( Wave). Click “Learn more” to open the Wave client download interface.
UCM630x Web GUI Wave guide interface
The setup wizard guides users to complete basic configuration, such as administrator password modification, network settings, time zone settings, extension settings, and routing rule configuration, etc.
UCM630X Setup Wizard
The setup wizard can be closed and reopened at any time. At the end of the wizard, a summary of the pending configuration changes can be reviewed before applying them.
Main Settings
There are 12 main sections in the web portal to manage various features of the UCM.
System Status: Displays the dashboard, system information, current active calls, and network status.
Extensions/Trunks: Manages extensions, trunks, and routing rules.
Call Features: Manages various features of the UCM such as the IVR and voicemail.
Messaging: In this section the main settings for the methods of messaging which are offered by the UCM.
PBX Settings: Manages the settings related to PBX functionality such as SIP settings and interface settings.
System Settings: Manages the settings related to the UCM system itself such as network and security settings.
Contacts: Manages all the type of contacts and departments in the UCM.
Device Management: Manages cameras and Grandstream provisioning mechanism Zero Config.
Maintenance: Manages settings and logs related to system management and maintenance such as
user management, activity logs, backup settings, upgrade settings, and troubleshooting tools.
CDR: Contains the call detail records, statistics, and audio recordings of calls processed by the UCM.
RemoteConnect: the user can view the RemoteConnect purchased for the UCM. The user can also configure related settings from this section.
Integrations: Manages the settings of features unrelated to core PBX functionality such as CRM/PMS integrations.
Web GUI Languages
Currently the UCM630X series Web GUI supports English, Simplified Chinese, Traditional Chinese, Spanish, French, Portuguese, Russian, Italian, Polish, German, Turkish, and Czech.
Users can select the UCM’s web UI display language in the top-right corner of the page.
UCM630X Web GUI Language
Web GUI Search Bar
Users can search for options in the web portal with the search bar on the top right of the page.
Web GUI Search Bar
Saving and Applying Changes
After making changes to a page, click on the “Save” button to save them and then the “Apply Changes” button that finalizes the changes. If a modification requires a reboot, a prompt will appear asking to reboot the device.
Open Source License
On the bottom of the page, as shown in the screenshot below, the user can access the open source license of the UCM6300 Series software.
SYSTEM STATUS
In this category, the user can view different information regarding the general operation of the IPPBX. Such as the dashboard, which displays the resources usage by the processes of the PBX, as well as the trunks created, the status of the different physical interfaces of the device, general statistics about the ongoing calls and meeting, and storage usage information.
Dashboard
Space Usage
Resource Usage
RemoteConnect
PBX Status
Interface Status
Trunks
Device Storage Capacity
UCM6300 Series Dashboard
On the dashboard the user can view different statuses and place the cursor on the different sections to obtain more information about the UCM device. For example, the user can place the cursor on the port icon to view the IP address as shown in the screenshot below.
Interface Status
The administrator can also use the dashboard to view information about the different services of the UCM. Such as the number of multimedia meetings, the number of extensions (registered and unregistered), storage lifespan, etc…
PBX Status
System Information
System Information page provides information regarding the hardware and software information of the UCM device, in addition to the network configuration. Remark tab allows the user to add additional information regarding the UCM device.
General
In General tab, the user can view the hardware and software information. Hardware information include model and part number. Software information include information about the version of the boot loader, the core software, and the PBX software. In addition to Wave Web version, language package version, and the recovery software version.
Network
Network page shows information related to the network interface of the UCM. This includes MAC Address, network configuration assigned by the DHCP server, link speed, and duplex mode.
Remark
In Remark tab, the user can add a note regarding the UCM device to easily identify the device when logged into the user manual.
Remark
Active Calls
The active calls on the UCM6300 Series are displayed in the SystemStatus > Active Calls page. Users can monitor the status, hang up a call, and barge in the active calls in a real-time manner.
To view the status of active calls, navigate to SystemStatus > Active Calls. The following figure shows extension 1004 is calling 1000. 1000 is ringing.
The following figure shows the call between 1000 and 5555 is established.
The gray color of the active call means the connection of call time is less than half an hour. It means this call is normal.
The orange color of the active call means the connection of call time is greater than half an hour but less than one hour. It means this call is a bit long.
The red color of the active call means the connection of call time is more than one hour. It means this call could be abnormal.
Network Status
In this category, the user can view real-time traffic, active connections, and active Unix Domain Sockets
Network Port Real-time Traffic
In this page, the user can view the rate of the data sent and received by the IPPBX. The graphs of the network activity is displayed for each interface.
Network Port Real time Traffic
Active Connection
In this page, the user can view the network ports open and the established connections.
Active Connections
Active Unix Domain Sockets
In the page the user can view the active unix domain sockets.
Active Unix Domain Sockets
EXTENSION/TRUNK
Extensions
Create New SIP Extension
To manually create a new SIP user, go to Extension/Trunk→Extensions. Click on “Add” and a new window will show for users to fill in the extension information.
Create a New SIP Extension
Extension options are divided into the following categories:
Basic Settings
Media
Call Policy
Features
Voicemail
Custom Time
AI
Wave Client
Follow me
Advanced Settings
Select first which type of extension: SIP Extension, IAX Extension, or FXS Extension. The configuration parameters are as follows.
General
Extension
The extension number associated with the user.
CallerID Number
Configure the CallerID Number that would be applied for outbound calls from this user.
Note:
The ability to manipulate your outbound Caller ID may be limited by your VoIP provider.
Call Privileges
Assign permission level to the user. The available permissions are “Internal”, “Local”, “National” and “International” from the lowest level to the highest level. The default setting is “Internal”.
Note: Users need to have the same level as or higher level than an outbound rule’s privilege to make outbound calls using this rule.
SIP/IAX Password
Configure the password for the user. A random secure password will be automatically generated. It is recommended to use this password for security purposes.
Note: The password should contain at least 10 characters, with at least one lower-case letter, one upper-case letter, one numeral, and one special character.
The password must not contain an ascending or descending consecutive numeric sequence, or a consecutive sequence of the same number/letter.
Auth ID
Configure the authentication ID for the user. If not configured, the extension number will be used for authentication.
Voicemail
Configure Voicemail. There are three valid options, and the default option is “Enable Local Voicemail”.
Disable Voicemail: Disable Voicemail.
Enable Local Voicemail: Enable voicemail for the user.
Enable Remote Voicemail: Forward the notify message from the remote voicemail system for the user, and the local voicemail will be disabled. Note: Remote voicemail feature is used only for Infomatec (Brazil).
Voicemail Password
Configure voicemail password (digits only) for the user to access the voicemail box. A random numeric password is automatically generated. It is recommended to use the randomly generated password for security purposes.
Skip Voicemail Password Verification
When a user dials voicemail code, the password verification IVR is skipped. If enabled, this would allow one-button voicemail access. By default, this option is disabled.
Send Voicemail Email Notification
Configures whether to send emails to the extension’s email address to notify of a new voicemail.
Attach Voicemail to Email
Configures whether to attach a voicemail audio file to the voicemail notification emails.
Note: When set to “Default”, the global settings in Basic Call Features > Voicemail > Voicemail Email Settings will be used.
Keep Voicemail after Emailing
Whether to keep the local voicemail recording after sending them. If set to “Default”, the global settings will be used.
Note: When set to “Default”, the global settings in Basic Call Features > Voicemail > Voicemail Email Settings will be used.
Enable Keep-alive
If enabled, an empty SDP packet will be sent to the SIP server periodically to keep the NAT port open. The default setting is “No”.
Keep-alive Frequency
Configure the Keep-alive interval (in seconds) to check if the host is up. The default setting is 60 seconds.
Enable SCA
If enabled, (1) Call Forward, Call Waiting, and Do Not Disturb settings will not work, (2) Concurrent Registrations can be set only to 1, and (3) Private numbers can be added in Advanced Call Features > SCA page.
Emergency CID Name
CallerID name that will be used for emergency calls and callbacks.
Disable This Extension
If selected, this extension will be disabled on the PBX.
Note: The disabled extension still exists on the PBX but cannot be used on the end device.
Sync Contact
If enabled, this extension number will be displayed in the Wave contact, otherwise, it will not be displayed, and it cannot be found in the chat, but the user can still dial this number.
User Settings
First Name
Configure the first name of the user. The first name can contain characters, letters, digits, and _.
Last Name
Configure the last name of the user. The last name can contain characters, letters, digits, and _.
Email Address
Fill in the Email address for the user. Voicemail will be sent to this Email address.
User/Wave Password
Configure the password for user portal access. A random password is automatically generated. It is recommended to use the randomly generated password for security purposes.
The password must respect the following criteria:
At least one lower case letter
At least one upper case letter
At least one numeral
At least one special character
At least 10 total characters
User Portal/Wave Privileges
Change User Portal/Wave Privileges.
Default: Setting this privilege will grant the standard Wave privileges.
Wave Administrator: Setting this privilege will grant the user access to Management Portal on Wave.
Language
Select the voice prompt language to be used for this extension. The default setting is “Default” which is the selected voice prompt language under PBX Settings > Voice Prompt > Language Settings. The dropdown list shows all the currently available voice prompt languages on the PBX. To add more languages to the list, please download the voice prompt package by selecting “Check Prompt List” under PBX Settings > Voice Prompt > Language Settings.
Concurrent Registrations
The maximum endpoints which can be registered to this extension. For security concerns, the default value is 3.
Note: The user can configure up to 10 registrations per extensions.
Mobile Phone Number
Configure the phone number for the extension, user can type the related star code for the phone number followed by the extension number to directly call this number.
For example, the user can type *881000 to call the mobile number associated with extension 1000.
Department
Configure the user’s department. The department can be configured in User Management > Address Book Management > Department Management.
Job Title: The user’s department position.
Contact Privileges
Same as Department Contact Privileges
When enabled, The extension will inherit the same privilege attributed to the department it belongs to.
Contact View Privileges
Select the privileges regarding the contact view in SIP endpoints and Wave.
Use NAT when the PBX is on a public IP communicating with devices hidden behind NAT (e.g., broadband router). If there is a one-way audio issue, usually it is related to NAT configuration or the Firewall’s support of SIP and RTP ports. The default setting is enabled.
Enable Direct Media
By default, the PBX will route the media streams from SIP endpoints through itself. If this option is enabled, the PBX will attempt to redirect the RTP media streams to bypass the PBX and to go directly between caller and callee.
Note: It is not always possible for the PBX to negotiate endpoint-to-endpoint media routing.
DTMF Mode
Select DTMF mode for the user to send DTMF. The default setting is “RFC4733”. If “Info” is selected, the SIP INFO message will be used. If “Inband” is selected, a-law or u-law are required. When “Auto” is selected, RFC4733 will be used if offered, otherwise “Inband” will be used.
Note: The default DTMF mode selected is RFC4733.
TEL URI
If the phone has an assigned PSTN telephone number, this field should be set to “User=Phone”. The “User=Phone” parameter will be attached to the Request-Line and “TO” header in the SIP request to indicate the E.164 number. If set to “Enable”, “Tel” will be used instead of “SIP” in the SIP request.
Alert-Info
When present in an INVITE request, the alert-Info header field specifies an alternative ring tone to the UAS.
Enable T.38 UDPTL
Enable or disable T.38 UDPTL support.
TURN Relay
Enable this option if the following are true:
PBX is deployed on a private network.
There are remote endpoints outside the PBX’s network registering to it via its public IP address.
The network’s firewall is not configured for media port forwarding.
Media NAT penetration is required.
Once a TURN server is configured, media will be forwarded to it. This configuration does not affect endpoints that are registered via the PBX’s RemoteConnect address.
Codec Preference
Select audio and video codec for the extension. The available codecs are: PCMU, PCMA, GSM, AAL2-G.726-32, G,726, G.722, G.729, G.723, iLBC, ADPCM, H.264, H.263, H.263p, RTX and VP8.
QoS
Jitter Buffer
Select the jitter buffer method.
Disable: Jitter buffer will not be used.
Fixed: Jitter buffer with a fixed size (equal to the value of “jitter buffer size”)
Adaptive: Jitter buffer with an adaptive size (no more than the value of “max jitter buffer”).
NetEQ: Dynamic jitter buffer via NetEQ.
Packet Loss Retransmission
Configure to enable Packet Loss Retransmission.
NACK
NACK+RTX(SSRC-GROUP)
OFF
Video FEC
Check to enable Forward Error Correction (FEC) for Video.
Audio FEC
Check to enable Forward Error Correction (FEC) for Audio.
Silence Suppression
If enabled, the PBX will send CN packets for silence suppression after a successful CN negotiation in the SIP SDP. If the client endpoint’s OPUS codec supports the reception of DTX packets, the PBX will send DTX packets instead.
FECC
Configure to enable Remote Camera Management.
RTP Encryption
SRTP
Enable SRTP for the call. The default setting is disabled.
Disabled
Enabled and Enforced: SRTP will be necessary to transmit media traffic. If the IP phone of this extension has SRTP disabled, calls cannot be established.
Optional: The PBX will negotiate whether to use SRTP or not. If the SIP endpoint has SRTP enabled, SRTP will be used. If it is disabled, SRTP will not be used.
SRTP Crypto Suite
SRTP encryption suite used by the PBX for outbound calls. Priority is based on order of configuration.
The following encryption alogrithms can be used to encrypt an RTP stream.
AES_CM_128_HMAC_SHA1_80 (This is the default algorithm used)
AES_256_CM_HMAC_SHA1_80
AEAD_AES_128_GCM
AEAD_AES_256_GCM
ZRTP Encryption Mode
ZRTP, also known as Media Path Key Agreement for Secure RTP, is an encryption protocol which allows negotiating the encryption key for RTP traffic. ZRTP uses Diffie-Hellman exchange to establish an encrypted and secure connection between the PBX and the SIP endpoint.
If the SIP endpoint has both SRTP and ZRTP enabled, ZRTP will always be prioritized.
SIP Extension Configuration Parameters→Media
Presence Status
Presence Status
Select which presence status to set for the extension and configure call forward conditions for each status. Six possible options are possible: “Available”, “Away”, “Chat”, “Custom”, “DND” and “Unavailable”. More details at [PRESENCE].
Note: For supported Cisco endpoints (CP69xx/78xx/88xx series), enabling DND directly from the phone will synchronize with the PBX and update the extension presence status to DND on the UCM. DND synchronization may also function on other Cisco models, although compatibility is not explicitly guaranteed.
Call Transfer
Call Forward Unconditional
Enable and configure the Call Forward Unconditional target number. Available options for target number are:
“None”: Call forward deactivated.
“Extension”: Select an extension from the dropdown list as CFU target.
“Custom Number”: Enter a customer number as a target. For example: *97.
“Voicemail”: Select an extension from the dropdown list. Incoming calls will be forwarded to the voicemail of the selected extension.
“Ring Group”: Select a ring group from the dropdown list as CFU target.
“Queues”: Select a queue from the dropdown list as CFU target.
“Voicemail Group”: Select a voicemail group from the dropdown list as CFU target.
Custom Prompt: The call will be forwarded to a custom prompt.
The default setting is “None”.
CFU Time Condition
Select time condition for Call Forward Unconditional. CFU takes effect only during the selected time condition. The available time conditions are ‘All’, ‘Office Time’, ‘Out of Office Time’, ‘Holiday’, ‘Out of Holiday’, ‘Out of Office Time or Holiday’, ‘Office Time and Out of Holiday’, ‘Specific Time’, ‘Out of Specific Time’, ‘Out of Specific Time or Holiday’, ‘Specific Time and Out of Holiday’.
Notes:
“Specific” has higher priority to “Office Times” if there is a conflict in terms of time period.
Specific time can be configured under the Specific Time section. Scroll down the add Time Condition for a specific time.
Office Time and Holiday could be configured on page System Settings > Time Settings > Office Time/Holiday page.
Call Forward No Answer
Configure the Call Forward No Answer target number. Available options for target number are:
“None”: Call forward deactivated.
“Extension”: Select an extension from the dropdown list as CFN target.
“Custom Number”: Enter a customer number as a target. For example: *97.
“Voicemail”: Select an extension from the dropdown list. Incoming calls will be forwarded to the voicemail of the selected extension.
“Ring Group”: Select a ring group from the dropdown list as CFN target.
“Queues”: Select a queue from the dropdown list as CFN target.
“Voicemail Group”: Select a voicemail group from the dropdown list as CFN target.
Custom Prompt: The call will be forwarded to a custom prompt.
The default setting is “None”.
CFN Time Condition
Select time condition for Call Forward No Answer. The available time conditions are ‘All’, ‘Office Time’, ‘Out of Office Time’, ‘Holiday’, ‘Out of Holiday’, ‘Out of Office Time or Holiday’, ‘Office Time and Out of Holiday’, ‘Specific Time’, ‘Out of Specific Time’, ‘Out of Specific Time or Holiday’, ‘Specific Time and Out of Holiday’.
Notes:
“Specific” has higher priority to “Office Times” if there is a conflict in terms of time period.
Specific time can be configured under the Specific Time section. Scroll down the add Time Condition for a specific time.
Office Time and Holiday could be configured on page System Settings > Time Settings > Office Time/Holiday page.
Call Forward Busy
Configure the Call Forward Busy target number. Available options for target number are:
“None”: Call forward deactivated.
“Extension”: Select an extension from the dropdown list as CFB target.
“Custom Number”: Enter a customer number as a target. For example: *97
“Voicemail”: Select an extension from the dropdown list. Incoming calls will be forwarded to the voicemail of the selected extension.
“Ring Group”: Select a ring group from the dropdown list as CFB target.
“Queues”: Select a queue from the dropdown list as CFB target.
“Voicemail Group”: Select a voicemail group from dropdown list as CFB target.
Custom Prompt:
The default setting is “None”.
CFB Time Condition
Select time condition for Call Forward Busy. The available time conditions ‘All’, ‘Office Time’, ‘Out of Office Time’, ‘Holiday’, ‘Out of Holiday’, ‘Out of Office Time or Holiday’, ‘Office Time and Out of Holiday’, ‘Specific Time’, ‘Out of Specific Time’, ‘Out of Specific Time or Holiday’, ‘Specific Time and Out of Holiday’.
Notes:
“Specific” has higher priority to “Office Times” if there is a conflict in terms of time period.
Specific time can be configured under the Specific Time section. Scroll down the add Time Condition for a specific time.
Office Time and Holiday could be configured on page System Settings > Time Settings > Office Time/Holiday page.
Forwarding Exemption List
Calls from users in the forward exemption list will not be forwarded. Multiple numbers are supported and must be separated by new lines.
Pattern matching is supported.
Z match any digit from 1-9，N match any digit from 2-9，X match any digit from 0-9.
Do Not Disturb
If Do Not Disturb is enabled, all incoming calls will be dropped. All call forward settings will be ignored.
DND Time Condition
Select time condition for Do Not Disturb. The available time conditions are “Office Time”, “Out of Office Time”, “Holiday”, “Out of Holiday”, “Out of Office Time or Holiday”, and “Specific”.
Notes:
“Specific” has higher priority to “Office Times” if there is a conflict in terms of time period.
Specific time can be configured under the Specific Time section. Scroll down the add Time Condition for a specific time.
Office Time and Holiday could be configured on page System Settings > Time Settings > Office Time/Holiday page.
DND Allowlist
If DND is enabled, calls from the allowlisted numbers will not be rejected. Multiple numbers are supported and must be separated by new lines. Pattern matching is supported.
Z match any digit from 1-9.
N match any digit from 2-9.
X match any digit from 0-9.
Call Number Handling Policy
Call Number Handling Policy determines the destination of the calls received. The user can configure the destination based on the a matching pattern of the callee number.
Call Number Matching Mode: Support input extension numbers and pattern matching rules: [12345-9] … Any digit in the brackets. In this example, 1,2,3,4,5,6,7,8,9 are allowed. N … Any digit from 2-9. . … Wildcard, matching one or more characters. ! … Wildcard, matching zero or more characters immediately. X … Any digit from 0-9. Z … Any digit from 1-9. – … Hyphens are used mainly to improve readability and are not involved in pattern matching. [] Contain special characters ([x], [n], [z]) represent letters x, n, z.
Call Destination: Select the destination of the call. These are the destinations which can be set; Disconnect, Extensions, Voicemail, IVR, Hang up After Playing Background Sound, Call Accepted.
If enabled, the PBX will automatically alert this extension when a called party is available, given that a previous call to that party failed for some reason. By default, it is disabled.
CC Mode
Two modes for Call Completion are supported:
Normal: This extension is used as an ordinary extension.
For Trunk: This extension is registered from a PBX.
The default setting is “Normal”.
Call Settings
Call Duration Limit
Block calls for the configured duration.
Maximum Call Duration (s)
The maximum allowed duration of a call in seconds. Default value is 0 (no limit).
The Maximum Number of Call Lines
The maximum number of simultaneous calls that the extension can have. 0 indicates no limit.
Outgoing Call Frequency Limit
If enabled, if the number of outbound calls exceed the configured threshold within the specified period, further outbound will be not be allowed.
Period (m)
The time window for the configured outbound call frequency limit. Supported value range is 1 to 120 minutes. Default value is 1.
Max Number of Calls
The maximum allowed number of outbound calls within the specified period. Supported value range is 1 to 20. Default value is 5.
Ring Simultaneously
Ring Simultaneously
Enable this option to have an external number ring simultaneously along with the extension. If a register trunk is used for outbound, the register number will be used to be displayed for the external number as the caller ID number.
External Number
Set the external number to ring simultaneously. ‘-’ is the connection character that will be ignored.
This field accepts only letters, numbers, and special characters + = * #.
Time Condition for Ring Simultaneously
Ring the external number simultaneously along with the extension based on this time condition.
Use callee DOD on FWD or RS
Use the DOD number when calls are being diverted/forwarded to external destinations or when ring simultaneous is configured.
Monitor Privilege Control
Allowed to be Monitored
When disabled, this user’s calls cannot be listened to by anyone. When enabled, this user’s calls are allowed to be listened to through this extension or the opposite extension.
Call Montoring Allowlist
Add members from “Available Extensions” to “Selected Extensions” so that the selected extensions can spy on the used extension using feature code.
Allow Operator Panel Monitoring
Configure whether this extension can be monitored by the Operator Panel administrator.
Seamless transfer privilege control
Allowed to seamless transfer
Any extensions on the PBX can perform a seamless transfer. When using the Pickup Incall feature, only extensions available on the “Selected Extensions” list can perform a seamless transfer to the edited extension.
PMS Remote Wakeup Whitelist
Select the extensions that can set wakeup service for other extensions
Selected extensions can set a PMS wakeup service for this extension via feature code.
Other Settings
Ring Timeout
Configure the number of seconds to ring the user before the call is forwarded to voicemail (voicemail is enabled) or hang up (voicemail is disabled). If not specified, the default ring timeout is 60 seconds on the PBX. The valid range is between 5 seconds and 600 seconds.
Note: If the end point also has a ring timeout configured, the actual ring timeout used is the shortest time set by either device.
Auto Record
Enable automatic recording for the calls using this extension. The default setting is disabled. The recordings can be accessed under CDR > Recording Files.
Skip Trunk Auth
If set to “yes”, users can skip entering the password when making outbound calls.
If set to “By Time”, users can skip entering the password when making outbound calls during the selected time condition.
If set to “No”, users will be asked to enter the password when making outbound calls.
Time Condition for Skip Trunk Auth
If ‘Skip Trunk Auth’ is set to ‘By Time’, select a time condition during which users can skip entering the password when making outbound calls.
Dial Trunk Password
Configure personal password when making outbound calls via the trunk.
Support Hot-Desking Mode
Check to enable Hot-Desking Mode on the extension. Hot-Desking allows using the same endpoint device and logs in using extension/password combination. This feature is used in scenarios where different users need to use the same endpoint device during a different time of the day for instance. If enabled, SIP Password will accept only alphabet characters and digits. Auth ID will be changed to the same as Extension.
Enable LDAP
If enabled, the extension will be added to the LDAP Phonebook PBX list. Default is enabled.
Use MOH as IVR ringback tone
If enabled, when the call to the extension is made through the IVR, the caller will hear MOH as a ringback tone instead of the regular ringback tone.
Music On Hold
Specify which Music On Hold class to suggest to the bridged channel when putting them on hold.
Max Number of Calls
Set the maximum number of outgoing calls in a period. The valide tange is from 1 to 20. The default value is 5.
Enable Auto-Answer Support
If enabled, the extension will support auto-answer when indicated by Call-info/Alert-info headers.
Call Waiting
Allows calls to the extension even when it is already in a call. This only works if the caller is directly dialing the extension. If disabled, the CC service will take effect only for unanswered and timeout calls.
Stop Ringing
If enabled, when the extension has concurrent registrations on multiple devices, upon incoming call or meeting invite ringing, if one end device rejects the call, the rest of the devices will also stop ringing. By default, it’s disabled.
Email Missed Call Log
If enabled, the log of missed calls will be sent to the extension’s configured email address.
Missed Call Type
If Email Missed Calls enabled, users can select the type of missed calls to be sent via email, the available types are:
Default: All missed calls will be sent in email notifications.
Missed Internal Call: Only missed local extension-to-extension calls will be sent in email notifications.
Missed External Call: Only missed calls from trunks will be sent in email notifications.
Enable SCA (Share Call Appearance)
If enabled, (1) Call Forward, Call Waiting and Do Not Disturb settings will not work, (2) Concurrent Registrations can be set only to 1, and (3) Private numbers can be added in Advanced Call Features > SCA page.
Emergency CID
CallerID name and number that will be used when making emergency calls and receiving direct callbacks. If ELIN subnet mapping has been configured, and the extension is registered to a device in a mapped subnet, the configured ELIN will be used for CID number instead.
Language
Select voice prompt language for this extension. If set to “Default”, the global setting for voice prompt language will be used. If a language is selected, the voice prompt will be in the corresponding language when calling this specific extension.
SIP Extension Configuration Parameters→Features
Specific Time
Time Condition
Click to add Time Condition to configure a specific time for this extension.
SIP Extension Configuration Parameters→Custom Time
AI Call Transcription and Summary
Automatic Transcribing And Summarizing
Enables or disables automatic transcription and summarization for all calls associated with this extension. When enabled, calls for this extension are automatically transcribed and summarized without user action.
Language
Defines the language recognition behavior for call transcription on this extension. The options are:
Follow Global Settings: Uses the language configuration defined under AI Settings.
Automatic Recognition: Automatically detects the spoken language during the call. This is recommended when multiple languages are expected, though recognition accuracy may vary.
Preferred Language: Prioritizes recognition of the selected language, while still allowing multilingual detection with potentially reduced accuracy.
Note: This setting controls only the transcription behavior for this extension. It does not enable or disable AI services at the system level.
AI Voicemail To Text
Automatic Transcription
This section determines whether voicemail messages left for this extension are automatically converted from speech to text.
Language
Specifies the language recognition behavior used for voicemail transcription. The options are:
Follow Global Settings: Uses the language configuration defined under AI Settings.
Automatic Recognition: Automatically detects the spoken language during the call. This is recommended when multiple languages are expected, though recognition accuracy may vary.
Preferred Language: Prioritizes recognition of the selected language, while still allowing multilingual detection with potentially reduced accuracy.
Note: This setting controls only the transcription behavior for this extension. It does not enable or disable AI services at the system level.
SIP Extension Configuration Parameters > AI
General
Enable Wave
Enable Wave for the specific extension.
Allow Concurrent Logins from the Same Client Type
Enables/disables the ability to login to Wave from different sessions on the same type of client
Notes:
Concurrent Registrations limit for the SIP extension will still apply.
When this option is enabled, Concurrent Registrations cannot be configured as “1 (Allowed to Seize)”
This option is disabled by default.
Multi-Factor Authentication
When this option is enabled, the extension user will be prompted to configure multi-factor authentication on their account when they log in using Wave. The user can choose to use an OTP device or application, or they can use their email as a second factor of authentication.
To ensure enabling multi-factor authentication successfully, please refer to the minimum version required below for Wave on each platform
Wave Web: 1.0.27.12 and later
Wave Desktop: 1.27.10 and later
Wave App for Android™: 1.0.27.18 and later
Wave App for iOS™: 1.27.24 and later
Wave Welcome Email
Wave Welcome Email template.
Wave Permission Settings
Clicking the path will direct you to Wave Permission configuration.
Please note that the access to the QR code using the UCM6300 web UI using the admin account has been removed for security and confidentiality reasons.
Follow Me
Enable
Configure to enable or disable Follow Me for this user.
Skip Trunk Auth
If the outbound calls need to check the password, we should enable this option or enable the option “Skip Trunk Auth” of the Extension. Otherwise, this Follow Me cannot call out.
Music On Hold Class
Configure the Music On Hold class that the caller would hear while tracking the user.
Confirm When Answering
If enabled, call will need to be confirmed after answering.
Enable Destination
Configure to enable destination.
Default Destination
The call will be routed to this destination if no one in the Follow Me answers the call.
Use Callee DOD for Follow Me
Use the callee DOD number as CID if configured Follow Me numbers are external numbers.
Play Follow Me Prompt
If enabled, the Follow Me prompt tone will be played.
New Follow Me Number
Add a new Follow Me number which could be a “Local Extension” or an “External Number”. The selected dial plan should have permissions to dial the defined external number.
Dialing Order
This is the order in which the Follow Me destinations will be dialed to reach the user.
SIP Extension Configuration Parameters→Follow Me
SIP Settings
Send PCPID Header
If enabled, this extension's SIP INVITE messages will contain the P-Called-Party-ID (PCPID) header if the callee is a SIP device.
Enable Auto-Answer
If enabled, the extension will support auto-answer when indicated by Call-info/Alert-info headers.
Enable Keep-alive
If enabled, the PBX will regularly send SIP OPTIONS to check if host device is online.
Keep-alive Frequency
Configure the keep-alive interval (in seconds) to check if the host is up.
TEL URI
If "Enabled" option is selected, TEL URI and Remove OBP from Route cannot be enabled at the same time. If the phone has an assigned PSTN telephone number, this field should be set to "User=Phone". A "User=Phone" parameter will then be attached to the Request-Line and "TO" header in the SIP request to indicate the E.164 number. If set to "Enable", "Tel:" will be used instead of "SIP:" in the SIP request.
ACL Policy
Access Control List manages the IP addresses that can register to this extension.
Default: Follows Geo-IP Access Control
Allow Whitelist IP Address: Only whitelisted IP addresses in the configured network segments can register to this extension.
Allow Whitelist IP Address+RemoteConnect: Registrations from whitelisted IP address network segments and RemoteConnect registrations to this extension will be allowed.
Fax
Fax Mode
Configure fax mode. The following options are available:
None: Disable fax support. This is the default option.
Fax Detect: During a call, the fax signal from the user/trunk will be detected, and the received fax will be sent to the user's configured email address. If the destination does not have a configured email address, the fax will be sent to the Default Email Address configured in the Call Features > Fax/T.38 > Fax Settings page.
Fax to Email
If set to "Yes", the fax will be sent to the user-configured email address. If no user email address is found, the fax will be sent to the default email address configured in Fax/T.38 > Fax Settings.
The UCM630X supports Inter-Asterisk eXchange (IAX) protocol. IAX is used for transporting VoIP telephony sessions between servers and terminal devices. Unlike SIP, IAX provides both the session opening and media packet transport. For more information, please refer to RFC 5456.
To manually create a new IAX user, go to Web GUI🡪Extension/Trunk🡪Extensions. Click on “Add” and a new dialog window will show for users which need to make sure first to select the extension type to be IAX Extension before proceeding to fill in the extension information. The configuration parameters are as follows.
General
Extension
The extension number associated with the user.
CallerID Number
Configure the CallerID Number that would be applied for outbound calls from this user. Note: The ability to manipulate your outbound Caller ID may be limited by your VoIP provider.
Privilege
Assign permission level to the user. The available permissions are “Internal”, “Local”, “National” and “International” from the lowest level to the highest level. The default setting is “Internal”.
Note: Users need to have the same level as or higher level than an outbound rule’s privilege to make outbound calls using this rule.
SIP/IAX Password
Configure the password for the user. A random secure password will be automatically generated. It is recommended to use this password for security purposes.
Voicemail
Configure Voicemail.
There are three valid options, and the default option is “Enable Local Voicemail”.
Disable Voicemail: Disable Voicemail.
Enable Local Voicemail: Enable voicemail for the user.
Voicemail Password
Configure voicemail password (digits only) for the user to access the voicemail box. A random numeric password is automatically generated. It is recommended to use the randomly generated password for security purposes.
Skip Voicemail Password Verification
When a user dials voicemail code, the password verification IVR is skipped. If enabled, this would allow one-button voicemail access. By default, this option is disabled.
Send Voicemail Email Notification
Configures whether to send emails to the extension’s email address to notify of a new voicemail.
Attach Voicemail to Email
Configures whether to attach a voicemail audio file to the voicemail notification emails.
Keep Voicemail after Emailing
Only applies if extension-level or global Send Voicemail to Email is enabled.
Disable This Extension
If selected, this extension will be disabled on the UCM630X.
Note: The disabled extension still exists on the PBX but cannot be used on the end device.
User Settings
First Name
Configure the first name of the user. The first name can contain characters, letters, digits, and _.
Last Name
Configure the last name of the user. The last name can contain characters, letters, digits, and _.
Email Address
Fill in the Email address for the user. Voicemail will be sent to this Email address.
User Password
Configure the password for user portal access. A random password is automatically generated. It is recommended to use the randomly generated password for security purposes.
Language
Select the voice prompt language to be used for this extension. The default setting is “Default” which is the selected voice prompt language under Web GUI🡪PBX Settings🡪Voice Prompt🡪Language Settings. The dropdown list shows all the currently available voice prompt languages on the UCM630X. To add more languages to the list, please download the voice prompt package by selecting “Check Prompt List” under Web GUI🡪PBX Settings🡪Voice Prompt🡪Language Settings.
Mobile Phone Number
Configure the Mobile number of the user.
IAX Settings
Max Number of Calls
Configure the maximum number of calls allowed for each remote IP address.
Require Call Token
Configure to enable/disable requiring call token. If set to “Auto”, it might lock out users who depend on backward compatibility when peer authentication credentials are shared between physical endpoints. The default setting is “Yes”.
SRTP
Enable SRTP for the call. The default setting is disabled.
ACL Policy
Access Control List manages the IP addresses that can register to this extension.
Allow All: Any IP address can register to this extension.
Local Network: Only IP addresses in the configured network segments can register to this extension.
Codec Preference
Select audio and video codec for the extension. The available codecs are: PCMU, PCMA, GSM, AAL2-G.726-32, G,726, G.722, G.729, G.723, iLBC, ADPCM, H.264, H.263, H.263p, RTX and VP8.
Call Transfer
Call Forward Unconditional
Configure the Call Forward Unconditional target number. If not configured, the Call Forward Unconditional feature is deactivated. The default setting is deactivated.
CFU Time Condition
Select time condition for Call Forward Unconditional. CFU takes effect only during the selected time condition. The available time conditions are “Office Time”, “Out of Office Time”, “Holiday”, “Out of Holiday”, “Out of Office Time or Holiday”, and “Specific”.
Note:
“Specific” has higher priority to “Office Times” if there is a conflict in terms of time period.
Specific time can be configured on the bottom of the extension configuration dialog. Scroll down the add Time Condition for a specific time.
Office Time and Holiday could be configured on page System Settings🡪Time Settings🡪Office Time/Holiday page.
Call Forward No Answer
Configure the Call Forward No Answer target number. If not configured, the Call Forward No Answer feature is deactivated. The default setting is deactivated.
CFN Time Condition
Select time condition for Call Forward No Answer. The available time conditions are “Office Time”, “Out of Office Time”, “Holiday”, “Out of Holiday”, “Out of Office Time or Holiday”, and “Specific”.
Notes:
“Specific” has higher priority to “Office Times” if there is a conflict in terms of time period.
Specific time can be configured on the bottom of the extension configuration dialog. Scroll down the add Time Condition for a specific time.
Office Time and Holiday could be configured on page System Settings🡪Time Settings🡪Office Time/Holiday page.
Call Forward Busy
Configure the Call Forward Busy target number. If not configured, the Call Forward Busy feature is deactivated. The default setting is deactivated.
CFB Time Condition
Select time condition for Call Forward Busy. The available time conditions are “Office Time”, “Out of Office Time”, “Holiday”, “Out of Holiday”, “Out of Office Time or Holiday”, and “Specific”.
Notes:
“Specific” has higher priority to “Office Times” if there is a conflict in terms of time period.
Specific time can be configured on the bottom of the extension configuration dialog. Scroll down the add Time Condition for a specific time.
Office Time and Holiday could be configured on page System Settings🡪Time Settings🡪Office Time/Holiday page.
Do Not Disturb
If Do Not Disturb is enabled, all incoming calls will be dropped. All call forward settings will be ignored.
DND Time Condition
The time condition of DND. The DND will take effect while the time condition is satisfied.
DND Whitelist
If DND is enabled, calls from the whitelisted numbers will not be rejected. Multiple numbers are supported and must be separated by new lines. Pattern matching is supported.
Z match any digit from 1-9.
N match any digit from 2-9.
X match any digit from 0-9.
FWD Whitelist
Calls from users in the forward whitelist will not be forwarded.
Pattern matching is supported.
Z match any digit from 1-9.
N match any digit from 2-9.
X match any digit from 0-9.
Ring Simultaneously
Ring Simultaneously
Enable this option to have an external number ring simultaneously along with the extension. If a register trunk is used for outbound, the register number will be used to be displayed for the external number as the caller ID number.
External Number
Set the external number to ring simultaneously. ‘-’ is the connection character that will be ignored.
Time Condition for Ring Simultaneously
Ring the external number simultaneously along with the extension based on this time condition.
Use callee DOD on FWD or RS
Use the callee’s DOD number as CallerID on Outgoing Forwarding or Ring Simultaneously calls.
Monitor Privilege Control
Call Monitoring Whitelist
Members of the list can spy on this extension via feature codes.
Seamless transfer privilege control
Allowed to seamless transfer
Members of the list can seamlessly transfer via feature code.
Other Settings
Ring Timeout
Configure the number of seconds to ring the user before the call is forwarded to voicemail (voicemail is enabled) or hang up (voicemail is disabled). If not specified, the default ring timeout is 60 seconds on the UCM630X, which can be configured in the global ring timeout setting under Web GUI🡪PBX Settings🡪Voice Prompt🡪Custom Prompt: General Preference. The valid range is between 5 seconds and 600 seconds.
Note: If the endpoint also has a ring timeout configured, the actual ring timeout used is the shortest time set by either device.
Auto Record
Enable automatic recording for the calls using this extension. The default setting is disabled. The recording files can be accessed under Web GUI🡪CDR🡪Recording Files.
Skip Trunk Auth
If set to “Yes”, users can skip entering the password when making outbound calls.
If set to “By Time”, users can skip entering the password when making outbound calls during the selected time condition.
If set to “No”, users will be asked to enter the password when making outbound calls.
Time Condition for Skip Trunk Auth
If “Skip Trunk Auth” is set to “By Time”, select a time condition during which users can skip entering the password when making outbound calls.
Dial Trunk Password
Configure personal password when making outbound calls via the trunk.
Enable LDAP
If enabled, the extension will be added to LDAP Phonebook PBX lists.
Music On Hold
Configure the Music On Hold class to suggest to the bridged channel when putting them on hold.
Use MOH as IVR ringback tone
If enabled, when the call to the extension is made through the IVR, the caller will hear MOH as a ringback tone instead of the regular ringback tone.
Call Duration Limit
Check to enable and set the call limit the duration.
Maximum Call Duration (s)
The maximum call duration (in seconds). The default value 0 means no limit. Max value is 86400 seconds
Email Missed Calls
Send a log of missed calls to the extension’s email address.
Missed Call Type
If Email Missed Calls enabled, users can select the type of missed calls to be sent via email, the available types are:
Default: All missed calls will be sent in email notifications.
Missed Internal Call: Only missed local extension-to-extension calls will be sent in email notifications.
Missed External Call: Only missed calls from trunks will be sent in email notifications.
IAX Extension Configuration Parameters🡪Specific Time
Specific Time
Time Condition
Click to add Time Condition to configure a specific time for this extension.
Follow Me
Enable
Configure to enable or disable Follow Me for this user.
Skip Trunk Auth
If the outbound calls need to check the password, we should enable this option or enable the option “Skip Trunk Auth” of the Extension. Otherwise, this Follow Me cannot call out.
Music On Hold Class
Configure the Music On Hold class that the caller would hear while tracking the user.
Confirm When Answering
If enabled, call will need to be confirmed after answering.
Enable Destination
Configure to enable destination.
Default Destination
The call will be routed to this destination if no one in the Follow Me answers the call.
Use Callee DOD for Follow Me
Use the callee DOD number as CID if configured Follow Me numbers are external numbers.
Play Follow Me Prompt
If enabled, the Follow Me prompt tone will be played.
New Follow Me Number
Add a new Follow Me number which could be a “Local Extension” or an “External Number”. The selected dial plan should have permissions to dial the defined external number.
Dialing Order
This is the order in which the Follow Me destinations will be dialed to reach the user.
Create New FXS Extension
The UCM630X supports Foreign eXchange Subscriber (FXS) interface. FXS is used when a user needs to connect analog phone lines or FAX machines to the UCM630X.
To manually create a new FXS user, go to Web GUI🡪Extension/Trunk🡪Extensions. Click on “Add” and a new dialog window will show for users which need to make sure first to select the extension type to be FXS Extension before proceeding to fill in the extension information. The configuration parameters are as follows.
General
Extension
The extension number associated with the user.
Analog Station
Select the FXS port to be assigned for this extension.
Caller ID Number
Configure the CallerID Number that would be applied for outbound calls from this user.
Note: The ability to manipulate your outbound Caller ID may be limited by your VoIP provider.
Privilege
Assign permission level to the user. The available permissions are “Internal”, “Local”, “National” and “International” from the lowest level to the highest level. The default setting is “Internal”.
Note: Users need to have the same level as or higher level than an outbound rule’s privilege to make outbound calls using this rule.
Voicemail
Configure Voicemail.
There are three valid options, and the default option is “Enable Local Voicemail”.
Disable Voicemail: Disable Voicemail.
Enable Local Voicemail: Enable voicemail for the user.
Voicemail Password
Configure voicemail password (digits only) for the user to access the voicemail box. A random numeric password is automatically generated. It is recommended to use the randomly generated password for security purposes.
Skip Voicemail Password Verification
When a user dials voicemail code, the password verification IVR is skipped. If enabled, this would allow one-button voicemail access. By default, this option is disabled.
Send Voicemail Email Notification
Configures whether to send emails to the extension’s email address to notify of a new voicemail.
Attach Voicemail to Email
Configures whether to attach a voicemail audio file to the voicemail notification emails.
Keep Voicemail after Emailing
Only applies if extension-level or global Send Voicemail to Email is enabled.
Emergency CID Name
CallerID name that will be used for emergency calls and callbacks.
Disable This Extension
If selected, this extension will be disabled on the UCM630X.
Note: The disabled extension still exists on the PBX but cannot be used on the end device.
User Settings
First Name
Configure the first name of the user. The first name can contain characters, letters, digits, and _.
Last Name
Configure the last name of the user. The last name can contain characters, letters, digits, and _.
Email Address
Fill in the Email address for the user. Voicemail will be sent to this Email address.
User Password
Configure the password for user portal access. A random password is automatically generated. It is recommended to use the randomly generated password for security purposes.
Mobile Phone Number
Configure the Mobile number of the user.
Language
Select the voice prompt language to be used for this extension. The default setting is “Default” which is the selected voice prompt language under Web GUI🡪PBX Settings🡪Voice Prompt🡪Language Settings. The dropdown list shows all the currently available voice prompt languages on the UCM630X. To add more languages to the list, please download the voice prompt package by selecting “Check Prompt List” under Web GUI🡪PBX Settings🡪Voice Prompt🡪Language Settings.
Analog Settings
Call Waiting
Configure to enable/disable call waiting feature. The default setting is “No”.
User ‘#’ as SEND
If configured, the # key can be used as SNED key after dialing the number on the analog phone. The default setting is “Yes”.
RX Gain
Configure the RX gain for the receiving channel of the analog FXS port. The valid range is -30dB to +6dB. The default setting is 0.
TX Gain
Configure the TX gain for the transmitting channel of the analog FXS port. The valid range is -30dB to +6dB. The default setting is 0.
Min RX Flash
Configure the minimum period of time (in milliseconds) that the hook flash must remain unpressed for the PBX to consider the event as a valid flash event. The valid range is 30ms to 1000ms. The default setting is 200ms.
Max RX Flash
Configure the maximum period of time (in milliseconds) that the hook flash must remain unpressed for the PBX to consider the event as a valid flash event. The minimum period of time is 256ms and it cannot be modified. The default setting is 1250ms.
Enable Polarity Reversal
If enabled, a polarity reversal will be marked as received when an outgoing call is answered by the remote party. For some countries, a polarity reversal is used for signaling the disconnection of a phone line and the call will be considered as Hangup on a polarity reversal. The default setting is “Yes”.
Echo Cancellation
Specify “ON”, “OFF” or a value (the power of 2) from 32 to 1024 as the number of taps of cancellation.
Note: When configuring the number of taps, the number 256 is not translated into 256ms of echo cancellation. Instead, 256 taps mean 256/8 = 32 ms. The default setting is “ON”, which is 128 taps.
3-Way Calling
Configure to enable/disable the 3-way calling feature on the user. The default setting is enabled.
Send CallerID After
Configure the number of rings before sending CID. The default setting is 1.
Fax Mode
For the FXS extension, there are three options available in Fax Mode. The default setting is “None”.
None: Disable Fax.
Fax Gateway: If selected, the UCM630X can support the conversation and processing of Fax data from T.30 to T.38 or T.38 to T.30. only for FXS ports.
Fax Detection: During a call, the fax signal from the user/trunk will be detected, and the received fax will be sent to the email address configured for the user. If an email address has been configured for the user, the fax will be sent to the Default Email Address configured in Fax/T.38->Fax Settings.
Call Transfer
Call Forward Unconditional
Configure the Call Forward Unconditional target number. If not configured, the Call Forward Unconditional feature is deactivated. The default setting is deactivated.
CFU Time Condition
Select time condition for Call Forward Unconditional. CFU takes effect only during the selected time condition. The available time conditions are “Office Time”, “Out of Office Time”, “Holiday”, “Out of Holiday”, “Out of Office Time or Holiday”, and “Specific”.
Note:
“Specific” has higher priority to “Office Times” if there is a conflict in terms of time period.
Specific time can be configured on the bottom of the extension configuration dialog. Scroll down the add Time Condition for a specific time.
Office Time and Holiday could be configured on page System Settings🡪Time Settings🡪Office Time/Holiday page.
Call Forward No Answer
Configure the Call Forward No Answer target number. If not configured, the Call Forward No Answer feature is deactivated. The default setting is deactivated.
CFN Time Condition
Select time condition for Call Forward No Answer. The available time conditions are “Office Time”, “Out of Office Time”, “Holiday”, “Out of Holiday”, “Out of Office Time or Holiday”, and “Specific”.
Notes:
“Specific” has higher priority to “Office Times” if there is a conflict in terms of time period.
Specific time can be configured on the bottom of the extension configuration dialog. Scroll down the add Time Condition for a specific time.
Office Time and Holiday could be configured on page System Settings🡪Time Settings🡪Office Time/Holiday page.
Call Forward Busy
Configure the Call Forward Busy target number. If not configured, the Call Forward Busy feature is deactivated. The default setting is deactivated.
CFB Time Condition
Select time condition for Call Forward Busy. The available time conditions are “Office Time”, “Out of Office Time”, “Holiday”, “Out of Holiday”, “Out of Office Time or Holiday”, and “Specific”.
Notes:
“Specific” has higher priority to “Office Times” if there is a conflict in terms of time period.
Specific time can be configured on the bottom of the extension configuration dialog. Scroll down the add Time Condition for a specific time.
Office Time and Holiday could be configured on page System Settings🡪Time Settings🡪Office Time/Holiday page.
Do Not Disturb
If Do Not Disturb is enabled, all incoming calls will be dropped.
All call forward settings will be ignored.
DND Time Condition
The time condition of DND. The DND will take effect while the time condition is satisfied.
DND Whitelist
If DND is enabled, calls from the whitelisted numbers will not be rejected. Multiple numbers are supported and must be separated by new lines. Pattern matching is supported.
Z match any digit from 1-9.
N match any digit from 2-9.
X match any digit from 0-9.
FWD Whitelist
Calls from users in the forward whitelist will not be forwarded.
Pattern matching is supported.
Z match any digit from 1-9.
N match any digit from 2-9.
X match any digit from 0-9.
CC Settings
Enable CC
If enabled, UCM630X will automatically alert this extension when a called party is available, given that a previous call to that party failed for some reason.
Ring Simultaneously
Ring Simultaneously
Enable this option to have an external number ring simultaneously along with the extension. If a register trunk is used for outbound, the register number will be used to be displayed for the external number as the caller ID number.
External Number
Set the external number to ring simultaneously. ‘-’ is the connection character that will be ignored.
Time Condition for Ring Simultaneously
Ring the external number simultaneously along with the extension based on this time condition.
Use callee DOD on FWD or RS
Use the callee’s DOD number as CallerID on Outgoing Forwarding or Ring Simultaneously calls.
Hotline
Enable Hotline
If enabled, a hotline dialing plan will be activated, a pre-configured number will be used according to the selected Hotline Type.
Hotline Number
Configure the Hotline Number
Hotline Type
Configure the Hotline Type:
Immediate Hotline: When the phone is off-hook, UCM630X will immediately dial the preset number
Delay Hotline: When the phone is off hook, if there is no dialing within 5 seconds, UCM630X will dial the preset number.
Monitor privilege control
Members of the list can spy on this extension via feature codes.
Seamless transfer privilege control
Allowed to seamless transfer
Members of the list can seamlessly transfer via feature code.
Other Settings
Ring Timeout
Configure the number of seconds to ring the user before the call is forwarded to voicemail (voicemail is enabled) or hang up (voicemail is disabled). If not specified, the default ring timeout is 60 seconds on the UCM630X, which can be configured in the global ring timeout setting under Web GUI🡪PBX Settings🡪Voice Prompt🡪Custom Prompt: General Preference. The valid range is between 5 seconds and 600 seconds.
Note: If the endpoint also has a ring timeout configured, the actual ring timeout used is the shortest time set by either device.
Auto Record
Enable automatic recording for the calls using this extension. The default setting is disabled. The recording files can be accessed under Web GUI🡪CDR🡪Recording Files.
Skip Trunk Auth
If set to “Yes”, users can skip entering the password when making outbound calls.
If set to “By Time”, users can skip entering the password when making outbound calls during the selected time condition.
If set to “No”, users will be asked to enter the password when making outbound calls.
Time Condition for Skip Trunk Auth
If “Skip Trunk Auth” is set to “By Time”, select a time condition during which users can skip entering a password when making outbound calls.
Dial Trunk Password
Configure personal password when making outbound calls via the trunk.
Enable LDAP
If enabled, this extension will be added to the LDAP Phonebook PBX list; if disabled, this extension will be skipped when creating LDAP Phonebook.
Use MOH as IVR ringback tone
If enabled, when the call to the extension is made through the IVR, the caller will hear MOH as a ringback tone instead of the regular ringback tone.
Music On Hold
Select which Music On Hold class to suggest to the extension when putting the active call on hold.
Call Duration Limit
Check to enable and set the call limit the duration.
Maximum Call Duration (s)
The maximum call duration (in seconds). The default value 0 means no limit. Max value is 86400 seconds
Email Missed Calls
Send a log of missed calls to the extension’s email address.
Missed Call Type
If Email Missed Calls enabled, users can select the type of missed calls to be sent via email, the available types are:
Default: All missed calls will be sent in email notifications.
Missed Internal Call: Only missed local extension-to-extension calls will be sent in email notifications.
Missed External Call: Only missed calls from trunks will be sent in email notifications.
Specific Time
Time Condition
Click to add Time Condition to configure a specific time for this extension.
Follow Me
Enable
Configure to enable or disable Follow Me for this user.
Skip Trunk Auth
If the outbound calls need to check the password, we should enable this option or enable the option "Skip Trunk Auth" of the Extension. Otherwise, this Follow Me cannot call out.
Music On Hold Class
Configure the Music On Hold class that the caller would hear while tracking the user.
Confirm When Answering
If enabled, call will need to be confirmed after answering.
Enable Destination
Configure to enable destination.
Default Destination
The call will be routed to this destination if no one in the Follow Me answers the call.
Use Callee DOD for Follow Me
Use the callee DOD number as CID if configured Follow Me numbers are external numbers.
Play Follow Me Prompt
If enabled, the Follow Me prompt tone will be played.
New Follow Me Number
Add a new Follow Me number which could be a "Local Extension" or an "External Number". The selected dial plan should have permissions to dial the defined external number.
Dialing Order
This is the order in which the Follow Me destinations will be dialed to reach the user.
Batch Add Extensions
Batch Add SIP Extensions
To add multiple SIP extensions, BATCH add can be used to create standardized SIP extension accounts. However, a unique extension username cannot be set using BATCH add.
Under Web GUI🡪Extension/Trunk🡪Extensions, click on “Add” and select extension type as a SIP extension, and “Select Add Method” as Batch.
General
Create Number
Specify the number of extensions to be added. The default setting is 5.
Extension Incrementation
Select how much to increment successive extensions. For example, if the value is 2, the extensions will be 1000,1002,1004, …… Note: Up to 3 characters.
Extension
Configure the starting extension number of the batch of extensions to be added.
Permission
Assign permission level to the user. The available permissions are “Internal”, “Local”, “National” and “International” from the lowest level to the highest level. The default setting is “Internal”.
Note: Users need to have the same level as or higher level than an outbound rule’s privilege to make outbound calls from this rule.
Voicemail
Configure Voicemail.
There are three valid options, and the default option is “Enable Local Voicemail”.
Disable Voicemail: Disable Voicemail.
Enable Local Voicemail: Enable voicemail for the user.
Enable Remote Voicemail: Forward the notify message from the remote voicemail system for the user, and the local voicemail will be disabled. Note: Remote voicemail feature is used only for Infomatec (Brazil).
SIP/IAX Password
Configure the SIP/IAX password for the users. Three options are available to create a password for the batch of extensions.
User Random Password.
A random secure password will be automatically generated. It is recommended to use this password for security purposes.
Use Extension as Password.
Enter a password to be used on all the extensions in the batch.
Voicemail Password
Configure Voicemail password (digits only) for the users.
User Random Password.
A random password in digits will be automatically generated. It is recommended to use this password for security purposes.
Use Extension as Password.
Enter a password to be used on all the extensions in the batch.
Send Voicemail to Email
Send voicemail messages to the configured email address. If set to “Default”, the global setting will be used. Global settings can be found in Voicemail->Voicemail Email Settings.
Keep Voicemail after Emailing
Only applies if extension-level or global Send Voicemail to Email is enabled.
CallerID Number
Configure CallerID Number when adding Batch Extensions.
Use Extension as Number
Users can choose to use the extension number as CallerID
Use as Number
Users can choose to set a specific number instead of using the extension number.
Skip Voicemail Password Verification
When a user dials voicemail code, the password verification IVR is skipped. If enabled, this would allow one-button voicemail access. By default, this option is disabled.
Enable Keep-alive
If enabled, the PBX will regularly send SIP OPTIONS to check if the host device is online.
Keep-alive Frequency
Configure the keep-alive interval (in seconds) to check if the host is up.
Disable This Extension
Check this box to disable this extension.
Enable SCA
If enabled, (1) Call Forward, Call Waiting, and Do Not Disturb settings will not work, (2) Concurrent Registrations can be set only to 1, and (3) Private numbers can be added in Advanced Call Features🡪SCA page.
Emergency Calls CID
CallerID number that will be used when calling out and receiving direct callbacks.
Enable Wave
If enabled, the extension can be registered to and accessed via Wave. If disabled, Wave cannot be used, but regular registration and calling functionality will still work.
Sync Contact
If enabled, this extension number will be displayed in the Wave contact, otherwise, it will not be displayed, and it cannot be found in the chat, but the user can still dial this number.
Language
Select voice prompt language for this extension.
If set to “Default”, the global setting for voice prompt language will be used.
Media
NAT
Use NAT when the PBX is on a public IP communicating with devices hidden behind NAT (e.g., broadband router). If there is a one-way audio issue, usually it is related to NAT configuration or the Firewall’s support of SIP and RTP ports. The default setting is enabled.
Enable Direct Media
By default, the PBX will route the media steams from SIP endpoints through itself. If enabled, the PBX will attempt to negotiate with the endpoints to route the media stream directly. It is not always possible for the PBX to negotiate endpoint-to-endpoint media routing. The default setting is “No”.
DTMF Mode
Select DTMF mode for the user to send DTMF. The default setting is “RFC4733”. If “Info” is selected, the SIP INFO message will be used. If “Inband” is selected, a-law or u-law are required. When “Auto” is selected, RFC4733 will be used if offered, otherwise “Inband” will be used.
Alert-info
When present in an INVITE request, the Alert-info header field specifies an alternative ring tone to the UAS.
SRTP
Enable/disable SRTP for RTP stream encryption.
Packet Loss Retransmission
Configure to enable Packet Loss Retransmission.
NACK
NACK+RTX(SSRC-GROUP)
OFF
Video FEC
Check to enable Forward Error Correction (FEC) for Video.
FECC
Configure to enable FECC
Audio FEC
Check to enable Forward Error Correction (FEC) for Audio.
ACL Policy
Access Control List manages the IP addresses that can register to this extension.
Allow All: Any IP address can register to this extension.
Local Network: Only IP addresses in the configured network segments can register to this extension. Press “Add Local Network Address” to add more IP segments.
Jitter Buffer
Select the jitter buffer method.
Disable: Jitter buffer will not be used.
Fixed: Jitter buffer with a fixed size (equal to the value of “jitter buffer size”)
Adaptive: Jitter buffer with an adaptive size (no more than the value of “max jitter buffer”).
NetEQ: Dynamic jitter buffer via NetEQ.
Codec Preference
Configure the codecs to be used.
Call Transfer
Presence Status
Select which presence status to set for the extension and configure call forward conditions for each status. Six possible options are possible: “Available”, “Away”, “Chat”, “Custom”, “DND” and “Unavailable”. More details at [PRESENCE].
Call Forward Unconditional
Enable and configure the Call Forward Unconditional target number. Available options for target number are:
“None”: Call forward deactivated.
“Extension”: Select an extension from the dropdown list as CFU target.
“Custom Number”: Enter a customer number as a target. For example: *97.
“Voicemail”: Select an extension from the dropdown list. Incoming calls will be forwarded to the voicemail of the selected extension.
“Ring Group”: Select a ring group from the dropdown list as CFU target.
“Queues”: Select a queue from the dropdown list as CFU target.
“Voicemail Group”: Select a voicemail group from the dropdown list as CFU target.
The default setting is “None”.
CFU Time Condition
Select time condition for Call Forward Unconditional. CFU takes effect only during the selected time condition. The available time conditions are “Office Time”, “Out of Office Time”, “Holiday”, “Out of Holiday”, “Out of Office Time or Holiday”, and “Specific”.
Note:
“Specific” has higher priority to “Office Times” if there is a conflict in terms of time period.
Specific time can be configured on the bottom of the extension configuration dialog. Scroll down the add Time Condition for a specific time.
Office Time and Holiday could be configured on page System Settings🡪Time Settings🡪Office Time/Holiday page.
Call Forward No Answer
Configure the Call Forward No Answer target number. Available options for target number are:
“None”: Call forward deactivated.
“Extension”: Select an extension from the dropdown list as CFN target.
“Custom Number”: Enter a customer number as a target. For example: *97.
“Voicemail”: Select an extension from the dropdown list. Incoming calls will be forwarded to the voicemail of the selected extension.
“Ring Group”: Select a ring group from the dropdown list as CFN target.
“Queues”: Select a queue from the dropdown list as CFN target.
“Voicemail Group”: Select a voicemail group from the dropdown list as CFN target.
The default setting is “None”.
CFN Time Condition
Select time condition for Call Forward No Answer. The available time conditions are “Office Time”, “Out of Office Time”, “Holiday”, “Out of Holiday”, “Out of Office Time or Holiday”, and “Specific”.
Notes:
“Specific” has higher priority to “Office Times” if there is a conflict in terms of time period.
Specific time can be configured on the bottom of the extension configuration dialog. Scroll down the add Time Condition for a specific time.
Office Time and Holiday could be configured on page System Settings🡪Time Settings🡪Office Time/Holiday page.
Call Forward Busy
Configure the Call Forward Busy target number. Available options for target number are:
“None”: Call forward deactivated.
“Extension”: Select an extension from the dropdown list as CFB target.
“Custom Number”: Enter a customer number as a target. For example: *97.
“Voicemail”: Select an extension from the dropdown list. Incoming calls will be forwarded to the voicemail of the selected extension.
“Ring Group”: Select a ring group from the dropdown list as CFB target.
“Queues”: Select a queue from the dropdown list as CFB target.
“Voicemail Group”: Select a voicemail group from the dropdown list as CFB target.
The default setting is “None”.
CFB Time Condition
Select time condition for Call Forward Busy. The available time conditions are “Office Time”, “Out of Office Time”, “Holiday”, “Out of Holiday”, “Out of Office Time or Holiday”, and “Specific”.
Notes:
“Specific” has higher priority to “Office Times” if there is a conflict in terms of time period.
Specific time can be configured on the bottom of the extension configuration dialog. Scroll down the add Time Condition for a specific time.
Office Time and Holiday could be configured on page System Settings🡪Time Settings🡪Office Time/Holiday page.
Do Not Disturb
If Do Not Disturb is enabled, all incoming calls will be dropped.
All call forward settings will be ignored.
DND Time Condition
Select time condition for Do Not Disturb. The available time conditions are “Office Time”, “Out of Office Time”, “Holiday”, “Out of Holiday”, “Out of Office Time or Holiday”, and “Specific”.
Notes:
“Specific” has higher priority to “Office Times” if there is a conflict in terms of time period.
Specific time can be configured on the bottom of the extension configuration dialog. Scroll down the add Time Condition for a specific time.
Office Time and Holiday could be configured on page System Settings🡪Time Settings🡪Office Time/Holiday page.
DND Whitelist
If DND is enabled, calls from the whitelisted numbers will not be rejected. Multiple numbers are supported and must be separated by new lines. Pattern matching is supported.
Z matches any digit from 1-9
N matches any digit from 2-9
X matches any digit from 0-9.
FWD Whitelist
Calls from users in the forward whitelist will not be forwarded. Pattern matching is supported.
Z matches any digit from 1-9
N matches any digit from 2-9
X matches any digit from 0-9.
CC Settings
Enable CC
If enabled, UCM630X will automatically alert this extension when a called party is available, given that a previous call to that party failed for some reason. By default, it is disabled.
CC Mode
Two modes for Call Completion are supported:
Normal: This extension is used as an ordinary extension.
For Trunk: This extension is registered from a PBX.
The default setting is “Normal”.
CC Max Agents
Configure the maximum number of CCSS agents which may be allocated for this channel. In other words, this number serves as the maximum number of CC requests this channel can make. The minimum value is 1.
CC Max Monitors
Configure the maximum number of monitor structures that may be created for this device. In other words, this number tells how many callers may request CC services for a specific device at one time. The minimum value is 1.
Ring Simultaneously
Ring Simultaneously
Enable this option to have an external number ring simultaneously along with the extension. If a register trunk is used for outbound, the register number will be used to be displayed for the external number as the caller ID number.
External Number
Set the external number to ring simultaneously. ‘-’ is the connection character that will be ignored.
This field accepts only letters, numbers, and special characters + = * #.
Time Condition for Ring Simultaneously
Ring the external number simultaneously along with the extension based on this time condition.
Use callee DOD on FWD or RS
Use the DOD number when calls are being diverted/forwarded to external destinations or when ring simultaneous is configured.
Monitor privilege control
Allowed to
call-barging
Add members from “Available Extensions” to “Selected Extensions” so that the selected extensions can spy on the used extension using feature code.
Seamless transfer privilege control
Allowed to seamless transfer
Any extensions on the UCM can perform a seamless transfer. When using the Pickup in call feature, only extensions available on the “Selected Extensions” list can perform a seamless transfer to the edited extension.
Other Settings
Ring Timeout
Configure the number of seconds to ring the user before the call is forwarded to voicemail (voicemail is enabled) or hang up (voicemail is disabled). If not specified, the default ring timeout is 60 seconds on the UCM630X, which can be configured in the global ring timeout setting under Web GUI 🡪 PBX Settings 🡪 Voice Prompt 🡪 Custom Prompt: General Preference. The valid range is between 3 seconds and 600 seconds.
Note: If the endpoint also has a ring timeout configured, the actual ring timeout used is the shortest time set by either device.
Auto Record
Enable automatic recording for the calls using this extension. The default setting is disabled. The recordings can be accessed under Web GUI🡪CDR🡪RecordingFiles.
Skip Trunk Auth
If set to “yes”, users can skip entering the password when making outbound calls.
If set to “By Time”, users can skip entering the password when making outbound calls during the selected time condition.
If set to “No”, users will be asked to enter the password when making outbound calls.
Time Condition for Skip Trunk Auth
If ‘Skip Trunk Auth’ is set to ‘By Time’, select a time condition during which users can skip entering a password when making outbound calls.
Dial Trunk Password
Configure personal password when making outbound calls via the trunk.
Enable LDAP
If enabled, the extension will be added to the LDAP Phonebook PBX list.
Bind PMS Room
If enabled, the system will create a room whose room number, by default, will equal the extension number in the PMS module. Note: If this room already exists, the configuration of the existing room will be overwritten.
Music On Hold
Specify which Music On Hold class to suggest to the bridged channel when putting them on hold.
Call Duration Limit
The maximum duration of call-blocking.
Maximum Call Duration
The maximum call duration (in seconds). The default value 0 means no limit.
Call Waiting
If disabled, UCM will not invite the extension when it is already in a call and will do the same work as the user is busy.
Note: the option only works when the caller dials the extension directly.
Batch Add SIP Extension Parameters
Batch Add IAX Extensions
Under Web GUI🡪Extension/Trunk🡪Extensions, click on “Add”, then select extension type as IAX Extension and the add method to be Batch.
General
Create Number
Specify the number of extensions to be added. The default setting is 5.
Extension Incrementation
Select how much to increment successive extensions. For example, if the value is 2, the extensions will be 1000,1002,1004, ……
Extension
The extension number associated with this particular user/phone.
Permission
Assign permission level to the user. The available permissions are “Internal”, “Local”, “National” and “International” from the lowest level to the highest level. The default setting is “Internal”.
Note: Users need to have the same level as or higher level than an outbound rule’s privilege to make outbound calls from this rule.
CallerID Number
Configure the Caller ID number displayed when dialing calls from this user. Note: The Caller ID usage might be limited by your VoIP provider. In Batch Add Method, “e” means to use the extension as the number.
Voicemail
Configure Voicemail. There are three valid options and the default option is “Enable Local Voicemail”.
Disable Voicemail: Disable Voicemail.
Enable Local Voicemail: Enable voicemail for the user.
SIP/IAX Password
Configure the SIP/IAX password for the users. Three options are available to create a password for the batch of extensions.
User Random Password.
A random secure password will be automatically generated. It is recommended to use this password for security purposes.
Use Extension as Password.
Enter a password to be used on all the extensions in the batch.
Voicemail Password
Configure Voicemail password (digits only) for the users.
User Random Password.
A random password in digits will be automatically generated. It is recommended to use this password for security purposes.
Use Extension as Password.
Enter a password to be used on all the extensions in the batch.
Send Voicemail to Email
Send voicemail messages to the configured email address. If set to “Default”, the global setting will be used. Global settings can be found in Voicemail 🡪 Voicemail Email Settings.
Keep Voicemail after Emailing
Only applies if extension-level or global Send Voicemail to Email is enabled.
Auto Record
Enable automatic recording for the calls using this extension. The default setting is disabled. The recording files can be accessed under Web GUI🡪CDR🡪Recording Files.
Skip Voicemail Password Verification
When a user dials voicemail code, the password verification IVR is skipped. If enabled, this would allow one-button voicemail access. By default, this option is disabled.
Disable This Extension
Check this box to disable this extension.
Language
Select voice prompt language for this extension. If set to “Default”, the global setting for voice prompt language will be used.
IAX Settings
Max Number of Calls
Configure the maximum number of calls allowed for each remote IP address.
Require Call Token
Configure to enable/disable requiring call token. If set to “Auto”, it might lock out users who depend on backward compatibility when peer authentication credentials are shared between physical endpoints.
The default setting is “Yes”.
SRTP
Enable/disable SRTP for RTP stream encryption.
ACL Policy
Access Control List manages the IP addresses that can register to this extension.
Allow All: Any IP address can register to this extension.
Local Network: Only IP addresses in the configured network segments can register to this extension.
Codec Preference
Configure the codecs to be used.
Call Transfer
Call Forward Unconditional
Enable and configure the Call Forward Unconditional target number.
CFU Time Condition
Select time condition for Call Forward Unconditional. CFU takes effect only during the selected time condition. The available time conditions are “Office Time”, “Out of Office Time”, “Holiday”, “Out of Holiday”, “Out of Office Time or Holiday”, and “Specific”.
Note:
“Specific” has higher priority to “Office Times” if there is a conflict in terms of time period.
Specific time can be configured on the bottom of the extension configuration dialog. Scroll down the add Time Condition for a specific time.
Office Time and Holiday could be configured on page System Settings🡪Time Settings🡪Office Time/Holiday page.
Call Forward No Answer
Configure the Call Forward No Answer target number.
CFN Time Condition
Select time condition for Call Forward No Answer. The available time conditions are “Office Time”, “Out of Office Time”, “Holiday”, “Out of Holiday”, “Out of Office Time or Holiday”, and “Specific”.
Notes:
“Specific” has higher priority to “Office Times” if there is a conflict in terms of time period.
Specific time can be configured on the bottom of the extension configuration dialog. Scroll down the add Time Condition for a specific time.
Office Time and Holiday could be configured on page System Settings🡪Time Settings🡪Office Time/Holiday page.
Call Forward Busy
Configure the Call Forward Busy target number.
CFB Time Condition
Select time condition for Call Forward Busy. The available time conditions are “Office Time”, “Out of Office Time”, “Holiday”, “Out of Holiday”, “Out of Office Time or Holiday”, and “Specific”.
Notes:
“Specific” has higher priority to “Office Times” if there is a conflict in terms of time period.
Specific time can be configured on the bottom of the extension configuration dialog. Scroll down the add Time Condition for a specific time.
Office Time and Holiday could be configured on page System Settings🡪Time Settings🡪Office Time/Holiday page.
Do Not Disturb
If Do Not Disturb is enabled, all incoming calls will be dropped.
All call forward settings will be ignored.
DND Time Condition
Select time condition for Do Not Disturb. The available time conditions are “Office Time”, “Out of Office Time”, “Holiday”, “Out of Holiday”, “Out of Office Time or Holiday”, and “Specific”.
Notes:
“Specific” has higher priority to “Office Times” if there is a conflict in terms of time period.
Specific time can be configured on the bottom of the extension configuration dialog. Scroll down the add Time Condition for a specific time.
Office Time and Holiday could be configured on page System Settings🡪Time Settings🡪Office Time/Holiday page.
DND Whitelist
If DND is enabled, calls from the whitelisted numbers will not be rejected. Multiple numbers are supported and must be separated by new lines. Pattern matching is supported.
Z match any digit from 1-9，
N match any digit from 2-9，
X match any digit from 0-9.
FWD Whitelist
Calls from users in the forward whitelist will not be forwarded. Pattern matching is supported.
Z match any digit from 1-9，
N match any digit from 2-9，
X match any digit from 0-9.
Ring Simultaneously
Ring Simultaneously
Enable this option to have an external number ring simultaneously along with the extension. If a register trunk is used for outbound, the register number will be used to be displayed for the external number as the caller ID number.
External Number
Set the external number to ring simultaneously. ‘-’ is the connection character that will be ignored.
This field accepts only letters, numbers, and special characters + = * #.
Time Condition for Ring Simultaneously
Ring the external number simultaneously along with the extension based on this time condition.
Use callee DOD on FWD or RS
Use the DOD number when calls are being diverted/forwarded to external destinations or when ring simultaneous is configured.
Monitor privilege control
Allowed to
call-barging
Add members from “Available Extensions” to “Selected Extensions” so that the selected extensions can spy on the used extension using feature code.
Seamless transfer privilege control
Allowed to seamless transfer
Any extensions on the UCM can perform a seamless transfer. When using the Pickup in call feature, only extensions available on the “Selected Extensions” list can perform a seamless transfer to the edited extension.
Other Settings
Ring Timeout
Configure the number of seconds to ring the user before the call is forwarded to voicemail (voicemail is enabled) or hang up (voicemail is disabled). If not specified, the default ring timeout is 60 seconds on the UCM630X, which can be configured in the global ring timeout setting under Web GUI🡪PBX Settings🡪Voice Prompt🡪Custom Prompt: General Preference. The valid range is between 5 seconds and 600 seconds.
Note: If the endpoint also has a ring timeout configured, the actual ring timeout used is the shortest time set by either device.
Auto Record
Enable automatic recording for the calls using this extension. The default setting is disabled. The recordings can be accessed under Web GUI🡪CDR🡪RecordingFiles.
Skip Trunk Auth
If set to “yes”, users can skip entering the password when making outbound calls.
If set to “By Time”, users can skip entering the password when making outbound calls during the selected time condition.
If set to “No”, users will be asked to enter the password when making outbound calls.
Time Condition for Skip Trunk Auth
If ‘Skip Trunk Auth’ is set to ‘By Time’, select a time condition during which users can skip entering a password when making outbound calls.
Dial Trunk Password
Configure personal password when making outbound calls via the trunk.
Enable LDAP
If enabled, the extension will be added to the LDAP Phonebook PBX list.
Music On Hold
Specify which Music On Hold class to suggest to the bridged channel when putting them on hold.
Call Duration Limit
Check to enable and set the call limit the duration.
Maximum Call Duration (s)
The maximum call duration (in seconds). The default value 0 means no limit. Max value is 86400 seconds
Batch Add IAX Extension Parameters
Batch Extension Resetting Functionality
Users can select multiple extensions and reset their settings to default by pressing the reset button and confirming the reset functionality. Once done, all settings on the Basic Settings page will be restored to default values except for Concurrent Registrations. User voicemail password will be reset to Random Password. User voicemail prompts and recordings will be deleted. User Management settings will also be restored to default except for usernames and custom privileges
Search and Edit Extension
All the UCM630X extensions are listed under Web GUI🡪Extension/Trunk🡪Extensions, with status, Extension, CallerID Name, Technology (SIP, IAX, and FXS), IP and Port. Each extension has a checkbox for users to “Edit” or “Delete”. Also, options “Edit” , “Reboot” and “Delete” are available per extension. Users can search for an extension by specifying the extension number to find an extension quickly.
Manage Extensions
Status
Users can see the following icon for each extension to indicate the SIP status.
Green: Idle
Blue: Ringing
Yellow: In Use
Grey: Unavailable (the extension is not registered or disabled on the PBX)
Edit single extension
Click on
to start editing the extension parameters.
Reset single extension
Click on
to reset the extension parameters to default (except concurrent registration).
Other settings will be restored to default in Maintenance🡪UserManagement🡪UserInformation except for username and permissions and delete the user voicemail prompt and voice messages.
Note
This is the expected behavior when you reset an extension:
All the data and configuration on the user side will be deleted. That includes user information, call history, call recordings, faxes, voice mails, meeting schedules and recordings, as well as chat history. However, the data related to the user will be kept on the UCM side.
The extension will be removed from group chats and the messages sent previously by the extension will be kept. However, only other users can search through those messages while the new user of the extension cannot.
If the extension was in a meeting schedule, the meeting will still be present. The extension will be removed from the meeting and will not be notified about the meeting.
Reboot the user
Click on to send NOTIFY reboot event to the device which has a UCM630X extension already registered. To successfully reboot the user, “Zero Config” needs to be enabled on Device Management>Zero Config>Zero Config Settings.
Delete single extension
Click on
to delete the extension. Or select the checkbox of the extension and then click on “Delete Selected Extensions”.
Notes
This is the expected behavior when you delete an extension:
The system will delete all the data of the extension except the CDR and meetings record. All the data on the user side will be erased.
The extension will be removed from group chats and the messages sent previously by the extension will be kept. However, only other users can search through those messages while the new user of the extension cannot.
If the extension was in a meeting schedule, the meeting will still be present. The extension will be removed from the meeting and will not be notified about the meeting.
Modify selected extensions
Select the checkbox for the extension(s). Then click on “Edit” to edit the extensions in a batch.
Delete selected extensions
Select the checkbox for the extension(s). Then click on “Delete ” to delete the extension(s).
Export Extensions
The extensions configured on the UCM630X can be exported to a CSV or XLSX format file with selected technology “SIP”, “IAX” or “FXS”. Click on the “Export Extensions” button and select technology in the prompt below.
Export Extensions
Export Basic Settings
Export Basic Information includes:
Extension
CallerID Number
Privilege
SIP/IAX Password
AuthID
Voicemail
Voicemail Password
Sync Contact
First Name
Last Name
Email Address
User/Wave Password
If importing extensions with no values for settings, the following will occur:
If importing new extensions, or if Replace is selected as the duplicate import option, the default values for those settings will be used.
If Update is selected as the duplicate import option, no changes will be made to the existing settings.
The exported file can serve as a template for users to fill in desired extension information to be imported to the UCM630X.
Import Extensions
The capability to import extensions to the UCM630X provides users the flexibility to batch add extensions with similar or different configurations quickly into the PBX system.
Export extension file from the UCM630X by clicking on the “Export Extensions” button.
Fill up the extension information you would like in the exported template.
Click on the “Import Extensions” button. The following dialog will be prompted.
Import Extensions
Select the option in “On Duplicate Extension” to define how the duplicate extension(s) in the imported file should be treated by the PBX.
Skip: Duplicate extensions in the file will be skipped. The PBX will keep the current extension information as previously configured without change.
Delete and Recreate: The current extension previously configured will be deleted and the duplicate extension in the file will be loaded to the PBX.
Update Information: The current extension previously configured in the PBX will be kept. However, if the duplicate extension in the file has a different configuration for any options, it will override the configuration for those options in the extension.
Click on “Choose file to upload” to select a file from a local directory on the PC.
Click on “Apply Changes” to apply the imported file on the UCM630X.
All time/Office time/out of office time/holiday/out of holiday/out of office time or holiday/specific time
CFN Time Condition
CFB Time Condition
All time/Office time/out of office time/holiday/out of holiday/out of office time or holiday/specific time
Music On Hold
Default/ringbacktone_default
Ring simultaneously
Yes/no
External Number
Digits
Time Condition for Ring Simultaneously
All time/Office time/out of office time/holiday/out of holiday/out of office time or holiday/specific time
Time Condition for Skip Trunk Auth
All time/Office time/out of office time/holiday/out of holiday/out of office time or holiday/specific time
Enable LDAP
Yes/no
Limit Max time (s)
empty
Do Not Disturb
Yes/no
DND Time Condition
All time/Office time/out of office time/holiday/out of holiday/out of office time or holiday/specific time
Do Not Disturb Whitelist
Empty/digits
User Password
Alphanumeric characters.
First Name
Alphanumeric without special characters.
Last Name
Alphanumeric without special characters.
Email Address
Email address
Language
Default/en/zh
Phone Number
Digits
Call-Barging Monitor
Extensions allowed to call barging
Seamless Transfer Members
Extensions allowed to seamless transfer
IAX extensions Imported File Example
Field
Supported Values
Extension
Digits
Technology
FXS
Analog Station
FXS1/FXS2
Enable Voicemail
yes/no
CallerID Number
Digits
Voicemail Password
Digits
Skip Voicemail Password Verification
yes/no
Ring Timeout
Empty/ 3 to 600 (in second)
Auto Record
yes/no
Fax Mode
None/Fax Gateway/Fax Detection
Skip Trunk Auth
Yes/no/bytime
Permission
Internal/Local/National/International
Call Forward Busy
Digits
Call Forward No Answer
Digits
Call Forward Unconditional
Digits
Call Waiting
Yes/no
Use # as SEND
Yes/no
RX Gain
Values from -30🡪6
TX Gain
Values from -30🡪6
MIN RX Flash
Values from: 30 – 1000
MAX RX Flash
Values from: 40 – 2000
Enable Polarity Reversal
Yes/no
Echo Cancellation
On/Off/32/64/128/256/512/1024
3-Way Calling
Yes/no
Send CallerID After
1/2
Dial Trunk Password
digits
Disable This Extension
Yes/no
CFU Time Condition
All time/Office time/out of office time/holiday/out of holiday/out of office time or holiday/specific time
CFN Time Condition
All time/Office time/out of office time/holiday/out of holiday/out of office time or holiday/specific time
CFB Time Condition
All time/Office time/out of office time/holiday/out of holiday/out of office time or holiday/specific time
Music On Hold
Default/ringbacktone_default
CC Agent Policy
If CC is disabled use: never
If CC is set to normal use: generic
If CC is set to trunk use: native
CC Monitor Policy
Generic/never
CCBS Available Timer
3600/4800
CCNR Available Timer
3600/7200
CC Offer Timer
60/120
CC Max Agents
Value from 1-999
CC Max Monitors
Value from 1-999
Ring simultaneously
Yes/no
External Number
Digits
Time Condition for Ring Simultaneously
All time/Office time/out of office time/holiday/out of holiday/out of office time or holiday/specific time
Time Condition for Skip Trunk Auth
Enable LDAP
Yes/no
Enable Hotline
Yes/no
Hotline Type
Immediate hotline/delay hotline
Hotline Number
digits
Limit Max time (s)
empty
Do Not Disturb
Yes/no
DND Time Condition
All time/Office time/out of office time/holiday/out of holiday/out of office time or holiday/specific time
Do Not Disturb Whitelist
Empty/digits
User Password
Alphanumeric characters.
First Name
Alphanumeric without special characters.
Last Name
Alphanumeric without special characters.
Email Address
Email address
Language
Default/en/zh
Phone Number
Digits
Call-Barging Monitor
Extensions allowed to call barging
Seamless Transfer Members
Extensions allowed to seamless transfer
FXS Extensions Imported File Example
The file should contain all the above fields, if one of them is missing or empty, the UCM630X will display the following error message for missing fields.
Import Error
Extension Details
Users can click on an extension number in the Extensions list page and quickly view information about it such as:
Extension: This shows the Extension number.
Status: This shows the status of the extension.
Presence status: Indicates the Presence Status of this extension.
Terminal Type: This shows the type of the terminal using this extension (SIP, FXS…etc.).
Caller ID Name: Reveals the Caller ID Name configured on the extension.
Messages: Shows the messages’ stats.
IP and Port: The IP address and the ports of the device using the extension.
Email status: Show the Email status (sent, to be sent…etc.).
Ring Group: Indicates the ring groups that this extension belongs to.
Call Queue: Indicates the Cal Queues that this extension belongs to.
Call Queue (Dynamic): Indicates the Call Queues that this extension belongs to as a dynamic agent.
Extension Details
Email Notification
Once the extensions are created with Email addresses, the PBX administrator can click on the button “E-mail Notification” to send the account registration and configuration information to the user. Please make sure the Email setting under Web GUI🡪System Settings🡪Email Settings is properly configured and tested on the UCM630X before using “E-mail Notification”.
When clicking on ”More” > “E-mail Notification” button, the following message will be prompted on the web page. Click on OK to confirm sending the account information to all users’ Email addresses.
E mail Notification Prompt Information
The user will receive an Email including account registration information as well as the Wave Settings with the QR code:
Wave Settings and QR Code
Important Note
For security and confidentiality reasons, it is high advisable for the user to change the Wave login extension after the first time log in.
The UCM admin can also send “Remote Registration” and “Wave Welcome” as the figure below shows
Send Remote Registration Mail
Multiple Registrations per Extension
UCM630X supports multiple registrations per extension so that users can use the same extension on devices in different locations.
Multiple Registrations per Extension
This feature can be enabled by configuring the option “Concurrent Registrations” under Web GUI🡪Extension/Trunk🡪Edit Extension. The default value is set to 3 registrations. The maximum is 10. When the option “1(allowed to seize) is selected, the UCM will allow newer registration attempts to seize the extension from a previously registered endpoint. To prevent this behaviour, please select the option 1.
Extension Concurrent Registrations
SMS Message Support
The UCM630X provides built-in SIP SMS message support. For SIP end devices such as Grandstream GXP or GXV phones that support SIP message, after a UCM630X account is registered on the end device, the user can send and receive SMS messages. Please refer to the end device documentation on how to send and receive SMS messages.
SMS Message Support
Extension Groups
The UCM630X extension group feature allows users to assign and categorize extensions in different groups to better manage the configurations on the UCM630X. For example, when configuring “Enable Filter on Source Caller ID”, users could select a group instead of each person’s extension to assign. This feature simplifies the configuration process and helps manage and categorize the extensions for a business environment.
Configure Extension Groups
Extension groups can be configured via Web GUI🡪Extension/Trunk🡪Extension Groups.
Click on to create a new extension group.
Click on to edit the extension group.
Click on to delete the extension group.
Select extensions from the list on the left side to the right side.
Edit Extension Group
Click on to change the ringing priority of the members selected on the group.
Using Extension Groups
Here is an example where the extension group can be used. Go to Web GUI🡪Extension/Trunk🡪Outbound Routes and select “Enable Filter on Source Caller ID”. Both single extensions and extension groups will show up for users to select.
Select Extension Group in Outbound Route
Analog Trunks
Go to Web GUI🡪Extension/Trunk🡪Analog Trunks to add and edit analog trunks.
Click on “Create New Analog Trunk” to add a new analog trunk.
Click on to edit the analog trunk.
Click on to delete the analog trunk.
Analog Trunk Configuratio
The analog trunk options are listed in the table below.
Parameter
Description
FXO Port
Select the channel for the analog trunk.
UCM6301: 1 channel
UCM6302: 2 channels
UCM6304: 4 channels
UCM6308: 8 channels
Trunk Name
Specify a unique label to identify the trunk when listed in outbound rules, incoming rules, etc.
Advanced Options
Disable This Trunk
If selected, the trunk will be disabled, and incoming/Outgoing calls via this trunk will not be possible.
SLA Mode
Enable this option to satisfy two primary use cases, which include emulating a simple key system and creating shared extensions on a PBX. Enable SLA Mode will disable polarity reversal.
Barge Allowed
The barge option specifies whether other stations can join a call in progress on this trunk. If enabled, the other stations can press the line button to join the call.
The default setting is Yes.
This option appears when SLA Mode is enabled.
Hold Access
The hold option specifies hold permissions for this trunk. If set to “Open”, any station can place this trunk on hold and any other station is allowed to retrieve the call. If set to “Private”, only the station that places the call on hold can retrieve the call.
The default setting is Yes.
Enable Polarity Reversal
If enabled, a polarity reversal will be marked as received when an outgoing call is answered by the remote party. For some countries, a polarity reversal is used for signaling the disconnection of a phone line and the call will be considered as “Hangup” on a polarity reversal. The default setting is “No”.
Polarity on Answer Delay (ms)
When the FXO port answers the call, FXS may send a Polarity Reversal. If this interval is shorter than the value of “Polarity on Answer Delay”, the Polarity Reversal will be ignored. Otherwise, the FXO will On-hook to disconnect the call. The default setting is 600ms.
Current Disconnect Threshold (ms)
This is the periodic time (in ms) that the UCM630X will use to check on a voltage drop in the line. The default setting is 200. The valid range is 50 to 3000.
Ring Timeout (ms)
Configure the ring timeout (in ms). Trunk (FXO) devices must have a timeout to determine if there was a Hangup before the line is answered. This value can be used to configure how long it takes before the UCM630X considers a non-ringing line with Hangup activity. The default setting is 8000.
RX Gain
Configure the RX gain for the receiving channel of the analog FXO port. The valid range is from -13.5 (dB) to + 12.0 (dB). The default setting is 0.
TX Gain
Configure the TX gain for the transmitting channel of the analog FXO port. The valid range is from -13.5 (dB) to + 12.0 (dB). The default setting is 0.
Use CallerID
Configure to enable CallerID detection.
The default setting is “Yes”.
Caller ID Scheme
Select the Caller ID scheme for this trunk.
Bellcore/Telcordia
ETSI-FSK During Ringing
ETSI-FSK Prior to Ringing with DTAS
ETSI-FSK Prior to Ringing with LR
ETSI-FSK Prior to Ringing with RP
ETSI-DTMF During Ringing
ETSI-DTMF Prior to Ringing with DTAS
ETSI-DTMF Prior to Ringing with LR
ETSI-DTMF Prior to Ringing with RP
SIN 227-BT
NTT Japan
Auto-Detect
If you are not sure which scheme to choose, please select “Auto Detect”. The default setting is “Bellcore/Telcordia”.
Fax Mode
Configures how faxes to this extension will be handled.
None: Faxes will not be processed.
Fax Gateway: Faxes to this extension will be processed and converted from T.30 to T.38 or vice-versa. FXS/FXO ports only.
The default setting is None.
FXO Dial Delay (ms)
Configure the time interval between off-hook and first dialed digit for outbound calls.
Auto Record
Enable automatic recording for the calls using this trunk. The default setting is disabled. The recording files can be accessed under Web GUI > CDR > Recording Files.
Speed Dial Out
If enabled, a # sign will be automatically added to the end of the called number for outgoing calls to improve dialing efficiency. If the FXS gateway does not support #, it may cause outgoing calls to fail. After activation, the SLA mode will be disabled.
DirectCallback
Allows external numbers the option to get directed to the extension that last called them.
For Example, User 2002 has dialed external number 061234575 but they were not reachable, once they have received missed call notification on their phone, they would mostly call back the number, if the option “Direct Callback” is enabled then they will be directly bridged to user 2002 regardless of the configured inbound destination.
DAHDI Out Line Selection
This is to implement an analog trunk outbound line selection strategy.
Three options are available:
Ascend: When the call goes out from this analog trunk, it will always try to use the first idle FXO port. The port order that the call will use to go out if UCM6302 is used would be port 1🡪port 2🡪. Every time it will start with port 1 (if it is idle).
Poll: When the call goes out from this analog trunk, it will use the port that is not used last time. And it will always use the port in the order of port 1🡪2🡪1🡪2🡪1🡪2🡪…, following the last port being used in case UCM6302, is used.
Descend: When the call goes out from this analog trunk, it will always try to use the last idle FXO port. The port order that the call will use to go out if UCM6302 is used would be port 2🡪port 1. Every time it will start with port 2 (if it is idle).
The default setting is “Ascend” mode.
Max Outgoing Calls
The number of current outgoing calls over the trunk at the same time. The default value 0 means no limit.
Echo Cancellation Mode
The Non-Linear Processing (NLP) in echo cancellation helps to remove/suppress residual echo components that could not be removed by the LEC (Line Echo Canceller). Following modes are supported:
Default: The NLP limits the signal level to the background noise level when active, and the background noise level adjustment is low.
High Noise Level Adjustment: The NLP limits the signal level to the background noise level when active, and the background noise level adjustment is high.
Noise Masking: The NLP sends sign noise when active, and the background noise level adjustment is high.
White Noise Injection: The NLP injects white noise when active. The level corresponds to the background noise level at Sin, and the background noise level adjustment is high.
Max Incoming Calls
The max allowed number of concurrent incoming calls through the trunk. Default is 0 (no limit).
Noise Cancellation RX Frequency (Hz)
Prevents interference from low-frequency signals; when enabled, the RX frequency will only allow signals above this configured value to pass.
These are the supported values:
OFF
20
40
60
200
The default value is "OFF".
Noise Cancellation TX Frequency (Hz)
Prevents interference from low-frequency signals; when enabled, the TX frequency will only allow signals above this configured value to pass.
These are the supported values:
OFF
20
40
60
200
The default value is "OFF".
Enable Total Time Limit For Outbound Calls
If enabled, a limit will be placed on the cumulative duration of outbound calls within a specified period. Once this limit has been reached, further outbound calls from this trunk will not be allowed.
Period
Configure the cumulative period for the total duration of outgoing calls. After reaching the next cycle, the accumulated time will be cleared, and it will start to accumulate again from 0. At the same time, the limit of the time-out trunk will be automatically lifted. If By Month is selected, the cycle will be one natural month, if Quarterly is selected, the cycle will be three months from the current month.
Total Time (m)
Configure the maximum allowed cumulative duration of outbound calls allowed by this trunk within the configured period. Once this limit has been reached, further outbound calls from this trunk will not be allowed.
Tone Settings
Busy Detection
Busy Detection is used to detect far-end Hangup or for detecting busy signal. The default setting is “Yes”.
Busy Tone Count
If “Busy Detection” is enabled, users can specify the number of busy tones to be played before hanging up. The default setting is 2. Better results might be achieved if set to 4, 6, or even 8. Please note that the higher the number is, the more time is needed to Hangup the channel. However, this might lower the probability to get a random Hangup.
Congestion Detection
Congestion detection is used to detect far-end congestion signal. The default setting is “Yes”.
Congestion Count
If “Congestion Detection” is enabled, users can specify the number of congestion tones to wait for. The default setting is 2.
Tone Country
Select the country for tone settings. If “Custom” is selected, users could manually configure the values for Busy Tone and Congestion Tone. The default setting is “United States of America (USA)”.
Frequencies are in Hz and cadence on and off are in ms.
Frequencies Range: [0, 4000)
Busy Level Range: (-300, 0)
Cadence Range: [0, 16383].
Select Tone Country “Custom” to manually configure Busy Tone value.
Default value:
f1=480@-50,f2=620@-50,c=250/250
PSTN Detection
Click on “Detect” to detect the busy tone, Polarity Reversal, and Current Disconnect by PSTN. Before the detection, please make sure there is more than one channel configured and working properly. If the detection has a busy tone, the “Tone Country” option will be set as “Custom”.
PSTN Detection
The UCM630X provides a PSTN detection function to help users detect the busy tone, Polarity Reversal, and Current Disconnect by making a call from the PSTN line to another destination. The detecting call will be answered and up for about 1 minute. Once done, the detecting result will show and can be used for the UCM630X settings.
Go to UCM630X Web GUI🡪Extension/Trunk🡪Analog Trunks page.
Click to edit the analog trunk created for the FXO port.
In the window to edit the analog trunk, go to the “Tone Settings” section and there are two methods to set the busy tone.
Tone Country. The default setting is “United States of America (USA)”.
PSTN Detection.
UCM630X FXO Tone Settings
Click on “Detect” to start PSTN detection.
UCM630X PSTN Detection
If there are two FXO ports connected to PSTN lines, use the following settings for auto-detection.
Detect Model: Auto Detect.
Source Channel: The source channel to be detected.
Destination Channel: The channel to help detect. For example, the second FXO port.
Destination Number: The number to be dialed for detecting. This number must be the actual PSTN number for the FXO port used as the destination channel.
UCM630X PSTN Detection Auto Detect
If there is only one FXO port connected to the PSTN line, use the following settings for auto-detection.
UCM630X PSTN Detection Semi Auto Detect
Detect Model: Semi-auto Detect.
Source Channel: The source channel to be detected.
Destination Number: The number to be dialed for detecting. This number could be a cell phone number or another PSTN number that can be reached from the source channel PSTN number.
Click “Detect” to start detecting. The source channel will initiate a call to the destination number. For “Auto Detect”, the call will be automatically answered. For “Semi-auto Detect”, the UCM630X Web GUI will display a prompt to notify the user to answer or hang up the call to finish the detecting process.
Once done, the detected result will show. Users could save the detecting result as the current UCM630X settings.
Detect Model
Select “Auto Detect” or “Semi-auto Detect” for PSTN detection.
Auto-Detect: Please make sure two or more channels are connected to the UCM630X and in idle status before starting the detection. During the detection, one channel will be used as the caller (Source Channel) and another channel will be used as a callee (Destination Channel). The UCM630X will control the call to be established and hang up between caller and callee to finish the detection.
Semi-auto Detect: Semi-auto detection requires answering or hanging up the call manually. Please make sure one channel is connected to the UCM630X and in idle status before starting the detection. During the detection, the source-channel will be used as a caller and send the call to the configured Destination Number. Users will then need to follow the prompts in Web GUI to help finish the detection.
The default setting is “Auto Detect”.
Source Channel
Select the channel to be detected.
Destination Channel
Select the channel to help detect when “Auto Detect” is used.
Destination Number
Configure the number to be called to help the detection.
Dump Call Progress Tone File
Choose whether to save the calling tone file, it is not checked by default.
PSTN Detection for Analog Trunk
The PSTN detection process will keep the call up for about 1 minute.
If “Semi-auto Detect’ is used, please pick up the call only after being informed from the Web GUI prompt.
Once the detection is successful, the detected parameters “Busy Tone”, “Polarity Reversal” and “Current Disconnect by PSTN” will be filled into the corresponding fields in the analog trunk configuration.
VoIP Trunks
VoIP Trunks
VoIP trunks can be configured on the UCM under Web GUI→Extension/Trunk→VoIP Trunks.
VoIP Trunks Overview Page
Once created, all VoIP trunks will appear in a list showing the following key information:
Provider Name: A user-defined label to identify the trunk.
Status: The current state of the trunk (Registered, Reachable, Unreachable, or Unmonitored).
Active Calls: The number of calls currently using the trunk.
Endpoint Type: The protocol used for the trunk (SIP or IAX).
Type: The trunk type (register, peer, or account).
Hostname/IP Address: The server address of the trunk.
Username: The authentication username for register/account trunks.
Total Time for Outbound Calls (m): The cumulative outbound call duration limit.
Options: Quick access to management functions using the icons described below:
Edit:Opens the trunk configuration page (Basic + Advanced settings).
DOD: Opens Direct Outward Dialing settings for that trunk (maps extensions to outbound CallerID).
Sync LDAP: Starts LDAP phonebook synchronization (only for SIP peer trunks with Sync LDAP enabled).
Delete: Removes the trunk from the UCM system.
The following sections provide a detailed explanation of the available configuration parameters for each trunk type.
Register SIP Trunk
This type of SIP trunk allows registering the trunk to an account SIP trunk, which allows exchanging the calls between two PBXs. This deployment is often found when connecting the UCM to an ITSP service line.
Basic Settings
Provider Name
Configure a unique label to identify this trunk when listed in outbound rules, inbound rules, etc.
Host Name
Configure the IP address or URL for the VoIP provider’s server of the trunk.
Transport
Configure the SIP transport protocol to be used in this trunk. The default setting is "UDP".
UDP
TCP
TLS
SIP URI Scheme When Using TLS
When TLS is selected as Transport for register trunk, users can select
between SIP and SIPS URI scheme.
Keep Original CID
Keep the CID from the inbound call when dialing out. This setting will override the “Keep Trunk CID” option. Please make sure that the peer PBX at the other side supports to match user entry using the “username” field from the authentication line.
Keep Trunk CID
If enabled, the trunk CID will not be overridden by the extension’s CID when the extension has CID configured. The default setting is “No”.
NAT
Turn on this option when the PBX is using public IP and communicating with devices behind NAT. If there is a one-way audio issue, usually it is related to NAT configuration or SIP/RTP port configuration on the firewall.
Disable This Trunk
If selected, the trunk will be disabled.
Note: If a current SIP trunk is disabled, UCM will send UNREGISTER message (REGISTER message with expires=0) to the SIP provider.
TEL URI
If the trunk has an assigned PSTN telephone number, this field should be set to "User=Phone". Then a "User=Phone" parameter will be attached to the Request-Line and TO header in the SIP request to indicate the E.164 number. If set to "Enable", "Tel:" will be used instead of "SIP:" in the SIP request. The default setting is disabled.
Need Registration
Select whether the trunk needs to register on the external server or not when the "Register SIP Trunk" type is selected.
The default setting is No.
Allow outgoing calls if registration fails
If enabled outgoing calls even if the registration to this trunk fails will still be able to go through.
Note that if we uncheck the “Need Registration” option, this option will be ignored.
CallerID Name
Configure the new name of the caller when the extension has no CallerID Name configured.
From Domain
Configure the actual domain name where the extension comes from. This can be used to override the “From” Header.
For example, "trunk.UCM630X.provider.com" is the From Domain in From Header: sip:1234567@trunk.UCM630X.provider.com.
From User
Configure the actual username of the extension. This can be used to override the “From” Header. There are cases where there is a single ID for registration (single trunk) with multiple DIDs.
For example, "1234567" is the From User in From Header: sip:1234567@trunk.UCM630X.provider.com.
Username
Enter the username to register to the trunk from the provider when the "Register SIP Trunk" type is selected.
Password
Enter the password to register to the trunk when "Register SIP Trunk" is selected.
Auth ID
Enter the Authentication ID for the "Register SIP Trunk" type.
Auth Trunk
If enabled, the UCM will send a 401 response to the incoming call to authenticate the trunk.
Auto Record
Enable automatic recording for the calls using this trunk (for SIP trunk only). The default setting is disabled. The recording files can be accessed under Web GUI🡲CDR🡲Recording Files.
RemoteConnect Mode
If enabled, the RemoteConnect related parameters will be set synchronously. Please make the trunk host is allocated by GDMS or it supports TLS.
Direct Callback
Allows external numbers the option to get directed to the extension that last called them.
For Example, User 2002 has dialed external number 061234575, but they were not reachable, once they have received missed call notification on their phone, they would mostly call back the number, if the option “Direct Callback” is enabled then they will be directly bridged to user 2002 regardless of the configured inbound destination.
Monitor Concurrent Calls
If enabled, the "Trunk Concurrent Calls" system event will monitor the number of concurrent calls in this trunk. When the number of concurrent calls in a certain period exceeds the set threshold, an alarm message will be generated. Note: Please turn on the alert for the "Trunk Concurrent Calls" event first.
Concurrent Call Threshold
Threshold of all incoming and outgoing concurrent calls through this trunk.
Outgoing Concurrent Calls Threshold
Threshold of all outgoing concurrent calls passing through this trunk.
Incoming Concurrent Calls Threshold
Threshold of all incoming concurrent calls passing through this trunk.
Advanced Settings
Codec Preference
Select the audio codec for the VoIP trunk. The available codecs are: PCMU, PCMA, GSM, AAL2-G.726-32, G.726, G.722, G.729, G.723, iLBC and ADPCM.
Packet Loss Retransmission
Configure to enable Packet Loss Retransmission.
NACK
NACK+RTX(SSRC-GROUP)
OFF
Audio FEC
Configure to enable Forward Error Correction (FEC).
Video FEC
Video FEC
ICE Support
Toggles ICE support. For peer trunks, ICE support will need to be enabled on the other end.
TURN Relay
TURN servers are used for media NAT traversal and will be prioritized if ICE is also enabled.
FECC
Remote Camera Management
SRTP
Enable SRTP for the call. The default setting is disabled.
Disabled
Enabled and Enforced: SRTP will be necessary to transmit media traffic. If the IP phone of this extension has SRTP disabled, calls cannot be established.
Optional: The UCM will negotiate whether to use SRTP or not. If the SIP endpoint has SRTP enabled, SRTP will be used. If it is disabled, SRTP will not be used.
SRTP Crypto Suite
SRTP encryption suite used by UCM for outbound calls. Priority is based on order of configuration.
The following encryption protocols can be used to encrypt an RTP stream.
AES_CM_128_HMAC_SHA1_80 (This is the default used protocol)
AES_256_CM_HMAC_SHA1_80
AEAD_AES_128_GCM
AEAD_AES_256_GCM
ZRTP Encryption Mode
If disabled, UCM will not support ZRTP encryption. Otherwise, ZRTP will be supported, and if the registered endpoint supports both ZRTP and SRTP, ZRTP will be used first.
Enable T.38 UDPTL
Enable or disable T.38 UDPTL support.
Special Attributes
Carry the ssrc/msid/mid/ct/as/tias/record properties of the SDP. These attributes may cause incompatibility when interconnecting with other devices.
Send PPI Header
If enabled, the SIP INVITE message sent to the trunk will contain PPI (P-Preferred-Identity) header. The default setting is “No”.
Note: “Send PPI Header” and “Send PAI Header” cannot be enabled at the same time. Only one of the two headers can be contained in the SIP INVITE message.
PPI Mode
Default – Include the trunk’s preferred CID (configured in Basic Settings) in the PPI Header.
Original CID – Include the original CID in the PPI Header.
DOD Number – Include the trunk’s DOD number in the PPI Header. If no DOD number has been set, the trunk’s preferred CID will be used.
Default: Include the trunk’s preferred CID (configured in Basic Settings) in the PPI Header.
Original CID: Include the original CID in the PPI Header.
DOD Number: Include the trunk’s DOD number in the PPI Header. If no DOD number has been set, the trunk’s preferred CID will be used.
Send PAI Header
If enabled, the SIP INVITE message sent to the trunk will contain PAI (P-Asserted-Identity) header including configured PAI Header. The default setting is “No”.
Note: “Send PPI Header” and “Send PAI Header” cannot be enabled at the same time. Only one of the two headers can be contained in the SIP INVITE message.
PAI Header
If “Send PAI Header” is enabled and “PAI Header” is configured as “123456” for instance, the PAI header in the SIP message sent from the UCM will contain “123456”. If “Send PAI Header” is enabled and “PAI Header” is configured as “empty”, the PAI header in the SIP message sent from the UCM will contain the original CID.
Note: “Send PAI Header” needs to be enabled to use this feature
Send Anonymous
If checked, the "From" header in the outgoing INVITE message will be set to anonymous.
Passthrough PAI Header
If checked and the option "Send PAI Header" is not checked, the PAI header will be passthrough from one side to the other side.
Send PANI Header
If checked, the INVITE and REGISTER sent to the trunk will contain the P-Access-Network-Info header.
Send Diversion Header
Configure whether or not send Diversion header on the trunk call. Diversion header indicates that the call has been forwarded, it includes information about the call before the forwarding like the original callee and the type of forwarding.
Yes: Include the Diversion header.
No Deflection: Do not include Diversion header if the diversion reason is "deflection". "Deflection" is used as a diversion reason when calls are rerouted to an external number, either through Follow Me or on the inbound route level.
No: Do not the include Diversion header.
Access Network Info
The access network information is in the P-Access-Network-Info header.
Send Anonymous
If checked, the "From" header in the outgoing INVITE message will be set to anonymous.
Outbound Proxy Support
Select to enable outbound proxy in this trunk.
The default setting is "No".
Outbound Proxy
When outbound proxy support is enabled, enter the IP address or URL of the outbound proxy.
Remove OBP from Route
It is used to set if the phone system will remove outbound proxy URI from the route header. If is set to “Yes”, it will remove the route header from SIP requests. The default setting is “No”.
DID Mode
Configure where to get the destination ID of an incoming SIP call, from SIP Request-line or To-header. The default is set to "Request-line".
GIN Registration
If enabled, the UCM will send a GIN REGISTER (generate implicit numbers).
DTMF Mode
Configure the default DTMF mode when sending DTMF on this trunk.
Default: The global setting of DTMF mode will be used. The global setting for the DTMF Mode setting is under Web GUI🡲PBX Settings🡲SIP Settings🡲ToS.
RFC4733: Send DTMF using RFC4733.
Info: Send DTMF using SIP INFO message.
Inband: Send DTMF using inband audio. This requires a 64-bit codec, i.e., PCMU and PCMA.
Auto: Send DTMF using RFC4733 if offered. Otherwise, an inband will be used.
Enable Heartbeat Detection
If enabled, the UCM630X will regularly send SIP OPTIONS to the device to check if the device is still online. The default setting is "No".
Heartbeat Frequency
When the "Enable Heartbeat Detection" option is set to "Yes", configure the interval (in seconds) of the SIP OPTIONS message sent to the device to check if the device is still online. The default setting is 60 seconds.
Max Outgoing Calls
The number of concurrent outgoing calls over the trunk at the same time. The default value is 0, that indicates that there is not set limit.
Max Incoming Calls
The maximum allowed number of concurrent incoming calls through the trunk. Default is 0, this indicate that no limit is set.
Max Concurrent Calls
The maximum allowed number of concurrent incoming and outgoing calls going through the SIP trunk. The default value is 0, and it indicates that no limit has been set.
Response to Blocked Call
Set the response code to the caller when the concurrent calls has reached the upper limit.
480: Temporarily Unavailable
486: Busy Here
503: Service Unavailable
STIR/SHAKEN
Configure this feature to prevent call spoofing, robocalls and spam calls.
Disabled
Outgoing Attest: The UCM will only authenticate the caller ID.
Incoming Verify: The UCM will only verify if the caller ID is authenticated
Both: The UCM will authenticate the oungoing calls as well as verify if the incoming calls are authenticated.
CC Settings
EnableCC
If enabled, the system will automatically alert the user when a called party is available, given that a previous call to that party failed for some reason.
CC Max Agents
Configure the maximum number of CCSS agents which may be allocated for this channel. In other words, this number serves as the maximum number of CC requests this channel is allowed to make. The minimum value is 1.
CC Max Monitors
Configure the maximum number of monitor structures that may be created for this device. In other words, this number tells how many callers may request CC services for a specific device at one time. The minimum value is 1.
Peer SIP Trunk
Peer trunk allows to create a peer-to-peer connection between two PBXs over the internet or in an internal network. This allows the calls to be exchanged between the PBXs.
Basic Settings
Provider Name
Configure a unique label to identify this trunk when listed in outbound rules, inbound rules and etc.
Host Name
Configure the IP address or URL for the VoIP provider’s server of the trunk.
Auto Record
Enable automatic recording for the calls using this trunk (for SIP trunk only). The default setting is disabled. The recording files can be accessed under Web GUI🡪CDR🡪Recording Files.
Keep Original CID
Keep the CID from the inbound call when dialing out, this setting will override “Keep Trunk CID” option. Please make sure that the peer PBX at the other side supports to match user entry using “username” field from authentication line.
Keep Trunk CID
If enabled, the trunk CID will not be overridden by extension’s CID when the extension has CID configured. The default setting is “No”.
NAT
Turn on this option when the PBX is using public IP and communicating with devices behind NAT. If there is one-way audio issue, usually it is related to NAT configuration or SIP/RTP port configuration on the firewall.
Disable This Trunk
If selected, the trunk will be disabled.
Note: If a current SIP trunk is disabled, UCM will send UNREGISTER message (REGISTER message with expires=0) to the SIP provider.
TEL URI
If the trunk has an assigned PSTN telephone number, this field should be set to "User=Phone". Then a "User=Phone" parameter will be attached to the Request-Line and TO header in the SIP request to indicate the E.164 number. If set to "Enable", "Tel:" will be used instead of "SIP:" in the SIP request. The default setting is disabled.
Caller ID Number
Configure the Caller ID. This is the number that the trunk will try to use when making outbound calls. For some providers, it might not be possible to set the CallerID with this option and this option will be ignored.
Important Note: When making outgoing calls, the following priority order rule will be used to determine which CallerID will be set before sending out the call :
CID from inbound call (Keep Original CID Enabled) 🡪 Trunk Username/CallerID (Keep Trunk CID Enabled) 🡪 DOD 🡪 Extension CallerID Number 🡪 Trunk Username/CallerID (Keep Trunk CID Disabled) 🡪 Global Outbound CID.
CallerID Name
Configure the name of the caller to be displayed when the extension has no CallerID Name configured.
Transport
Configure the SIP transport protocol to be used in this trunk. The default setting is "UDP".
UDP
TCP
TLS
Direct Callback
Allows external numbers the option to get directed to the extension that last called them.
For Example: User 2002 has dialed external number 061234575 but they were not reachable, once they have received missed call notification on their phone, they would mostly call back the number, if the option “Direct Callback” is enabled then they will be directly bridged to user 2002 regardless of the configured inbound destination.
RemoteConnect Mode
If enabled, the RemoteConnect related parameters will be set synchronously. Please make the trunk host is allocated by GDMS or it supports TLS.
Monitor Concurrent Calls
If enabled, the number of concurrent calls on this trunk will be monitored. If the "Trunk Concurrent Calls" system alert is enabled, alert notifications will be generated if the number of concurrent calls exceeds this trunk's configured concurrent call thresholds.
Concurrent Call Threshold
Threshold of all incoming and outgoing concrrent calls through this trunk.
Outgoing Concurrent Call Threshold
Threshold of all outgoing concurrent calls passing through this trunk.
Incoming Concurrent Call Threshold
Threshold of all incoming concurrent calls passing through this trunk.
Enable Total Time Limit For Outbound Calls
If enabled, a limit will be placed on the cumulative duration of outbound calls within a specified period. Once this limit has been reached, further outbound calls from this trunk will not be allowed.
Advanced Settings
Codec Preference
Select codec for the VoIP trunk. The available codecs are: PCMU, PCMA, GSM, AAL2-G.726-32, G.726, G.722, G.729, G.723, iLBC, ADPCM, H.264, H.263, H.263p and VP8.
Packet Loss Retransmission
Configure to enable Packet Loss Retransmission.
Audio FEC
Configure to enable Forward Error Correction (FEC) for audio.
Video FEC
Configure to enable Forward Error Correction (FEC) for video.
Media Traversal Method
Select the NAT traversal method for media packets.
None: No NAT traversal mechanism will be used by the UCM.
ICE Support: STUN will be used as a NAT traversal mechanism.
TURN Relay: TURN relay will be used to relay the media packets.
Send PPI Header
If checked, the invite message sent to trunks will contain PPI (P-Preferred-Identity) Header.
Send PAI Header
If checked, the INVITE, 18x and 200 SIP messages sent to trunks will contain P-Asserted-Identity (PAI) header. It is not possible to send both PPI and PAI headers.
Passthrough PAI Header
If enabled and "Send PAI Header" is disabled, PAI headers will be preserved as calls pass through the UCM.
Send PANI Header
If checked, the INVITE sent to the trunk will contain P-Access-Network-Info header.
Send Diversion Header
Configure whether or not send Diversion header on the trunk call. Diversion header indicates that the call has been forwarded, it includes information about the call before the forwarding like the original callee and the type of forwarding.
Yes: Include the Diversion header.
No Deflection: Do not include Diversion header if the diversion reason is "deflection". "Deflection" is used as a diversion reason when calls are rerouted to an external number, either through Follow Me or on the inbound route level.
No: Do not include the Diversion header.
Send Anonymous
If checked, the "From" header in outgoing INVITE message will be set to anonymous.
Outbound Proxy Support
Enable to send outbound signal to the proxy instead of the devices directly.
DID Mode
Configure where to get the destination ID of an incoming SIP call, from SIP Request-line or To-header. The default is set to "Request-line".
GIN Registration
If enabled, the UCM will send a GIN REGISTER (generate implicit numbers).
DTMF Mode
Configure the default DTMF mode when sending DTMF on this trunk.
Default: The global setting of DTMF mode will be used. The global setting for DTMF Mode setting is under Web GUI🡪PBX Settings🡪SIP Settings🡪ToS.
RFC4733: Send DTMF using RFC4733.
Info: Send DTMF using SIP INFO message.
Inband: Send DTMF using inband audio. This requires 64-bit codec, i.e., PCMU and PCMA.
Auto: Send DTMF using RFC4733 if offered. Otherwise, inband is used.
Enable Heartbeat Detection
If enabled, the UCM630xA will regularly send SIP OPTIONS to the device to check if the device is still online. The default setting is "No".
Heartbeat Frequency
When "Enable Heartbeat Detection" option is set to "Yes", configure the interval (in seconds) of the SIP OPTIONS message sent to the device to check if the device is still online. The default setting is 60 seconds.
Max Outgoing Calls
The number of concurrent outgoing calls over the trunk at the same time. The default value 0 means no limit
Max Incoming Calls
The max allowed number of concurrent incoming calls through the trunk.
Response to Blocked Call
Set the response code to the caller when the concurrent calls has reached the upper limit.
480: Temporarily Unavailable.
486: Busy Here
503: Service Unavailable
ICE support
Toggles ICE support. For peer trunks, ICE support will need to be enabled on the other end.
FECC
Configure to enable Far-end Camera Control
Silence Suppression
If enabled, the UCM will send CN packets for silence suppression after a successful CN negotiation in the SIP SDP. If the client endpoint's OPUS codec supports the reception of DTX packets, the UCM will send DTX packets instead.
SRTP
Enable SRTP for the VoIP trunk. The default setting is "No".
ZRTP Encryption Mode
If disabled, UCM will not support ZRTP encryption. Otherwise, ZRTP will be supported, and if the registered endpoint supports both ZRTP and SRTP, ZRTP will be used first.
IPVT Mode
Configures the UCM to be used exclusively for IPVT. Warning: This will lock out certain UCM features.
Sync LDAP Enable
Automatically sync local LDAP phonebooks to a remote peer (SIP peer trunk only). To ensure successful syncing, the remote peer must also enable this service and set the same password as the local UCM. Port 873 is used by default.
Sync LDAP Password: Password used for LDAP phonebook encryption and decryption. The password must be the same for both peers to ensure successful syncing.
LDAP Outbound Rule: Specify an outbound rule. The PBX system will automatically modify the remote contacts by adding prefix parsed from this rule.
LDAP Dialed Prefix: System will automatically modify the remote contacts by adding this prefix.
LDAP Sync Method: Specifies the sync method of the UCM. When an LDAP sync request is received, the UCM will send the phonebook data via the specified method.
LDAP Last Sync Date: The last successful sync date.
Enable T.38 UDPTL
Enable or disable T.38 UDPTL support.
STIR/SHAKEN
Configure this feature to prevent call spoofing, robocalls and spam calls.
Disabled
Outgoing Attest: The UCM will only authenticate the caller ID.
Incoming Verify: The UCM will only verify if the caller ID is authenticated.
Both: The UCM will authenticate the oungoing calls as well as verify if the incoming calls are authenticated.
CC Settings
Enable CC
If enabled, the system will automatically alert the user when a called party is available, given that a previous call to that party failed for some reason.
CC Max Agents
Configure the maximum number of CCSS agents which may be allocated for this channel. In other words, this number serves as the maximum number of CC requests this channel can make. The minimum value is 1.
CC Max Monitors
Configure the maximum number of monitor structures which may be created for this device. In other words, this number tells how many callers may request CC services for a specific device at one time.
The minimum value is 1.
Account SIP Trunk
This type of SIP trunk allows devices such as ATAs and gateways to trunk directly with the UCM6300 to handle and route calls.
This is especially useful when the devices do not have a static IP address for peering or if they cannot register to a UCM extension due to call handling and routing complications.
Basic Settings
Provider Name
Configure a unique label to identify this trunk when listed in outbound rules, inbound rules, etc.
Transport
Configure the SIP transport protocol to be used in this trunk. The default setting is "UDP".
UDP
TCP
TLS
Keep Original CID
Keep the CID from the inbound call when dialing out. This setting will override the “Keep Trunk CID” option. Please make sure that the peer PBX at the other side supports to match user entry using the “username” field from the authentication line.
Keep Trunk CID
If enabled, the trunk CID will not be overridden by the extension’s CID when the extension has CID configured. The default setting is “No”.
NAT
Turn on this option when the PBX is using public IP and communicating with devices behind NAT. If there is a one-way audio issue, usually it is related to NAT configuration or SIP/RTP port configuration on the firewall.
Disable This Trunk
If selected, the trunk will be disabled.
Note: If a current SIP trunk is disabled, UCM will send UNREGISTER message (REGISTER message with expires=0) to the SIP provider.
TEL URI
If the trunk has an assigned PSTN telephone number, this field should be set to "User=Phone". Then a "User=Phone" parameter will be attached to the Request-Line and TO header in the SIP request to indicate the E.164 number. If set to "Enable", "Tel:" will be used instead of "SIP:" in the SIP request. The default setting is disabled.
CallerID Number
Number that the trunk will try to use when making outbound calls.
CID priority from highest to lowest is as follows:
From User (register trunk only) >>> Inbound Call CID (if Keep Original CID is enabled and the call is originally from another trunk) >>> Trunk CID / Register Trunk Username (Keep Trunk CID enabled) >>> DOD CID >>> Extension CID >>> Trunk CID / Register Trunk Username (Keep Trunk CID disabled) >>> Global Outbound CID.
Note 1: Certain providers may ignore this CID.
Note 2: If this CID contains asterisk (*), call recordings from this trunk may be lost when saving them to NAS storage.
CallerID Name
Configure the new name of the caller when the extension has no CallerID Name configured.
Username
Enter the username to register to the trunk from the provider when the "Register SIP Trunk" type is selected.
Password
Enter the password to register to the trunk when "Register SIP Trunk" is selected.
AuthID
Enter the Authentication ID for the "Register SIP Trunk" type.
Auto Record
Enable automatic recording for the calls using this trunk (for SIP trunk only). The default setting is disabled. The recording files can be accessed under Web GUI🡲CDR🡲Recording Files.
Direct Callback
Allows external numbers the option to get directed to the extension that last called them.
For Example, User 2002 has dialed external number 061234575, but they were not reachable, once they have received missed call notification on their phone, they would mostly call back the number, if the option “Direct Callback” is enabled then they will be directly bridged to user 2002 regardless of the configured inbound destination.
Monitor Concurrent Calls
If enabled, the number of concurrent calls on this trunk will be monitored. If the "Trunk Concurrent Calls" system alert is enabled, alert notifications will be generated if the number of concurrent calls exceeds this trunk's configured concurrent call thresholds.
Outgoing Concurrent Calls Threshold
Threshold of all outgoing concurrent calls passing through this trunk.
Incoming Concurrent Calls Threshold
Threshold of all incoming concurrent calls passing through this trunk.
Advanced Settings
Codec Preference
Select the audio codec for the VoIP trunk. The available codecs are: PCMU, PCMA, GSM, AAL2-G.726-32, G.726, G.722, G.729, G.723, iLBC and ADPCM.
Packet Loss Retransmission
Configure to enable Packet Loss Retransmission.
NACK
NACK+RTX(SSRC-GROUP)
OFF
Audio FEC
Configure to enable Forward Error Correction (FEC).
Video FEC
Video FEC
ICE Support
Toggles ICE support. For peer trunks, ICE support will need to be enabled on the other end.
TURN Relay
TURN servers are used for media NAT traversal and will be prioritized if ICE is also enabled.
FECC
Remote Camera Management
SRTP
Toggle encryption of RTP streams.
SRTP Crypto Suite
SRTP encryption suite used by UCM for outbound calls. Priority is based on order of configuration.
ZRTP Encryption Mode
If disabled, UCM will not support ZRTP encryption. Otherwise, ZRTP will be supported, and if the registered endpoint supports both ZRTP and SRTP, ZRTP will be used first.
Enable T.38 UDPTL
Enable or disable T.38 UDPTL support.
Special Attributes
Carry the ssrc/msid/mid/ct/as/tias/record properties of the SDP. These attributes may cause incompatibility when interconnecting with other devices.
Send PPI Header
If enabled, the SIP INVITE message sent to the trunk will contain PPI (P-Preferred-Identity) header. The default setting is “No”.
Note: “Send PPI Header” and “Send PAI Header” cannot be enabled at the same time. Only one of the two headers can be contained in the SIP INVITE message.
PPI Mode
Default – Include the trunk’s preferred CID (configured in Basic Settings) in the PPI Header.
Original CID – Include the original CID in the PPI Header.
DOD Number – Include the trunk’s DOD number in the PPI Header. If no DOD number has been set, the trunk’s preferred CID will be used.
Send PAI Header
If enabled, the SIP INVITE message sent to the trunk will contain PAI (P-Asserted-Identity) header including configured PAI Header. The default setting is “No”.
Note: “Send PPI Header” and “Send PAI Header” cannot be enabled at the same time. Only one of the two headers can be contained in the SIP INVITE message.
PAI Header
If “Send PAI Header” is enabled and “PAI Header” is configured as “123456” for instance, the PAI header in the SIP message sent from the UCM will contain “123456”. If “Send PAI Header” is enabled and “PAI Header” is configured as “empty”, the PAI header in the SIP message sent from the UCM will contain the original CID.
Note:
“Send PAI Header” needs to be enabled to use this feature
Send Anonymous
If checked, the "From" header in the outgoing INVITE message will be set to anonymous.
DOD As From Name
If enabled and "From User" is configured, the INVITE's From header will contain the DOD number.
Note:
Passthrough PAI Header
If checked and the option "Send PAI Header" is not checked, the PAI header will be passthrough from one side to the other side.
Send PANI Header
If checked, the INVITE and REGISTER sent to the trunk will contain the P-Access-Network-Info header.
Send Diversion Header
Configure whether or not send Diversion header on the trunk call. Diversion header indicates that the call has been forwarded, it includes information about the call before the forwarding like the original callee and the type of forwarding.
Yes: Include the Diversion header.
No Deflection: Do not include Diversion header if the diversion reason is "deflection". "Deflection" is used as a diversion reason when calls are rerouted to an external number, either through Follow Me or on the inbound route level.
No: Do not include the Diversion header.
Access Network Info
The access network information is in the P-Access-Network-Info header.
Send Anonymous
If checked, the "From" header in the outgoing INVITE message will be set to anonymous.
Outbound Proxy Support
Select to enable outbound proxy in this trunk.
The default setting is "No".
Outbound Proxy
When outbound proxy support is enabled, enter the IP address or URL of the outbound proxy.
Remove OBP from Route
It is used to set if the phone system will remove outbound proxy URI from the route header. If is set to “Yes”, it will remove the route header from SIP requests. The default setting is “No”.
DID Mode
Configure where to get the destination ID of an incoming SIP call, from SIP Request-line or To-header. The default is set to "Request-line".
GIN Registration
If enabled, the UCM will send a GIN REGISTER (generate implicit numbers).
DTMF Mode
Configure the default DTMF mode when sending DTMF on this trunk.
Default: The global setting of DTMF mode will be used. The global setting for the DTMF Mode setting is under Web GUI🡲PBX Settings🡲SIP Settings🡲ToS.
RFC4733: Send DTMF using RFC4733.
Info: Send DTMF using SIP INFO message.
Inband: Send DTMF using inband audio. This requires a 64-bit codec, i.e., PCMU and PCMA.
Auto: Send DTMF using RFC4733 if offered. Otherwise, an inband will be used.
Enable Heartbeat Detection
If enabled, the UCM630X will regularly send SIP OPTIONS to the device to check if the device is still online. The default setting is "No".
Heartbeat Frequency
When the "Enable Heartbeat Detection" option is set to "Yes", configure the interval (in seconds) of the SIP OPTIONS message sent to the device to check if the device is still online. The default setting is 60 seconds.
The Maximum Number of Call Lines
The maximum number of concurrent calls using the trunk. The default setting is 0, which means no limit.
STIR/SHAKEN
Configure this feature to prevent call spoofing, robocalls and spam calls.
Disabled
Outgoing Attest: The UCM will only authenticate the caller ID.
Incoming Verify: The UCM will only verify if the caller ID is authenticated
Both: The UCM will authenticate the oungoing calls as well as verify if the incoming calls are authenticated.
CC Settings
EnableCC
If enabled, the system will automatically alert the user when a called party is available, given that a previous call to that party failed for some reason.
CC Max Agents
Configure the maximum number of CCSS agents which may be allocated for this channel. In other words, this number serves as the maximum number of CC requests this channel is allowed to make. The minimum value is 1.
CC Max Monitors
Configure the maximum number of monitor structures that may be created for this device. In other words, this number tells how many callers may request CC services for a specific device at one time. The minimum value is 1.
IAX Trunk Configuration
Type
Select the VoIP trunk type.
Peer IAX Trunk
Register IAX Trunk
Provider Name
Configure a unique label to identify this trunk when listed in outbound rules, inbound rules, etc.
Host Name
Configure the IP address or URL for the VoIP provider’s server of the trunk.
Keep Trunk CID
If enabled, the trunk CID will not be overridden by the extension's CID when the extension has CID configured. The default setting is "No".
Username
Enter the username to register to the trunk from the provider when the "Register IAX Trunk" type is selected.
Password
Enter the password to register to the trunk from the provider when the "Register IAX Trunk" type is selected.
Disable This Trunk
If selected, the trunk will be disabled.
Caller ID Number
The number that the trunk will try to use when making outbound calls. CID priority from highest to lowest is as follows:
From User (register trunk only) >>> Inbound Call CID (if Keep Original CID is enabled and the call is originally from another trunk) >>> Trunk CID (Keep Trunk CID enabled) >>> DOD CID >>> Extension CID >>> Register Trunk Username (Keep Trunk CID disabled) >>> Global Outbound CID.
Note 1: Certain providers may ignore this CID.
Note 2: If this CID contains an asterisk (*), call recordings from this trunk might be lost when saving them to NAS storage.
CallerID Name
Configure the new name of the caller when the extension has no CallerID Name configured.
Create New IAX Trunk
Basic Settings
Provider Name
Configure a unique label to identify this trunk when listed in outbound rules, inbound rules, etc.
Host Name
Configure the IP address or URL for the VoIP provider’s server of the trunk.
Keep Trunk CID
If enabled, the trunk CID will not be overridden by the extension’s CID when the extension has CID configured. The default setting is “No”.
Disable This Trunk
If selected, the trunk will be disabled.
Caller ID
Configure the Caller ID. This is the number that the trunk will try to use when making outbound calls. For some providers, it might not be possible to set the CallerID with this option and this option will be ignored.
Important Note: When making outgoing calls, the following priority order rule will be used to determine which CallerID will be set before sending out the call.
From the user (Register Trunk Only) 🡪 CID from inbound call (Keep Original CID Enabled) 🡪 Trunk Username/CallerID (Keep Trunk CID Enabled) 🡪 DOD 🡪 Extension CallerID Number 🡪 Trunk Username/CallerID (Keep Trunk CID Disabled) 🡪 Global Outbound CID.
CallerID Name
Configure the name of the caller to be displayed when the extension has no CallerID Name configured.
Username
Enter the username to register to the trunk from the provider.
Password
Enter the password to register to the trunk from the provider.
Advanced Settings
Codec Preference
Select audio and video codec for the VoIP trunk. The available codecs are: PCMU, PCMA, GSM, AAL2-G.726-32, G.726, G.722, G.729, G.723, iLBC, ADPCM, H.264, H.263, H.263p and VP8.
Enable Heartbeat Detection
If enabled, the UCM630X will regularly send SIP OPTIONS to the device to check if the device is still online. The default setting is “No”.
Heartbeat Frequency
When the “Enable Heartbeat Detection” option is set to “Yes”, configure the interval (in seconds) of the SIP OPTIONS message sent to the device to check if the device is still online. The default setting is 60 seconds.
Maximum Number of Call Lines
The maximum number of concurrent calls using the trunk. The default setting is 0, which means no limit.
Basic Settings
Provider Name
Configure a unique label to identify this trunk when listed in outbound rules, inbound rules, etc.
Host Name
Configure the IP address or URL for the VoIP provider’s server of the trunk.
Keep Trunk CID
If enabled, the trunk CID will not be overridden by the extension’s CID when the extension has CID configured. The default setting is “No”.
Disable This Trunk
If selected, the trunk will be disabled.
Caller ID
Configure the Caller ID. This is the number that the trunk will try to use when making outbound calls. For some providers, it might not be possible to set the CallerID with this option and this option will be ignored.
Important Note: When making outgoing calls, the following priority order rule will be used to determine which CallerID will be set before sending out the call.
CID from inbound call (Keep Original CID Enabled) 🡪 Trunk Username/CallerID (Keep Trunk CID Enabled) 🡪 DOD 🡪 Extension CallerID Number 🡪 Trunk Username/CallerID (Keep Trunk CID Disabled) 🡪 Global Outbound CID..
CallerID Name
Configure the name of the caller to be displayed when the extension has no CallerID Name configured.
Advanced Settings
Codec Preference
Select audio and video codec for the VoIP trunk. The available codecs are: PCMU, PCMA, GSM, AAL2-G.726-32, G.726, G.722, G.729, G.723, iLBC, ADPCM, H.264, H.263, H.263p and VP8.
Enable Heartbeat Detection
If enabled, the UCM630X will regularly send SIP OPTIONS to the device to check if the device is still online. The default setting is “No”.
Heartbeat Frequency
When the “Enable Heartbeat Detection” option is set to “Yes”, configure the interval (in seconds) of the SIP OPTIONS message sent to the device to check if the device is still online. The default setting is 60 seconds.
Maximum Number of Call Lines
The maximum number of concurrent calls using the trunk. The default setting is 0, which means no limit.
Trunk Groups
Users can create VoIP Trunk Groups to register and easily apply the same settings on multiple accounts within the same SIP server. This can drastically reduce the amount of time needed to manage accounts for the same server and improve the overall cleanliness of the web UI.
Trunk Group
Once creating the new trunk group and configuring the SIP settings, users can add multiple accounts within the configured SIP server by pressing the button and configuring the username, password, and authentication ID fields.
Trunk Group Configuration
Trunk Name
Create a unique label to easily identify the trunk for inbound route configuration.
Disable This Trunk
Check this box to disable this trunk.
Auto Record
If enabled, calls handled with this extension/trunk will automatically be recorded.
Monitor Concurrent Calls
If enabled, the number of concurrent calls on this trunk will be monitored. If the "Trunk Concurrent Calls" system alert is enabled, alert notifications will be generated if the number of concurrent calls exceeds this trunk's configured concurrent call thresholds.
Incoming Concurrent Call Threshold
Threshold of all incoming concurrent calls passing through this trunk.
WebRTC Inbound Link Address
This link can be embedded onto a web page. Clicking the link will connect to a pre-configured WebRTC trunk destination. You can also enter this link in the browser address bar to directly access and test WebRTC calls.
Direct Outward Dialing (DOD)
The UCM630X provides Direct Outward Dialing (DOD), which is a service of a local phone company (or local exchange carrier) that allows subscribers within a company’s PBX system to connect to outside lines directly.
Example of how DOD is used:
Company ABC has a SIP trunk. This SIP trunk has 4 DIDs associated with it. The main number of the office is routed to an auto attendant. The other three numbers are direct lines to specific users of the company. Now when a user makes an outbound call their caller ID shows up as the main office number. This poses a problem, as the CEO would like their calls to come from their direct line. This can be accomplished by configuring DOD for the CEO’s extension.
Steps to configure DOD on the UCM630X:
To setup DOD go to UCM630X Web GUI🡪Extension/Trunk🡪VoIP Trunks page.
Click on the “DOD” icon to access the DOD options for the selected SIP Trunk.
Click “Add DOD” to begin your DOD setup
Enter a SIP trunk DID number in the “DOD number” field. In this example, ABC company has a total of 4 DID numbers. Enter the phone number used by the CEO here.
When adding extensions, you can choose whether to “Enable Strip” according to your needs. If it is enabled, you can configure the number (0-64) that will be stripped from the extension number before being added to the DOD number. For example, if the entered digit is 2, and the DOD number for extension 4002 is 1122, then dialing out from 4002, 112202 will be used as the caller ID (DOD).
Select an extension from the “Available Extensions” list. Users have the option of selecting more than one extension. In this case, Company ABC would select the CEO’s extension. After making the selection, click on the button to move the extension(s) to the “Selected Extensions” list.
DOD Extension Selection
Click “Save” at the bottom.
Once completed, the user will return to the EDIT DOD page that shows all the extensions that are associated with a particular DOD.
Edit DOD
From this page users can:
Add Direct Outward Dialing (DOD) entries manually.
Import DOD entries from CSV or XLSX files.
Export DOD entries to CSV or XLSX files.
Filter DOD entries by number or name.
Select multiple DOD entries for bulk operations.
Delete one or multiple selected DOD entries in batch.
For DOD importing, please refer to the screenshot below for the template used.
DOD CSV file Template
Note
If the user imports a DOD number that had already been added. The UCM will prompt to skip, replace, or update the DOD which is already added.
WebRTC Trunks
WebRTC, Web Real-Time Communication, is a real time audio/video chatting framework that allows real-time audio/video chatting through the web browser. WebRTC usually does not refer to the web application itself but to the set of protocols and practices bundled with a graphical interface. Our UCM63xx supports creating WebRTC trunks to use exclusively with web application, this allows the users to join calls and meetings just by clicking a link to a web page.
Below is a figure that shows the options to configure when setting up this feature:
Trunk Name
Create a unique label to easily identify the trunk for inbound route configuration.
Disable This Trunk
Check this box to disable this trunk.
Auto Record
If enabled, calls handled with this extension/trunk will automatically be recorded.
Monitor Concurrent Calls
If enabled, the number of concurrent calls on this trunk will be monitored. If the "Trunk Concurrent Calls" system alert is enabled, alert notifications will be generated if the number of concurrent calls exceeds this trunk's configured concurrent call thresholds.
Incoming Concurrent Call Threshold
Threshold of all incoming concurrent calls passing through this trunk.
WebRTC Inbound Link Address
This link can be embedded onto a web page. Clicking the link will connect to a pre-configured WebRTC trunk destination. You can also enter this link in the browser address bar to directly access and test WebRTC calls.
Important Note
Please note that in order to use WebRTC Trunk feature, the UCM must have a paid RemoteConnect plan. For more information, please refer to the following link: https://ucmrc.gdms.cloud/plans
SLA Station
The UCM630X supports SLA (Shared Line Appearance) that allows mapping the key with LED on a multi-line phone to different external lines. When there is an incoming call and the phone starts to ring, the LED on the key will flash in red and the call can be picked up by pressing this key. This allows users to know if the line is occupied or not. The SLA function on the UCM630X is like BLF but SLA is used to monitor external lines, i.e., analog trunk on the UCM630X. Users could configure the phone with BLF mode on the MPK to monitor the analog trunk status or press the line key pick-up call from the analog trunk on the UCM630X.
Create/Edit Shared Line Appearance Station
Shared Line Appearance Station can be configured on Web GUI🡪Extension/Trunk🡪SLA Station.
SLA Station
Click on to add an Shared Line Appearance Station.
Click on to edit the Shared Line Appearance Station. The following table shows the SLA Station configuration parameters.
Click on to delete the Shared Line Appearance Station.
Station Name
Configure a name to identify the SLA Station.
Station
Specify a SIP extension as a station that will be using SLA.
Available SLA Trunks
Existing Analog Trunks with SLA Mode enabled will be listed here.
Associated SLA Trunks
Select a trunk for this SLA from the Available SLA Trunks list. Click on
to arrange the order. If there are multiple trunks selected, when there are calls on those trunks at the same time, pressing the LINE key on the phone will pick up the call on the first trunk here.
SLA Station Options
Ring Timeout
Configure the time (in seconds) to ring the station before the call is considered unanswered. No timeout is set by default. If set to 0, there will be no timeout.
Ring Delay
Configure the time (in seconds) for a delay before ringing the station when a call first comes in on the shared line. No delay is set by default. If set to 0, there will be no delay.
Hold Access
This option defines the competence of the hold action for one particular trunk. If set to “open”, any station could hold a call on that trunk or resume one held session; if set to “private”, only the station that places the trunk call on hold could resume the session. The default setting is “open”.
SLA Station Configuration Parameters
Sample Configuration
On the UCM630X, go to Web GUI🡪Extension/Trunk🡪Analog Trunks page. Create an analog trunk or edit the existing analog trunk. Make sure “SLA Mode” is enabled for the analog trunk. Once enabled, this analog trunk will be only available for the SLA stations created under Web GUI🡪Extension/Trunk🡪SLA Station page.
Enable SLA Mode for Analog Trunk
Click on “Save”. The analog trunk will be listed with trunk mode “SLA”.
Analog Trunk with SLA Mode Enabled
On the UCM630X, go to Web GUI🡪Extension/Trunk🡪SLA Station page, click on “Add”. Please refer to section [Create/Edit SLA Station] for the configuration parameters. Users can create one or more SLA stations to monitor the analog trunk. The following figure shows station 1005 associated with FXO1 trunk.
SLA Example SLA Station
SLA Example SLA Created
On the SIP phone 2, configure to register UCM630X extension 1005. Configure the MPK as BLF mode and the value must be set to “extension_trunkname”, which is 1005_fxo1 in this case.
SLA Example MPK Configuration
Now the SLA station is ready to use. The following functions can be achieved by this configuration.
Making an outbound call from the station/extension, using LINE key
When the extension is in an idle state, press the line key for this extension on the phone to off-hook. Then dial the station’s extension number, for example, dial 1002 on phone 1 (or dial 1005 on phone 2), to hear the dial tone. Then the users could dial an external number for the outbound call.
Making an outbound call from the station/extension, using the BLF key
When the extension is in an idle state (BLF is lit in green), press the MPK and users could dial external numbers directly.
Answering call using LINE key
When the station is ringing (BLF is blinking in red), press the LINE key to answer the incoming call.
Barging-in active call using BLF key
When there is an active call between an SLA station and an external number using the SLA trunk, other SLA stations monitoring the same trunk could join the call by pressing the BLF key if “Barge Allowed” is enabled for the analog trunk.
Hold/UnHold using BLF key
If the external line is previously put on hold by an SLA station, another station that monitors the same SLA trunk could UnHold the call by pressing the BLF key if “Hold Access” is set to “open” on the analog trunk and the SLA station.
Outbound Routes
This section explains how to configure and manage outbound routes on the UCM630X. Outbound routes control all external outgoing calls initiated by the UCM, regardless of trunk type (SIP, Analog, or Digital).
Configuring Outbound Routes
An outbound route in the UCM630X links a dial pattern to a trunk, allowing different call types to use different trunks. For example:
Users can also configure a failover trunk to handle calls if the primary trunk is unavailable.
To manage outbound routes:
Go to Web GUI→Extension/Trunk→Outbound Routes.
Outbound Routes Overview Page
Click the Add button to create a new outbound route.
Click Import to upload routes in CSV or XLSX format.
Click Export to download routes in CSV or XLSX format.
Click the Edit icon to modify a route.
Click the Delete icon to remove a single route, or use the selection feature to delete multiple outbound routes at once.
On the UCM630X, route selection is determined by the Outgoing Routing Priority feature, which can prioritize routes by either list order or pattern accuracy. For detailed configuration, see the Outgoing Routing Priority section in this guide.
When creating an outbound route, users can configure the parameters described in the table below:
General
Outbound Rule Name
Configure the name of the calling rule (e.g., local, long_distance, etc.). Letters, digits, _ and – are allowed.
Outbound Number Matching Pattern
All patterns are prefixed by the “_” character, but please do not enter more than one “_” at the beginning. All patterns can add comments, such as “_pattern /* comment */”. In patterns, some characters have special meanings:
[12345-9] … Any digit in the brackets. In this example, 1,2,3,4,5,6,7,8,9 is allowed.
N … Any digit from 2-9.
. … Wildcard, matching one or more characters.
! … Wildcard, matching zero or more characters immediately.
X … Any digit from 0-9.
Z … Any digit from 1-9.
– … Hyphen is to connect characters and it will be ignored
[] Contain special characters ([x], [n], [z]) represent letters x, n, z.
Auto Record
If enabled, calls using this route will automatically be recorded.
Local Country Code
If your local country code is affected by the outbound blacklist, please enter it here to bypass the blacklist.
Outbound Route CID
Sets the Caller ID for this outbound route. Format must be “name<number>”, “<number>”, or “number”. This CID is ignored if a DOD is configured.
Note: This field does not apply to analog trunks.
Caller ID Manipulation
Enables Caller ID manipulation for this outbound rule. When enabled, the UCM applies the configured Strip/Prepend rules below to calls using this route. The transformation is applied to both the SIP From header and the Remote-Party-ID (RPID) header to ensure compatibility with ITSPs that use either header for Caller ID processing.
Example: a forwarded caller ID of 0123456789 with a strip of 1 and prepend of +972 will result in +972123456789 in both the From and RPID headers.
Caller ID Mode
Determines which Caller ID numbers the transformation should apply to, this option supports two modes:
Original CID: Transform only the forwarded caller’s number. The UCM must have “Keep Original CID” enabled on the trunk for forwarded calls. Otherwise, to avoid overwriting the number before applying the transformation.
All: Apply transformations to every outbound number on this route
The default setting is “Original CID”.
Strip
Specifies the number of leading characters to remove from the Caller ID before sending the call out. Only numeric values (0–2) are allowed.
Prepend
Defines characters to add in front of the Caller ID after stripping. Used to adjust Caller ID format to match ITSP requirements. Supports 0–20 characters (Digits, Letters, + – * # only).
Don’t Call Me Blocklist
If enabled, outgoing calls will first be checked against the “Don’t Call Me” database. If the called number is in the database, the call will be blocked.
After creating the outbound route, users can choose to enable and disable it. If the route is disabled, it will not take effect anymore. However, the route settings will remain in UCM. Users can enable it again when it is needed.
Outbound Permission
Password Settings
Configures the authentication method for this outbound route. The options are:
Password: The configured password will be used.
PIN Groups: The PIN number related to the configured PIN Group will be used
The default option is “Password”.
Password
Configure the password for users to use this rule when making outbound calls.
PIN Groups
Select a PIN Group
PIN Groups with Privilege Level
If enabled and PIN Groups are used, Privilege Levels and Filter on Source Caller ID will also be applied.
Privilege Level
Select the privilege level for the outbound rule.
Internal: The lowest level required. All users can use this rule.
Local: Users with Local, National, or International levels can use this rule.
National: Users with National or International levels can use this rule.
International: The highest level required. Only users with the international level can use this rule.
Disable: The default setting is “Disable”. If selected, only the matched source caller ID will be allowed to use this outbound route.
Please be aware of the potential security risks when using the “Internal” level, which means all users can use this outbound rule to dial out from the trunk.
Enable Source Caller ID Allowlist
When enabled, users could specify extensions allowed to use this outbound route. “Privilege Level” is automatically disabled if using “Enable Source Caller ID Allowlist”.
The following two methods can be used at the same time to define the extensions as the source caller ID.
Select available extensions/extension groups from the list. This allows users to specify arbitrary single extensions available in the PBX.
Custom Dynamic Route: define the pattern for the source caller ID. This allows users to define extension range instead of selecting them one by one.
All patterns are prefixed with the “_”.
Special characters
X: Any Digit from 0-9. Z: Any Digit from 1-9. N: Any Digit from 2-9. “.“: Wildcard. Match one or more characters. “!“: Wildcard. Match zero or more characters immediately.
Example: [12345–9] – Any digit from 1 to 9.
Note: Multiple patterns can be used. Patterns should be separated by a comma “,”. Example: _X. , _NNXXNXXXXX, _818X.
Call Duration Limit
Enable to configure the maximum duration for the call using this outbound route.
Per-Call Duration Limit
Enable to configure the maximum duration of each call using this outbound route. Once this duration has been reached the call will be terminated.
Maximum Call Duration (s)
Configure the maximum duration of the call (in seconds). The default setting is 0, which means no limit.
Warning Time (s)
Configure the warning time for the call using this outbound route. If set to x seconds, the warning tone will be played to the caller when x seconds are left to end the call.
Warning Repeat Interval (s)
Configure the warning repeat interval for the call using this outbound route. If set to X seconds, the warning tone will be played every x seconds after the first warning.
Total Call Duration Limit
Enables setting a maximum total call time for this outbound route within a specified period.
Period
Configures the cumulative period for total outgoing call duration. At the start of each new cycle, accumulated time resets to 0 and any outbound time limits are lifted. The options are:
Monthly: cycle is one calendar month.
Quarterly: cycle is three months from the current month.
The defaullt option is “Monthly”.
Total Time (m)
Specifies the maximum total call duration allowed for the route within the selected period, in minutes. Once this limit is reached, further calls through this route will be blocked until the period resets.
Main Trunk
Trunk
Select the trunk for this outbound rule.
Strip
Allows the user to specify the number of digits that will be stripped from the beginning of the dialed string before the call is placed via the selected trunk.
Example: The users will dial 9 as the first digit of long-distance calls. In this case, 1 digit should be stripped before the call is placed.
Prepend
Specify the digits to be prepended before the call is placed via the trunk. Those digits will be prepended after the dialing number is stripped.
Failover Trunk
Failover Trunk
Failover trunks can be used to make sure that a call goes through an alternate route when the primary trunk is busy or down. If “Use Failover Trunk” is enabled and “Failover trunk” is defined, the calls that cannot be placed via the regular trunk may have a secondary trunk to go through.
10 failover trunks are supported.
Strip
Allows the user to specify the number of digits that will be stripped from the beginning of the dialed string before the call is placed via the selected trunk.
Example: The users will dial 9 as the first digit of long-distance calls. In this case, 1 digit should be stripped before the call is placed.
Prepend
Specify the digits to be prepended before the call is placed via the trunk. Those digits will be prepended after the dialing number is stripped.
Time Condition
Time Condition Mode
Use Main Trunk or Failover Trunk: Use the Main Trunk and its settings during the configured time conditions. If the main trunk is unavailable, the Failover Trunk and its settings will be used instead.
Use Specific Trunks: Use specific trunks during the configured time conditions. The Strip and Prepend settings of the Main Trunk will be used. If a trunk is unavailable during its time condition, no failover trunks will be used.
Failover Trunk Toggles
This option controls whether failover trunks will be used if receiving specific responses to outgoing calls.
Outbound Routes
Failover Trunk Toggles
If a call receives the selected response codes, the UCM will not be redirect it to the call route’s failover trunk.
Note
Due to the addition of this option, the Enable 486 to Failover Trunks option under PBX Settings🡪General Settings page has been removed.
Carrier
In Carrier page, the user can configure LCR, Least Cost Routing, which is a mechanism where the user can set the priority for the trunks to use when emitting a call. Typically for Least Cost Routing, the user can set higher priority for the trunks which have a lower call rate. This is an effective approach to use the trunks which have a lower cost, and in the case when they cannot be used, like when they are down or many concurrent calls, the next trunk in the list will be used.
To configure this option, navigate to Extension/Trunk > Outbound Routes and click on Carrier.
On the list of carriers, please click on “Add”.
Select the trunks to apply the rates on, the add the rate in Carrier Rates section.
Click on “Add” button under Carrier Rates section.
Add Call Rate
Parameter Name
Description
Match Prefix
If the prefix entered is matched, this rate will apply to this call.
Rate
Enter the rate of the call.
Expiration Date
Select the expiraton date and time
Note:
To learn more about configuring the LCR feature and how it operates on the UCM6300 series, please refer to the Grandstream Billing System Guide.
Outbound Routes DOD
It is possible to specify DOD number based on Outbound Route, as displayed on the screenshot below. For each outbound route.
Outbound Routes Page
DOD for First Outbound Route
DOD for Second Outbound Route
Outbound Blacklist
The UCM630X allows users to configure a blacklist for outbound routes. If the dialing number matches the blacklist numbers or patterns, the outbound call will not be allowed. The outbound blacklist can be configured under UCM Web GUI🡪Extension/Trunk🡪Outbound Routes: Outbound Blacklist.
Users can configure numbers, patterns or select country code to add to the blacklist. Please note that the blacklist settings apply to all outbound routes.
Country Codes
Users can export outbound route blacklists and delete all blacklist entries. Additionally, users can also import blacklists for outbound routes.
Blacklist ImportExport
Don’t Call Me Blacklist Integration
UCM now supports integration with Vercel’s Don’t Call Me, a large public database containing numbers that have been registered and opted to not receive unsolicited telemarketing calls. This allows UCM to query dialed numbers via API and deny outgoing calls if they are found in database to comply with some countries’ laws.
To access the integration page, please navigate to Extension/Trunk > Outbound Routes, then click on “Outbound Blacklist” button and click on Integrate Don’t Call Me Blacklist.
Dont Call Me Database Integration
Parameter
Description
Integrate Don't Call Me Blacklist
Enable or disable Don't Call Me integration
Authorization Token
Enter the authorization token generated by the Don't Call Me database.
Query Timeout (s)
Enter the duration after which the query is considered timed out.
Query Timeout Handling
Select the action to perform after the query timeout.
Allow Dialing: If the query times out, the call will be allowed.
Prohibit Dialing: If the query times out, the call will be prohibited.
Test Connection
Click on this button to test that the integration is working as intended.
Note: If the database or Internet access is momentarily down, this test will fail.
Scheduled Sync
The UCM630X allows users to synchronize the outbound routes, this feature can be found on the Web GUI🡪Extension/Trunk🡪Outbound Routes🡪 Scheduled Sync.
Scheduled Sync
Enable the Scheduled Sync feature
Server Address
Enter the TFTP server address. For example, “192.168.1.2:69”.
File Name
Specify the file name
Sync Time
Enter the sync time (24hr format). The valid range is 0-23.
Sync Frequency
Create new sync every x day(s). The valid range is 1 to 30.
Outbound Routes/Scheduled Sync
PIN Groups
The UCM630X supports the pin group. Once this feature is configured, users can apply pin groups to specific outbound routes. When placing a call on pin-protected outbound routes, the caller will be asked to input the group pin number, this feature can be found on the Web GUI🡪Extension/Trunk🡪Outbound Routes🡪PIN Groups.
Name
Specify the name of the group
Record In CDR
Specify whether to enable/disable record in CDR
PIN Number
Specify the code that will be asked once dialing via a trunk
PIN Name
Specify the name of the PIN
Outbound Routes/PIN Group
Once the user clicks , the following figure shows to configure the new PIN.
Create New PIN Group
The following screenshot shows an example of created PIN Groups and members:
PIN Members
If PIN group is enabled on outbound route level, password, privilege level and enable the filter on source caller ID will be disabled, unless if you check the option “PIN Groups with Privilege Level” where you can use the PIN Groups and Privilege Level or PIN Groups and Enable Filter on Source Caller ID.
Outbound PIN
If PIN group CDR is enabled, the call with PIN group information will be displayed as part of CDR under the Account Code field.
CDR Record
Importing PIN Groups:
Users can also import PIN Groups by uploading csv or xlsx files for each group. To do this:
Navigate to Extension/Trunk🡪Outbound Routes🡪PIN Groups and click on the “Upload” button.
Importing PIN Groups
Select the CSV file to upload. Incorrect file formats and improperly formatted files will result in error messages such as the one below:
Incorrect CSV File
To ensure a successful import, please follow the format in the sample image below
CSV File Format
The top-left value (A1) is the PIN Group name. In this case, it is “ALPHA”.
Row 2 contains the labels for the modifiable fields: pin and pin_name. These values should not be changed and will cause an upload error otherwise.
Rows 3+ contain the user-defined values with Column A holding the PINs and Column B holding the PIN names. PIN values must consist of at least four digits.
Once the file is successfully uploaded, the entry will be added to the list of PIN Groups.
Outgoing Routing Priority
Outgoing Routing Priority Policy feature allows defining the priority approach for the outbound routes. Using this feature, the administrator can select either the accuracy of the dial pattern, or the position of the outbound route in the list to determine the route of the call.
To configure this feature, please click on the following button on the Outbound Routes page.
Selecting one of the policies will result in the following behaviour.
List Sorting Priority: Selecting this option will result in taking the sorting order of the list of outbound routes as a matching criteria for the dial pattern. The route with the first matching dial plan will be used to route the call. Any routes further down the list with a more resembling dial pattern will not be taken into consideration.
Accuracy First: Selecting this option will result in choosing the route with the most resembling dial pattern. In contrast with List Sorting Priority, the position of the route in the list is irrelevant and will not be taken into consideration.
Inbound Routes
Inbound routes allow the UCM630X to control and forward incoming external calls to specific destinations based on defined criteria. These criteria can include source caller ID, destination number, and other route-level settings. A default destination can also be set to handle calls that do not match any specific criteria.
Configuring Inbound Routes
To manage inbound routes:
Go to Web GUI→Extension/Trunk→Inbound Routes.
Inbound Routes Overview Page
Click the Add button to create a new inbound route.
Click Blocklist to configure numbers or patterns that should be blocked on all inbound routes.
Click Import to upload routes in CSV or XLSX format.
Click Export to download routes in CSV or XLSX format.
Click the Edit icon to modify an existing inbound route.
Click the Filter button to search in the list inbound routes using specific filters.
Click the Delete icon to remove a single route, or use the selection feature to delete multiple routes at once.
When creating an inbound route, users can configure the parameters described in the table below:
Trunks
Select the trunk to configure the inbound rule.
Inbound Route Name
Configure the name of the Inbound Route. For example, “Local”, “LongDistance” etc.
Pattern
All patterns are prefixed with the “_”.
Special characters:
X: Any Digit from 0-9. Z: Any Digit from 1-9. N: Any Digit from 2-9. “.“: Wildcard. Match one or more characters. “!“: Wildcard. Match zero or more characters immediately. Example: [12345-9] – Any digit from 1 to 9.
Notes: Multiple patterns can be used. Each pattern should be entered in a new line.
Example: _X. _ NNXXNXXXXX /* 10-digit long distance */
Disable This Route
After creating the inbound route, users can choose to enable and disable it. If the route is disabled, it will not take effect anymore. However, the route settings will remain in the PBX. Users can enable it again when it is needed.
CID Source
Configures the source of the CID to match with the configured CallerID Pattern. None: CID is not obtained from any source. Only applicable if no CallerID Pattern is configured. DiversionID: CID is obtained from the Diversion header. Only applicable to SIP trunks. CallerID: If the call is from a SIP trunk, the CID is obtained from the From header. Otherwise, the CID will be obtained from other related signaling.
Seamless Transfer Whitelist
Allows the selected extension to use this function. If an extension is busy, and a mobile phone is bound to that extension, the mobile phone can pick up calls to that extension.
Ringback tone
Choose the custom ringback tone to play when the caller reaches the route.
Auto Record
If enabled, calls using this route will automatically be recorded.
Block Collect Call
If enabled, collect calls will be blocked.
Note: Collect calls are indicated by the header “P-Asserted-Service-Info: service-code=Backward Collect Call, P-Asserted-Service-Info: service-code=Collect Call”.
Alert-Info
Configure the Alert-Info, when the PBX receives an INVITE request, the Alert-Info header field specifies an alternative ring tone to the UAS.
Fax Detection
If enabled, fax signals from the trunk during a call will be detected.
Fax Destination
Configures the destination of faxes.
Extension: send the fax to the designated FXS/SIP extension (fax machine) or a FAX extension.
Fax to Email: send the fax as an email attachment to the designated extension’s email address. If the selected extension does not have an associated email address, it will be sent to the default email address configured in the Call Features->Fax/T.38->Fax Settings page.
Note: please make sure the sending email address is correctly configured in System Settings->Email Settings.
Auto Answer
If enabled, the PBX will automatically answer calls and receive faxes through the inbound route. If disabled, the PBX will not receive a fax until after the call has been answered. Enabling this option will slow down the answering of non-fax calls on the inbound route. The alert tone heard during the detection period can be customized.
Block Collect Calls
If enabled, collect calls will be blocked. Note: Collect calls are indicated by the header "P-Asserted-Service-Info: service-code=Backward Collect Call, P-Asserted-Service-Info: service-code=Collect Call". Note: This is affected by Block Set Calls on the SIP Settings -> General Settings page.
Prepend Trunk Name
If enabled, the trunk name will be added to the caller id name as the displayed caller id name.
Set Caller ID Info
Manipulates Caller ID (CID) name and/or number within the call flow to help identify who is calling. When enabled two fields will show allowing to manipulate the CalleID Number and the Caller ID Name.
CallerID Number
Configure the pattern-matching format to manipulate the numbers of incoming callers or to set a fixed CallerID number for calls that go through this inbound route.
${CALLERID(num)}: Default value which indicates the number of an incoming caller (CID). The CID will not be modified.
${CALLERID(num):n}: Skips the first n characters of a CID number, where n is a number.
${CALLERID(num):-n}: Takes the last n characters of a CID number, where n is a number.
${CALLERID(num):s:n}: Takes n characters of a CID number starting from s+1, where n is a number and s is a character position (e.g. ${CALLERID(num):2:7} takes 7 characters after the second character of a CID number).
n${CALLERID(num)}: Prepends n to a CID number, where n is a number.
CallerID Name
The default string is ${CALLERID(name)}，which means the name of an incoming caller, it is a pattern-matching syntax format.
A${CALLERID(name)}B means Prepend a character ‘A’ and suffix a character ‘B’ to ${CALLERID(name)}.
Not using pattern-matching syntax means setting a fixed name to the incoming caller.
Enable Route-Level Inbound Mode
Gives uses the ability to configure inbound mode per individual route. When enabled two fields will show allowing to set the Inbound mode and the Inbound mode Suffix.
Note: Global inbound mode must be enabled before users can configure route-level inbound mode.
Inbound Mode
Choose the inbound mode for this route.
Note: Toggling the global inbound mode will not affect routes that have Route-level Inbound Mode enabled. If all routes have the option enabled, toggling the global inbound mode via BLF will trigger a voice prompt indicating that none of the routes will be affected by the global inbound mode change.
Inbound Mode Suffix
Dial “Global Inbound Mode feature code + Inbound Mode Suffix” or a route’s assigned suffix to toggle the route’s inbound mode.
The BLF subscribed to the inbound mode suffix can monitor the current inbound mode.
Inbound Multiple Mode
Multiple mode allows users to switch between destinations of the inbound rule by feature codes. Configure related feature codes as described in [Inbound Route: Multiple Mode]. If this option is enabled, the user can use feature code to switch between different modes/destinations.
CallerID Name Lookup
If enabled, the callerID will be resolved to a name through local LDAP. Note, if a matched name is found, the original callerID name will be replaced. The name lookup is performed before other callerID or callerID name modifiers (e.g., Inbound Route's Set CallerID Info or Prepend Trunk Name). Note: Name lookup may impact system performance.
Dial Trunk
This option shows up only when “By DID” is selected. If enabled, the external users dialing into the trunk via this inbound route can dial outbound calls using the PBX’s trunk.
Privilege Level
This option shows up only when “By DID” is selected.
Disable: Only the selected Extensions or Extension Groups are allowed to use this rule when enabled Filter on Source Caller ID.
Internal: The lowest level required. All users are allowed to use this rule, checking this level might be risky for security purposes.
Local: Users with Local level, National or International level are allowed to use this rule.
National: Users with National or International Level are allowed to use this rule.
International: The highest level required. Only users with an international level are allowed to use this rule.
Allowed DID Destination
This option shows up only when “By DID” is selected. This controls the destination that can be reached by the external caller via the inbound route. The DID destination is:
Extension
Conference
Call Queue
Ring Group
Paging/Intercom Groups
IVR
Voicemail Groups
Dial By Name
All
Default Destination
Select the default destination for the inbound call.
Extension
Voicemail
Conference Room
Call Queue
Ring Group
Paging/Intercom
Voicemail Group
DISA
IVR
External Number
By DID
When “By DID” is used, the PBX will look for the destination based on the number dialed, which could be local extensions, conference, call queue, ring group, paging/intercom group, IVR, and voicemail groups as configured in “DID destination”. If the dialed number matches the DID pattern, the call will be allowed to go through.
Dial By Name
Callback
Strip
Specify the digits to be prepended before the call is placed via the trunk. Those digits will be prepended after the dialing number is stripped.
Prepend
Specify the digits to be prepended before the call is placed via the trunk. Those digits will be prepended after the dialing number is stripped.
Time Condition
Start Time
Select the start time “hour:minute” for the trunk to use the inbound rule.
End Time
Select the end time “hour:minute” for the trunk to use the inbound rule.
Date
Select “By Week” or “By Day” and specify the date for the trunk to use the inbound rule.
Week
Select the day in the week to use the inbound rule.
Destination
Select the destination for the inbound call under the defined time condition.
Extension
Voicemail
Conference Room
Call Queue
Ring Group
Paging/Intercom
Voicemail Group
DISA
IVR
By DID
When “By DID” is used, the PBX will look for the destination based on the number dialed, which could be local extensions, conference, call queue, ring group, paging/intercom group, IVR, and voicemail groups as configured in “DID destination”. If the dialed number matches the DID pattern, the call will be allowed to go through.
Configure the number of digits to be stripped in the “Strip” option.
Dial By Name
External Number
Callback
Inbound Route: Prepend
UCM630X allows users to prepend digits to an inbound DID pattern, with strip taking precedence over prepend. With the ability to prepend digits in the inbound route DID pattern, the user no longer needs to create multiple routes for the same trunk to route calls to different extensions. The following example demonstrates the process:
If Trunk provides a DID pattern of 18005251163.
If Strip is set to 8, UCM630X will strip the first 8 digits.
If Prepend is set to 2, UCM630X will then prepend a 2 to the stripped number, now the number becomes 2163.
UCM630X will now forward the incoming call to extension 2163.
Inbound Route feature Prepend
Inbound Route: Multiple Mode
In the UCM630X, the user can configure an inbound route to enable multiple mode to switch between different destinations. The inbound multiple mode can be enabled under Inbound Route settings (Global Inbound Multi-Mode must be enabled first) .
Inbound Route Inbound Multi Mode
When Multiple Mode is enabled for the inbound route, the user can configure a “Default Destination” and up to 9 destination modes for all routes (Mode 1, Mode 2, etc). By default, the call coming into the inbound routes will be routed to the default destination.
SIP end devices that have registered on the UCM630X can dial feature code *62 to switch to inbound route “Mode 1” for example and dial feature code *61 to switch back to “Default Destination”. These feature codes can be customized under Inbound Routes Set Global Inbound Mode (please make sure they are not in conflict with other configured feature codes on the UCM630x). Switching between different mode can be easily done without Web GUI login.
For example, the customer service hotline destination has to be set to a different IVR after 7 PM. The user can dial *62 to switch to “Mode 1” with that IVR set as the destination before off work.
To customize feature codes for Global Inbound Multi-Modes, click on under the “Inbound Routes” page, check the “Global Inbound Multi-Mode” option, and change “Inbound Default Mode” and “Inbound Mode 1” values (By default, *61 and *62 respectively).
Users can also add modes by clicking on the “Add Mode” button. (Up to 8 additional modes).
Inbound Route Global Inbound Multi Mode Feature Codes
Inbound Route: Custom Inbound Mode
In the UCM630X, users can enable Custom Inbound Mode to switch between different destinations for each specific inbound route. The Custom Inbound Mode can be enabled under Inbound Route settings.
Inbound Route Custom Inbound Mode
The global inbound mode must be enabled before configuring Route-Level Inbound Mode. Additionally, other modes must be configured as well.
When Custom Inbound Mode is enabled, the user can configure a “Default Destination” and or a “Mode X” destination for each specific route. This Inbound route will use the inbound mode specified in this page’s Inbound Mode setting instead of the configured Global Inbound Mode.
Users can toggle the route’s inbound mode by dialing “Global Inbound Mode feature code + Inbound Mode Feature Code” and the current inbound route can be monitored by subscribing a BLF to the Inbound Mode Suffix.
For example, the Inbound Default Mode feature code is set to *61 and the Inbound Mode Feature Code for route 1 is set to 1010. To switch the mode of route 1 to Default Mode, users can dial *611010.
Note: Toggling the global inbound mode will not affect routes that have Custom Inbound Mode enabled. If all routes have the option enabled, toggling the global inbound mode via BLF will trigger a voice prompt indicating that none of the routes will be affected by the global inbound mode change.
Inbound Route: Set Global Inbound Mode (Inbound Mode BLF Monitoring)
Users can assign MPKs and VPKs to monitor and toggle the current global inbound mode of the UCM.
To do this, please refer to the following steps:
Access the UCM web GUI and navigate to Extension/Trunk🡪Inbound Routes.
Click on the button and enable Global Inbound Multi-Mode.
Edit the subscribe number field to the desired BLF value.
Global Inbound Mode BLF Subscription Number
Configure the BLF value on a phone’s MPK/VPK. As an example, a GXP2140 with the BLF configured will show the Inbound Mode status on its screen once configured. The 777 BLF is lit green, indicating that the current inbound mode is “Default Mode”.
Inbound Mode Default Mode
Pressing the key will toggle the inbound mode to “Mode 1”, and the button’s color will change to red.
Inbound Mode Mode 1
Inbound Routes: 3rd Party Database Search
This feature allows the UCM to perform a real-time lookup using an external database when an inbound call is received. If the incoming caller number matches a record in the external database, the corresponding name is retrieved and displayed as the caller ID.
To access this feature, navigate to Extension/Trunk→Inbound Routes and click on the “3rd Party Database Search” button.
Inbound Routes Page
Note:
Database connection parameters (database type, server address, and credentials) are configured globally under 3rd Party Database Integration. This page only specifies the query keys used to construct the lookup statement for inbound routes.
On this page, users can enable or disable third-party database lookup for inbound routes by enabling or disabling the 3rd Party Database Search option.
This page also allows users to specify the database objects used by the UCM to construct the SQL query for inbound caller name lookup. The parameters configured here must exactly match the corresponding table and column names in the external database.
3rd Party Database Search Feature for Inbound Routes
The following table describes the parameters used by the UCM to generate the SQL lookup query for inbound caller name resolution.
Field
Description
Table
Specifies the name of the database table that contains caller information. This table is queried when an inbound call is received.
Note: The table name must exist in the configured database and be accessible by the database user defined under 3rd Party Database Integration.
Caller Name
Specifies the column in the selected table that stores the caller’s display name. When a matching record is found, the value from this column is used as the inbound caller ID name.
Number
Specifies the column in the selected table that stores the phone number. The UCM compares the inbound caller number against this column to determine whether a matching record exists.
Based on the configured query keys, the UCM automatically generates and executes a SQL query in the following format:
SELECT<Caller Name Column>FROM<Table>WHERE<Number Column> LIKE '%[INBOUND_NUMBER]%';
The inbound caller number is dynamically substituted at call time.
Inbound Route: Import/Export Inbound Route
Users can now import and export inbound routes to quickly set up inbound routing on a UCM or to back up an existing configuration. An exported inbound route configuration can be directly imported without needing any manual modifications.
To import inbound routes, click on “Import”.
ImportExport Inbound Route
When uploading the file, the user can choose to either skip or overwrite the existing inbound route by selecting “Skip” or “Update” in On Duplicate Route, respectively.
The imported file should be in csv or xlsx format and using UTF-8 encoding, the imported file should contain below columns, and each column should be separated by a comma (It is recommended to use Notepad++ for the imported file creation):
Disable This Route: Yes/No.
Pattern: Always prefixed with _
CallerID Pattern: Always prefixed with _
Prepend Trunk Name: Yes/No.
Prepend User Defined Name Enable: Yes/No.
Prepend User Defined Name: A string.
Alert-info: None, Ring 1, Ring 2… User should enter an Alert-info string following the values we have in the Inbound route Alert-Info list.
Allowed to seamless transfer: [Extension_number]
Inbound Multiple Mode: Yes/No.
Default Destination: By DID, Extension, Voicemail… Users should enter a Default Destination string following the values we have in the Inbound route Default Destination list.
Destination: An Extension number, Ring Group Extension…
Default Time Condition.
Mode 1: By DID, Extension, Voicemail… Users should enter a Default Destination string following the values we have in the mode 1 Default Destination list.
Mode 1 Destination: An Extension number, Ring Group Extension…
Mode 1 Time Condition.
Blocklist Configurations
In the UCM630X, blocklist is supported for all inbound routes. Users could enable the blocklistfeature and manage the Blacklist by clicking on “Blacklist”.
Select the checkbox for “Blacklist Enable” to turn on the Blacklist feature for all inbound routes. Blacklist is disabled by default.
Enter a number in the “Add Blacklist Number” field and then click ”Add” to add to the list. Anonymous can also be added as a Blacklist Number by typing “Anonymous” in Add Blacklist Number field.
To remove a number from the Blacklist, select the number in the “Blacklist list” and click on or click on the” Clear” button to remove all the numbers on the blacklist.
Users can also export the inbound route blacklist by pressing the button.
Blacklist Configuration Parameters
To add blacklisted numbers in batch, click on “Import” to upload the blacklist file in csv or xlsx format.
Blacklist CSV File
Users could also add a number to the Blacklist or remove a number from the Blacklist by dialing the feature code for “Blacklist Add’ (default: *40) and “Blacklist Remove” (default: *41) from an extension. The feature code can be configured under Web GUI Basic Call Features > Feature Codes.
BASIC CALL FEATURES
Multimedia Meeting
The UCM630X supports multimedia meeting room allowing multiple rooms used at the same time.
The multimedia meeting room configurations can be accessed under Web GUI Basic Call Features>Multimedia Meeting. In this page, users could create, edit, view, invite, manage the participants, and delete multimedia meeting rooms. The multimedia meeting room status and meeting call recordings (if recording is enabled) will be displayed in this web page as well.
For video meeting, which is based on WebRTC, participants can join the meeting from PC without installing extra plug-in or software.
The UCM admin can create multiple multimedia meeting rooms for users to dial in.
Model
Number of Public Meeting Rooms
Number of Meeting Room Members
UCM6301
4
75
UCM6302
8
150
UCM6304
15
200
UCM6308
25
300
Meeting room specifications affect user participation to a certain extent. UCM supports forecasting of meeting resources. There will be corresponding judgments and adjustments in the following scenarios:
When meeting resources are used up, scheduled meeting members cannot join the meeting in advance.
When a point-to-point call is transferred to a conference, the conference resources are used up.
When meeting resources are used up, do not join a group IM chat when you initiate a meeting.
When meeting resources are used up, do not join an instant meeting.
Close other instant meetings or scheduled meetings that have timed out to ensure that invited members can join the scheduled meeting.
In an ongoing meeting, if the number of invited members exceeds the upper limit, members cannot be invited to join the meeting.
Enable flow control for videos and presentations in the conference room.
Note
The multimedia meeting room supports up to 4 video calls and one video presentation.
The administrator can set the number of videos to 9 parties. The increase in the number of videos will take up more system resources and affect the overall performance of the UCM system. Please set it according to your needs.
During a meeting, when the system detects that another scheduled meeting is about to be held, it will remind the meeting members that the subsequent meeting room has been reserved, please end the meeting in advance.
The use of video in the meeting will take up system resources and may cause performance problems when used.
The maximum meeting duration is 12 hours. If it exceeds 12 hours, the system will remind the current meeting and the host can continue to extend the meeting.
Multimedia Room Configurations
Click on “Add” to add a new meeting room.
Click on to edit the meeting room.
Click on to delete the meeting room.
Meeting Settings contains the following options:
Extension
The number to dial to reach the meeting room.
Meeting Name
Meeting Name
Privilege
Please select the permission for outgoing calls.
Allow User Invite
If enabled, participants will be able to invite other to the meeting by pressing 1 on their keypad or by clicking the Participants -> Invite option on the Wave bottom bar.
Allowed to Override Most Mute
Allowed to Override Host Mute
Auto Record
Meeting audio and video can be automatically recorded. These recordings can be found under the Meeting Recording or Meeting Video Recordings Page.
Record Audio: Record only the meeting Audio.
Record video: Record the meeting audio and all video feeds. When there is a shared source (shared screen/shared whiteboard/shared document) or focus, only the shared or focus screen is recorded, and when both are present, the shared screen will b recorded.
Record video (Focus Mode): Record the focus screen and all audio of the meeting. When a shared source is present in the meeting, only the shared screen is recorded.
Room Password
If meeting room password is configured, meeting participants will need to enter a password to enter the room. Scheduling meetings will not be supported for this room.
Log in to the UCM Web GUI and open the Basic Call Features > Multimedia Meeting page to manage the conference room. Users can create, edit, view, invite, manage meeting members, and delete meeting rooms. The conference room status and conference call recording (if recording function is enabled) will be displayed on the page. The meeting rooms in the list include public meeting rooms and random meeting rooms. For temporary meeting room administrators, only the “batch kicking people” function is supported. The temporary meeting room has no meeting password and host code. The member who initiates the group meeting is the host, and ordinary members have the right to invite.
Multimedia Meeting
Meetings Settings
To edit the general settings of the meetings rooms created in the UCM, the user can click on “Meetings Settings” button under the Room tab.
Meeting Max Concurrent Audio
Maximum number of partipants that can be heard simultaenously in multimedia meetings. If the number of participants talking at any given point exceeds this value, the audio of the excess participants will not be heard.
Meeting Voice Indicator Sensitivity
Configures the sensitivity of the talking indicator in multimedia meetings. Setting this higher will make the talking indicator appear more easily for lower volumes of audio. Note: This does not adjust audio input sensitivity itself. Lower volumes of sounds may still be heard even if the talking indicator does not show the source.
Meeting Audio Quality
Audio quality of multimedia meetings
Meeting Record Prompt
If enabled, system will prompt the user before the start of meeting recording that your meeting will be recorded.
Allow New Participants To View Chat History
Configure whether new attendees joining in the middle of a Wave meeting can view the chat content already in the meeting.
Meeting AGC (beta)
Enabling this option will toggle on Automatic Gain Control for meeting audio. AGC is a system that dynamically reduces the variability of sound levels by adjusting high and low volumes based on the average or peak sound level. High volume sounds will be lowered, and low volume sounds will be boosted.
Auto End Meeting
If enabled, the meeting will automatically end if there are no participants left in the meeting besides monitoring devices (e.g., GDS, IP cameras, etc.).
Silence Suppression
Silence suppression for temporary accounts (e.g., meeting participants that joined the meeting via link). If enabled, the UCM will send CN packets for silence suppression after a successful CN negotiation in the SIP SDP. If the client endpoint's OPUS codec supports the reception of DTX packets, the UCM will send DTX packets instead.
Add Contact Number to Email
Configure whether to add the enterprise contact number to meeting notification emails. Participants will be able to join meetings by dialing this number and then entering the room number when prompted. For security purposes, this information will only be added to the notification emails for meetings that do not use public meeting rooms.
Contact Number
If enabled, the AMI will send the corresponding event when a user starts or stops talking.
Enable Talk Detection
If enabled, the AMI will send the corresponding event when a user starts or stops talking.
DSP Talking Threshold (ms)
The amount of time(ms) that sound exceeds what the DSP has established as the baseline for silence before a user is considered to be talking. This value affects several operations and should not be changed unless the impact on call quality is fully understood.
DSP Silence Threshold (ms)
The amount of time(ms) that sound falls within what the DSP has established as the baseline for silence before a user is considered be silent. This value affects several operations and should not be changed unless the impact on call quality is fully understood.
Max Number of Video Feeds
Set the maximum number of video feeds supported per meeting room.
Audio Codec Preference
Configures the preferred codecs for temporary accounts such as meeting participants who joined via link.
Packet Loss Retransmission
Packet Loss Retransmission configuration for temporary accounts (meeting participants without registered extensions who entered the meeting via link).
Jitter Buffer
Select the jitter buffer method for temporary accounts such as meeting participants who joined via link.
Disabled: Jitter buffer will not be used.
Fixed: Jitter buffer with a fixed size (equal to the value of "Jitter Buffer Size")
Adaptive: Jitter buffer with an adaptive size that will not exceed the value of "Max Jitter Buffer").
NetEQ: Dynamic jitter buffer via NetEQ.
Multimedia Meeting Call Operations
Join a Meeting Call
Users could dial the meeting room extension to join the meeting. If password is required, enter the password to join the meeting as a normal user, or enter the admin password to join the meeting as administrator.
Invite Other Parties to Join Meeting
When using the UCM630X meeting room., there are two ways to invite other parties to join the meeting.
Invite from Web GUI.
For each meeting room in UCM630X Web GUI Basic Call Features>Multimedia Meeting, there is an icon for option “Invite a participant”. Click on it and enter the number of the party you would like to invite. Then click on “Add”. A call will be sent to this number to join it into the conference.
Meeting Invitation from Web GUI
Invite by dialing 0 or 1 during conference call.
A meeting participant can invite other parties to the meeting by dialing from the phone during the meeting call. Please make sure option “Enable User Invite” is turned on for the meeting room first. Enter 0 or 1 during the meeting call. Follow the voice prompt to input the number of the party you would like to invite. A call will be sent to this number to join it into the meeting.
0: If 0 is entered to invite other party, once the invited party picks up the invitation call, a permission will be asked to “accept” or “reject” the invitation before joining the conference.
1: If 1 is entered to invite other party, no permission will be required from the invited party.
Conference administrator can always invite other parties from the phone during the call by entering 0 or 1. To join a conference room as administrator, enter the admin password when joining the conference. A conference room can have multiple administrators.
During The Meeting
During the meeting call, users can manage the conference from Web GUI or IVR.
Manage the meeting call from Web GUI.
Log in UCM630X Web GUI during the meeting call, the participants in each meeting room will be listed.
Click on to kick a participant from the meeting.
Click on to mute the participant.
Click on to lock this meeting room so that other users cannot join it anymore.
Click on to invite other users into the meeting room.
Click on to Invite meeting rooms or invite contact groups.
Manage the meeting call from IVR.
Please see options listed in the table below.
Meeting Administrator IVR Menu
1
Mute/unmute yourself.
2
Lock/unlock the conference room.
3
Kick the last joined user from the conference.
4
Decrease the volume of the conference call.
5
Decrease your volume.
6
Increase the volume of the conference call.
7
Increase your volume.
8
More options.
1: List all users currently in the conference call.
2: Kick all non-Administrator participants from the conference call.
3: Mute/Unmute all non-Administrator participants from the conference call.
4: Record the conference call.
8: Exit the caller menu and return to the conference.
Meeting User IVR Menu
1
Mute/unmute yourself.
4
Decrease the volume of the conference call.
5
Decrease your volume.
6
Increase the volume of the conference call.
7
Increase your volume.
8
Exit the caller menu and return to the conference.
When there is participant in the meeting, the meeting room configuration cannot be modified.
Schedule Meeting
Log in to the UCM Web GUI, open the Basic Call Features > Mutimedia Meeting > Meeting Schedule page, and you can manage the reservation management of the meeting room. Users can create, edit, view, and delete conference room reservation records. The following is a set meeting room reservation, which shows the ongoing and pending reservations. Once the conference room is reserved, all users will be removed from the conference room at the start time, and extensions will no longer be allowed to enter the conference room. At the scheduled meeting time, UCM will send invitations to the extensions that have been selected to participate in the meeting. At the same time, it supports users to enter the meeting 10 minutes in advance. If the current meeting is occupied, enter the waiting room and wait (members joining the meeting in advance occupy global member resources, but it will be released after the scheduled meeting starts); otherwise, you can join the meeting directly and the meeting will be held in advance. After the meeting ends, the reservation record is transferred to meeting history list. Meeting history displays the information of the ended and expired meetings.
Click the button “Schedule Meeting” to edit the meeting room reservation.
Schedule meeting Interface
General
Meeting Subject
Configure the name of the scheduled meeting. Letters, digits, some special characters are also supported. The characters ` % # ? < > @ $ ^ ~ | are not allowed.
Public Meeting Room
Choose which room to have this scheduled meeting.
Time
Configure the meeting date and time.
Time Zone
Select the meeting time zone.
Repeat
Choose when to repeat a scheduled meeting.
No Repeat
Every Day
Weekly
Monthly
Custom: it specifies how often the meeting is repeated per days/weeks. E.g., every 3 days/weeks.
End Repeat
This option appears when a reccurrent schedule is configured.
Configure the date when the recurrence stops.
Password
Configure the meeting’s login password.
Meeting Agenda
The description of this scheduled meeting.
Attendee
Host
Configure Host.
Host Password
Configure the Host Password.
Note: It is randomly generated when first creating a new meeting Schedule.
Invitees
Local extensions, remote extensions, and special extensions are supported.
Allow User Invite
If enabled, participants will be able to invite others to the meeting by pressing 1 on their keypad or by clicking the Participants->Invite option.
Advanced
Email Reminder (m)
Check to enable scheduled meeting email reminder. Email reminders will be sent out x minutes prior to the start of the meeting. Valid range is 5-120. 60 is the default value.
Note: After editing the time of a single recurrence of a scheduled meeting, a cancellation email will be sent out followed by a meeting update email.
Call Participant
If enabled, the invited participants will be called upon meeting start time.
Allowed to Override Host Mute
If enabled, participants will be able to unmute themselves if they have been muted by the host.
Play Joining/Leaving Meeting Announcement
Configure whether the join/leave meeting prompt is played when participants join or leave.
Auto Record
Meeting audio and video can be automatically recorded. These recordings can be found under the Meeting Recordings or Meeting Video Recordings page.
Record Audio: Record only the meeting audio.
Record Video: Record the meeting audio and all video feeds. When there is a shared source (shared screen/shared whiteboard/shared document) or focus, only the shared or focus screen is recorded, and when both are present, the shared screen is recorded.
Record Video (Focus Mode): Record the focus screen and all audio of the meeting. When a shared source is present in the meeting, only the shared screen is recorded.
Note: Please note that UCM63XX Audio Series doesn’t support Screen Sharing, Whiteboard, or PDF file sharing.
Sync Google Calendar
Select this option to sync scheduled meeting with Google Calendar.
Note: Google Service Setting OAuth2.0 must be configured on the IPPBX. Please refer to section [Google Service Settings Support].
Support AI transcription
Choose whether to support AI transcription for the scheduled meeting. This parameter cannot be controlled if the AI meeting transcription and summary is disabled in the general AI Settings.
Language
Specifies the language recognition behavior used for AI transcription. The options are:
Automatic Recognition: Automatically detects the spoken language during the meeting. This is recommended when multiple languages are expected, though recognition accuracy may vary.
Preferred Language: Prioritizes recognition of the selected language, while still allowing multilingual detection with potentially reduced accuracy.
Note: This setting controls only the transcription language for this scheduled meeting. It does not apply to the general AI Conference Transcription and Summary feature.
Automatic AI Transcription
Once enabled, meeting audio will be automatically transcribed in real time once the meeting starts. A summary will also be generated after the meeting.
Once the Meeting Schedule is configured, scheduled meeting will be displayed as below figure.
Meetings Schedule
Click the button to view the meeting details in the Meeting room. The meeting details of Meeting History include actual participant information.
Meeting details
Click on to edit the Meeting Schedule.
Click on to delete the Meeting Schedule.
At the scheduled meeting time, UCM630X will send INVITE to the extensions that have been selected for conference.
Once the meeting starts, it will be displayed under Pending Meeting with an “Ongoing” status, as displayed below:
Meeting Scheduled Ongoing
Once the conference is finished, the conference will be displayed under Meeting History as shown below:
Meeting Schedule Completed
Click the button to download the Meeting Report of the meeting.
Click the button to reschedule the Meeting.
In addition, once the meeting ends, the system will send a meeting report email to the host including PDF file where he/she can view the meeting, participant information, device type and trend graph of participant levels.
You can also choose to display the meetings that took place in a specific timeframe. Please see the screenshot below:
Please make sure that outbound route is properly configured for remote extensions to join the meeting.
Meeting Recordings
The UCM630X allows users to record the audio of the meeting call and retrieve the recording from Web GUI🡪Basic Call Features> MultimediaMeeting> Meeting Recordings.
To record the Meeting call, when the meeting room is in idle, enable “Auto Record” from the meeting room configuration dialog. Save the setting and apply the change. When the meeting call starts, the call will be automatically recorded in .wav format.
The recording files will be listed as below once available. Users could click on to download the recording or click on to delete the recording. Users could also delete all recording files by clicking on “Delete All Recording Files” or delete multiple recording files at once by clicking on “Delete” after selecting the recording files.
Meeting Recordings
Meeting Video Recordings
The UCM630X allows users to record the audio and video of the meeting call and retrieve the recording from Web GUI Basic Call Features>MultimediaMeeting>Meeting Recordings.
To record the Meeting call, when the meeting room is in idle, enable “Auto Record” from the meeting room configuration dialog. Save the setting and apply the change. When the meeting call starts, the call will be automatically recorded in .mkv format.
The recording files will be listed as below once available. Users could click on to download the recording or click on to delete the recording. Users could also delete all recording files by clicking on “Delete All Recording Files” or delete multiple recording files at once by clicking on “Delete” after selecting the recording files.
Call Statistics
Meeting reports will now be generated after every conference. These reports can be exported to a csv or xlsx file for offline viewing. The conference report page can be accessed by clicking on the Call Statistics button on the main Conference page.
Meeting Call Statistics
Meeting Report on Web
Meeting Report on CSV
IVR
Configure IVR
IVR configurations can be accessed under the UCM630X Web GUI Basic Call Features>IVR. Users could create, edit, view, and delete an IVR.
Click on “Add” to add a new IVR.
Click on to edit the IVR configuration.
Click on to delete the IVR.
Create New IVR
General
Name
Configure the name of the IVR. Letters, digits, _ and – are allowed.
Extension
Enter the extension number for users to access the IVR.
Auto Record
If enabled, calls to this IVR will automatically be recorded.
Prompt Language
Select voice prompt language for this extension. If set to "Default", the global setting for Voice Prompt will be used.。
This configuration only applies to the system prompt, and does not affect the language of custom prompt.
Prompt
Initial tone that plays when the user enters the IVR.
IVR Webhook
IVR Webhook
If enabled, call event notification and call control can be achieved via URL. Using webhooks, the user can send requests to a specific server to perform actions through DTMF.
Target URL
Target URL address for receiving notification commands as well as sending operation commands. It needs to be the full URL of the web server, static parameters and pages can be included.
Username
Enter the username used to connect to the target URL.
Password
Enter the password used to connect to the target URL.
Call Event
Select the call events to notify the IVR about.
All
Notify IVR of Incoming Calls
Notify IVR of Answer
Notify IVR of DTMF Events
Notify IVR of End
Call Control
If enabled, the predefined IVR flow for the destination URL will be followed. Configurations related to the original IVR flow such as dialed numbers, key events, etc. will be disabled.
Timeout Time (s)
Configure the timeout time for receiving call control, default 2 seconds, the system tries up to three times after the timeout.
Timeout/Invalid Settings
Digit Timeout (s)
Configure the timeout between digit entries. After the user enters a digit, the user needs to enter the next digit within the timeout. If no digit is detected within the timeout, the UCM630X will consider the entries complete. The default timeout is 3s.
Response Timeout (s)
After playing the prompts in the IVR, the UCM630X will wait for the DTMF entry within the timeout (in seconds). If no DTMF entry is detected within the timeout, a timeout prompt will be played. The default setting is 10 seconds.
Response Timeout Prompt
Select the prompt message to be played when timeout occurs.
Response Timeout Prompt Repeats
Configure the number of times to repeat the prompt if no DTMF input is detected. When the loop ends, it will go to the timeout destination if configured, or hang up. The default setting is 3.
Invalid Input Prompt
Select the prompt message to be played when an invalid extension is pressed.
Invalid Input Prompt Repeats
Configure the number of times to repeat the prompt if the DTMF input is invalid. When the loop ends, it will go to the invalid destination if configured, or hang up. The default setting is 3.
PMS Wake-Up Call Service Mode
PMS Wake-Up Call Service
If enabled, this IVR can be used with Wakeup Service to send notifications to specified destinations based on caller key presses.
If enabled, key events will only be supported in standard mode. Time conditions will not be supported.
Other Settings
Replace Display Name
If enabled, the UCM will replace the caller display name with IVR name.
Return IVR Menu
If enabled and if a call to an extension fails, the caller will be redirected to the IVR menu.
Alert-info
When present in an INVITE request, the Alert-info header field specifies an alternative ringtone to the UAS.
IVR Black/Whitelist
If enabled only numbers inside of the Whitelist or outside of the Blacklist can be called from IVR.
Internal Black/Whitelist
Contain numbers, either of Blacklist or Whitelist.
External Black/Whitelist
This feature can be used only when Dial Trunk is enabled, it contains external numbers allowed or denied calling from the IVR, the allowed format is the following: Number1, number2, number3…
Replace Display Name
If enabled, the UCM will replace the caller display name with IVR name.
Return to IVR Menu
If enabled and if a call to an extension fails, the caller will be redirected to the IVR menu.
Alert Info
When present in an INVITE request, the alert-Info header field specifies and alternative ring tone to the UAS.
Timeout
When exceeding the number of defined answer timeout, IVR will enter the configured event when timeout. If not configured, then it will Hangup.
Invalid
Configure the destination when the Invalid Repeat Loop is done.
Time Condition
Configure the time condition for each key press event, so that it goes to the corresponding destination within a specified time.
Key Pressing Events
Blocklist/Allowlist in IVR
In some scenarios, the IPPBX administrator needs to restrict the extensions that can be reached from IVR. For example, the company CEO and directors prefer only receiving calls transferred by the secretary, some special extensions are used on IP surveillance end points which should not be reached from external calls via IVR for privacy reason. UCM has now added blacklist and whitelist in IVR settings for users to manage this.
Up to 500 extensions are allowed on the blocklist/allowlist.
To use this feature, log in UCM Web GUI and navigate to Basic Call Features > IVR > Create/Edit IVR: IVR Black/Whitelist.
If the user selects “Blocklist Enable” and adds extension in the list, the extensions in the list will not be allowed to be reached via IVR.
If the user selects “Allowlist Enable” and adds extension in the list, only the extensions in the list can be allowed to be reached via IVR.
BlackWhitelist
Create Custom Prompt
To record new IVR prompt or upload IVR prompt to be used in IVR, click on “Upload Audio File” next to the “Welcome Prompt” option and the users will be redirected to Custom Prompt page. Or users could go to Web GUI🡪PBX Settings🡪Voice Prompt🡪Custom Prompt page directly.
Click on Prompt to Create IVR Prompt
Once the IVR prompt file is successfully added to the UCM630X, it will be added into the prompt list options for users to select in different IVR scenarios.
Key Pressing Events
Standard Key Event
UCM supports adding time conditions for different key events, so that each key event of the IVR goes to the corresponding destination within a specified time.
Each key event support up to five time conditions, the options available are: All time, Office Time, Out of Office Time, Holiday, Out of Holiday, Out of Office Time or Holiday, Office Time and Out Of Holiday, Specific time.
Key Pressing Events
Note:
If you select “Specific time”, you need to select the start time and the end time.
The frequency supports two options: By week and By Month, by default the specific time does not include the holidays.
Specific Time
The following table describes available options that can be assigned for Standard Key Pressing Events:
Key Event Type
Select Standard to configure single-key DTMF events (0–9, *). This mode supports time-based routing per key.
Key (0–9, *)
Each section corresponds to a specific DTMF key (for example, Key 0, Key 2). Configuration under a key defines how calls are routed when that key is pressed.
Destination
Select the destination type and target for the key event. Supported destinations include:
Extension
Meeting
Voicemail
Voicemail Group
IVR (Maximum 64 nested IVRs)
Ring Group
Queues
Paging/Intercom Group
Fax
Custom Prompt
Hang-up
DISA
Dial By Name
External Number
Callback
Announcement
Time Condition
Assign a time condition to each destination entry. The IVR evaluates the time conditions in order and routes the call to the first matching rule. Common options include All Time, Office Time, Out of Office Time, Holiday, and Specific Time.
Note: A single key can contain multiple destination entries with different time conditions (up to five). Users can click the (+) icon to add another destination with a different time condition for the same key, or the (–) icon to remove an existing rule.
Timeout
Configures the destination when the Timeout Repeat Loop is done.
Note: A single key can contain multiple destination entries with different time conditions (up to five). Users can click the (+) icon to add another destination with a different time condition for this option, or the (–) icon to remove an existing rule.
Invalid
Configures the destination when the Invalid Repeat loop is done.
Note: A single key can contain multiple destination entries with different time conditions (up to five). Users can click the (+) icon to add another destination with a different time condition for this option, or the (–) icon to remove an existing rule.
Custom Key Event
Users can create custom IVR key press events, vastly increasing the options a business can provide to its customers and improving customer relations and accessibility.
This new feature supports the following:
Up to 100 custom key press events
Each key combination can contain up to 8 characters (numbers and star (*) only)
Supports Time Conditions
Different custom keys can have the same Destination and Time Condition
Note
IVR option Dial Other Extensions will be disabled if using custom IVR keys.
The following options are available for Custom Key Pressing Events:
Key Event Type
Select “Custom” to configure multi-digit DTMF key combinations. This mode supports time-based routing and advanced IVR logic.
Key
Defines the DTMF key combination that triggers the event.
Notes:
Each key combination can contain up to 8 characters
Supported characters: 0–9 and *
Up to 100 custom key events are supported per IVR
Destination
Select the destination type and target for the custom key event. Supported destinations include:
Extension
Meeting
Voicemail
Voicemail Group
IVR (Maximum 64 nested IVRs)
Ring Group
Queues
Paging/Intercom Group
Fax
Custom Prompt
Hang-up
DISA
Dial By Name
External Number
Callback
Announcement
Time Condition
Assign a time condition to each destination entry. The IVR evaluates the time conditions in order and routes the call to the first matching rule. Common options include All Time, Office Time, Out of Office Time, Holiday, and Specific Time.
Note: A single key can contain multiple destination entries with different time conditions (up to five). Users can click the (+) icon to add another destination with a different time condition for the same key, or the (–) icon to remove an existing rule.
Timeout
Configures the destination when the Timeout Repeat Loop is done.
Note: A single key can contain multiple destination entries with different time conditions (up to five). Users can click the (+) icon to add another destination with a different time condition for this option, or the (–) icon to remove an existing rule.
Invalid
Configures the destination when the Invalid Repeat loop is done.
Note: A single key can contain multiple destination entries with different time conditions (up to five). Users can click the (+) icon to add another destination with a different time condition for this option, or the (–) icon to remove an existing rule.
Voicemail
Configure Voicemail
If the voicemail is enabled for UCM630X extensions, the configurations of the voicemail can be globally set up and managed under Web GUI >Basic Call Features>Voicemail.
Voicemail Settings
Max Greeting Time (s)
Configure the maximum number of seconds for the voicemail greeting. The default setting is 60 seconds.
The accepted range for this option is 60 - 600
Dial ‘0’ For Operator
If enabled, the caller can press 0 to exit the voicemail application and connect to the configured operator’s extension.
Operator Type
Configure the operator type; either an extension or a ring group.
Operator Extension
Select the operator extension, which will be dialed when users press 0 to exit voicemail application. The operator extension can also be used in IVR.
Max Messages Per Folder
Configure the maximum number of messages per folder in users’ voicemail. The valid range 10 to 1000. The default setting is 50.
Max Message Length (m)
Select the maximum duration of the voicemail message. The message will not be recorded if the duration exceeds the max message time. The default setting is 15 minutes. The available options are:
1 minute
2 minutes
5 minutes
15 minutes
30 minutes
Unlimited
Note: Silence and noise duration are not counted in message time.
Min Message Length (s)
Configures the minimum length (in seconds) of a voicemail message. Messages shorter than this value will not be saved to the voicemail box.
Note: Silence and detected noise will not count towards the message length.
No Minimum
1 second
2 second
3 second
4 second
5 second
Announce Message Caller-ID
If enabled, the caller ID of the user who has left the message will be announced at the beginning of the voicemail message. The default setting is “No”.
Announce Message Duration
If enabled, the message duration will be announced at the beginning of the voicemail message. The default setting is “No”.
Play Envelope
If enabled, a brief introduction (received time, received from, and etc.) of each message will be played when accessed from the voicemail application.
Play Most Recent First
If enabled, it will play the most recent message first.
Allow User Review
If enabled, users can review the message following the IVR before sending.
Voicemail Remote Access
If enabled, external callers routed by DID and reaching VM will be prompted by the UCM with 2 options:
Press 1 to leave a message.
To leave a message for the extension reached by DID.
Press 2 to access voicemail management system.
This will allow the caller to access any extension voicemail after entering the extension number and its voicemail password. Note: This option applies to inbound calls routed by DID only. The default setting is "Disabled".
Forward Voicemail to Peered UCMs
Enables the forwarding of voicemail to remote extensions on peered SIP trunks.
The default setting is "Disabled".
Voicemail Password
Voicemail password that will be used for reset extensions.
The password requirements are the following:
Only numbers are accepted
The password should consist of at least 4 digits
Repetitive and sequential numbers are not accepted
Format
Choose the format to use for voicemail files storage.
GSM
WAV
Warning: WAV files take signifcantly more storage space than GSM files.
Username Prompt
Configure the username prompt.
Resetting an extension will reset Voicemail Password, Send Voicemail to Email, and Keep Voicemail after Emailing values to default. Previous custom voicemail prompts and messages will be deleted.
Access Voicemail
If the voicemail is enabled for UCM630X extensions, the users can dial the voicemail access number (by default *97) to access their extension’s voicemail. The users will be prompted to enter the voicemail password and then can enter digits from the phone keypad to navigate in the IVR menu for different options.
Otherwise the user can dial the voicemail access code (by default *98) followed by the extension number and password in order to access to that specific extension’s voicemail.
Main Menu
Sub Menu 1
Sub Menu 2
1 – New messages
3 - Advanced options
1 - Send a reply
2 - Call the person who sent this message
3 - Hear the message envelop
4 - Leave a message
* - Return to the main menu
5 - Repeat the current message
7 - Delete this message
8 - Forward the message to another user
9 – Save
* - Help
# - Exit
2 – Change folders
0 - New messages
1 - Old messages
2 - Work messages
3 - Family messages
4 - Friend messages
# - Cancel
3 – Advanced options
1 - Send a reply
2 - Call the person who sent this message
3 - Hear the message envelop
4 - Leave a message
* - Return to the main menu
0 – Mailbox options
1 - Record your unavailable message
1 - Accept this recording
2 - Listen to it
3 - Re-record your message
2 - Record your busy message
1 - Accept this recording
2 - Listen to it
3 - Re-record your message
3 - Record your name
1 - Accept this recording
2 - Listen to it
3 - Re-record your message
4 - Record temporary greeting
1 - Accept this recording
2 - Listen to it
3 - Re-record your message
5 - Change your password
* - Return to the main menu
Tips
While listening to the voicemail, press * or # to rewind and forward the voice message, respectively. Each press will forward or rewind 3 seconds.
Rewind can go back to the begining of the message while forward will not work when there are 3 seconds or less left in the voice message.
Voice guidance will be automatically played when the voicemail is done playing.
Leaving Voicemail
If an extension has voicemail enabled under basic settings “Extension/Trunk 🡪 Extensions 🡪 BasicSettings” and after a ring timeout or user not available, the caller will be automatically redirected to the voicemail in order to leave a message on which case they can press # in order to submit the message.
In case if the caller is calling from an internal extension, they will be directly forwarded to the extension’s voicemail box. But if the caller is calling from outside the system and the incoming call is routed by DID to the destination extension, then the caller will be prompted with the choice to either press1 to access voicemail management or press 2 to leave a message for the called extension. This feature could be useful for remote voicemail administration.
Voicemail Email Settings
The UCM630X can be configured to send the voicemail as attachment to Email. Click on “Voicemail Email Settings” button to configure the Email attributes and content.
Send Voicemail to Email
If enabled, voicemail will be sent to the user’s email address. Note: SMTP server must be configured to use this option.
Keep Voicemail after Emailing
Enable this option if you want to keep recording files after the Email is sent. The default setting is Enable.
Email Template
Fill in the “Subject:” and “Message:” content, to be used in the Email when sending to the user. The template variables are:
t: TAB
${VM_NAME}: Recipient’s first name and last name
${VM_DUR}: The duration of the voicemail message
${VM_MAILBOX}: The recipient’s extension
${VM_CALLERID}: The caller ID of the person who has left the message
${VM_MSGNUM}: The number of messages in the mailbox
${VM_DATE}: The date and time when the message is left
Voicemail Email Settings
Click on “Email Template” button to view the default template as an example.
Configure Voicemail Group
The UCM630X supports voicemail group and all the extensions added in the group will receive the voicemail to the group extension. The voicemail group can be configured under Basic Call Features > Voicemail > Voicemail Group. Click on “Add” to configure the group.
Voicemail Group
Extension
Enter the Voicemail Group Extension. The voicemail messages left to this extension will be forwarded to all the voicemail group members.
Name
Configure the Name to identify the voicemail group. Letters, digits, _ and - are allowed.
Method
Select the preference for receiving and managing group voicemail.
Forwarded: Voicemail will be stored in the group voicemail box, and each voicemail group member will be forwarded a copy of it.
Shared: Voicemail will be stored in the group voicemail box, and voicemail status will be shared among all voicemail group members. If a member deletes a voicemail, it will also be deleted for all members. Likewise, if one member reads a voicemail, it will be considered read for the entire group.
Voicemail Password
Configure the voicemail password for the users to check voicemail messages.
Email Address
Configure the Email address for the voicemail group extension.
Shared Voicemail Status
If enabled, voicemail group status can be monitored via BLF. Green indicates no unread voicemail, and red indicates existing unread voicemail.
Members
Select available mailboxes from the left list and add them to the right list. The extensions need to have voicemail enabled to be listed in available mailboxes list.
Greet Prompt
This voicemail prompt will be played when the callee does not answer within their ring timeout period. Priority: Temporary Prompt > Busy Prompt/Unavailable Prompt > Greet Prompt
Sound file must be PCM encoded, 16 bits at 8000Hz mono with mp3/wav format, or raw ulaw/alaw/gsm file with .mp3/.wav/.ulaw/.alaw/.gsm suffix. The file size must be less than 5MB.
Temporary Prompt
This voicemail prompt will be played in all scenarios when it is configured (unregistered, unanswered/ring timeout, busy, DND). Priority: Temporary Prompt > Busy Prompt/Unavailable Prompt > Greet Prompt
Sound file must be PCM encoded, 16 bits at 8000Hz mono with mp3/wav format, or raw ulaw/alaw/gsm file with .mp3/.wav/.ulaw/.alaw/.gsm suffix. The file size must be less than 5MB.
Unavailable Prompt
This voicemail prompt will be played when user enters voicemail. Priority: Temporary Prompt > Busy Prompt/Unavailable Prompt > Greet Prompt
Sound file must be PCM encoded, 16 bits at 8000Hz mono with mp3/wav format, or raw ulaw/alaw/gsm file with .mp3/.wav/.ulaw/.alaw/.gsm suffix. The file size must be less than 5MB.
Note
The administrator can add up to 150 extensions to a single voicemail group.
Ring Groups
The UCM630X supports ring group feature with different ring strategies applied to the ring group members. This section describes the ring group configuration on the UCM630X.
Configure Ring Group
Ring group settings can be accessed via Basic Call Features>Ring Group.
Ring Group
Click on to add ring group.
Click on to edit the ring group. The following table shows the ring group configuration parameters.
Click on to delete the ring group.
Ring Group Name
Configure ring group name to identify the ring group. Letters, digits, _ and – are allowed.
Extension
Configure the ring group extension.
Members
Select available users from the left side to the ring group member list on the right side. Click on ⮝ ⮟ to arrange the order.
LDAP Phonebook
Select available remote users from the left side to the ring group member list on the right side. Click on ⮝ ⮟ to arrange the order. Note: LDAP Sync must be enabled first.
Ring Strategy
Select the ring strategy. The default setting is “Ring in order”.
Ring Simultaneously: Ring all the members at the same time when there is incoming call to the ring group extension. If any of the member answers the call, it will stop ringing.
Ring in Order: Ring the members with the order configured in ring group list. If the first member does not answer the call, it will stop ringing the first member and start ringing the second member.
Music On Hold
Select the “Music On Hold” Class of this Ring Group, “Music On Hold” can be managed from the “Music On Hold” panel on the left.
Custom Prompt
This option is to set a custom prompt for a ring group to announce to caller. Click on ‘Prompt’, it will direct the users to upload the customized voice prompts.
Note: Users can also refer to the page PBX Settings🡲 Voice Prompt🡲 Custom Prompt, where they could record new prompt or upload prompt files.
Ring Timeout on Each Member
Configure the number of seconds to ring each member. If set to 0, it will keep ringing. The default setting is 60 seconds.
Note: The actual ring timeout might be overridden by users if the phone has ring timeout settings as well.
Auto Record
If enabled, calls on this ring group will be automatically recorded. The default setting is No. The recording files can be accessed from WebGUI🡲 CDR🡲 Recording Files.
Endpoint Call Forwarding Support
This allows the UCM to work with endpoint-configured call forwarding settings to redirect calls to ring group. For example, if a member wants to receive calls to the ring group on his mobile phone, he will have to set his endpoint’s call forwarding settings to his mobile number. By default, it is disabled.
However, this feature has the following limitations:
This feature will work only when call forwarding is configured on endpoints, not on the UCM.
If the forwarded call goes through an analog trunk, and polarity reversal is disabled, the other ring group members will no longer receive the call after it is forwarded.
If the forwarded call goes through a VoIP trunk, and the outbound route for it is PIN-protected and requires authentication, the other ring group members will no longer receive the call after it is forwarded.
If the forwarded call hits voicemail, the other ring group members will no longer receive the call.
Replace Display Name
If enabled, the UCM will replace the caller display name with the Ring Group name the caller know whether the call is incoming from a direct extension or a Ring Group.
Skip Busy Agent
If enabled, skip busy agents regardless of call waiting settings.
Enable Destination
If enabled, users could select extension, voicemail, ring group, IVR, call queue, voicemail group as the destination if the call to the ring group has no answer. Secret and Email address are required if voicemail is selected as the destination.
Default Destination
The call would be routed to this destination if no one in this ring group answers the call.
Note: Users can now set the voicemail of ring groups as routing destinations and IVR key press event destinations and to do so ring group must have their Default Destination set to Voicemail with Ring Group Extensions.
Voicemail
Whether to enable the voicemail for the ring group or not.
Voicemail Password
Configure the voicemail password (only numbers).
Email Address
Fill in the user's Email address (s), the voice message will be sent to this address (s).
Busy Prompt
This voicemail prompt will be played when the callee is in another call or is in DND mode. Priority: Temporary Prompt > Busy Prompt/Unavailable Prompt > Greet Prompt
Sound file must be PCM encoded, 16 bits at 8000Hz mono with mp3/wav format, or raw ulaw/alaw/gsm file with .mp3/.wav/.ulaw/.alaw/.gsm suffix. The file size must be less than 5MB.
Greet Prompt
This voicemail prompt will be played when the callee does not answer within their ring timeout period. Priority: Temporary Prompt > Busy Prompt/Unavailable Prompt > Greet Prompt
Sound file must be PCM encoded, 16 bits at 8000Hz mono with mp3/wav format, or raw ulaw/alaw/gsm file with .mp3/.wav/.ulaw/.alaw/.gsm suffix. The file size must be less than 5MB.
Temporary Prompt
This voicemail prompt well be played in all scenarios when it is configured (unregistered, unanswered/ring timeout, busy, DND). Priority: Temporary Prompt > Busy Prompt/Unavailable Prompt > Greet Prompt
Sound file must be PCM encoded, 16 bits at 8000Hz mono with mp3/wav format, or raw ulaw/alaw/gsm file with .mp3/.wav/.ulaw/.alaw/.gsm suffix. The file size must be less than 5MB.
Unavailable Prompt
This voicemail prompt will only be played when the callee’s extension is unregistered. Priority: Temporary Prompt > Busy Prompt/Unavailable Prompt > Greet Prompt
Sound file must be PCM encoded, 16 bits at 8000Hz mono with mp3/wav format, or raw ulaw/alaw/gsm file with .mp3/.wav/.ulaw/.alaw/.gsm suffix. The file size must be less than 5MB.
Ring Group Configuration
Remote Extension in Ring Group
Remote extensions from the peer trunk of a remote UCM630X can be included in the ring group with local extension. An example of Ring Group with peer extensions is presented in the following:
Creating SIP Peer Trunk between both UCM630X _A and UCM630X _B. SIP Trunk can be found under Web GUI🡪Extension/Trunk🡪VoIP Trunks. Also, please configure their Inbound/Outbound routes accordingly.
Click edit button in the menu , and check if Sync LDAP Enable is selected, this option will allow UCM630X_A update remote LDAP server automatically from peer UCM630X _B. In addition, Sync LDAP Password must match for UCM630X _A and UCM630X _B to sync LDAP contact automatically. Port number can be anything between 0~65535, and use the outbound rule created in step 1 for the LDAP Outbound Rule option.
Sync LDAP Server Options
In case if LDAP server does not sync automatically, user can manually sync LDAP server. Under VoIP Trunks page, click sync button shown in the following figure to manually sync LDAP contacts from peer UCM630X.
Manually Sync LDAP Server
Under Ring Groups setting page, click “Add”. Ring Groups can be found under Web GUI Basic Call Features>Ring Groups.
If LDAP server is synced correctly, Available LDAP Numbers box will display available remote extensions that can be included in the current ring group. Please also make sure the extensions in the peer UCM630X can be included into that UCM630X’s LDAP contact.
Ring Group Remote Extension
Paging/Intercom
Paging and Intercom Group can be used to make an announcement over the speaker on a group of phones. Targeted phones will answer immediately using speaker. The UCM630X paging and intercom can be used via feature code to a single extension or a paging/intercom group. This section describes the configuration of paging/intercom group under Web GUI Basic Call Features>Paging/Intercom.
Paging/Intercom Groups
2-way Intercom
2 way Intercom
Parameter
Description
Name
Configure intercom group name.
Strategy
Select “2-way Intercom”.
Extension
Configure the intercom group extension.
Private Intercom
If enabled, members can only hear the voice of the initiator and cannot hear the voice of other members. The initiator can hear the voice of all members.
Auto Record
Enable this option to record in WAV format.
Replace Display Name
If enabled, the PBX will replace the caller display name with Intercom name.
First Answer Termination
Enabling this option will result in halting other phones from ringing once the intercom is answered.
Maximum Call Duration
Specify the maximum call duration in seconds. The default value 0 means no limit.
Disable
If disabled, the real-time and scheduled paging/intercom will not be triggered.
Local Members
Selected members will receive paging/intercom calls to this paging/intercom group.
LDAP Members
Select a number from the LDAP phonebook. If LDAP contacts were synchronized through the SIP trunk, the IPPBX will use that same trunk to send the call. Other trunks will not be used.
Paging/Intercom Allowlist
Select the extensions which are allowed to initiate the paging/intercom.
Selected: Only selected extension will be allowed to initiate paging/intercom.
All: Allow all extensions and configured services to initiate paging/intercom.
Custom Prompt
This option is to set a custom prompt for a paging/intercom group to announce to caller. Click on ‘Upload Audio File’, it will direct the users to upload the customized voice prompts.
Note: Users can also refer to the page PBX Settings > Voice Prompt > Custom Prompt, where they could record new prompt or upload prompt files.
Play Prompt to Caller
Play the prompt to the caller.
Note
The number of members of the intercom group is limited at 50 members.
Private Intercom
Private intercom allows the user to initiate an intercom to many endpoints. Whichever endpoint microphone has detected sound input first, only the intercom initiator and the responder will be able to hear each other. Once the first responder has finished talking, the second responder can start talking. To configure private intercom, the user can follow the steps mentioned above in 2-way intercom and while creating the intercom, the user may tick the option “Private Intercom” as indicated in the screenshot below.
Private Intercom
Parameter
Configuration
Name
Enter a name for the intercom
Strategy
Choose "Private Intercom".
Extension
Configure the intercom group extension.
Auto Record
Enable this option to record in WAV format.
Replace Display Name
If enabled, the PBX will replace the caller display name with Paging/Intercom name.
Maximum Call Duration (s)
The maximum allowed duration of a call in seconds. Default value is 0 (no limit).
Disable
If disabled, the real-time and scheduled paging/intercom will not be triggered.
Custom Prompt
This option sets a custom prompt to be used as an announcement to the person receiving a paging/intercom call. The file can be uploaded from the page "Custom Prompt". Click "Upload Audio File" to add additional record.
Members
Selected members will receive paging/intercom calls to this paging/intercom group.
Paging/Intercom Whitelist
Only selected extensions will be able to use this paging /intercom group. If none is selected, all extensions will be able to use this paging/intercom group.
1-way Paging
1-way paging feature allows to send paging to multiple endpoints. The administrator can configure to have the paging message played upon answering on the IP phone’s end, or to have the message played through the speaker as soon as the page is sent.
1 way Paging
Parameter
Description
Name
Configure paging/intercom group name.
Strategy
Select “1-way Paging”.
Extension
Configure the paging/intercom group extension.
Video Broadcast
If checked, video paging will be supported. If the caller sends a video page, the paging group members will be able to receive and view the video.
Auto Record
Enable this option to record in WAV format (audio) and MKV format (video).
Replace Display Name
If enabled, the PBX will replace the caller display name with Paging/Intercom name.
First Answer Termination
Enabling this option will result in halting other phones from ringing once the paging is answered.
Delayed Paging
If enabled, a caller can enter *82 before the paging group extension to start a delayed paging call. In a delayed paging call, the system will prompt the caller to record a message. Once the messaging is recorded and saved, and the configured delay has passed, the paging call will be sent out. When a paging group member answers the call, the prerecorded message will be played, and the call will end after it is finished playing.
Maximum Call Duration
Specify the maximum call duration in seconds. The default value 0 means no limit.
Disable
If disabled, the real-time and scheduled paging/intercom will not be triggered.
Local Members
Selected members will receive paging/intercom calls to this paging/intercom group.
LDAP Members
Select a number from the LDAP phonebook. The LDAP number can use only the main trunk and specified trunks to make outbound calls. Other trunks cannot be used.
Announcement File
Configures an audio/video file to play to the paging members. This can be used to play preconfigured audio/video at the beginning of paging calls or to simply notify members that it is a paging/intercom call.
Play Prompt to Caller
Play the prompt to the caller.
Paging/Intercom Whitelist
Select which extensions are allowed to use the paging/intercom feature for this paging group.
Note
The number of members of the paging group is limited at 50 members.
In case the user wants to broadcast a video, the following requirements should be respected.
H.264 video encoding
.mkv or .tar/.tgz/tar.gz format
MKV files must be 30 MB file or less
Compressed files (.tar/.tgz/tar.gz) must be 50 MB or less.
File name can only contain alphanumeric characters, hyphens (-) and period (.)
If Auto Record is enabled, recorded video pages will be saved in MKV file format.Saved recordings can be found in the CDR🡪Recordings🡪Video Recordings page.
Video Broadcast
Using this feature, the user can send a video to the SIP endpoints which support streaming video to notify the users of the beginning of a paging. To configure Video Broadcast before a paging, the user can create a 1-way paging following the steps mentioned in the previous section. Then the user can enable “Video Broadcast” in the settings.
Video Broadcast
The user can upload the video in the “Announcement File” section as shown in the screenshot below.
Multicast Paging
Multicast Paging
Parameter
Description
Name
Configure paging/intercom group name.
Strategy
Select “Multicast Paging”.
Extension
Configure the paging/intercom group extension.
Maximum Call Duration
Specify the maximum call duration in seconds. The default value 0 means no limit.
Disable
If disabled, the real-time and scheduled paging/intercom will not be triggered.
Multicast IP Address/Port
The allowed multicast IP address range is 224.0.1.0 – 238.255.255.255.
Note: You can add up to 30 multicast addresses.
Paging/Intercom Allowlist
Select the extension which can initiate this paging. If none is selected, all extensions will be able to use this paging/intercom group.
Opening Prompt
Select the opening prompt for the paging.
Custom Prompt
This option is to set a custom prompt for a paging/intercom group to announce to caller. Click on ‘Prompt’, it will direct the users to upload the customized voice prompts.
Note: Users can also refer to the page PBX Settings🡪Voice Prompt🡪Custom Prompt, where they could record new prompt or upload prompt files.
Play Prompt to Caller
Play the prompt to the caller.
Prompt Playback Count
Sets the number of times the prompt is played during the page/intercom. To ensure the prompt is played the specified number of times, please set an appropriate max call duration.
Background Sound
Enable background sound.
Background Sound Source
If an extension is selected as the audio source, the audio from that extension will be automatically used as the background sound when the paging/intercom is initiated.
Custom Background Sound
Extension Shared Audio
Custom Background Sound
Choose or upload a custom background sound.
Announcement Command
While background sound is playing, callers can start and end an announcement by pressing *1.
Start/End Announcement Cue
If enabled, after pressing the Announcement command (*1) to start and end the announcement, the system will play this prompt. Otherwise, only a beep will play.
Mute Background Sound
If enabled, the ongoing background sound will be muted during the announcement.
Multicast Audio Format
Choose the format/codec of the multicast audio.
Delayed Paging
If enabled, a caller can enter *82 before the paging group extension to start a delayed paging call. In a delayed paging call, the system will prompt the caller to record a message. Once the messaging is recorded and saved, and the configured delay has passed, the paging call will be sent out. When a paging group member answers the call, the recorded message will be played, and the call will end after it is finished playing.
Delay (s)
Configure the amount of delay in seconds after a message is recorded to send out the delayed paging call. Default is 5 seconds.
Multicast Paging Configuration Parameters
Multicast Community
Multicast community allows creating an extension, which when dialed, can send a preconfigured prompt as a multicast paging to a group of extensions. The user should create first a Paging/Intercom Group with Multicast Paging as the Strategy selected. Please see previous section for more information.
Multicast Community Parameters
Name
Enter the name of the multicast community.
Extension
Configure the extension number for the paging/intercom group. When this number is dialed, the paging/intercom will be initiated.
Delayed Paging
If enabled, a caller can enter *82 before the paging group extension to start a delayed paging call. In a delayed paging call, the system will prompt the caller to record a message. Once the messaging is recorded and saved, and the configured delay has passed, the paging call will be sent out. When a paging group member answers the call, the precorded message will be played, and the call will end after it is finished playing.
Delay (s): Configure the amount of delay in seconds after a message is recorded to send out the delayed paging call. Default is 5 seconds.
Maximum Call Duration (s)
The maximum allowed duration of a call in seconds. Default value is 0 (no limit).
Note: Please note that the call duration that can be configured can be within the range 0 - 86400.
Custom Prompt
Choose the custom prompt to play for the callees at the beginning of the paging. The user can also directly upload a prompt file directly on this page.
Note: When uploading the custom prompt file, please make sure it respects the following requirements:
The audio file must be less than 5 MB in file size with a file extension of .mp3/. wav/. ulaw/. alaw/. gsm. WAV files must be PCM encoded, 16 bit mono, and 8000Hz.
If uploading a compressed file, the file extension must be .tar/.tgz/.tar.gz, and the file size must not exceed 50MB. File name can only contain alphanumeric characters and special characters -_
Play Prompt to Caller
When this option is enabled, the prompt will be played back on the caller's phone.
Prompt Playback Count
Sets the number of times the prompt is played during the page/intercom. To ensure the prompt is played the specified number of times, please set an appropriate max call duration.
Note: The minimum number of playcounts which can be configured is 1 and the maximum is 10.
Multicast Paging Group
Configures multicast paging groups within a community. When dialing the extension number of the community, users may simultaneously initiate paging to linked multicast paging groups.
Paging/Intercom Whitelist
Selected: Only selected extension will be allowed to initiate paging/intercom.
All: Allow all extensions and configured services to initiate paging/intercom.
Scheduled Paging/Intercom
Scheduled paging/intercom feature allows the users to program a paging or an intercom call to be triggers at a certain time and date. The paging/intercom can be scheduled to be triggered periodically, or it can be scheduled to be triggered once.
Pending Paging/Intercom
In this page, the user can create scheduled paging/intercom to be played automatically when the time scheduled arrives.
Create New Scheduled PagingIntercom
Paging/Intercom
Select existing paging/intercom groups and multicast communities.
Name
Enter the name of the scheduled Intercom/Paging.
Caller
Once a caller is selected, and the specified start time is reached, the system will contact the caller. If this call is rejected, the page/intercom will be cancelled. If caller is set to None, the system will call all group members and play the configured prompt.
Start Date
Select the date of the start of the paging/intercom.
Start Time
Select the start time of the paging/intercom.
Repeat
Select the repeat interval of the paging/intercom.
No Repeat: The intercom/paging will play once on the scheduled date and time.
Everyday: The intercom/paging will play daily starting from the scheduled day and on the time scheduled every day.
Weekly: The intercom/paging will play weekly on the selected day(s) of the week.
Monthly: The intercom/paging will play monthly on the selected date of the month.
Include Holidays
When Every day, Weekly, or Monthly is selected. This option will appear.
If enabled, scheduled pages/intercoms will run during holidays. Otherwise, scheduled pages/intercoms displayed on the calendar will not actually be run.
Sync to Google Calendar
This feature cannot be used if Google Services have not been authorized. Please resolve this in the Integrations > Google Services page.
Once the paging and intercom has been created, it can be viewed on the same page.
Pending PagingIntercom
Paging/Intercom Schedule
This section displays the schedule of the paging/intercom which have been scheduled. The user can choose to display per day, week, or per month.
Scheduled PagingIntercom
Call Queue
The UCM630X supports call queue by using static agents or dynamic agents. Call Queue system can accept more calls than the available agents. Incoming calls will be held until next agent is available in the system. This section describes the configuration of call queue under Web GUI Basic Call Features > Call Queue.
Add Call Queue
Call queue settings can be accessed via Web GUI > Basic Call Features > Call Queue.
Call Queue Page
Click on “Add” to add call queue.
Click on to edit the call queue.
Click on to delete the call queue.
The call queue configuration parameters are listed in the table below.
Basic Settings
General
Extension
Configure the call queue extension number.
Name
Configure the call queue name to identify the call queue.
Proficiency Routing
If enabled, incoming calls will be routed to the agents with the highest available proficiency level (lower number = higher profiency). If multiple agents have the same level, the Ring Strategy for Same Proficency Level will be used to route calls among those agents. Please make sure to assign proficiency levels to the agents.
Note: This option applies to both static and dynamic agents.
Strategy
(Ring Strategy of Equal Skill Level when Proficiency Routing is enabled)
Select the strategy for the call queue.
Ring All: Ring all available Agents simultaneously until one answers.
Linear: Ring agents in the specified order.
Least Recent: Ring the agent who has been called the least recently.
Fewest Calls: Ring the agent with the fewest completed calls.
Random: Ring a random agent.
Round Robin: Ring the agents in Round Robin scheduling with memory.
The default setting is “Ring All“.
Music On Hold
Select the Music On Hold class for the call queue.
Note: Music On Hold classes can be managed from Web GUI > PBX Settings > Music On Hold.
Max Queue Length
Configure the maximum number of calls to be queued at once. This number does not include calls that have been connected with agents, only calls that are still in queue. When this maximum value is exceeded, the caller will hear a busy tone and be forwarded to the configured failover destination. Default value is 0 (unlimited).
Agent Rest Time (s)
Configure the amount of time in seconds after ending a call where the agent will not receive additional calls. Once this time has passed, the agent will be able to receive calls again. If set to 0, agents can receive additional calls immediately after ending a call. Default value is 10 seconds.
Retry Time (s)
Configure the number of seconds to wait before ringing the next agent. The minimum is 1 and the default setting is 5 seconds. Since only 3 digits can be entered, the max value is 999.
Agent Ring Time
Configure the number of seconds to ring an agent. The minimum is 5 and the default setting is 30 seconds. Since only 3 digits can be entered, the max value is 999.
Auto Record
If enabled, the calls on the call queue will be automatically recorded. The recording files can be accessed in Queue Recordings under Web GUI > Call Features > Call Queue.
Users can choose whether to automatically record only internal calls, external calls or all calls. By default, Auto Record is disabled.
Prompt Language
Choose the language of the prompt which will be played to the caller.
When the option “default” is selected, the language defined in PBX Settings > Voice Prompt > Language Settings will be selected.
Welcome Prompt
Enable
Enable the welcome prompt.
Custom Prompt
Choose the initial tone that plays when the user dials the queue number.
Note: The user can upload a custom prompt directly from this parameter. Only the following file formats are supported: .tar, .tgz, .tar.gz, .mp3, .wav, .gsm, .alaw, .ulaw
Play Full Welcome Prompt
If enabled, queue agents will not be rung until after the welcome prompt is done playing. Otherwise, queue agents will be rung while the welcome prompt is being played to the caller.
Satisfaction Survey Prompt
Custom Prompt
After a queue agent hangs up a call, a prompt will play asking the caller to rate their satisfaction on a scale of 1 to 5, with 5 being the highest.
Notes: The user can upload a custom prompt directly from this parameter. Only the following file formats are supported: .tar, .tgz, .tar.gz, .mp3, .wav, .gsm, .alaw, .ulaw
The user can upload a custom prompt directly from this parameter.
Only the following file formats are supported: .tar, .tgz, .tar.gz, .mp3, .wav, .gsm, .alaw, .ulaw
Super administrator, administrators and queue chairmen can access agent satisfaction statistics by going to Call Queue Statistics > Overview > Agent Satisfaction Statistics/Queue Satisfaction Statistics.
The service satisfaction information can also be downloaded from Call Queue Statistics.
Max Wait Time
Max Wait Time
Configures the amount of time (in seconds) a caller will be kept in queue before the the call is automatically routed to the configured Max Wait Time Destination. If set to 0, callers will be kept in queue indefinitely. Default is 60 seconds.
Destination
The call will be routed to this destination if no one in this queue answers after the max wait time expires.
Reset Agent Call Counter
Enable
Specifies the frequency at which the agent call counter will be reset. This will affect counter data used for agent ring strategies and the queue switchboard data.
Repeat
Set the repeat frequency to One-time, Daily, Weekly or Monthly.
Date/Time
Set the date and time.
Destination Prompt Cycle
Enable
If enabled, the callers will hear the configured custom prompt at set intervals while waiting. If they press “1,” they are immediately routed to a predefined failover destination.
Destination Prompt Cycle
Configure the voice prompt cycle (in seconds) of this call queue. When playing the voice prompt, you can press 1 to transfer to failover destination.
Custom Prompt
When playing a custom prompt, press 1 to enter the failover destination. Otherwise, continue waiting in queue.
Note: The user can upload a custom prompt directly from this parameter. Only the following file formats are supported: .tar, .tgz, .tar.gz, .mp3, .wav, .gsm, .alaw, .ulaw
Destination
After the specified amount of time, the caller will be prompted to press 1 to immediately get redirected to the configured failover destination.
Advanced Settings
Virtual Queue
Enable Virtual Queue
If enabled, the system will activate a virtual queue for users, allowing them to opt for a callback instead of waiting. Callers will be prompted to either remain in the queue or choose a number that the PBX will use to reach them, ensuring they retain their position in line.
Virtual Queue Mode
DTMF mode: pressing 2 will manually trigger virtual queue and callers will hear a prompt to manually set a callback number.
Timeout mode: virtual queue will automatically be triggered when the configured Virtual Queue Period has passed and the users can choose a callback number.
Auto mode: virtual queue will automatically be triggered when the configured Virtual Queue Period has passed but the callback number will automatically be set to the caller’s detected CID number.
Virtual Queue Period (s)
The amount of time in seconds that must pass before virtual queue is offered to callers when using Timeout mode or Auto mode.
Virtual Queue Outbound Prefix
System will add this prefix to dialed numbers when calling back users.
Enable Virtual Queue Position Announcement
If enabled, the system will inform callers waiting in the queue of their positions in line.
Enable Virtual Queue Wait Time Announcement
If enabled, the estimated wait time for the call to get answered will periodically be announced to the caller.
Enable Virtual Queue Callback Timeout
If enabled, agents will have a set amount of time to answer a virtual queue callback.
Write Timeout
The amount of time in seconds that agents will have to answer a virtual queue callback. If the value is less than the Agent Ring Time, then the Agent Ring Time will take effect.
Virtual Queue Welcome Prompt
Upload the file of your welcome prompt of the virtual queue. Only the following file formats are supported: .tar, .tgz, .tar.gz, .mp3, .wav, .gsm, .alaw, .ulaw
Queue Announcement
Enable Position Announcement
If enabled, the system will inform callers waiting in the queue of their positions in line.
Enable Wait Time Announcement
If enabled, the estimated wait time for the call to get answered will periodically be announced to the caller. Note: Wait time will not be announced if less than one minute.
Announcement Interval
The interval at which caller positions and estimated wait times will be announced. Valid range is between 20 and 600 seconds. Default value is 20.
Agent ID Announcement
If enabled, a system prompt containing the agent ID will be played to the caller when answered by an agent.
Premium Code
Callers can increase their priority in queue by entering their premium code and # within 5 seconds of the premium code prompt ending.
Premium Code Prompt
After enabling the position announcement, the premium code related functions can be set to share the same announcement cycle with the position announcement.
Custom Announcement
Custom Prompt
The system will periodically play this annoucement to callers that enter the queue. Only the following file formats are supported: .tar, .tgz, .tar.gz, .mp3, .wav, .gsm, .alaw, .ulaw
Announcement Interval (s)
Configures the interval for playing the queue’s custom announcement. Valid range is between 20 and 600 seconds. Default value is 60.
Empty Queue
Leave When Empty
Configure whether the callers will be disconnected from the queue or not if the queue has no agent anymore. The default setting is “Strict”.
Yes: Callers will be disconnected from the queue if all agents are paused or invalid.
No: Never disconnect the callers from the queue when the queue is empty.
Strict: Callers will be disconnected from the queue if all agents are paused, invalid or unavailable.
Dial in Empty Queue
Configure whether the callers can dial into a call queue if the queue has no agent. The default setting is “No”.
Yes: Callers can always dial into a call queue.
No: Callers cannot dial into a queue if all agents are paused or invalid.
Strict: Callers cannot dial into a queue if the agents are paused, invalid or unavailable.
Failover Destination
Choose the destination where the call will be directed when the queue is empty or when all the agents are not logged in, here are the destinations that can be configured:
Play Sound.
Extension.
Voicemail.
Queues.
Ring Group.
Voicemail Group.
IVR
External Number.
CTI
Enable Agent Login
Enabling agent login will cause the dynamic agents to be unavailable.
Queue Chairman
The queue chairman can log into his web portal to operate the queue.
Service Level Agreement (SLA)
Enable SLA
Toggles Service Level Agreement (SLA), which is percentage measurement of the queue group’s ability to answer incoming calls within a defined amount of time. If a queue group’s calculated SLA percentage is below the configured threshold value, alerts will be generated and sent out via email to the specified recipients.
Example: The SLA goal is 80% of calls (Threshold) within 20 seconds (SLA Time). If less than 80% of queue calls are answered within 20 seconds, the specified users will be notified of it.
SLA Time (s)
Configures the amount of time in seconds that agents must answer incoming queue calls within to satisfy service quality requirements. Answering calls past this time will negatively affect the SLA measurement, and an alert will be generated once it hits below the specified SLA alert threshold. Supported values are 1 to 180. Default value is 20.
SLA Alert Email Notification
Enable SLA alert email notification.
Alert Threshold (%)
Configures the SLA alert threshold. If the percentage of queue calls answered within the configured SLA Time go below this value, an alert email will be generated and sent to the configured recipients. Supported values are 1 to 100. Default value is 80.
SLA Alert Interval (m)
Configures the minimum amount of time (in minutes) between alert sending. If a new alert is generated within this period, it will not be sent to recipients until the next alert interval. The valid range is from 1 to 120. The default value is 120.
SLA Alert Email Template
The template of the SLA alert email notifications.
Alert Email Recipients
Send SLA alert notifications to the configured alert email recipients. If a recipient does not have an email address configured, they will not receive the alert notifications.
Other Settings
Report Hold Time
If enabled, the PBX will report (to the agent) the duration of time of the call before the caller is connected to the agent. The default setting is “No”.
Replace Display Name
If enabled, the PBX will replace the caller display name with the Call Queue name so that the caller knows the call is incoming from a Call Queue.
Enable Feature Codes
Enable feature codes option for call queue. For example, *83 is used for “Agent Pause”
Autofill
Enable/Disable the Autofill feature which distributes calls automatically to available agents as soon as they become free instead of having callers wait in a traditional queue.
Dynamic Login Password
If enabled, the configured PIN number is required for dynamic agent to log in. The default setting is disabled.
Alert-Info
When present in an INVITE request, the Alert-info header field specifies an alternative ring tone to the UAS.
Call Memory
If enabled, the system will remember the last agent a caller has talked to. If the caller enters the queue again within the configured Retrieval Time (Days), the remembered agent will be prioritized for answering the call.
Memory Retention Time (Days)
Sets the amount of time that callers will be remembered for Call Memory agent matching. Calls to the queue after this period of time will no longer prioritize the caller’s last agent. Valid range is 1 to 30 days. Default value is 7.
Enable RPID Header
Toggles the sending of Remote-Party-ID header to the caller. Requires enable Send Remote Party ID configuration in ToS page.
Agents
Dynamic Agents
Configure the dynamic agents of this queue, allowing dynamic agents to sign into the queue and receive incoming calls from the queue. The total number of static agents and logged in dynamic agents needs to meet the number limit of the agents on this device.
Static Agents
Go to “Agents” Tab and Select the available users to be the static agents in the call queue. Choose from the available users on the left to the static agents list on the right. Click on < or > to choose. And use UP and Down arrow to select the order of the agent within the call queue.
Static and Dynamic Agents
There are two types of agents that can be part of a call queue: static agents, manually added when configuring the queue, and dynamic agents, which can login and log out from the call queue anytime by using preset codes.
Static can be configured on Basic Call Features > Call Queue > Edit Queue > Agents. While dynamic agents only need a Login and Logout suffix to be able to join a queue.
These codes can be found under Basic Call Features > Call Queue > Global Queue Settings > Dynamic AgentLogin Setting as shown below:
Dynamic Agent Login Settings
Note:
When configuring the call queue settings, checking the option “Enable Agent Login” will cause the dynamic agents to be unavailable.
To guarantee a high level of audio quality with the call queue feature, UCMs will limit the number of agents allowed to be assigned depending on the UCM model used. If the user attempts to configure the number of static agents to be more than the maximum allowed number, a warning message will appear.
The following table lists the maximum number of agents for each UCM model:
UCM Model
Maximum Number of Agents in Call Queue
UCM6301
25
UCM6302
50
UCM6304
80
UCM6308
160
Important
Adding an agent to more than one queue will count towards the number of agents supported. E.g., adding an agent to 2 more queues will be counted as 2 additional agents, which will be deduced from the overall number of supported agents. This includes static and dynamic agents.
Call Queue Feature Codes
Users can leverage feature codes to perform different call queue related actions by accessing Basic Call Features > Feature Codes > Feature Codes, below is the description of each code along with their default values:
Agent Pause (*83): Allows agents to pause their activity in all queues for a specific reason. Once the code is dialed, the agent will be prompted to enter a pause reason represented by a digit from 0 to 9. Another way to do this is to dial the feature code and the reason code number together. (e.g. dialing *831 to directly set the pause status as “Lunchtime” (1)).
Agent Unpause (*84): This code is used by the agent to resume activity in all queues.
Note:
Users can configure up to 10 pause reason when the Agent Pause Reason Settings are set to “Custom”. However, there only 5 pause reasons on the default settings: (1) Lunch, (2) Hourly Break, (3) Backoffice, (4) Email, and (5) Wrap.
Dynamic Agent Logout (*85): Agents can dial this code to logout from all queues.
Queue Recordings
Queue recordings are shown under Basic Call Features🡪Call Queue🡪Queue Recordings.
Queue Recordings Page
Click on
to download the recording file in .wav format; and on
to delete the recording file.
Users can also download recordings in batch either by selecting specific recordings using the checkbox and clicking on or by downloading all files through the button.
Note:
If file data/file encryption is enabled for recording files, the Decryption Tool will be required to access the downloaded file. Instructions for using the tool can be found in this guide.
Queue Switchboard
Switchboard is a Web GUI tool for call queue monitoring and management, admin can access to it from the menu Basic Call Features > Call Queue then press “Switchboard”.
Following page will be displayed:
Switchboard Summary
Page above summarizes the available queues statistics and if one of the queues is clicked the user will be directed to page below:
Call Queue Switchboard
The table below gives a brief description for the main menus:
Waiting
Shows the current waiting calls along with the caller ID and the option to hang-up call.
Proceeding
Shows the current established calls along with the caller ID and the callee (agent) as well as the option to hang-up, transfer, add conference or barge-in the call.
Agents
Displays some basic call statistics and agent’s mode (static or dynamic) along with the list of agents in the queue and the extension status:
Idle
Ringing
In Use
Paused
Unavailable
Queue Switchboard Privilege
There are three different privilege levels for Call Queue management from the switchboard: Super Admin, Queue Chairman, and Queue Agent.
Super Admin
Default admin of the PBX. Call queue privileges include:
Viewing and edit all queue agents.
Monitor and execute actions for incoming/outgoing calls for all queues.
Generate Call Queue reports to track performance.
Queue Chairman
User appointed by Super Admin to monitor and manage an assigned queue extension via Switchboard.
The Queue Chairman can log into the PBX user portal with their extension number and assigned user password.
Call Queue privileges include:
Viewing status and information related to all agents in the assigned queue.
Perform actions on calls such as hang-up, transfer or barge-in.
Manual Login/Logout of static and dynamic agents.
Viewing CDR
Queue Agent
User appointed by Super Admin to be a member of a queue extension.
A queue agent can log into the PBX user portal with their extension number and assigned user password to manage their calls only.
Call Queue Statistics
Along with call center features, users can also gather detailed call queue statistics allowing them to make better changes/decision to manage better the call distribution and handling based on time, agent, and queue.
To access call queue statistics, go to Basic Call Features > Call Queue and click on “Call Queue Statistics”, the following page will be displayed:
Call Queue Statistics
Users can download statistics by clicking the button. They can also set up automatic email deliveries of these statistics at regular intervals by clicking on
Additionally, users can clear the statistics using the button.
Call Queue Statistics Automatic Download
This section provides a detailed description of each tab on the Basic Call Features🡪Call Queue🡪Call Queue Statistics page.
Overview
The overview page shows shows the following information:
Agent statistics: shows the number of calls and call-related information of agents.
Queue Statistics: counts the number of calls in the queue and information such as calls, waiting, and callback.
Agent satisfaction statistics: used for user’s rating of agents;
Queue satisfaction statistics: counts the score survey statistics.
By selecting a time interval, administrators can get detailed statistics for agents such as total calls, answered calls etc, as well as queue statistics like abandoned calls, transferred calls and SLA.
Abandoned Call Calculation:
When a call queue is configured with a failover destination pointing to another queue, the abandonment statistics are calculated independently for each queue.
If a call enters CQ1 and is redirected to CQ2 (failover destination) and the call is answered, CQ1 records the call as abandoned, and CQ2 marks the call as answered.
If the call is not answered in either queue, both call queues consider the call as abandoned.
A more detailed version of the queue statistics (as shown in image below) can be found under Call Queue > Call Queue Statistics > Overview > Queue Statistics > Options > Details.
Queue Statistics Details
Agent Details
Agent Details is a call log that shows every call to each individual agent from all queues. The following information is available:
Time: the date and time the call was received.
Agent: the agent extension that was rung for the call.
Name: the name of to agent that received the call.
Queue: the queue that the call went to.
Caller ID Number: the CID of the caller
Abandoned: indicates whether the call was picked up or not by that specific agent. If the call rang several agents simultaneously, and this specific agent did not pick up the call, the call will be considered abandoned even if a different agent in the same queue picked it up.
Wait Time: the amount of time that the call was waiting in queue after dialing in.
Talk Time: the duration of the call after it was picked up by agent.
Service Satisfaction: Indicates whether the call was not surveyed, not evaluated, or provides the satisfaction score result.
Agent details
Login Record
Login Record is a report that shows the timestamps of dynamic agent logins and logouts and calculates the login duration. The following information is available:
Agent: the extension that logged in and out.
Queue: the queue that the extension logged in and out of.
Login Time: the time that the extension logged into the queue.
Logout Time: the time that the extension logged out of the queue.
Login Duration: the total length of time that the extension was logged in.
Login Record
Pause Log
Pause Logis a report that shows information related to agent pauses. An entry will only be created after an agent unpauses. The following information is available:
Agent: The extension that paused/unpaused.
Name: The name of the agents that paused/unpaused.
Queue: The queue that the agent is in.
Pause Time: The time when the agent paused.
Resume Time: The time when the agent unpaused.
Pause Duration: The total length of time the agent was paused for.
Pause Reason: The reason of the pause (e.g., lunch, coffee break, etc…)
Pause Log
Global Queue Settings
As explained before, under this section users can configure the feature codes for Dynamic agent login and logout, and also can now customize the keys for virtual queue options like shown below.
Global Queue Settings
Dynamic Agent Login Settings
Agent Login Code Suffix
Configure the code to dial after the queue extension to log into the queue (i.e. queue extension + suffix). If no suffix is configured, dynamic agents will not be able to log in.
Agent Logout Code Suffix
Configure the code to dial after the queue extension to log out of the queue (i.e. queue extension + suffix). If no suffix is configured, dynamic agents will not be able to log out.
Agent Pause Reason
Agent Pause Reason Settings
Select the agent pause reason settings.
Default: Use the default settings for the agent pause reason.
Custom: User the custom settings. These settings should be configured using they corresponding key for each status. The user can upload a custom prompt which will be played for the agent once they set the pause reason.
Key Settings
Enter which key to press to set the different pause reasons.
Virtual Queue Callback Key Settings
Enable
Select whether to enable or disable virtual queue callback feature. By default it’s disabled.
Call Back Current Number
Press the feature key configured to set your current number as callback number.
Custom Callback Number
Press these feature key configured to set a custom callback number.
Continue Waiting
Press the feature key configured to continue waiting.
Speed Dial
Add Speed Dial
The UCM630X supports Speed Dial feature that allows users to call a certain destination by pressing one or four digits on the keypad. This creates a system-wide speed dial access for all the extensions on the UCM630X.
To enable Speed Dial, on the UCM630X Web GUI, go to page Web GUI Basic Call Features🡪Speed Dial.
User should first click on
. Then decide from one digit up to four digits combination used for Speed Dial and select a dial destination from “Default Destination”. The supported destinations include extension, voicemail, conference room, voicemail group, IVR, ring group, call queue, page group, DISA, Dial by Name and external number.
Note
The maximum number of speed dial entries which can be configured is 1000 speed dial entries.
Speed Dial Destinations
The following can be configured as the default destination of a speed dial:
Extension: Choose the extension to call when dialing the speed dial number.
Multimedia Meeting: Choose the meeting room extension to call when dialing the speed dial number.
Voicemail: Choose the extension which voicemail will be accessed to when dialing the speed dial number.
Voicemail Group: Choose the voicemail group which will be accessed when dialing the speed dial number.
IVR: Choose the IVR which will be accessed when dialing the speed dial number.
Ring Group: Choose the ring group which will be called when dialing the speed dial number
Queues: Choose the queue which will be called when dialing the speed dial number.
Paging/Intercom: Choose the paging/intercom group which will be initiated when the speed dial number is dialed.
Fax: Select the fax extension which will be used as a destination when the speed dial number is dialed.
DISA: Choose DISA as the destination when the speed dial number is dialed.
Dial By Name: Choose Dial By Name as the dialing destination.
Announcement: Choose an announcement as the destination when the speed dial number is dialed.
External Number: Enter an external number to call when the speed dial number is dialed.
Custom Number: Choose a custom number to call when the speed dial number is dialed. This can also be a feature code.
List of Speed Dial
Import Speed Dial
The user can import speed dial entries, this reduces the amount of configuring the same speed dial entries on different UCMs. To do this, please click on “Import” as the figure below shows.
Import Dial Speed
Then select the file of the speed dial entries and click
Important
Please use UTF-8 encoding when importing a csv or xlsx.
Alert
Importing speed dial entries will overwrite the existing speed dials, if you wish to import new speed dial entries to the already existing ones, you will have to export them then combine them together in one file before you import it.
Export Speed Dial
To export speed dial entries, please click on export as the screenshot below shows, then choose the location where to save the file.
Export Dial Speed
Event List
Besides BLF, users can also configure the phones to monitor event list. In this way, both local extensions on the same UCM630X and remote extensions on the VOIP trunk can be monitored. The event list setting is under Web GUI Basic Call Features> Event List.
Click on “Add” to add a new event list.
Sort selected extensions manually in the Eventlist
Click on to edit the event list configuration.
Click on to delete the event list.
URI
Configure the name of this event list (for example, office_event_list). Please note the URI name cannot be the same as the extension name on the IPPBX. The valid characters are letters, digits, _ and -.
Local Extensions
Select the available extensions/Extension Groups listed on the local IPPBX to be monitored in the event list.
Remote Extensions
If LDAP sync is enabled between the IPPBX and the peer IPPBX, the remote extensions will be listed under "Available Extensions". If not, manually enter the remote extensions under "Special Extensions" field.
Special Extensions
Manually enter the remote extensions in the peer/register trunk to be monitored in the event list. Valid format: 5000,5001,9000
Create New Event List
Remote extension monitoring works on the UCM630X via event list BLF, among Peer SIP trunks or Register SIP trunks (register to each other). Therefore, please properly configure SIP trunks on the UCM630X first before using remote BLF feature. Please note the SIP end points need support event list BLF in order to monitor remote extensions.
When an event list is created on the UCM630X and remote extensions are added to the list, the UCM630X will send out SIP SUBSCRIBE to the remote UCM630X to obtain the remote extension status. When the SIP end points register and subscribe to the local UCM630X event list, it can obtain the remote extension status from this event list. Once successfully configured, the event list page will show the status of total extension and subscribers for each event list. Users can also select the event URI to check the monitored extension’s status and the subscribers’ details.
To configure LDAP sync, please go to UCM630X Web GUI🡪Extension/Trunk🡪VoIP Trunk. You will see “Sync LDAP Enable” option. Once enabled, please configure password information for the remote peer UCM630X to connect to the local UCM630X. Additional information such as port number, LDAP outbound rule, LDAP Dialed Prefix will also be required. Both the local UCM630X and remote UCM630X need enable LDAP sync option with the same password for successful connection and synchronization.
Currently LDAP sync feature only works between two UCM630Xs.
(Theoretically) Remote BLF monitoring will work when the remote PBX being monitored is non-UCM630X PBX. However, it might not work the other way around depending on whether the non-UCM630X PBX supports event list BLF or remote monitoring feature.
Feature Codes
Feature codes allow users to perform certain actions such as call park or enabling do not disturb mode, by dialing a configured code. (e.g. dialing #72 to park a call).
The UCM630x is by default configured with feature codes for different use cases, but users can change these codes manually by accessing Basic Call Features > Feature codes.
Notes:
When manually configuring feature codes, please make sure there is no conflict between the values.
In order to avoid incompatibility, some feature codes do not support being nested by other numbers. (e.g. if a feature code is *44, another feature code cannot be *441). This is important because there are a few codes that can be used in conjunction with a series of digits.
For example, users can dial *72 (Call Forward Always Enable) followed by 1000 (*721000) to set the forwarding destination as extension 1000. However, if there is another feature code configured as *7210, it is impossible for the UCM to determine whether the user wants to use this code or to enable call forward always with extension 10 as the destination.
Feature Maps
Blind Transfer
- Default code: #1
- Enter the code during active call. After hearing "Transfer", you will hear dial tone. Enter the number to transfer to. Then the user will be disconnected, and transfer is completed. - Options:
Disable
Allow Caller: Enable the feature code on caller side only.
Allow Callee: Enable the feature code on callee side only.
Allow Both: Enable the feature code on both caller and callee.
Attended Transfer
- Default code: *2 - Enter the code during active call. After hearing "Transfer", you will hear the dial tone. Enter the number to transfer to and the user will be connected to this number. Hang up the call to complete the attended transfer. In case of the called party does not answer, users could press *0 to cancel the call and retrieve the first call leg. - Options:
Disable
Allow Caller: Enable the feature code on caller side only.
Allow Callee: Enable the feature code on callee side only.
Allow Both: Enable the feature code on both caller and callee.
Transfer Dialing Timeout Period (s)
Configures the dial timeout period of blind and attended transfers.
Seamless Transfer
Default code: *44 (Disabled by default).
Seamless Transfer allows user to perform blind transfer using PBX feature code without having music on hold presented during the transfer process, it minimizes the interruption during transfer, making the process smooth and simple.
During an active call use the feature code (*44 by default) followed by the number you want to transfer to in order to perform the seamless transfer.
(This feature code cannot be nested by other feature codes)
Disconnect
- Default code: *0 - Enter the code during active call. It will disconnect the call. - Options:
Disable
Allow Caller: Enable the feature code on caller side only.
Allow Callee: Enable the feature code on callee side only.
Allow Both: Enable the feature code on both caller and callee.
Call Park
- Default code: #72
- Enter the code during active call to park the call. - Options:
Disable
Allow Caller: Enable the feature code on caller side only.
Allow Callee: Enable the feature code on callee side only.
Allow Both: Enable the feature code on both caller and callee.
Feature Code Input Timeout (ms)
Configure the maximum interval (ms) between digits for feature code activation.
Start/Stop Call Recording
-Default code: *3 - Enter the code followed by # or SEND to start recording the audio call and the PBX will mix the streams natively on the fly as the call is in progress.
- Options:
Disable
Allow Caller: Enable the feature code on caller side only.
Allow Callee: Enable the feature code on callee side only.
Allow Both: Enable the feature code on both caller and callee.
Enable Recording Whitelist
Enable the Recording Whitelist feature
Recording Operation Whitelist
Select extension in the whitelist that can use the *3 recording function.
Feature Code Digits Timeout
Set the maximum interval (ms) between digits for feature code activation
DND/Call Forward
Call Forward Setting Type
Basic
Advanced
If Advanced is selected, call forwarding can be set for all calls, internal calls and external calls. To do this, users can dial one of the feature codes below and then dial 0, 1 or 2.
The feature code modifiers are as follow:
🡪 0 corresponds to "All calls".
🡪 1 refers to "Internal calls". (calls that came within the PBX)
🡪 2 is used for "External calls". (calls from outside the PBX)
Do Not Disturb (DND) Activate
Default code: *77
Activate DND feature to ignore any incoming calls.
Do Not Disturb (DND) Deactivate
Default code: *78
Deactivate DND Feature.
Call Forward Busy Enable
Default Code: *90
Enables Call Forward Busy (CFB) for the dialing extension.
Assuming feature code is xxx, the following call forward setting methods are available :
(This feature code cannot be nested by other feature codes)
Call Forward Busy Disable
Default Code: *91
Disables Call Forward Busy (CFB) for the dialing extension.Assuming feature code is xxx, use one of the following methods based on your Call Forward Setting Type: Basic: Dial xxx. Advanced: Dial xxx + 0/1/2.
Call Forward No Answer Enable
Default Code: *92
Enables Call Forward No Answer (CFNA) for the dialing extension.
Assuming feature code is xxx, the following call forward setting methods are available :
(This feature code cannot be nested by other feature codes)
Call Forward No Answer Disable
Default Code: *93
Disables Call Forward No Answer (CFNA) for the dialing extension.Assuming feature code is xxx, use one of the following methods based on your Call Forward Setting Type: Basic: Dial xxx. Advanced: Dial xxx + 0/1/2.
Call Forward Always Enable
Default Code: *72
Enables Call Forward Always (CFA) for the dialing extension.
Assuming feature code is xxx, the following call forward setting methods are available :
(This feature code cannot be nested by other feature codes)
Call Forward Always Disable
Default Code: *73
Disables Call Forward Always (CFA) for the dialing extension.Assuming feature code is xxx, use one of the following methods based on your Call Forward Setting Type: Basic: Dial xxx. Advanced: Dial xxx + 0/1/2.
Remote Call Forward Enable
Enable this option and configure the Remote Call Forward Whitelist below to allow specific extensions to dial the remote call forwarding feature codes to set call forwarding for any extension.
Remote DND / Call Forward Settings
Enable
Enable this option and configure the Whitelist below to allow specific extensions to dial feature codes to set DND or call forwarding for any extension.
Remote Call Forward Busy Enable
Default code: *65
Configures and enables CFB for any extension.
Remote Call Forward No Answer Enable
Default code: *66
Configures and enables CFNA for any extension.
Remote Call Forward Always Enable
Default code: *67
Configures and enables CFU for any extension.
Remote DND Enable
Default code: *68
Enables Do Not Disturb for any extension.
Remote Call Forward Busy Disable
Default code: *651
Disables CFB for any extension.
Remote Call Forward No Answer Disable
Default code: *661
Disables CFNA for any extension.
Remote Call Forward Always Disable
Default code: *671
Disables CFU for any extension.
Remote DND Disable
Default code: *681
Disables Do Not Disturb for any extension.
Whitelist
Extensions in this whitelist can configure DND or call forwarding for any extension via feature codes.
Feature Codes
Voicemail
Voicemail Access Code
- Default code: *98 - Enter *98 and follow the voice prompt. Or dial *98 followed by the extension and # to access the entered extension's voicemail box.
(This feature code cannot be nested by other feature codes)
My Voicemail
- Default code: *97 - Press *97 to access the voicemail box.
Voicemail Group Access Code
Default code: *99
Dial this code to access group voicemail. If password is required, enter password followed by the pound (#) key.
Direct Dial Voicemail Prefix
Prefix used to dial directly to voicemail.
Call Queue
Agent Pause
Default code: *83
Pause the agent in all call queues.
(This feature code cannot be nested by other feature codes)
Agent Unpause
Default code: *84
Unpause the agent in all call queues.
Dynamic Agent Logout
Default code: *85
Log the dynamic agent out of all queues.
Call Pickup
Pickup on Ringing Prefix
Picks up a ringing call for another extension. Example: If the prefix is **, and there is a call ringing ext 1008, dial **1008 from a different extension to pick up the call to 1008.
(This feature code cannot be nested by other feature codes)
Pickup In-call Prefix
Picks up an ongoing call for another extension. Example: If the feature code is *45, and ext 1008 is in a call, dialing *45 and then 1008 following the prompt will take that call. Note: The feature code user must be in the extension's Allowed to seamless transfer list to pick up calls for it.
Pickup Extension
This is the feature code to pick up incoming calls for other extensions in the same pickup group. The default setting is *8.
Call Barging
Enable Spy
Check this box to enable spy feature codes.
Listen Spy
This is the feature code to listen in on a call to monitor performance. Your line will be muted, and neither party will hear you. The default setting is *54.
(This feature code cannot be nested by other feature codes)
Barge Spy
This is the feature code to join in on the call to assist both parties. The default setting is *56.
(This feature code cannot be nested by other feature codes)
Whisper Spy
This is the feature code to speak to only one party in the call. For example, you could whisper to employees to help them handle a call. Only an employee on your account will be able to hear you. The default setting is *55.
(This feature code cannot be nested by other feature codes)
PMS
PMS Wakeup Service
Dial this feature code to access PMS Wakeup Service. You can add, update, activate or deactivate PMS Wakeup Service.
PMS Remote Wakeup Service
Dial this code to add, update, activate, and deactivate PMS wakeup service for other extensions.
Update PMS Room Status
2 methods are available:
1. Dial the room status feature code + housekeeper code, listen to the prompt and then the dial the appropriate key for the desired room status. Example: The housekeeper with housekeeper code 0001 dials *230001, listens to the room status options prompt, and then dials 1 to change room status to Available.
2. Dial room status feature code*housekeeper code*desired room status option key to quickly change the room status without needing to go through the system voice prompts. Example: Housekeeper with Housekeeper code 0001 dials *23*0001*1 to change room status Available.
(This feature code cannot be nested by other feature codes)
Misc
Paging Prefix
Configure the paging prefix for paging. For example, if the Paging Prefix is set to *81, dial *816000 to initiate a paging call to extension 6000.
(This feature code cannot be nested by other feature codes)
Intercom Prefix
Configure the intercom prefix for intercom calls. For example, if the Intercom Prefix is set to *80, dial *806000 to initiate an intercom call to extension 6000.
(This feature code cannot be nested by other feature codes)
Blacklist Add
Follow the voice prompt to add a caller ID to blacklist.
Blacklist Last Caller
Add the last inbound caller ID number to blacklist.
Blacklist Remove
Follow the voice prompt to remove a caller ID from blacklist.
Direct Dial Mobile Phone Prefix
If calling mobile phone numbers is permitted, use this prefix plus the extension number to dial the mobile phone number of this extension directly.
(This feature code cannot be nested by other feature codes)
Call Completion Request
If the caller wants to use CC to complete a call, he/she can dial this code. After the CC has been registered successfully, the system will start to monitor the status of the callee. The system will call back the caller when the callee's extension is available.
Call Completion Cancel
If the caller has requested CC successfully, and he/she doesn't need to call back anymore, he/she can dial this code to cancel the request.
Presence Status
Dial this feature code to set the presence status of the extension.
Call Flip
- Default code: *46
- Dial this code to move the call of this extension from another device to the current device.
Wakeup Service
Dial this feature code to access PBX Wakeup Service. You can add, update, activate or deactivate PBX Wakeup Service.
Remote Extension Privilege Update
Whitelisted extensions will be able to use the Remote Extension Privilege Update feature code to remotely change any extension's outgoing call privilege.
Note: After this function has been enabled, the extension is the whitelist can set the privilege for outgoing calls of any extension by dialing the feature code.
Remote Extension Privilege Update Whitelist
Remote Extension Privilege Update Whitelist
Procedure:
Dial *26 on the whitelisted extension, hear the prompt "Change extension's outgoing permission level, please enter the phone number, then enter # key."
After the process, voice will prompt "Press 1 to set to internal, press 2 to set to local, press 3 to set to national, press 4 to set to international."
After selecting, it will prompt "Change extension XXXX outgoing permission to XXX", and hang up.
Privileged Call
Dial the feature code + extension number, for example *001002 to hang up the current call of extension 1002 with privilege, and then call extension 1002.
Privileged Call Whitelist
The extensions in this white list can use the feature code of the privileged call.
Priority Call
Makes a high priority call to a specified extension by dialing the feature + extension number. If the specified extension is an ongoing call, it will be forcibly hung up to allow the caller to ring the extension.
(This feature code cannot be nested by other feature codes)
Priority Call Whitelist
Extension in the whitelist will be allowed to use this feature code to make priority calls.
The UCM630X also allows user to one click enable / disable specific feature code as shown below:
EnableDisable Feature codes
Parking Lot
User can create parking lots and their related slots under Web GUI Basic Call Features>Parking Lot. In the Parking Lot page, users can create lots of their own. This allows different groups within an organization to have their own parking lots instead of sharing one large parking lot with others. While creating a new parking lot, users can assign it a range that they think is appropriate for the group that will use the parking lot.
Parking Lot
User can create a new Parking lot by clicking on button “Add” :
New Parking Lot
Parking Lot Extension
Default Extension: 700
During an active call, initiate blind transfer and then enter this code to park the call.
Note: The user change the default extension for the parking lot to a different extension.
Parking Lot Name
Set a name to the parking lot
Parked Slots
Default Extension: 701-720
These are the extensions where the calls will be parked, i.e., parking lots that the parked calls can be retrieved.
Use Parking lot as Extension
If checked, the parking lot number can be used as extension. The user can transfer the call to the parking lot number to park the call. Please note this parking lot number range might conflict with extension range.
Parking Timeout (s)
Default setting is 300 seconds, and the maximum limit is 99.999 seconds.
This is the timeout allowed for a call to be parked. After the timeout, if the call is not picked up, the extension who parks the call will be called back.
Music On Hold Classes
Select the Music on Hold Class.
Failover Destination
Configures a callback failover destination when the extension that is called back is busy. The call will be routed to the destination number and this reduces the chance of dropping parked calls.
Ring All Callback on Timeout
If enabled, all registered endpoints of the extension will ring when callback occurs. Otherwise, only the original endpoint will be called back.
Forward to Destination on Timeout
If enabled, the call will be routed to the configured destination upon timeout. Otherwise, the call will be routed back to the original caller.
Timeout Destination
This option appears once Forward to Destination on Timeout is enabled. Upon park timeout, the call will be routed to the configured destination.
Parking Lot Timeout Alert-Info
Adds an Alert-Info header to parking lot callbacks after the Parking Timeout has been reached.
Call Park
The UCM630X provides call park and call pickup features via feature code.
Park a Call
There are two feature codes that can be used to park the call.
Feature Maps🡪Call Park (Default code #72)
During an active call, press #72 and the call will be parked. Parking lot number (default range 701 to 720) will be announced after parking the call.
Feature Misc🡪Call Park (Default code 700)
During an active call, initiate blind transfer (default code #1) and then dial 700 to park the call. Parking lot number (default range 701 to 720) will be announced after parking the call.
Retrieve Parked Call
To retrieve the parked call, simply dial the parking lot number and the call will be established. If a parked call is not retrieved after the timeout, the original extension who parks the call will be called back.
Monitor Call Park CID Name Information (GXP21xx, GRP261x Phones Only)
Users can see the CID name information of parked calls. VPK/MPKs must be configured as “Monitored Call Park” with the desired parking lot extension. The display will alternate between displaying the parking lot extension and the call’s CID name. There is no need to configure anything on the UCM.
Monitored Call Park CID name
ADVANCED CALL FEATURES
Pickup Groups
The UCM630X supports pickup group feature which allows users to pick up incoming calls for other extensions if they are in the same pickup group, by dialing “Pickup Extension” feature code (by default *8).
Configure Pickup Groups
Pickup Groups interface
Pickup groups can be configured via Web GUI Advanced Call Features🡪Pickup Groups.
Click on to create a new pickup group.
Click the button to upload the pickup group information.
Click the button to generate pickup group information.
Click on to edit the pickup group.
Click on to delete the pickup group.
Select extensions from the list on the left side to the right side.
Edit Pickup Group
Configure Pickup Feature Code
When picking up the call for the pickup group member, the user only needs to dial the pickup feature code. It is not necessary to add the extension number after the pickup feature code. The pickup feature code is configurable under Web GUI Basic Call Features🡪Feature Codes.
The default feature code for call pickup extension is *8, otherwise if the person intending to pick up the call knows the ringing extension they can use ** followed by the extension number in order to perform the call pickup operation. The following figure shows where you can customize these features codes
Edit Pickup Feature Code
Dial By Name
Dial by Name is a feature on the PBX that allows caller to search a person by first or last name via his/her phone’s keypad. The administrator can define the Dial by Name directory including the desired extensions in the directory and the searching type by “first name” or “last name”. After dialing in, the PBX IVR/Auto Attendant will guide the caller to spell the digits to find the person in the Dial by Name directory. This feature allows customers/clients to use the guided automatic system to contact the enterprise employees without having to know the extension number, which brings convenience and improves business image for the enterprise.
Dial by Name Configuration
The administrators can create the dial by name group under Web GUI Advanced Call Features>Dial By Name.
Create Dial by Name Group
Configure Extension First Name and Last Name
Name: Enter a Name to identify the Dial by Name group.
Extension: Configure the direct dial extension for the Dial By Name group.
Custom Prompt: This option sets a custom prompt for directory to announce to a caller. The file can be uploaded from the page “Custom Prompt”. Click “Upload Audio File” to add additional record.
Available Extensions/Selected Extensions: Select available extensions from the left side to the right side as the directory for the Dial By Name group. Only the selected extensions here can be reached by the Dial By Name IVR when dialing into this group. The extensions here must have a valid first name and last name configured under Web GUI🡪Extension/Trunk🡪Extensions in order to be searchable in Dial By Name directory through IVR. By specifying the extensions here, the administrators can make sure unscreened calls will not reach the company employee if he/she does not want to receive them directly.
Prompt Wait Time: Configure “Prompt Wait Time” for Dial By Name feature. During Dial By Name call, the caller will need to input the first letters of First/Last name before this wait time is reached. Otherwise, timeout will occur, and the call might hang up. The timeout range is between 3 and 60 seconds.
Query Type: Specify the query type. This defines how the caller will need to enter to search the directory. By First Name: enter the first 3 digits of the first name to search the directory. By Last Name: enter the first 3 digits of the last name to search the directory.
Select Type Specify the select type on the searching result. The IVR will confirm the name/number for the party the caller would like to reach before dialing out. By Order: After the caller enters the digits, the IVR will announce the first matching party’s name and number. The caller can confirm and dial out if it is the destination party, or press * to listen to the next matching result if it is not the desired party to call. By Menu: After the caller enters the digits, the IVR will announce 8 matching results. The caller can press number 1 to 8 to select and call or press 9 for results in next page. The Dial by Name group can be used as the destination for inbound route and key pressing event for IVR. The group name defined here will show up in the destination list when configuring IVR and inbound route. If Dial by Name is set as a key pressing event for IVR, user could use ‘*’ to exit from Dial by Name, then re-enter IVR and start a new event. The following example shows how to use this option.
In many situations, the user will find the need to access his own IP PBX resources, but he is not physically near one of his extensions. However, he does have access to his own cell phone. In this case, we can use what is commonly known as DISA (Direct Inward System Access). Under this scenario, the user will be able to call from the outside, whether it is using his cell phone, pay phone, regular PSTN, etc. After calling into UCM630X, the user can then dial out via the SIP trunk or PSTN trunk connected to UCM630X as it is an internal extension.
The UCM630X supports DISA to be used in IVR or inbound route. Before using it, create new DISA under Web GUI Advanced Call Features>DISA.
Click on to add a new DISA.
Click on to edit the DISA configuration.
Click on to delete the DISA.
Create New DISA
The following table details the parameters to set and configure DISA feature on UCM630X PBX.
Name
Configure DISA name to identify the DISA.
Password
Configure the password (digit only) required for the user to enter before using DISA to dial out.
Note: The password must be at least 4 digits.
Permission
Configure the permission level for DISA. The available permissions are "Internal", "Local", "National" and "International" from the lowest level to the highest level. The default setting is "Internal". If the user tries to dial outbound calls after dialing into the DISA, the IPPBX will compared the DISA's permission level with the outbound route's privilege level. If the DISA's permission level is higher than (or equal to) the outbound route's privilege level, the call will be allowed to go through.
Response Timeout
Configure the maximum amount of time the IPPBX will wait before hanging up if the user dials an incomplete or invalid number. The default setting is 10 seconds.
Digit Timeout
Configure the maximum amount of time permitted between digits when the user is typing the extension. The default setting is 5 seconds.
Allow Hangup
If enabled, during an active call, users can enter the IPPBX Hangup feature code (by default it is *0) to disconnect the call or hang up directly. A new dial tone will be heard shortly for the user to make a new call. The default setting is "No".
Replace Display Name
If enabled, the IPPBX will replace the caller display name with the DISA name.
Once successfully created, users can configure the inbound route destination as “DISA” or IVR key event as “DISA”. When dialing into DISA, users will be prompted with password first. After entering the correct password, a second dial tone will be heard for the users to dial out.
Callback
Callback is designed for users who often use their mobile phones to make long distance or international calls which may have high service charges. The callback feature provides an economic solution for reduce the cost from this.
The callback feature works as follows:
Configure a new callback on the UCM630X.
On the UCM630X, configure destination of the inbound route for analog trunk to callback.
Save and apply the settings.
The user calls the PSTN number of the UCM630X using the mobile phone, which goes to callback destination as specified in the inbound route.
Once the user hears the ringback tone from the mobile phone, hang up the call on the mobile phone.
The UCM630X will call back the user.
The user answers the call.
The call will be sent to DISA or IVR which directs the user to dial the destination number.
The user will be connected to the destination number.
In this way, the calls are placed and connected through trunks on the UCM630X instead of to the mobile phone directly. Therefore, the user will not be charged on mobile phone services for long distance or international calls.
To configure callback on the UCM630X, go to Web GUI Advanced Call Features>Callback page and click on . Configuration parameters are listed in the following table.
Name
Configure a name to identify the Callback. (Enter at least two characters)
CallerID Pattern
Configure the pattern of the callers allowed to use this callback. The caller who places the inbound call needs to have the CallerID match this pattern so that the caller can get callback after hanging up the call.
Note: If leaving as blank, all numbers are allowed to use this callback.
Outbound Prepend
Configure the prepend digits to be added at before dialing the outside number. The number with prepended digits will be used to match the outbound route. ‘-’ is the connection character which will be ignored.
Delay Before Callback
Configure the number of seconds to be delayed before calling back the user.
Destination
Configure the destination which the callback will direct the caller to. Two destinations are available:
IVR
DISA
The caller can then enter the desired number to dial out via UCM630X trunk.
Scheduled Call
The Scheduled Call service can be used to schedule a call to any valid destination. This service is available on the UCM630X as a separated module.
There are three ways to set up a Scheduled Call service:
Using admin login
Using user portal
Using feature code
Scheduled Call using Admin Login
Login to the UCM as admin.
Scheduled Call service can be found under Web GUI Advanced Call Features>Scheduled Call, click on ”Add” to create a new scheduled call. The following window will pop up.
Create a New Scheduled Call
Fill out the required fields and select the members to add to the scheduled call group.
Enable Scheduled Call
Enable/disable Scheduled Call feature.
Name
Enter a name (up to 64 characters) to identify the wakeup service.
Prompt
Select/upload the prompt to play for that extension.
Custom Date
Check to select the weekday(s) to perform the scheduled call.
Date
Select the date to perfom the scheduled call.
Time
Select the time to perform the scheduled call.
Members
Select the destination extensions of the scheduled call.
Click and to apply the changes.
A scheduled call entry is created. The UCM will send a scheduled call to every extension in the member list at the scheduled date and time.
Note
The scheduled call service has the following limitation on how many members can be added depending on UCM model.
UCM Model
Max members in a Scheduled Call
UCM6301
50
UCM6302
100
UCM6304
150
UCM6308
200
Scheduled Call from User Portal
Login to the user portal on the UCM630X.
Scheduled Call can be found under “Advanced Call Features > Scheduled Call”, click on ”Add” to create a new wakeup service.
User Portal Create New Scheduled Call
Configures the Name, Prompt, Date and Time for the user to make the scheduled call to.
Enable Scheduled Call
Enable/disable Scheduled Call feature.
Name
Enter a name (up to 64 characters) to identify the wakeup service.
Prompt
Select the prompt to play for that extension.
Custom Date
Check to select the weekday(s) to perform the scheduled call.
Date
Select the date to perfom the scheduled call.
Time
Select the time to perform the scheduled call.
Click and to apply the changes.
Scheduled Call Feature Code
Login to the UCM as admin.
Enable “Scheduled Call” from the Web GUI under Basic Call Features > Feature Codes > Feature Codes.
Scheduled Call Feature Code
Click and to apply the changes.
Dial “*36” which is the feature code by default to access to the UCM Scheduled Call to add, update, activate or deactivate UCM Scheduled Call.
Fax Sending
Besides the support of Fax machines, The UCM6300 supports also sending Fax via Web GUI access. This feature can be found on Integrations > FaxSending page. To send fax, pre-setup for analog trunk and outbound route is required. Please refer to [ANALOG TRUNKS], [VOIP TRUNKS] and [Outbound Routes] sections for configuring analog trunk and outbound route.
After making sure analog trunk or VoIP Trunk is setup properly and UCM6300 can reach out to PSTN numbers via the trunk, on Fax Sending page, enter the fax number and upload the file to be faxed. Then click on “Send” to start. The progress of sending fax will be displayed in Web GUI. Users can also view the sending history is in the same web page.
Fax Sending in Web GUI
After that you can see the ongoing sending operation on the progress bar.
Fax Send Progress
Only A3, A4, and B4 paper sizes are supported for the Fax Sending.
Fax/T.38
The UCM6300 series supports T.30/T.38 Fax and Fax Pass-through. It can convert the received Fax to PDF format and send it to the configured Email address. Fax/T.38 settings can be accessed via Web GUI AdvancedCall Features > FAX/T.38. The list of received Fax files will be displayed on the same web page for users to view, retrieve and delete.
Configure Fax/T.38
Click on “Create New Fax Extension”. In the popped-up window, fill the extension, name, and Email address to send the received Fax to.
Click on “Fax Settings” to configure the Fax parameters.
Click on to edit the Fax extension.
Click on to delete the Fax extension.
Fax Settings
Parameter
Description
Enable Error Correction Mode
Configure to enable Error Correction Mode (ECM).
Maximum Transfer Rate
Configure the maximum transfer rate during Fax rate negotiation.
Minimum Transfer Rate
Configure the minimum transfer rate during Fax rate negotiation.
Max Concurrent Sending Fax
Determines how many users can send fax at the same time.
Fax Queue Length
Maximum length of fax queue.
Fax Header Information
Adds header information to fax files.
Default Email Address
Send fax to this email address if the fax destination does not have an email address configured.
Send PDF Files Only
If enabled, fax emails will no longer attach TIFF files. Only PDF files will be attached.
Enable Fax Resend
Enable Fax Resend.
Max Resend Attempts
Max Resend Attempts.
Fax Resend Frequency
Fax Resend Frequency.
Receiving Fax
Example Configuration to Receive Fax from PSTN Line
The following instructions describe how to use the UCM6300 to receive fax from the PSTN line on the Fax machine connected to the UCM6300 FXS port.
Connect Fax machine to the UCM6300 FXS port.
Connect PSTN line to the UCM6300 FXO port.
Go to Web GUI🡪Extension/Trunk page.
Create or edit the analog trunk for Fax as below.
Fax Detection: Make sure the “Fax Detection” option is set to “NO”.
Configure Analog Trunk
Go to UCM6300 Extension/Trunk > Extensions page.
Create or edit the extension for FXS port.
Analog Station: Select FXS port to be assigned to the extension. By default, it is set to “None”.
Once selected, analog related settings for this extension will show up in “Analog Settings” section.
Configure Extension for Fax Machine FXS Extension
Configure Extension for Fax Machine Analog Settings
Go to Extension/Trunk > Inbound Routes page.
Create an inbound route to use the Fax analog trunk. Select the created extension for Fax machine in step 4 as the default destination.
Configure Inbound Rule for Fax
Now the Fax configuration is done. When there is an incoming Fax calling to the PSTN number for the FXO port, it will send the Fax to the Fax machine.
Example Configuration for Fax-To-Email
The following instructions describe a sample configuration on how to use Fax-to-Email feature on the UCM6300.
Connect PSTN line to the UCM6300 FXO port.
Go to UCM6300 Web GUI AdvancedCall Features>Fax/T.38 page. Create a new Fax extension.
Create Fax Extension
Go to UCM6300 Extension/Trunk > Analog Trunks page. Create a new analog trunk. Please make sure “Fax Detection” is set to “No”.
Go to UCM6300 Extension/Trunk > Inbound Routes page. Create a new inbound route and set the default destination to the Fax extension.
Inbound Route to Fax Extension
Once successfully configured, the incoming Fax from external Fax machine to the PSTN line number will be converted to PDF+TIFF file and sent to the extension 7200 and email address fax@domain.local as attachment.
In order for the file to be sent to the email address configured on the external extension, please make sure that the email settings are well configured. Please refer to [Email Settings] section.
List of Fax Files
Announcement Center
The UCM630X supports Announcement Center feature which allows users to pre-record and store voice message into UCM630X with a specified code. The users can also create group with specified extensions. When the code and the group number are dialed together in the combination of code + group number, the specified voice message is sent to all group members and only extensions in the group will hear the voice message. To access the Announcement Center, please navigate to Advanced Call Features > Announcement Center.
Announcement Center
Announcement Center Settings
Name
Configure a name for the newly created Announcement Center to identify this announcement center.
Code
Enter a code number for the custom prompt. This code will be used in combination with the group number. For example, if the code is 55, and group number is 666. The user can dial 55666 to send prompt 55 to all members in group 666.
Note: The combination number must not conflict with any number in the system such as extension number or conference number.
Custom Prompt
This option is to set a custom prompt as an announcement to notify group members. The file can be uploaded from page ‘Custom Prompt’. Click ‘Prompt’ to add additional record.
Note: When uploading a custom, please ensure that the custom prompt file respect the following requirements.
The audio file must be less than 5 MB in file size with a file extension of .mp3/. wav/. ulaw/. alaw/. gsm. WAV files must be PCM encoded, 16 bit mono, and 8000Hz.
If uploading a compressed file, the file extension must be .tar/.tgz/.tar.gz, and the file size must not exceed 50MB. File name can only contain alphanumeric characters and special characters -_
Ring Timeout
Configure the ring timeout for the group members. The default value is 30 seconds.
Auto Answer
If set to Yes, the Auto answer will be enabled by the members.
Call Privileges
Please select the permission level for outgoing calls.
Announce Message Caller-ID
If enabled, the caller's CID number will be announced before playing the uploaded prompt. This CID will also be used as the displayed CID of the call.
Group Settings
Name
Configure a name for the newly created group to identify the group.
Note: Name cannot exceed 64 characters.
Number
Configure the group number. The group number is used in combination with the code. For example, if group number is 666, and code is 55. The user can dial 55666 to send prompt 55 to all members in group 666.
Note: The combination number must not conflict with any number in the system such as extension number or conference number and cannot exceed 64 characters.
Internal Members
Choose the local extensions to add to the group.
LDAP Members
Choose the LDAP contacts to add to the group.
Custom Members
Enter the custom phone numbers to add to the group.
Note: The maximum number of custom numbers which can be added are 50 custom number.
Announcement Center feature can be found under Advanced Call Features > Announcement Center. The following example demonstrates the usage of this feature.
Click to add new group.
Give a name to the newly created group.
Create a group number which is used with code to send voice message.
Select the extensions to be included in the group, who will receive the voice message.
Announcement Center Group Configuration
Name
Configure a name for the newly created group to identify the group.
Note: Name cannot exceed 64 characters.
Number
Configure the group number. The group number is used in combination with the code. For example, if group number is 666, and code is 55. The user can dial 55666 to send prompt 55 to all members in group 666.
Note: The combination number must not conflict with any number in the system such as extension number or conference number and cannot exceed 64 characters.
Internal Members
Choose the local extensions to add to the group.
LDAP Members
Choose the LDAP contacts to add to the group.
Custom Members
Enter the custom phone numbers to add to the group.
Note: The maximum number of custom numbers which can be added are 50 custom number.
In this example, group “Test” has number 666. Extension 1000, 1001 and 1002 are in this group.
Click to create a new Announcement Center.
Give a name to the newly created Announcement Center.
Specify the code which will be used with group number to send the voice message to.
Select the message that will be used by the code from the Custom Prompt drop down menu. To create a new Prompt, please click “Prompt” link and follow the instructions in that page.
Announcement Center Code Configuration
Name
Configure a name for the newly created Announcement Center to identify this announcement center.
Code
Enter a code number for the custom prompt. This code will be used in combination with the group number. For example, if the code is 55, and group number is 666. The user can dial 55666 to send prompt 55 to all members in group 666.
Note: The combination number must not conflict with any number in the system such as extension number or conference number.
Custom Prompt
This option is to set a custom prompt as an announcement to notify group members. The file can be uploaded from page ‘Custom Prompt’. Click ‘Prompt’ to add additional record.
Note: When uploading a custom, please ensure that the custom prompt file respect the following requirements.
The audio file must be less than 5 MB in file size with a file extension of .mp3/. wav/. ulaw/. alaw/. gsm. WAV files must be PCM encoded, 16 bit mono, and 8000Hz.
If uploading a compressed file, the file extension must be .tar/.tgz/.tar.gz, and the file size must not exceed 50MB. File name can only contain alphanumeric characters and special characters -_
Ring Timeout
Configure the ring timeout for the group members. The default value is 30 seconds.
Auto Answer
If set to Yes, the Auto answer will be enabled by the members.
Call Privileges
Please select the permission level for outgoing calls.
Announce Message Caller-ID
If enabled, the caller's CID number will be announced before playing the uploaded prompt. This CID will also be used as the displayed CID of the call.
Code and Group number are used together to direct specified message to the target group. All extensions in the group will receive the message. For example, we can send code 55 to group 666 by dialing 55666 from any extension registered to the UCM630X. All the members in group 666 which are extension 1000, 1001 and 1002 will receive this voice message after they pick up the call.
Announcement Center Example
Announcement
The Announcement feature (not to be confused with Announcement Paging and Announcement Center) is a feature that allows users to set an unskippable audio file to play to callers before routing them to a configured destination. Announcements can be configured as a destination in the Inbound Routes page.
To configure Announcement, users need to follow below steps:
Navigate on the web GUI under Advanced Call Features > Announcement
Click on to add a new announcement.
Configure the required fields Name, Prompt, Default Destination to be used for the announcement.
Save and apply the configuration.
Create New Announcement
The table below gives more description of the configuration parameters when creating announcements.
Name
Configure the name of the Announcement.
Prompt
Choose/upload the audio file to play when the call reaches this announcement.
Default Destination
Select the destination which the call will be forwarded to after the announce has been played.
SCA (Shared Call Appearance)
SCA (Shared Call Appearance) functionality has been added to the UCM. With SCA, users can assign multiple devices to one extension, configure endpoints to monitor that extension, make actions on behalf of that extension such as viewing call status and placing and receiving calls, and even barging into existing calls. To configure the SCA functionality, please follow the steps below:
Users can enable SCA by navigating to the Extensions page, editing the desired extension, and enabling the option SCA.
With SCA enabled, the Concurrent Registrations field can only have a value of 1.
Enabling SCA option under Extensions Settings
After enabling the option, navigate to Advanced Call Features > SCA. The newly enabled SCA extension will be listed. Click the “+” button under the Options column to add a number that will share the main extension’s call appearance, which will be called private numbers.
SCA Number Configuration
Configure the private number as desired.
SCA Private Number Configuration
Once the private number has been created, users must now register a device to it. To properly register a device to the private number, use the configured private number as the SIP User ID. Auth ID and Password will be the same as the main extensions. Once registration is complete, SCA is now configured.
SCA Options
Next, configure the VPK or MPK to Shared for both the main extension and the private number. SCA is now configured for both endpoint devices.
The following table describe the SCA Number configuration setting:
Private Number
Configures the private number for the SCA.
Related Shared Line
Display the related shared line.
Enable this number
Whether enable this private number. If not enabled, this private number is only record in DB, it will not affect other system failure.
Allow Origination from This Number
Enable this option will allow calling from this private number.
By default, it is enabled.
Allow Termination to This Number
Enable this option will allows calls to this private number.
By default, it is enabled.
When editing the SCA number, additional options will be displayed. The following table explains all the additional options:
Shared Line Number
While SCA is enabled, this number will be the same as the extension number.
Allow Call Retrieve from Another Location
Allows remote call retrieval. Must be enabled in public hold. By default, it is enabled.
Alert All Appearances for Group Paging Calls
Allows all SCA group members to ring when the SCA shared number is paged. If disabled, only the SCA shared number will ring when paged. By default, it is disabled.
Multiple Call Arrangement
Allows simultaneous calls in an SCA group. By default, it is disabled.
Allow Bridging between Locations
Allows location bridging for SCA group. Must be enabled when using the Barge-In feature. By default, it is disabled.
Bridge Warning Tone
Configures the notification in the bridge when another party join.
None: No notification sound.
Barge-In only: Notification sound will play when another party join.
Barge-In and Repeat: Notification sound will play when another party joins and repeat every 30 seconds.
Emergency Calls
UCM supports configuration and management of numbers to be called in emergency situation, thus bypassing the regular outbound call routing process and allowing users in critical situation to dial out for emergency help with the possibility to have redundant trunks as point of exit in case one of the lines is down.
UCM63xx series are fully compliant with Kari’s Law and Ray Baum’s Act, for more information, please refer to the following links:
To configure emergency numbers, users need to follow below steps:
Navigate on the web GUI under Advanced Call Features > Emergency Calls”
Click on to add a new emergency number.
Configure the required fields “Name, Emergency Number and Trunk(s) to be used to reach the number”.
Save and apply the configuration.
Emergency Number Configuration
The table below gives more description of the configuration parameters when creating emergency numbers.
Name
Configure the name of the emergency call.
For example, “emergency911″,”emergency211” and etc.
Emergency Number
Config the emergency service number. For example,”911″,”211″ and etc.
Emergency Level
Select the emergency level of the number. Level “3” means the most urgent.
Disable Hunt on Busy
If this option is not enabled, when the lines of trunks which the coming emergency call routes by are completely occupied, the line-grabbing function will automatically cut off a line from all busy lines so that the coming emergency call can seize it for dialing out. This option is not enabled by default.
Custom Prompt
This option sets a custom prompt to be used as an announcement to the person receiving an emergency call. The file can be uploaded from the page “Custom Prompt”. Click “Prompt” to add additional record.
Use Trunks
Select the trunks for the emergency call. Select one trunk at least and select five trunks at most.
Emergency CID
Used for emergency calls. The peer device will display the call number. Extension emergency CID takes priority over this settings. If that is not configured for the dialing extension, this value will be used by default.
Members Notified
Select the members who will be notified when an emergency call occurs.
Note: You can select up to 30 members to notify.
Strip
Specify the number of digits that will be Stripped from the beginning of the dialed number before the call is placed via the selected trunk.
Prepend
Specify the digits to be Prepended before the call is placed via the trunk. Those digits will be prepended after the dialing number is stripped.
Auto Record
When enabled, emergency call will be automatically recorded.
Send Recording File
When enabled recording files will be sent to the configured email address.
Email Address
The email address to where the recording files will be sent.
911 Emergency Sample
Emergency Recordings
UCM6300 Series allows recording emergency calls and they can be found under Advanced Call Feature > Emergency Calls > Emergency Recordings
Emergency Recordings
Emergency Location Mapping
In compliance with Kari’s Law and the Ray Baum’s Act, UCM’s Emergency Calls feature now supports emergency location mapping. This will allow users to associate subnets with emergency location identification numbers (ELINs), which can then be used by E911 service providers for example to determine the location of callers. The new options can be found under Advanced Call Features > Emergency Calls > Emergency Location Mapping.
Emergency Location Mapping
ELIN: The emergency location identification number registered with the E911 provider. This number will be sent out as the emergency call’s CID number.
Geolocation Routing: Toggles whether to include the Geolocation header in the emergency call SIP INVITE message. The Location field value will be used as the Geolocation header value.
Send PAI Header: PAI stands for P-Asserted-Identity. Once enabled, the ELIN number will be sent via the PAI header field to ensure accurate location tracking for emergency services. This PAI header field takes precedence over the PAI header field of the trunks.
Type:
Network Method: Click add then enter the subnet address and the position.
Extension Method: Click add then enter the extension number and the position.
Important Note
Please note that ELIN Mapping is supported only on peer trunks. It would not apply on register trunks.
Restrict Calls
The Restrict Calls feature allows administrators to control outgoing call permissions for specific internal extensions. When a rule is enabled, users designated as Members are restricted to placing outbound calls only to the extensions listed in the Allowed List.
This section describes the configuration of this feature in the Advanced Call Features → Restrict Calls page.
Note:
This feature only restricts outbound calls placed by assigned Members. Non-allowed extensions can still place incoming calls to these Members. For strict two-way restriction between two groups, you must create two separate Restrict Calls rules.
Restrict Calls
Configure Restrict Calls
Click Add to create a new Restrict Calls rule.
Click the Edit icon to modify an existing rule.
Click the Delete icon to remove a rule.
When creating or editing a rule, users can configure the following:
Name
Enter a descriptive name for the Restrict Calls rule.
Restrict Calls Between Extension
Toggles the restriction rule on or off.
Enabled: Applies the rule. Members can only place outbound calls to numbers in the Allowed List.
Disabled: Bypasses the rule entirely. Members will have no outbound call restrictions. (Enabled by default)
Members
Select the internal extensions whose outbound calling ability will be restricted when the rule is enabled.
Allowed List
Select the specific internal extensions that the Members are permitted to call.
Operator Panel
Operator Panel settings can be accessed via Web GUI >Advanced Call Features>Operator Panel.
The UCM630X supports the operator panel so that UCM extension can be used as admin to manage calls and activities such as extension status, call queue status, transfer, barge-in, hangup, etc. On Grandstream Wave client, it can display the extensions, ring group, voicemail, call queue, call park status under the management of the extension. This section describes how to configure the operator panel.
Operator Panel Configuration Page
Click on “Add” to create the operator panel.
Click on to edit the operator panel.
Click on to delete the operator panel.
Name
Configure the name for the operator panel created for identification purposes.
Administrator
Assign the administrator for the operator panel. It can be an extension, a extension group or a department. For the selected extension groups and departments, subsequent extensions will automatically become administrators.
Management Module
Extension
The selected extensions will be supervised by the administrator, and you can choose extensions, extension groups, and departments. For the selected extension groups and departments, subsequent extensions will be automatically supervised by the administrator.
Ring Groups
The selected Ring Groups will be supervised by the administrator. If selecting “All”, all Ring Groups and subsequent updates will be automatically supervised by the administrator.
Voicemail Groups
The selected Voicemail Groups will be supervised by the administrator. If selecting “All”, all Voicemail Groups and subsequent updates will be automatically supervised by the administrator.
Call Queue
The selected Call Queue will be supervised by the administrator. If selecting “All”, all Call Queue and subsequent updates will be automatically supervised by the administrator.
Parking Lot
The selected Parking Lot will be supervised by the administrator. If selecting “All”, all Parking Lot and subsequent updates will be automatically supervised by the administrator.
Time Condition Routing
Time Condition Routing allows the user to create default destinations for call queues and ring groups which are based on time conditions under Advanced Call Features > Time Condition Routing.
Time Condition Routing
Parameter
Description
Name
Enter a unique and easily identifiable name for this routing.
Time
Configures the time period to use for this time-based routing.
Time Match
Default Destination
Calls received during the selected time period will be routed to this destination.
Time Mismatch
Default Destination
Calls received outside the selected time period will be routed to this destination.
MESSAGING
This section includes the messaging features offered by the UCM6300 Series. It includes instant messaging, live chat, message broadcast, and SMS features.
IM Settings
In this section the user can change the settings related to Wave instant messaging such as enabling or disabling read receipt, defining the maximum file size which the user can send on Wave. The user can also configure cloud instant messaging for the PBX, or configure the PBX as an instant messaging server.
IM Settings
In IM Settings tab, the user can choose to enable or disable read receipts when exchanging messaging using Wave.
IM Settings
Cloud IM Service
Enable Cloud IM
If you have purchased the Cloud IM package or purchased the Grandstream IM server, you can configure it. If you have not purchased it, the configuration will not take effect, but PBX local IM service is allowed. Please note that after enabling this feature, local chat data will not be visible.
Local Proxy
If enabled, the local proxy will be used to forward files and text messages if the IM server cannot be connected to upon Wave login due to certificate issues.
Cloud IM Server Address
The address of the server that provides IM service, you can fill in the address of the Cloud IM server provided by the RemoteConnect package or the IM server address of the GDMS.
Service ID
The service ID of the Cloud IM server.
Key
The Key to the Cloud IM server.
Site Name
Enter the name of the site.
Trusted User
The trusted user of the cloud IM. Only letters, numbers, and special characters are allowed.
Prefix
As the extension prefix, it is added before the extension number.
Sync Local Chat Data
Syncing existing local chat data to Cloud IM server. The Wave chat feature will not be available during the syncing process. It is recommended to avoid syncing during active working hours.
- Time Range
All
Last 12 Months
Last 6 Months
Last 3 Months
Last Month
- Data Type
IM Data
Images
Files
Cloud IM Service
After enabling Cloud IM, it means that all IM data in Wave is stored in the external server Cloud IM, and is no longer stored locally in UCM.GDMS can configure the External Cloud IM service for UCM devices. At this time, the UCM device synchronizes the configuration item information.
Cloud IM Service
Cloud IM Service
Enable Cloud IM
If you have purchased the Cloud IM package or purchased the Grandstream IM server, you can configure it. If you have not purchased it, the configuration will not take effect, but PBX local IM service is allowed. Please note that after enabling this feature, local chat data will not be visible.
Local Proxy
If enabled, the local proxy will be used to forward files and text messages if the IM server cannot be connected to upon Wave login due to certificate issues.
Cloud IM Server Address
The address of the server that provides IM service, you can fill in the address of the Cloud IM server provided by the RemoteConnect package or the IM server address of the GDMS.
Service ID
The service ID of the Cloud IM server.
Key
The Key to the Cloud IM server.
Site Name
Enter the name of the site.
Trusted User
The trusted user of the cloud IM. Only letters, numbers, and special characters are allowed.
Prefix
As the extension prefix, it is added before the extension number.
Sync Local Chat Data
Syncing existing local chat data to Cloud IM server. The Wave chat feature will not be available during the syncing process. It is recommended to avoid syncing during active working hours.
- Time Range
All
Last 12 Months
Last 6 Months
Last 3 Months
Last Month
- Data Type
IM Data
Images
Files
Note
Please note that synchronization of the local chat can only occur in the initial connection to a Cloud IM Server . If the UCM is already connected to a Cloud IM server, or the Cloud IM server has already been synced to other UCMs, local chat data will not be able to be synced.
Only account details and department information will be synced on local IM and cloud IM. Other configurations such as profile picture, work status, and favorite contacts will not be synced and these are stored in local IM or cloud IM respectively. Therefore, please be aware that when switching between local IM and cloud IM, part of the data cannot be synced and the previously stored data on local IM or cloud IM (depending on which one is switched to) will be retrieved.
IM Server
If Enable IM Server Mode is toggled on, UCM will function only as an IM server. The UCM management portal will remove PBX-related services and supports the binding of multiple cross-region UCM devices. The UCM device that wants to bind the IM server address is also bound by turning on the Cloud IM mode, and the IM data in his Wave is stored in this IM server.
IM server configuration interface
Company name
The entered company name
Server Address
The domain name or IP address of the Cloud IM server.
Service ID
The service ID of the Cloud IM server.
Key
The Key of the Cloud IM server.
Trusted User
The trusted user of the cloud IM. Only letters, numbers, and special characters are allowed.
Bound Device Information
Department
The department represented by the bound UCM.
MAC Address
MAC address of the bound UCM device.
Dial Prefix
Extension prefix
Live Chat
Live Chat feature allows to create chat channels that can be embedded on your website to enable your client to reach your customer service more easily. The client can contact your agents by text then
Name
Fill in the name of the Live Chat. It will be displayed on the chat session page of the agent (customer service), and the agent will know which Live Chat the visitor is accessing through.
Destination
Select the destination number, which is the extension or queue number of this Live Chat (receiving message).
Web Page Language
Select the display language on the visitor’s Live Chat interface.
Disable
If disabled, this live chat will no longer be available for use.
Call Settings
Allow Visitor to Call
Select whether to allow visitors to make calls.
Allow Calling Before Chat
Select whether to allow visitors to make phone calls before an agent (customer service) receive the session.
WebRTC Trunks
Select the WebRTC trunk of the phone customer service which is applicable. You can create it in Extension/Trunk -> WebRTC Trunk in advance. It is recommended that the destination number of the WebRTC Trunk be the same as the destination number of the live chat, so that after transferring the chat to a call the receiver will be the same agent.
Select the profile picture that visitors will see. You can upload a picture or use the default picture.
Name
Fill in the name of the agent that visitors will see.
Show Customer Service Real Name
Select whether to display the extension name of the agent
Chat Settings
Visitor Side Chat Log Retention Time (Days)
When the session ends, the visitor can view the chat history during this configured period. After this time, the chat history cannot be viewed.
Note: If the session never ends, the visitor will always see the chat history.
Live Chat Link Address
This link can be embedded onto web pages. Clicking it will connect visitors to the configured Live Chat destination. This link can also be entered directly into the browser address bar for testing purposes.
Message broadcast feature allows the administrator to broadcast a text message to all the endpoints selected by the administrator. The administrator can select departments or individual extensions to boardcast a text message.
Name
Configure the name of this broadcast.
Sender
Configure the sender of this broadcast.
Message Content
Enter the message to broadcast to recipients. Please keep in mind the display size of recipient endpoints as long messages may be cut off.
Recepients
Select the recipients of the broadcasted message.
SMS Settings
SMS Configuration
Configuring the SMS feature on the UCM6300 series allows the administrators to enable two-factor authentication, to send alerts, and meeting notices.
SMS Settings
Enable SMS
Tick this box to enable SMS service.
SMS Carrier
Choose the SMS carrier:
Amazon
Twilio
Region
Choose the region.
Account ID
Enter the ID of the account created at the carrier.
Secret
Enter the secret code.
Account ID
Configures Twilio account ID.
Auth Token
The key of the Twilio account.
Messages Server ID
Twilio SMS Server ID
From
Enter the number phone allocated for the UCM.
SMS Template
The template of the SMS can be modified in “SMS Template” tab. Please note that carriers may require to pre-register the templates for SMS that the UCM will send. Refer to the Amazon and Twilio documentation for more information.
SMS Templates
SMS Delivery Log
All the SMS messages sent will be logged in the following tab.
SMS Delivery Log
Advanced Messaging
The Advanced Messaging page provides a centralized interface for configuring chatbots, WhatsApp connectivity, and third-party messaging integrations directly from the UCM management portal. This allows administrators to easily create, manage, and integrate messaging services without relying on external tools.
The advanced messaging feature supports configuring:
General Chatbot: A customizable chatbot that can handle automated conversations and responses across supported messaging platforms.
Whatsapp Chatbot: A chatbot integrated with WhatsApp to automate customer interactions, messaging, and service workflows within the WhatsApp ecosystem.
Chatbot
General Chatbot
Navigate to UCM Web UI → Messaging → Advanced Messaging → Chatbot. Click Add to create a new chatbot. This will open the chatbot configuration page where you can define the chatbot type and basic settings.
In the Add Chatbot – Basic Settings page:
Name – Enter a unique name for the chatbot (e.g., SupportBot).
Description – (Optional) Add notes or details about the chatbot’s purpose.
Apply to Channel – Select the messaging channel where the chatbot will be used (e.g., WhatsApp or General).
After saving the basic settings, the chatbot will be created successfully. A Default Reply Flow is automatically applied, starting with a standard greeting (e.g., Hello! How can I help you?).
To customize this behavior, click Edit Reply Process and define the conversation flow according to your needs.
If no changes are required, click Back to List to return to the chatbot overview page.
In the Default Reply Flow editor:
Enable – Toggle on/off to activate or disable the reply flow.
Description – (Optional) Add details about the reply flow’s purpose.
Message – Enter the default greeting or automated response (e.g., Hello! How can I help you?).
Add Button – Insert interactive buttons to guide users toward predefined options or actions.
Click OK to save the changes.
In the Default Reply Flow editor, you can add interactive options and responses:
Under the default greeting, click Add Button and label it (e.g., Business Hours).
Link the button to a Reply block that contains the desired response (e.g., Our business hours are Monday to Friday, 9:00 AM – 6:00 PM. How can I assist you today?).
Use the Test panel on the right to preview the chatbot’s behavior.
Once satisfied, click Publish to activate the chatbot flow.
Whatsapp Chatbot
From the Advanced Messaging → WhatsApp tab, click Add WhatsApp. This opens the configuration page to register your WhatsApp account with the UCM.
Fill in the required fields:
Name – Enter a unique identifier for the WhatsApp integration.
Token – Provide the authentication token generated by your WhatsApp service.
Webhook – Enter the webhook URL for event callbacks.
Secret Key – (Optional) Add a key for securing webhook communications.
WhatsApp Phone Number – Enter the registered WhatsApp phone number.
Destination Number – Select the UCM extension that will receive WhatsApp messages.
Display sessions taken by other agents: Shows active chat sessions that are already handled by another agent.
Enable Chatbot – Toggle on and choose the chatbot to handle automated replies.
Define Chatbot Behavior
Chatbot Mode – Select how the chatbot should operate: Automatic Reception or Chat Assistance.
Transfer to Agent – Configure the fallback message when the chatbot cannot handle the request (e.g., Click “Transfer to Agent” to start chatting with customer service).
After Hours Prompt – Add a custom message to be sent outside business hours.
Integration
In the Integration tab, enable Interface Link to allow the UCM to send notification messages to Wave users.
Click Add to create a new integration entry.
Provide the App Name, Token, and URL as required.
For detailed API usage, refer to the API documentation linked in the interface.
When creating a new integration, enter the following details:
App ID – Automatically generated unique identifier for the application.
App Name – Enter a descriptive name for the integration (e.g., TEST).
Token – Provide the authentication token used for secure communication.
Click Generate Interface Link to complete the setup.
Once the interface link is generated, the application will appear in the list with its details:
App ID – Unique identifier of the integration.
App Name – Custom name assigned to the integration.
Token – Authentication token used for communication.
URL – Generated interface link for sending notifications.
Use the options on the right to edit, copy, or delete the configuration as needed.
PBX SETTINGS
This section describes internal options that have not been mentioned in previous sections yet. The settings in this section can be applied globally to the UCM630X, including general configurations, jitter buffer, RTP settings, ports config and STUN monitor. The options can be accessed via PBX Settings > General Settings.
General Settings
General Preferences
Global Outbound CID
Global-level CID Number used for all outgoing calls if no other CID numbers have been configured for the calling party.
Global Outbound CID Name
Global-level CID Name used for all outgoing calls if no other CID names have been configured for the calling party.
Ring Timeout (s)
Number of seconds to ring the extension before forwarding the call to voicemail. If Extensions > Features > Ring Timeout is not configured, the ring timeout value configured in General Settings > Ring Timeout will be used.
Call Duration Limit
Block calls for the configured duration. If Extensions > Features > Call Duration Limit and Outbound Routes > Call Duration Limit are not configured, General Settings > Call Duration Limit will be used.
Note: This setting is disabled by default
International Call Prefix
Digits users dial before a country code to place an international call (e.g., 00 or 011).
The PBX uses this prefix to detect and classify a dialed number as international for routing, permissions, and (when applicable) PMS billing/records.
Input: digits only (no +, no country code).
Domestic Long Distance Call Prefix
Digits users dial to reach a national (out-of-area) number within the same country (commonly 0 in many regions or 1 in NANP countries).
The PBX uses this prefix to identify national long-distance calls versus local calls for policy and rating purposes.
Input: digits only; leave blank if your country does not use one.
Local Area Code
The area/city code of the PBX’s location, used to normalize local dialing.
When callers dial a local number without an area code, the PBX can use this value to complete the number and to distinguish local from long-distance calls.
Input: the area/city code without the domestic long-distance prefix (e.g., enter 212, not 0212).
Recording Settings
Record Prompt
If enabled, the system will play voice prompt “This call will be recorded” before the recording is started.
Note: This setting is disabled by default
Allow External Numbers to Cancel Recording
If enabled, external call parties will be given the option to decline the recording of calls.
Merge Same Call Recordings
If enabled, the system will merge all recordings created during a call regardless of how many times a user starts and stops recording during a call.
Stereo Recording
If enabled, the caller and callee’s audio will be split into two channels during call recording. Not applicable to calls with more than 2 parties.
Calling Channel
Configure the audio channels for the calling party and the called party. If the caller is selected as the right channel, the callee will be used for the left channel, and vice-versa.
Note: This option is available when “Stereo Recording” is enabled.
International Call Prefix
When this configuration is empty, International Call Prefix can be empty or +.
Extension Preferences
Enforce Strong Password
If enabled, a strong password policy will be enforced. This does not affect user login passwords, which must be strong.
Enable Random Password
If enabled, the extension will created with a randomly generated password.
Send Extension Update Emails
If enabled, an email will be sent to an extension’s configured email address after creating it or modifying that extension’s settings.
Disable Extension Range
If set to “Yes”, users could disable the extension range pre-configured/configured on the IPPBX. The default setting is “No”. Note: It is recommended to keep the system assignment to avoid inappropriate usage and unnecessary issues.
User Extensions
1000-6299 User Extensions is referring to the extensions created under Web GUI > Extension/Trunk > Extensions page.
Meeting Extensions
6300-6399 This extension range is used for creating meeting rooms
Ring Group Extensions
6400-6499 This extension range is used for ring groups
Queue Extensions
6500-6599 This range of extensions is used for queueing
Voicemail Group Extension
6600-6699 This extension range is used for voicemail groups.
IVR Extensions
7000-7100 This extension range is used for
Dial by Name Extensions
7101-7199 This extension range is used for Dial by Name feature
Fax Extensions
7200-8200 This extension range is used for T.38 Fax
Zero Config Extension
Pick Extensions
4000-4999 This refers to the extensions that can be manually picked from end device when being provisioned by the IPPBX. There are two related options in zero config page🡪Zero Config Settings, “Pick Extension Segment” and “Enable Pick Extension”. If “Enable Pick Extension” under zero config settings is selected, the extension list defined in “Pick Extension Segment” will be sent out to the device after receiving the device’s request. This “Pick Extension Segment” should be a subset of the “Pick Extensions” range here. This feature is for the GXP series phones that support selecting extension to be provisioned via phone’s LCD.
Auto ProvisionExtensions
5000-6299 This sets the range for “Zero Config Extension Segment” which is the extensions can be assigned on the IPPBX to provision the end device.
Default Extension Segment
Clicking this button will reset the extension range to their default values.
SIP Settings
The UCM630X SIP global settings can be accessed via PBX Settings > SIP Settings.
General
Realm For Digest Authentication
Configure this as the host name or domain name of the PBX. Realms MUST be globally unique according to RFC3261.
Bind UDP Port
Configure the UDP port used for SIP. The default setting is 5060.
Bind IPv4 Address
Configure the IPv4 address to bind to. "0.0.0.0" means to bind to all IP addresses.
Bind IPv6 Address
Configure the IPv6 address to bind to. "[::]" means to bind to all IP addresses.
MWI From Header
If disabled, the server will not transfer the Diversion Header
Enable Diversion Header
If set to “No”, all transfers initiated by the endpoint in the IPPBX will be disabled (unless enabled in peers or users). The default setting is “Yes”.
Send Deflection Diversion
If 'Enable Diversion Header' and this option enabled, the INVITE request will contain Diversion with reason 'deflection' while the inbound call been routed to an external number.
Block Collect Calls
If enabled, collect calls will be blocked.
Note: Collect calls are indicated by the header “P-Asserted-Service-Info: service-code=Backward Collect Call, P-Asserted-Service-Info: service-code=Collect Call”.
Session Timer
Force Timer
If checked, always request, and run session timer.
Timer
If checked, run session timer only when requested by other UA.
Session Expire
Configure the maximum session refresh interval (in seconds). Default is 1800.
Min SE
Configure the minimum session refresh interval (in seconds).
The default setting is 90.
TCP/TLS
TCP Enable
Configure to allow incoming TCP connections with the PBX. The default setting is “No”.
TCP Bind IPv4 Address
Configure the IP address for the TCP server to bind to. “0.0.0.0” means binding to all interfaces. The port number is optional, and the default port number is 5060. For example, 192.168.1.1:5062.
TCP Bind IPv6 Address
Configure the IPv6 address for the TCP server to bind to. “[::]” means bind to all interfaces. The port number is optional with the default being 5060. For example, [2001:0DB8:0000:0000:0000:0000:1428:0000]:5060.
TLS Enable
Configure to allow incoming TLS connections with the PBX. The default setting is “Yes”.
TLS Bind IPv4 Address
Configure the IPv4 address for TLS server to bind to. “0.0.0.0” means binding to all interfaces. The port number is optional, and the default port number is 5061. For example, 192.168.1.1:5063. Note: The IP address must match the common name (host name) in the certificate so that the TLS socket will not bind to multiple IP addresses.
TLS Bind IPv6 Address
Configure the IPv6 address for TLS server to bind to. “[::]” means bind to all interfaces. The port number is optional with default being 5061. For example, [2001:0DB8:0000:0000:0000:0000:1428:0000]:5061. Note: The IP address must match the common name (host name) in the certificate so that the TLS socket will not bind to multiple IP addresses.
TLS Do Not Verify
If enabled, the TLS server’s certificate will not be verified when acting as a client. The default setting is “Yes”.
TLS Self-Signed CA
This is the CA certificate if the TLS server being connected to requires self-signed certificate, including server’s public key. This file will be renamed as “TLS.ca” automatically.
Notes:
Supported file extensions include .crt, .cer, .der, .pem, .key, and .ca.
DER-formatted certificates are supported and will automatically be converted to PEM format upon upload.
The size of the uploaded certificate file must be under 2MB.
Reset Certificates
Clicking on this button will reset the certificates.
Private Certificate and Key
TLS Cert
Upload the certificate file used for TLS connections. It must contain the client’s private key and the server’s signed certificate. Uploaded files will automatically be saved as “TLS.crt”.
Notes:
Supported file extensions include .crt, .cer, .der, .pem, .key, and .ca.
DER-formatted certificates are supported and will automatically be converted to PEM format upon upload.
The size of the uploaded certificate file must be under 2MB.
TLS Key
This file must be named with the CA subject name hash value. It contains CA’s (Certificate Authority) public key, which is used to verify the accessed servers. This file will be renamed as “TLS.key” automatically.
Notes:
Supported file extensions include .crt, .cer, .der, .pem, .key, and .ca.
DER-formatted certificates are supported and will automatically be converted to PEM format upon upload.
The size of the uploaded certificate file must be under 2MB.
Reset Certificates
Clicking on this button will reset the certificates.
Cipher Suite
Restrict Cipher List
By default, all SIP TLS encryption suites are in effect on the system, and when turned on, you can configure the encryption suites allowed to be used.
Cipher Suite
Select the encryption suites that are allowed to be used for SIP TLS connections, in the order of priority as configured.
NAT
External Host
Configure a static IP address and port (optional) used in outbound SIP messages if the UCM630X is behind NAT. If it is a host name, it will only be looked up once.
Use IP address in SDP
If enabled, the SDP connection will use the IP address resolved from the external host.
External UDP Port
Configure externally mapped UDP port when the PBX is behind a static NAT or PAT.
External TCP Port
Configure the externally mapped TCP port when the UCM630X is behind a static NAT or PAT.
External TLS Port
Configures the externally mapped TLS port when UCM630X is behind a static NAT or PAT.
Local Network Address
Specify a list of network addresses that are considered inside of the NAT network. Multiple entries are allowed. If not configured, the external IP address will not be set correctly.
A sample configuration could be as follows:
192.168.0.0/16
ToS
ToS for SIP
Configure the Type of Service for SIP packets. The default setting is None.
ToS for RTP Audio
Configure the Type of Service for RTP audio packets. The default setting is None.
ToS for RTP Video
Configure the Type of Service for RTP video packets. The default setting is None.
Default Incoming/Outgoing Registration Time
Configure the default duration (in seconds) of incoming/outgoing registration.
The default setting is 120.
Max Registration/Subscription Time
Configure the maximum duration (in seconds) of incoming registration and subscription allowed by the UCM630X.
The default setting is 3600.
Min Registration/Subscription Time
Configure the minimum duration (in seconds) of incoming registration and subscription allowed by the UCM630X.
The default setting is 60.
Enable Relaxed DTMF
Select to enable relaxed DTMF handling. The default setting is “No”.
DTMF Mode
Select DTMF mode to send DTMF. The default setting is RFC4733. If “Info” is selected, SIP INFO message will be used. If “Inband” is selected, a-law or u-law are required. When “Auto” is selected, “RFC4733” will be used if offered, otherwise “Inband” will be used.
The default setting is “RFC4733”.
RTP Timeout
During an active call, if there is no RTP activity within the timeout (in seconds), the call will be terminated. The default setting is no timeout.
Note: This setting does not apply to calls on hold.
RTP Hold Timeout
When the call is on hold, if there is no RTP activity within the timeout (in seconds), the call will be terminated. This value of RTP Hold Timeout should be larger than RTP Timeout.
The default setting is no timeout.
RTP Keep-alive
This feature can be used to avoid abnormal call drop when the remote provider requires RTP traffic during proceeding.
For example, when the call goes into voicemail and there is no RTP traffic sent out from UCM, configuring this option can avoid voicemail drop.
When configured, RTP keep-alive packet will be sent to remote party at the configured interval. If set to 0, RTP keep-alive is disabled.
100rel
Configure the 100rel setting on UCM630X.
The default setting is “Yes”.
Trust Remote Party ID
Configure whether the Remote-Party-ID should be trusted.
The default setting is “No”.
Send Remote Party ID
Configure whether the Remote-Party-ID should be sent or not.
The default setting is “No”.
Generate In-Band Ringing
Configure whether the UCM630X should generate Inband ringing or not. The default setting is “Never”.
Yes: The UCM630X will send 180 Ringing followed by 183 Session Progress and in-band audio.
No: The UCM630X will send 180 Ringing if 183 Session Progress has not been sent yet. If audio path is established already with 183 then send in-band ringing.
Never: Whenever ringing occurs, the UCM630X will send 180 Ringing as long as 200OK has not been set yet. Inband ringing will not be generated even the end point device is not working properly.
Server User Agent
Configure the user agent string for the UCM630X.
Send Compact SIP Headers
If enabled, compact SIP headers will be sent. The default setting is “No”.
Passthrough PAI Header
Passthrough PAI Header
Replace '#' with %23 in SIP URI
If enabled, the '#' character in the SIP URI will be replaced with %23.
STIR/SHAKEN
To prevent robocalls, UCM now supports STIR/SHAKE protocols. Related options have been added as a new tab in the SIP Settings page.
Clicking on the Add button will show the following window:
STIRSHAKEN
STIRSHAKEN Add Authorized CID and Attestation level
Authorized CID
Configure the authorized CID.
Attestation
Configure the attestation level, which is the level of confidence of the carrier that the CID has not been spoofed. The following options are available:
A (Full attestation): The carrier is associated with the caller and the number. There is high confidence that the CID has not been spoofed.
B (Partial attestation): The carrier is associated with the caller but not the number. There is uncertainty about whether the CID has been spoofed or not.
C (Gateway attestation): The carrier is not associated with the caller and has no confidence at all about the number. Generally used for traceback.
Clicking on the Certificate Settingsbutton will bring up the following window:
STIRSHAKEN Certificate Settings
Certificate Download Time (s)
Configure the public key download timeout period, the default value is 2 seconds.
Signature Valid Time (s)
Configure the validity period of the digital signature, the default value is 15 seconds.
Private Key
Configure the Private key.
Note: The uploaded file must be less than 2MB in file size, only supports the .key format and must be ECC type. This file will automatically be renamed to “private.key”.
Public Key
Configure the Public Key.
Note: The uploaded file must be less than 2MB in file size, only supports the .crt format and must be ECC type. This file will automatically be renamed to “public.crt”.
MISC
Outbound SIP Registrations
Register Timeout
Configure the register retry timeout (in seconds). The default setting is 20.
Register Attempts
Configure the number of registration attempts before the UCM630X gives up. The default setting is 0, which means the UCM630X will keep trying until the server side accepts the registration request.
Trunk Register Period (s)
Configures the time window within which to send initial trunk registration requests. Instead of sending out all initial trunk reqistration requests at once, requests will be randomly sent out within this period.
Video
Support SIP Video
Select to enable video support in SIP calls. The default setting is “Yes”.
Security
Reject Non-Matching INVITE
If enabled, when rejecting an incoming INVITE or REGISTER request, the UCM630X will always reject with “401 Unauthorized” instead of notifying the requester whether there is a matching user or peer for the request. This reduces the ability of an attacker to scan for valid SIP usernames. Default setting is “No”.
SDP Attribute Passthrough
Enable Attribute Passthrough
If enable, and if the service does not know the attribute of FEC/FECC/BFCP, then the attribute will be passthrough.
Early Media
Enable Use Final SDP
If enabled, call negotiation will use final response SDP.
Ignore 180 Response
If enabled, ringing indication after 183 response will be ignored.
Blind Transfer
Allow callback when blind transfer fails
If enabled, the UCM will call back to the transferrer when blind transfer fails (reason of failure includes busy and no answer).
Note: This feature takes effect only on internal calls.
Blind transfer timeout
Configure the timeout in (s) for the transferrer waiting for the destination to answer. Default is 60s.
Hold
Forward HOLD Requests
Configure the UCM to forward HOLD requests instead of processing holds internally. This serves to meet the standards set by some providers that require HOLD requests to be passed along from endpoint to endpoint. This option is disabled by default.
Note: Enabling this option may cause hold retrieval issues and MOH to not be heard.
Transparent Call-Info header
UCM supports transparent call info header in order to integrate GDS door system with GXP21XX/GRP261X phones, the UCM will forward the call-info header to the phone in order to request the live view from GDS door system and give the option to open the door via softkey.
Transparent Call Info
IAX Settings
The UCM630X IAX global settings can be accessed via PBX Settings > IAX Settings.
General
IAX General Settings
Bind Port
Configure the port number that the IAX2 will be allowed to listen to. The default setting is 4569.
Bind IPv4 Address
Force IAX2 to bind to a specific address instead of all addresses.
Bind IPv6 address
Configure the IPv6 address to bind to. “[::]” means to bind to all IP addresses.
IAX1 Compatibility
Select to configure IAX1 compatibility. The default setting is “No”.
No Checksums
If selected, UDP checksums will be disabled and no checksums will be calculated/checked on systems supporting this feature. The default setting is “No”.
Delay Reject
If enabled, the IAX2 will delay the rejection of calls to avoid DOS. The default setting is “No”.
ADSI
Select to enable ADSI phone compatibility. The default setting is “No”.
Music On Hold Interpret
Specify which Music On Hold class this channel would like to listen to when being put on hold. This music class is only effective if this channel has no music class configured and the bridged channel putting the call on hold has no “Music On Hold Suggest” setting.
Music On Hold Suggest
Specify which Music On Hold class to suggest to the bridged channel when putting the call on hold.
Bandwidth
Configure the bandwidth for IAX settings. The default setting is “Low”.
IAX Registration Options
IAX Registration Options
Min Reg Expire
Configure the minimum period (in seconds) of registration.
The default setting is 60.
Max Reg Expire
Configure the maximum period (in seconds) of registration.
The default setting is 3600.
IAX Thread Count
Configure the number of IAX helper threads.
The default setting is 10.
IAX Max Thread Count
Configure the maximum number of IAX threads allowed.
The default is 100.
Auto Kill
If enabled and no ACK is received for new messages after the specified wait time, the connection will be terminated.
Authentication Debugging
If enabled, authentication traffic in debugging will not show.
The default is “No”.
Codec Priority
Configure codec negotiation priority. The default setting is “Reqonly”.
Caller: Consider the callers preferred order ahead of the host’s.
Host: Consider the host’s preferred order ahead of the caller’s.
Disabled: Disable the consideration of codec preference all together.
Reqonly: This is the same as “Disabled”, except when the requested format is not available. The call will only be accepted if the requested format is available.
Type of Service
Configure ToS bit for preferred IP routing.
IAX Trunk Options
Trunk Frequency
Configure the frequency of trunk frames (in milliseconds).
The default is 20.
Trunk Time Stamps
If enabled, time stamps will be attached to trunk frames.
The default is “No”.
IAX Security
Call Token Optional
Enter a single IP address (e.g., 1.1.1.1) or a range of IP addresses (1.1.1.1/255.255.255.255) for which call token validation is not required.
Max Call Numbers
Configure the maximum number of calls allowed for a single IP address.
Max Unvalidated Call Numbers
Configure the maximum number of Unvalidated calls for all IP addresses.
Max Call Numbers
Configure to limit the number of calls for a give IP address of IP range.
IP or IP Range
Enter the IP address (1.1.1.1) or a range of IP addresses (1.1.1.1/255.255.255.255) to be considered for call number limits.
RTP Settings
RTP Settings
Internal Options/RTP Settings
RTP Settings
RTP Start
Configure the RTP port starting number. The default setting is 10000.
RTP End
Configure the RTP port ending address. The default setting is 20000.
Strict RTP
Configure to enable or disable strict RTP protection. If enabled, RTP packets that do not come from the source of the RTP stream will be dropped. The default setting is "Disable".
RTP Checksums
Configure to enable or disable RTP Checksums on RTP traffic. The default setting is "Disable".
ICE Support
Configure whether to support ICE. The default setting is enabled.
ICE is the integrated use of STUN and TURN structure to provide reliable VoIP or video calls and media transmission, via a SIP request/ response model or multiple candidate endpoints exchanging IP addresses and ports, such as private addresses and TURN server address.
STUN Server
Configure STUN server address. STUN protocol is a Client/Server and also a Request/Response protocol. It is used to check the connectivity between the two terminals, such as maintaining a NAT binding entries keep-alive agreement. The default STUN Server is stun.ipvideotalk.com.
Valid format:
[(hostname | IP-address) [':' port]
The default port number is 3478 if not specified.
BFCP UDP Start
Configure BFCP UDP port starting number. The default setting is 50000.
BFCP UDP End
Configure BFCP UDP port ending number. The default setting is 52999.
BFCP TCP Start
Configure BFCP TCP port starting number. The default setting is 53000.
BFCP TCP End
Configure BFCP TCP port ending number. The default setting is 55999.
TURN Server
Configure TURN server address. TURN is an enhanced version of the STUN protocol and is dedicated to the processing of symmetric NAT problems.
TURN Server Name
Configure turn server account name
TURN Server Password
Configure turn server account password.
Connection Protocol
Protocol used to connect to the TURN server.
Number of ICE Candidates
This configures the number of pre-collected ICE candidates to gather and send to remote peers. The higher the number, the greater the network traffic consumption.
Payload Type Settings
The UCM630X payload type for audio codecs and video codes can be configured here.
Payload Type Settings
AAL2-G.726
Configure payload type for ADPCM (G.726, 32kbps, AAL2 codeword packing). The default setting is 112.
DTMF
Configured payload type for DTMF. The default setting is 101.
G.721 Compatible
Configure to enable/disable G.721 compatible. The default setting is Yes.
G.726
Configure the payload type for G.726 if “G.721 Compatible” is disabled. The default setting is 111.
iLBC
Configure the payload type for iLBC. The default setting is 97.
OPUS
Configure the payload type for OPUS. The default setting is 123.
Audio FEC Payload Type
Configure the Audio FEC Payload Type. The default setting is 127
Audio RED Payload Type
Configure the Audio RED Payload Type. Default setting is 122
H.264
Configure the payload type for H.264. The default setting is 99.
H.263P
Configure the payload type for H.263+. The default setting is 100 103.
VP8
Configure the payload type for VP8. The default setting is 108.
Main Video FEC
Configure the Main Video FEC
RTP FECC
Configure the RTP FECC
RTX
Configure the RTX
G.722.1
G.722.1：Low-complexity coder, 24kbps.
G.722.1C
G.722.1C：Low-complexity coder, 48kbps.
Music On Hold
Music On Hold settings can be accessed via PBX Settings > Music On Hold. In this page, users could configure music on hold class and upload music files. The “default” Music On Hold class already has 5 audio files defined for users to use.
Music On Hold Default Class
Click on “Create New MOH Class” to add a new Music On Hold class.
Click on to configure the MOH class sort method to be “Alpha” or “Random” for the sound files.
Click on next to the selected Music On Hold class to delete this Music On Hold class.
Click on to start uploading. Users can upload:
Single files with 8KHz Mono Music file, or
Music on hold files in a compressed package with .tar, .tar.gz and .tgz as the suffix. The file name can only be letters, digits, or special characters -_
the size for the uploaded file should be less than 30M, the compressed file will be applied to the entire MoH.
Users could also download all the music on hold files from UCM. In the Music On Hold page, click on and the file will be downloaded to your local PC.
Click on to disable it from the selected Music On Hold Class.
Click on to enable it from the selected Music On Hold Class.
Select the sound files and click on to delete all selected Music On Hold files.
The UCM630X allows Users to select the Music On Hold file from WebGUI to play it. The UCM630X will initiate a call to the selected extension and play this Music On Hold file once the call is answered.
Steps to play the Music On Hold file:
Click on the button for the Music On Hold file.
In the prompted window, select the extension to playback and click .
Play Custom Prompt
The selected extension will ring.
Answer the call to listen to the music playback.
Users could also record their own Music On Hold to override an existing custom prompt, this can be done by following those steps:
Click on .
A message of confirmation will pop up, as shown below.
Information Prompt
Click .
In the prompted window, select the extension to playback and click .
Record Custom Prompt
Answer the call and start to record your new music on hold.
Hangup the call and refresh Music On Hold page then you can listen to the new recorded file.
Once the MOH file is deleted, there are two ways to recover the music files.
After downloading and unzip the pack, users could then upload the music files to UCM.
Factory reset could also recover the MOH file on the UCM.
Voice Prompt
The UCM630X supports multiple languages in Web GUI as well as system voice prompt. Currently, there are 16 languages supported in system voice prompt: British English, Deutsch, English, Spanish, Spanish (Catalonia), Spanish (Spain), Greek, French, Italian, Dutch, Polish, Portuguese (Brazil), Portuguese (Portugal), Russian, Swedish, Turkish, Czech, Ukrainian, Hebrew, Arabic, and Chinese.
English (United States) and Chinese voice prompts are built in with the UCM630X already. The other languages provided by Grandstream can be downloaded and installed from the UCM630X Web GUI directly. Additionally, users could customize their own voice prompts, package them and upload to the UCM630X.
Language settings for voice prompt can be accessed under PBX Settings > Voice Prompt > Language Settings.
Download and Install Voice Prompt Package
To download and install voice prompt package in different languages from UCM630X Web GUI, click on “Add Voice Prompt Package” button.
Language Settings for Voice Prompt
A new dialog window of voice prompt package list will be displayed. Users can see the version number (latest version available V.S. current installed version), package size and options to upgrade or download the language.
Voice Prompt Package List
Click on to download the language to the UCM630X. The installation will be automatically started once the downloading is finished.
New Voice Prompt Language Added
A new language option will be displayed after successfully installed. Users then could select it to apply in the UCM630X system voice prompt or delete it from the UCM630X.
Custom Prompt
Record New Custom Prompt
In the UCM630X PBX Settings>Voice Prompt>Custom Prompt page, click on “Record” and follow the steps below to record new IVR prompt.
Record New Custom Prompt
Specify the file name.
Select the format (GSM or WAV) for the prompt file to be recorded.
Select the extension to receive the call from the CloudUCM to record the custom prompt.
Click the “Record” button. A request will be sent to CloudUCM to call the extension for recording the custom prompt from the phone.
Pick up the call from the extension and start the recording following the voice prompt.
Once saved, the new custom prompt will be listed on this page. From here, you can manage it by selecting an action:
Online Playback: listen to the prompt directly from the Web GUI.
Playback Using Extension: select an extension to hear the prompt played over a call.
Record Again: replace the current recording with a new one.
Download: download the custom prompt recorded.
Delete: remove the prompt from the system.
Custom Prompt Page
Upload Custom Prompt
If the user has a pre-recorded IVR prompt file, click on “Upload” in Web GUI🡪PBX Settings🡪Voice Prompt🡪Custom Prompt page to upload the file to the UCM630X. The following are required for the IVR prompt file to be successfully uploaded and used by the UCM630X:
PCM encoded.
16 bits.
8000Hz mono.
In .mp3 or .wav format; or raw/ulaw/alaw/gsm file with .ulaw or .alaw suffix.
File size under 5MB.
Click on button, select the file you want to upload, then click on “choose file to upload” to start uploading. Once uploaded, the file will appear in the Custom Prompt web page.
If the file uploaded is mp3, the following prompt will appear.
Tick “Keep Copy of MP3” to keep an mp3 copy of the file which can be diffused with certain GSC speakers. Diffusing the MP3 files result in a highr quality sound played by GCS speakers.
Download All Custom Prompt
On the UCM630X, the users can download all custom prompts from UCM Web GUI to local PC. To download all custom prompt, log in UCM Web GUI and navigate to PBX Settings🡪Voice Prompt🡪Custom Prompt and click on ”Download All”. The following window will pop up in order to set a name for the downloaded file.
Download All Custom Prompt
The downloaded file will have a .tar extension.
Username Prompt
There are two ways to customize/set new username prompt:
Upload Username Prompt File from Web GUI
First, Users should have a pre-recorded file respecting the following format:
PCM encoded / 16 bits / 8000Hz mono.
In .tar/.tar.gz/.tgz format
File size under 30M.
Filename must be set as the extension number with 18 characters max. For example, the recorded file name 1000.wav will be used for extension 1000.
Go under web GUI PBX Settings 🡪 Voice Prompt 🡪 Username Prompt and click on ”Upload” button.
Select the recorded file to upload it and press Save and Apply Settings.
Click on to record again the username prompt.
Click on to play recorded username prompt.
Select username prompts and press to delete specific file or select multiple files for deletion using the button ”Delete” .
Record Username via Voicemail Menu
The second option to record username is using voicemail menu, please follow below steps:
Dial *98 to access the voicemail
After entering the desired extension and voicemail password, dial “0” to enter the recordings menu and then “3” to record a name.
Another option is that each user can record their own name by following below steps:
The user dials *97 to access his/her voicemail
After entering the voicemail password, the user can press “0” to enter the recordings menu and then “3” to record his name.
Call Prompt Tones
SIP Trunk Prompt Tone
Prompt Tone Settingstab on the UCM helps users choose which prompt will be played by the UCM during call failure, the voice message responses can be set to be played for 4XX, 5XX, and 6XX call failures.
The following default prompt names and their associated messages are supported:
Prompt Name
Message Played
sip-trunk-out-busy
“All circuits are busy now. Please try again later.”
sip-trunk-out-rejected
“The call was rejected by the server. Please try again later.”
sip-trunk-out-server-error
“Server error. Please check your device.”
sip-trunk-out-wrong-number
“Your call can’t be completed as dialed. Please check the number and dial again.”
general-failed
“Your call cannot be completed as dialed.”
no-answer
“The number you dialed is not answering. Please try again later.”
no-permission
“You are not allowed to dial this number.”
user-busy
“The number you have dialed is busy. Please try again later.”
wrong-number
“The number you dialed is incorrect. Please check the number and dial again.”
Additionally, custom voice messages recorded and uploaded in PBX Settings→Voice Prompt→Custom Promptcan be used for the failure responses instead of the default messages.
SIP Trunk Prompt Tone
General Call Prompt Tones
Moreover, users also have the possibility to customize the prompt for typical call failure reasons like (no permission to allow outbound calls, busy lines, incorrect number dialed …Etc.).
To customize these prompts user could record and upload their own files under PBXSettings > VoicePrompt > CustomPrompts then select each one for specific call failure case under PBXSettings -> Call Prompt Tones> General Call Prompt Tones page as shown on the following figure:
General Call Propt Tones
Alert-info Prompt
The user can change upload the ringtone files which can be used with Alert-info to play various ringtones depending on the configured behaviour. In this setting, the user can view all the ringtones uploaded, play them, download them, or delete them. If the user wishes to upload new ringtones, he/she can click on “Upload” and choose the ringtone files to upload.
Alert info Prompt Ringtones
Interface Settings
Analog Hardware
The analog hardware (FXS port and FXO port) on the UCM630X will be listed in this page. Click on to edit signaling preference for FXS port or configure ACIM settings for FXO port.
Select “Loop Start” or “Kewl Start” for each FXS port. And then click on “Update” to save the change.
FXS Ports Signaling Preference
For FXO port, users could manually enter the ACIM settings by selecting the value from dropdown list for each port. Or users could click on “Detect” and choose the detection algorithm, two algorithms exist (ERL, Pr) for the UCM630X to automatically detect the ACIM value. The detecting value will be automatically filled into the settings.
FXO Ports ACIM Settings
Tone Region
Select country to set the default tones for dial tone, busy tone, ring tone and etc. to be sent from the FXS port. The default setting is “United States of America (USA)”.
Advanced Settings
FXO Opermode
Select country to set the On-Hook Speed, Ringer Impedance, Ringer Threshold, Current Limiting, TIP/RING voltage adjustment, Minimum Operational Loop Current, and AC Impedance as predefined for your country’s analog line characteristics. The default setting is “United States of America (USA)”.
FXS Opermode
Select country to set the On-Hook Speed, Ringer Impedance, Ringer Threshold, Current Limiting, TIP/RING voltage adjustment, Minimum Operational Loop Current, and AC Impedance as predefined for your country’s analog line characteristics. The default setting is “United States of America (USA)”.
FXS TISS Override
Configure to enable or disable override Two-Wire Impedance Synthesis (TISS). The default setting is No.
If enabled, users can select the impedance value for Two-Wire Impedance Synthesis (TISS) override. The default setting is 600Ω.
PCMA Override
Select the codec to be used for analog lines. North American users should choose PCMU. All other countries, unless already known, should be assumed to be PCMA. The default setting is PCMU.
Note: This option requires system reboot to take effect.
Boost Ringer
Configure whether normal ringing voltage (40V) or maximum ringing voltage (89V) for analog phones attached to the FXS port is required. The default setting is “Normal”.
Fast Ringer
Configure to increase the ringing speed to 25HZ. This option can be used with “Low Power” option. The default setting is “Normal”.
Low Power
Configure the peak voltage up to 50V during “Fast Ringer” operation. This option is used with “Fast Ringer”. The default setting is “Normal”.
Ring Detect
If set to “Full Wave”, false ring detection will be prevented for lines where Caller ID is sent before the first ring and proceeded by a polarity reversal, as in UK. The default setting is “Standard”.
FXS MWI Mode
Configure the type of Message Waiting Indicator on FXS lines. The default setting is “FSK”.
FSK: Frequency Shift Key Indicator
NEON: Light Neon Bulb Indicator.
FXO Frequency Tolerance
Allows users to adjust the tolerance of the FXO ringing frequency. 63Hz is considered the standard value and is selected by default.
FXO Signaling Type Settings
DAHDI Settings
When users encounter issues such as audio delay in outbound calls using the analog trunk, they can adjust DAHDI settings on the UCM to attempt to lessen or resolve the issues.
DAHDI Settings
For the value of the option such as “32, half”:
The number in the option indicates the number of read/write buffers for TDM (DAHDI).
The “Half”, “Immediate” or “Full” option indicates the strategy when reading/writing data from buffer.
“Half”: Data will be read/written from buffer when half of the buffer is occupied with data.
“Immediate”: Read/write from buffer whenever there is data occupying the buffer.
“Full”: Data will be read/written from buffer when buffer is fully occupied with data.
Normally, DAHDI settings should be kept default and should be adjusted only when users encounter analog trunk/Fax-related issues.
File Manager
The File Manager section defines the storage location and automatic storage switching behavior for files generated by the UCM630x system. Storage is configured separately for each file category. This section determines where new files are written and how the system behaves when multiple storage targets are available.
The following file types are supported:
Recording Files
Video Recording Files
IM Files
File Manager
Each file category allows the administrator to define the storage path used for newly generated files. Available options depend on system configuration and detected storage devices (e.g., Local storage, GDMS Cloud Storage, USB, NAS).
When Enable Auto Change is enabled, the system stores files according to the defined Storage Path Priority. If the active storage device becomes unavailable or reaches capacity, the system automatically switches to the next available device in the priority list.
Note:
After configuring storage paths, administrators should configure external disk usage alerts under Maintenance→System Events→Alert Events List to ensure sufficient storage capacity.
Video Recording Files support external storage only and do not provide a Local storage option.
Custom Storage Path Priority
When the storage path for Recording Files is changed from Local to an external storage device (such as USB or NAS, if available), the Migrate Local Recordings option becomes available. This option allows existing recordings stored in internal memory to be copied to the newly selected external storage device. The administrator can select specific recording categories to migrate as shown below.
Note:
This option does not appear when switching from Local to GDMS Cloud Storage.
The function copies existing recordings to the selected storage device and does not delete the original files from local storage.
Migrate Local Recordings Option
Storage Device Management
NAS
The UCM supports adding and backing up recordings to a network-attached storage (NAS) server.
NAS
Following table describes NAS settings:
Enable
Enabled / Disable the NAS recording functionality.
Host
Configure the Domain or IP address of the NAS server.
Note: Currently, only IP addresses are supported in the Host/IP field.
Folder Path
Specify the name of the shared folder.
Example: folder1/subfolder2
Username
Specify the account username to access the NAS server.
Password
Configure the account password to access the NAS server. The password can include letters, number, and special characters.
Security Mode
Select a security mode based on the server settings to ensure proper connection establishment. The default value is ntlmssp.
None
krb5
krb5i
ntlm
ntlmi
ntlmv2
ntlmssp
ntlmsspi
Status
If configured correctly, the Status field will show “Mounted”, and the newly added NAS server will be shown on the Mounted Netdisk List. Additionally, the NAS will appear as a selectable storage option in the PBX Settings🡪Recording Storage page and CDR🡪Recording Files page.
Note
If Network Storage Device has 1GB of storage space left, it will be considered unavailable the UCM will trigger the external disk usage alert.
SFTP
SFTP integration offers synchronizing files between from the UCM to the SFTP server. SFTP is used to synchronize the following data: CDR Records, Recording Files, Voicemail, and Fax.
SFTP Integration
Enable
Tick this box to enable SFTP integration.
Account
Enter the account of the SFTP server.
Password
Enter the password of the account of the SFTP server.
Server Address
Enter the address of the SFTP server.
USB Disk/SD Card File Management
USB Disk/SD Card File Management is a feature which allows to manages the files stored on the USB flash drive attached to the UCM device, or an SD card attached to the system.
USB DiskSD Card File Management
Amazon S3
The Storage Device Management module allows you to integrate your UCM63xx with external cloud storage services. This page provides the option to configure a connection to a third-party Amazon S3 bucket to archive a copy of your critical data, specifically backup files.
This feature is designed for organizations that require an additional, independent copy of their configuration and data for long-term retention, compliance, or disaster recovery purposes, separate from the primary Grandstream cloud storage.
Note:
This integration is used for storing backup files to your own S3 bucket. All other system data, such as call recordings and voicemails, will continue to be stored in your primary storage space.
Amazon S3 Storage Settings
The table below describes the parameters that can be found on the Amazon S3 configuration tab:
Enable
Enables or disables Amazon S3 integration. When enabled, the configuration fields below become editable.
Region
Manually enter, or select from the drop-down list the AWS region where the bucket is located.
Bucket
Enter the name of the S3 bucket. Must be 3–63 characters, lowercase letters, numbers, and hyphens only.
Key ID
Enter the AWS Access Key ID generated after creating an account on the AWS platform.This value is encrypted and cannot be viewed after saving.
Secret Key
Enter the AWS Secret Access Key generated after creating an account. This value is encrypted and cannot be viewed after saving.
Test Connection
Click on this button to Test the connection to AWS S3 with the current settings.
Note: It is recommended to perform a connection test during the initial configuration to ensure your UCM can successfully communicate with the Amazon S3 bucket.
SYSTEM SETTINGS
This section will explain the available system-wide parameters and configuration options on the UCM630X series. This includes settings for the following items: General Settings, Cloud IM, HTTP server, network Settings, OpenVPN, DDNS Settings, Security Settings, LDAP server, Time settings, Email settings, and TR-069.
General Settings
System administrators can prevent the UCM from making calls and/or writing to the data partition (e.g., CDR, recordings, etc.) once the system reaches a specified threshold of storage usage and CPU usage respectively. These options are located in the System Settings 🡪 General Settings page.
General Settings Interface
General Settings
Device Name
Configure the name of the UCM.
Enable CPU Flow Control
Enables the CPU flow control.
CPU Flow Control Threshold
Used to set the threshold generated by the CPU Flow Control. When the system CPU reaches the threshold, it will prohibit the new calls.
The defaultvalue is 90%.
Data Partition Write Threshold
Used to set a threshold to stop writing data partition. When the disk data partition reaches the threshold configured, the data partition writing will be stopped. The default value is 90%.
General Settings Parameters
HTTP Server
The UCM630X’s embedded web server responds to HTTPS GET/POST requests and allows users to configure the UCM via web browsers such as Microsoft IE, Mozilla Firefox, and Google Chrome. By default, users can access the UCM by just typing its IP address into a browser address bar. The browser will automatically be redirected to HTTPS using port 8089. For example, typing in “192.168.40.50” into the address bar will redirect the browser to “https://192.168.40.50:8089”. This behavior can be changed in the System Settings🡪HTTP Server page.
Redirect From Port 80
Toggles automatic redirection to UCM’s web portal from port 80. If disabled, users will need to manually add the UCM’s configured HTTPS port to the server address when accessing the UCM web portal via browser. Default is “Enabled”.
External Host
Configure a URL and port (optional) used to access the UCM web portal if the UCM is behind NAT.
Port
Specifies the port number used to access the UCM HTTP server. Default is “8089”.
Enable IP Address Allowlist
IP Allowlist restricts all IP addresses except for those in the allowlist from accessing the device via HTTP(S) (i.e., web portal, ZeroConfig, CTI apps).
Permitted IP(s)
List of addresses that can access the UCM web portal.
Ex: 192.168.6.233 / 255.255.255.255
Wave Settings
Cross-origin Address Allowlist
The UCM will accept cross-server requests from addresses in the whitelist, which should be formatted as https://domain, https://ip:port or *. Entering * will allow cross-server requests from all addresses.
Note: This option allow third parties to embed a Wave portal into their websites. This allows the users to log into wave using their extension numbers and use limited Wave features.
Specifies the public domain name or IP address (and port, if required) used by Wave clients to access UCM services when the UCM is behind NAT or accessed from an external network. This address is synchronized to Wave and used for external service access, including high-availability and disaster recovery scenarios.
Note: When a RemoteConnect plan is enabled, this field is automatically populated with the Wave external host address provided by GDMS. Please ensure that Automatically Update the External Host Address for Waveis disabled to prevent the external host from being reset by GDMS.
Port
The port to access Wave Web and Wave Mobile. If behind NAT, please make sure to map the external port to this port.
Certificate Settings
Default Certificate Auto Renewal
If enabled, the default browser certificate will be automatically renewed after 398 days (the max certificate validity period of Chrome, Firefox, and Safari browsers). User-defined certificates are not affected.
Options
Selects the method of acquiring SSL certificates for the UCM web server. Two methods are currently available:
Upload Certificate: Upload the appropriate files from one’s own PC.
Request Certificate: Enter the domain for which to request a certificate for from “Let’s Encrypt”.
TLS Cert
Upload the certificate for the HTTP server used for TLS connections. It contains the client’s private key and the server’s signed certificate. Once uploaded, the file will automatically be saved as “certificate.pem”.
Notes:
Supported file extensions include .crt, .cer, .der, .pem, .key, and .ca.
DER-formatted certificates are supported and will automatically be converted to PEM format upon upload.
The file size must not exceed 2MB.
TLS Private Key
Upload the private key for the HTTP server. Once uploaded, the file will automatically be saved as “private.pem”.
Notes:
Supported file extensions include .crt, .cer, .der, .pem, .key, and .ca.
DER-formatted certificates are supported and will automatically be converted to PEM format upon upload.
The file size must not exceed 2MB.
If the protocol or port has been changed, the user will be logged out and redirected to the new URL.
Network Settings
After successfully connecting the UCM630X to the network for the first time, users could log in to the Web GUI and go to SystemSettings>Network Settings to configure the network parameters for the device.
In this section, all the available network setting options are listed for all models. Select each tab in Web GUI🡪SystemSettings🡪Network Settings page to configure LAN settings, WAN settings, 802.1X, and Port Forwarding.
Basic Settings
Please refer to the following tables for basic network configuration parameters on the UCM6300 Series.
Method
Select "Route", "Switch" or "Dual" mode on the network interface of UCM630X. The default setting is "Switch".
Route: WAN port will be used for the uplink connection. LAN port will function similarly to a regular router port.
Switch: WAN port will be used for the uplink connection. LAN port will be used as a bridge for connections.
Dual: Both WAN and LAN ports will be used for uplink connections labeled as LAN2 and LAN1, respectively. The port selected as the Default Interface will need to have a gateway IP address configured if it is using a static IP.
MTU
Specifies the maximum transmission unit value. Default is 1492.
IPv4 Address
Preferred DNS Server
If configured, this will be used as the Primary DNS server.
WAN (when "Method" is set to "Route")
IP Method
Select DHCP, Static IP, or PPPoE. The default setting is DHCP.
IP Address
Enter the IP address for static IP settings. The default setting is 192.168.0.160.
Subnet Mask
Enter the subnet mask address for static IP settings. The default setting is 255.255.0.0.
Gateway IP
Enter the gateway IP address for static IP settings. The default setting is 0.0.0.0.
DNS Server 1
Enter the DNS server 1 address for static IP settings.
DNS Server 2
Enter the DNS server 2 address for static IP settings.
Username
Enter the username to connect via PPPoE.
Password
Enter the password to connect via PPPoE.
Layer 2 QoS 802.1Q/VLAN Tag
Assign the VLAN tag of the layer 2 QoS packets for the WAN port.
Layer 2 QoS 802.1p Priority Value
Assign the priority value of the layer 2 QoS packets for the WAN port.
Enable VoIP VLAN
Users can configure a VLAN dedicated to VoIP-related data traffic when using Router or Switch network method.
If enabled, the following VLAN settings will be added to achieve VoIP data diversion.
Note: This option is not supported in HA or Cluster mode
IP Method
The UCM's address type.
Static IP: Manual configuration of address information.
IP Address
The IPv4 address of the device, format: xxx.xxx.xxx.xxx.
Subnet Mask
Enter the subnet mask. For example, "255.255.255.0".
Gateway IP
Enter the gateway IP address. Format: "xxx.xxx.xxx.xxx".
Layer 2 QoS 802.1Q/VLAN Tag
This assigns VLAN tag for Layer 2 QoS packets.If you are unsure of the second layer of Qos, please do not change the second layer VLAN tag and priority, this wrong configuration may cause the device to fail to obtain IP address. If set to 0, VLAN is disabled.
Layer 2 QoS 802.1p Priority Value
This assigns priority value for Layer 2 QoS packets.
LAN (when Method is set to "Route")
IP Address
Enter the IP address assigned to the LAN port. The default setting is 192.168.2.1.
Subnet Mask
Enter the subnet mask. The default setting is 255.255.255.0.
DHCP Server Enable
Enable or disable DHCP server capability. The default setting is "Yes".
DNS Server 1
Enter DNS server address 1. The default setting is 8.8.8.8.
DNS Server 2
Enter DNS server address 2. The default setting is 208.67.222.222.
Allow IP Address From
Enter the DHCP IP Pool starting address. The default setting is 192.168.2.100.
Allow IP Address To
Enter the DHCP IP Pool ending address. The default setting is 192.168.2.254.
Default IP Lease Time
Enter the IP lease time (in seconds). The default setting is 43200.
LAN (when Method is set to "Switch")
IP Method
Select DHCP, Static IP, or PPPoE. The default setting is DHCP.
IP Address
Enter the IP address for static IP settings. The default setting is 192.168.0.160.
Subnet Mask
Enter the subnet mask address for static IP settings. The default setting is 255.255.0.0.
Gateway IP
Enter the gateway IP address for static IP settings. The default setting is 0.0.0.0.
DNS Server 1
Enter the DNS server 1 address for static IP settings.
DNS Server 2
Enter the DNS server 2 address for static IP settings.
Username
Enter the username to connect via PPPoE.
Password
Enter the password to connect via PPPoE.
Layer 2 QoS 802.1Q/VLAN Tag
Assign the VLAN tag of the layer 2 QoS packets for the LAN port. The accepted range is 2-4094.
Layer 2 QoS 802.1p Priority Value
Assign the priority value of the layer 2 QoS packets for the LAN port. The default value is 0.
Enable VoIP VLAN
This configuration is not supported in HA or cluster mode.
If enabled, the following VLAN settings will be added to achieve VoIP data diversion.
IP Method
The UCM's address type.
Static IP: Manual configuration of address information.
IP Address
The IPv4 address of the device, format: xxx.xxx.xxx.xxx.
Subnet Mask
Enter the subnet mask. For example, "255.255.255.0".
Gateway IP
Enter the gateway IP address. Format: "xxx.xxx.xxx.xxx".
Layer 2 QoS 802.1Q/VLAN Tag
This assigns VLAN tag for Layer 2 QoS packets.If you are unsure of the second layer of Qos, please do not change the second layer VLAN tag and priority, this wrong configuration may cause the device to fail to obtain IP address. The accepted range is 2-4094.
Layer 2 QoS 802.1p Priority Value
This assigns priority value for Layer 2 QoS packets.
LAN 1 / LAN 2 (when Method is set to "Dual")
Default Interface
If "Dual" is selected as "Method", users will need to assign the default interface to be LAN 1 (mapped to UCM6302 WAN port) or LAN 2 (mapped to UCM6302 LAN port) and then configure network settings for LAN 1/LAN 2. The default interface is LAN 2.
IP Method
Select DHCP, Static IP, or PPPoE. The default setting is DHCP.
IP Address
Enter the IP address for static IP settings. The default setting is 192.168.0.160.
Subnet Mask
Enter the subnet mask address for static IP settings. The default setting is 255.255.0.0.
Gateway IP
Enter the gateway IP address for static IP settings when the port is assigned as the default interface. The default setting is 0.0.0.0.
DNS Server 1
Enter the DNS server 1 address for static IP settings.
DNS Server 2
Enter the DNS server 2 address for static IP settings.
Username
Enter the username to connect via PPPoE.
Password
Enter the password to connect via PPPoE.
Layer 2 QoS 802.1Q/VLAN Tag
Assign the VLAN tag of the layer 2 QoS packets for the LAN port.
The accepted range is 2-4094.
Layer 2 QoS 802.1p Priority Value
Assign the priority value of the layer 2 QoS packets for the LAN port. The default value is 0.
IP Method
The UCM's address type.
Static IP: Manual configuration of address information.
IP Address
The IPv4 address of the device, format: xxx.xxx.xxx.xxx.
Subnet Mask
Enter the subnet mask. For example, "255.255.255.0".
Gateway IP
Enter the gateway IP address. Format: "xxx.xxx.xxx.xxx".
Layer 2 QoS 802.1Q/VLAN Tag
This assigns VLAN tag for Layer 2 QoS packets.If you are unsure of the second layer of Qos, please do not change the second layer VLAN tag and priority, this wrong configuration may cause the device to fail to obtain IP address. The accepted range is 2-4094.
Layer 2 QoS 802.1p Priority Value
This assigns priority value for Layer 2 QoS packets.
IPv6 Address
WAN (when "Method" is set to "Route")
IP Method
Select Auto or Static. The default setting is Auto
IP Address
Enter the IP address for static IP settings.
IP Prefixlen
Enter the Prefix length for static settings. Default is 64
DNS Server 1
Enter the DNS server 1 address for static settings.
DNS Server 2
Enter the DNS server 2 address for static settings.
Enable VLAN
Enable VLAN tagging for this interface.
Layer 2 QoS 802.1Q/VLAN Tag
This assigns VLAN tag for Layer 2 QoS packets.If you are unsure of the second layer of Qos, please do not change the second layer VLAN tag and priority, this wrong configuration may cause the device to fail to obtain IP address.
Range: 2 - 4094
Layer 2 QoS 802.1p Priority Value
This assigns priority value for Layer 2 QoS packets.
Range: 0 - 7 with 7 indicating that the packets have higher priority, and 0 indicating lower priority.
Enable VoIP VLAN
This configuration is not supported in HA or cluster mode.
If enabled, the following VLAN settings will be added to achieve VoIP data diversion.
IP Method
The UCM's address type.
Static IP: Manual configuration of address information.
IP Address
The IPv4 address of the device, format: xxx.xxx.xxx.xxx.
Subnet Mask
Enter the subnet mask. For example, "255.255.255.0".
Gateway IP
Enter the gateway IP address. Format: "xxx.xxx.xxx.xxx".
Layer 2 QoS 802.1Q/VLAN Tag
This assigns VLAN tag for Layer 2 QoS packets.If you are unsure of the second layer of Qos, please do not change the second layer VLAN tag and priority, this wrong configuration may cause the device to fail to obtain IP address.
Range: 0 - 4094
Layer 2 QoS 802.1p Priority Value
This assigns priority value for Layer 2 QoS packets.
Range: 0 - 7 with 7 indicating that the packets have higher priority, and 0 indicating lower priority.
LAN (when Method is set to "Route")
DHCP Server
Select Disable, Auto, or DHCPv6.
Disable: the DHCPv6 server is disabled.
Auto: Stateless address auto configuration using NDP protocol.
DHCPv6: Stateful address auto configuration using DHCPv6 protocol.
The default setting is Disabled.
DHCP Prefix
Enter DHCP prefix. (Default is 2001:db8:2:2::)
DHCP prefixlen
Enter the Prefix length for static settings. Default is 64
DNS Server 1
Enter the DNS server 1 address for static settings. Default is (2001:4860:4860::8888 )
DNS Server 2
Enter the DNS server 2 address for static settings. Default is (2001:4860:4860::8844 )
Allow IP Address From
Configure starting IP address assigned by the DHCP prefix and DHCP prefixlen.
Allow IP Address To
Configure the ending IP address assigned by the DHCP Prefix and DHCP prefixlen.
Default IP Lease Time
Configure the lease time (in second) of the IP address.
Enable VLAN
Enable VLAN tagging for this interface.
Layer 2 QoS 802.1Q/VLAN Tag
This assigns VLAN tag for Layer 2 QoS packets.If you are unsure of the second layer of Qos, please do not change the second layer VLAN tag and priority, this wrong configuration may cause the device to fail to obtain IP address.
Range: 2 - 4094
Layer 2 QoS 802.1p Priority Value
This assigns priority value for Layer 2 QoS packets
Range: 0 - 7 with 7 indicating that the packets have higher priority, and 0 indicating lower priority.
LAN (when Method is set to "Switch")
IP Method
Select Auto or Static. The default setting is Auto
IP Address
Enter the IP address for static IP settings.
IP Prefixlen
Enter the Prefix length for static settings. Default is 64
DNS Server 1
Enter the DNS server 1 address for static settings.
DNS Server 2
Enter the DNS server 2 address for static settings.
Enable VLAN
Enable VLAN tagging for this interface.
Layer 2 QoS 802.1Q/VLAN Tag
This assigns VLAN tag for Layer 2 QoS packets.If you are unsure of the second layer of Qos, please do not change the second layer VLAN tag and priority, this wrong configuration may cause the device to fail to obtain IP address.
Range: 2 - 4094
Layer 2 QoS 802.1p Priority Value
This assigns priority value for Layer 2 QoS packets.
Range: 0 - 7 with 7 indicating that the packets have higher priority, and 0 indicating lower priority.
LAN 1 / LAN 2 (when Method is set to "Dual")
Default Interface
Users will need to assign the default interface to be LAN 1 (mapped to UCM630X WAN port) or LAN 2 (mapped to UCM630X LAN port) and then configure network settings for LAN 1/LAN 2. The default interface is LAN 1.
IP Method
Select Auto or Static. The default setting is Auto
IP Address
Enter the IP address for static IP settings.
IP Prefixlen
Enter the Prefix length for static settings. Default is 64
DNS Server 1
Enter the DNS server 1 address for static settings.
DNS Server 2
Enter the DNS server 2 address for static settings.
Enable VLAN
Enable VLAN tagging for this interface.
Layer 2 QoS 802.1Q/VLAN Tag
This assigns VLAN tag for Layer 2 QoS packets.If you are unsure of the second layer of Qos, please do not change the second layer VLAN tag and priority, this wrong configuration may cause the device to fail to obtain IP address.
Range: 2 - 4094
Layer 2 QoS 802.1p Priority Value
This assigns priority value for Layer 2 QoS packets.
Range: 0 - 7 with 7 indicating that the packets have higher priority, and 0 indicating lower priority.
Network Port Traffic Control
LAN (when Method is set to "Switch")
Enable Network Port Traffic Storm Alert
The UCM will send a an alert notification/email when there is an excessive number of packets in the LAN that impacts the overall performance of the network.
Note: To enable this feature email or HTTP notification should be set up correctly In Maintenance 🡲 System Events.
Ignore Safe Operational Flow
When enabled, it will ignore traffic storm alarms triggered by users' own operations after logging in, including security operations such as firmware upgrades, uploading backup files, beeping, zero-configuration templates/firmware, recording files, and downloading files from network disks.
Network Port Receiving Traffic Control
You can monitor the traffic in the RX direction on each network port and generate an alarm when the corresponding alarm event is turned on and the set threshold value is exceeded.
The threshold range is 1 - 1024000 in kbps and 1 - 1000 in mbps.
LAN 1 & LAN 2 (when Method is set to "Dual")
Enable Network Port Traffic Storm Alert
The UCM will send a an alert notification/email when there is an excessive number of packets in the LAN that impacts the overall performance of the network.
Note: To enable this feature email or HTTP notification should be set up correctly In Maintenance 🡲 System Events.
Ignore Safe Operational Flow
When enabled, it will ignore traffic storm alarms triggered by users' own operations after logging in, including security operations such as firmware upgrades, uploading backup files, beeping, zero-configuration templates/firmware, recording files, and downloading files from network disks.
LAN1 & LAN2
- Network Port Receiving Traffic Control
You can monitor the traffic in the RX direction on each network port and generate an alarm when the corresponding alarm event is turned on and the set threshold value is exceeded.
The threshold range is 1 - 1024000 in kbps and 1 - 1000 in mbps.
LAN & WAN (When Method is set to Route Mode)
Enable Network Port Traffic Storm Alert
The UCM will send a an alert notification/email when there is an excessive number of packets in the LAN that impacts the overall performance of the network.
Note: To enable this feature email or HTTP notification should be set up correctly In Maintenance 🡲 System Events.
Ignore Safe Operation Flow
When enabled, it will ignore traffic storm alarms triggered by users' own operations after logging in, including security operations such as firmware upgrades, uploading backup files, beeping, zero-configuration templates/firmware, recording files, and downloading files from network disks.
WAN:
Network Port Receiving Traffic Control
You can monitor the traffic in the RX direction on each network port and generate an alarm when the corresponding alarm event is turned on and the set threshold value is exceeded.
The threshold range is 1 - 1024000 in kbps and 1 - 1000 in mbps.
LAN:
Network Port Receiving Traffic Control
You can monitor the traffic in the RX direction on each network port and generate an alarm when the corresponding alarm event is turned on and the set threshold value is exceeded.
The threshold range is 1 - 1024000 in kbps and 1 - 1000 in mbps.
Method: Route
When the UCM630X has the method set to Route in network settings, WAN port interface is used for uplink connection and LAN port interface is used as a router. Please see a sample diagram below.
UCM6302 Network Interface Method Route
Method: Switch
WAN port interface is used for uplink connection; LAN port interface is used as a room for PC connection.
UCM6302 Network Interface Method Switch
Method: Dual
Both WAN port and LAN port are used for the uplink connection. Users will need to assign LAN 1 or LAN 2 as the default interface in option “Default Interface” and configure “Gateway IP” if static IP is used for this interface.
UCM6302 Network Interface Method Dual
802.1X Settings
IEEE 802.1X is an IEEE standard for port-based network access control. It provides an authentication mechanism to a device before the device can access the Internet or other LAN resources. The UCM630X supports 802.1X as a supplicant/client to be authenticated.
The following diagram and figure show UCM630X uses 802.1X mode “EAP-MD5” on the WAN port as a client in the network to access the Internet.
UCM630X Using 8021X as Client
UCM630X Using 8021X EAP MD5
The following tables shows the configuration parameters for the different 802.1X modes.
MD5
Parameter
Description
802.1X Mode
EAP-MD5
Identity
Enter the Identity for the 802.1X mode.
MD5 Password
Enter the MD5 Password for the 802.1X mode.
EAP TLS
Parameter
Description
802.1X Mode
EAP-MD5
Identity
Enter the Identity for the 802.1X mode.
802.1X Client Private Key Password
The private key password corresponding to the 802.1X client certificate.
802.1X CA Certificate
Upload 802.1X CA certificate. This file will be renamed as "8021x_ca_cert" automatically.
802.1X Client Certificate
Upload 802.1X client certificate. This file will be renamed as 8021x_client_cert automatically.
802.1X Client Private Key
Upload the private key corresponding to the 802.1X client certificate. This file will be renamed as 8021x_client_key automatically.
EAP PEAPv0/MSCHAPv2
Parameter
Description
802.1X Mode
EAP-MD5
Identity
Enter the Identity for the 802.1X mode.
MD5 Password
Enter the MD5 Password for the 802.1X mode.
802.1X CA Certificate
Upload 802.1X CA certificate. This file will be renamed as "8021x_ca_cert" automatically.
802.1X Client Certificate
Upload 802.1X client certificate. This file will be renamed as 8021x_client_cert automatically.
Static Routes
The UCM630X provides users static routing capability that allows the device to use manually configured routes, rather than information only from dynamic routing or gateway configured in the UCM630X Web GUI🡪System Settings🡪Network Settings🡪Basic Settings to forward traffic. It can be used to define a route when no other routes are available or necessary or used in complementary with existing routing on the UCM630X as a failover backup, etc.
Click on “Add IPv4 Static Route” to create a new IPv4 static route or click ”Add IPv6 Static Route” to create a new IPv6 static route. The configuration parameters are listed in the table below.
Once added, users can select to edit the static route.
Select to delete the static route.
Parameter
Description
Destination
Configure the destination IPv4 address or the destination IPv6 subnet for the UCM630X to reach using the static route.
Example:
IPv4 address – 192.168.66.4
IPv6 – 2001:740:D::1/64
Subnet Mask
Configure the subnet mask for the above destination address. If left blank, the default value is 255.255.255.255.
Example:
255.255.255.0
Gateway
Configure the IPv4 or IPv6 gateway address so that the UCM630X can reach the destination via this gateway. The gateway address is optional.
Example:
192.168.40.5 or 2001:740:D::1
Interface
Specify the network interface on the UCM630X to reach the destination using the static route.
LAN interface is eth0; WAN interface is eth1.
Static routes configuration can be reset from the LCD menu > Network Menu.
The following diagram shows a sample application of static route usage on UCM6304.
UCM630X Network Settings🡪Static Routes
The network topology of the above diagram is as below:
Network 192.168.69.0 has IP phones registered to UCM6304 LAN 1 address
Network 192.168.40.0 has IP phones registered to UCM6304 LAN 2 address
Network 192.168.66.0 has IP phones registered to UCM6304 via VPN
Network 192.168.40.0 has a VPN connection established with network 192.168.66.0
In this network, by default, the IP phones in network 192.168.69.0 are unable to call IP phones in network 192.168.66.0 when registered on different interfaces on the UCM6304. Therefore, we need to configure a static route on the UCM6304 so that the phones in isolated networks can make calls between each other.
UCM6304 Static Route Configuration
Port Forwarding
The UCM network interface supports the router function which provides users the ability to do port forwarding. If LAN mode is set to “Route” under Web GUI🡪SystemSettings🡪Network Settings🡪Basic Settings page, port forwarding is available for configuration.
The port forwarding configuration is under Web GUI🡪SystemSettings🡪Network Settings🡪Port Forwarding page. Please see related settings in the table below.
WAN Port
Specify the WAN port number or a range of WAN ports. An unlimited number of ports can be configured.
Note:
When it is set to a range, the WAN port, and LAN port must be configured with the same range, such as WAN port: 1000-1005 and LAN port: 1000-1005, and access from the WAN port will be forwarded to the LAN port with the same port number, for example, WAN port 1000 will be port forwarding to LAN port 1000.
LAN IP
Specify the LAN IP address.
LAN Port
Specify the LAN port number or a range of LAN ports.
Note:
When it is set to a range, the WAN port, and LAN port must be configured with the same range, such as WAN port: 1000-1005 and LAN port: 1000-1005, and access from the WAN port will be forwarded to the LAN port with the same port number, for example, WAN port 1000 will be port forwarding to LAN port 1000.
Protocol Type
Select protocol type "UDP Only", "TCP Only" or "TCP/UDP" for the forwarding in the selected port. The default setting is "UDP Only".
UCM630X Network Settings > Port Forwarding
The following figures demonstrate a port forwarding example to provide a phone’s Web GUI access to the public side.
UCM630X network mode is set to “Route”.
UCM630X WAN port is connected to the uplink switch, with a public IP address configured, e.g. 1.1.1.1.
UCM630X LAN port provides a DHCP pool that connects to multiple phone devices in the LAN network 192.168.2.x. The UCM60X is used as a router, with gateway address 192.168.2.1.
There is a GXP2160 connected under the LAN interface network of the UCM630X. It obtains IP address 192.168.2.100 from the UCM630X DHCP pool.
On the UCM630X Web GUI🡪System Settings🡪Network Settings🡪Port Forwarding, configure a port forwarding entry as the figure shows below.
WAN Port: This is the port opened on the WAN side for access purposes.
LAN IP: This is the GXP2160 IP address, under the LAN interface network of the UCM630X.
LAN Port: This is the port opened on the GXP2160 side for access purposes.
Protocol Type: We select TCP here for Web GUI access using HTTP.
Create New Port Forwarding
UCM630X Port Forwarding Configuration
This will allow users to access the GXP2160 Web GUI from the public side, by typing in the public IP address (example: 1.1.1.1:8088).
GXP2160 Web Access using UCM6302 Port Forwarding
Port Management
In this page, the user can view and change the default ports for the different services of the UCM. The user can click on “Go” to navigate to the page to edit the corresponding service port.
ARP Settings
The ARP settings can be configured under Web GUI🡪SystemSettings🡪Network Settings🡪ARP Settings
ARP GC Threshold 1
A minimum number of entries to keep. The garbage collector will not purge entries if there are fewer than this number. The default value is 128.
ARP GC Threshold 2
Threshold when garbage collector becomes more aggressive about purging entries. Entries older than 5 seconds will be cleared when over this number. The default value is 512.
ARP GC Threshold 3
The maximum number of non-PERMANENT neighbor entries allowed. Increase this when using large numbers of interfaces and when communicating with large numbers of directly connected peers. The default value is 1024.
ARP Settings
OpenVPN®
OpenVPN® settings allow the users to configure UCM630X to use VPN features, the following table gives details about the various options to configure the UCM as OpenVPN Client.
Open VPN® Feature on the UCM630X
OpenVPN® Enable
Enable / Disable the OpenVPN® feature.
Configuration Method
Select the OpenVPN® configuration method.
Manual Configuration: Allows to configure OpenVPN® settings manually.
Upload Configuration File: Allows to upload .ovpn and .conf files to the UCM and to automatically configure OpenVPN® settings.
OpenVPN® Server Address
Configures the hostname/IP and port of the server. For example 192.168.1.2:22
OpenVPN® Server Protocol
Specify the protocol user, user should use the same settings as used on the server
OpenVPN® Device mode
Use the same setting as used on the server.
Dev TUN: Create a routed IP tunnel.
Dev TAP: Create an Ethernet tunnel.
OpenVPN® Use Compression
Compress tunnel packets using the LZO algorithm on the VPN link. Do not enable this unless it is also enabled in the server config file.
Enable Weak SSL Ciphers
Either to enable the Weak SSL ciphers or not.
OpenVPN® Encryption Algorithm
Specify the cryptographic cipher. Users should make sure to use the same setting that they are using on the OpenVPN server.
OpenVPN® CA Cert
Upload as SSL/TLS root certificate. This file will be renamed as ‘ca.crt’ automatically.
OpenVPN® Client Cert
Upload a client certificate. This file will be renamed as ‘client.crt’ automatically.
OpenVPN® Client Key
Upload a client private key. This file will be renamed as ‘client.key’ automatically.
Username
Username used to authenticate into the server.
Password
Password used to authenticate into the server.
DDNS Settings
DDNS setting allows users to access UCM630X via domain name instead of IP address.
The UCM supports DDNS service from the following DDNS provider:
dydns.org
noip.com
freedns.afraid.org
zoneedit.com
oray.net
Here is an example of using noip.com for DDNS.
Register domain in DDNS service provider. Please note the UCM630X needs to have public IP access.
Register Domain Name on noipcom
On Web GUI🡪System Settings🡪Network Settings🡪DDNS Settings, enable DDNS service and configure username, password, and host name.
UCM630X DDNS Setting
Now you can use a domain name instead of an IP address to connect to the UCM630X Web GUI.
Using Domain Name to Connect to UCM630X
Security Settings
The UCM630X provides users firewall security configurations to prevent certain malicious attacks to the UCM630X system. Users could configure to allow, restrict, or reject specific traffic through the device for security and bandwidth purpose. The UCM630X also provides the Fail2ban feature for authentication errors in SIP REGISTER, INVITE and SUBSCRIBE. To configure firewall settings in the UCM630X, go to Web GUI🡪System Settings🡪Security Settings page.
Static Defense
Under Web GUI🡪System Settings🡪Security Settings🡪Static Defense page, users will see the following information:
Current service information with port, process, and type.
Typical firewall settings.
Custom firewall settings.
The following table shows a sample current service status running on the UCM630X.
Port
Process
Type
Protocol or Service
7777
Asterisk
TCP/IPv4
SIP
389
Slapd
TCP/IPv4
LDAP
6060
zero_config
UDP/IPv4
UCM630X zero_config service
5060
Asterisk
UDP/IPv4
SIP
4569
Asterisk
UDP/IPv4
IAX
38563
Asterisk
udp/ipv4
SIP
10000
gs_avs
udp/ipv4
gs_avs
10001
gs_avs
udp/ipv4
gs_avs
10002
gs_avs
udp/ipv4
gs_avs
10003
gs_avs
udp/ipv4
gs_avs
10004
gs_avs
udp/ipv4
gs_avs
10005
gs_avs
udp/ipv4
gs_avs
10006
gs_avs
udp/ipv4
gs_avs
10007
gs_avs
udp/ipv4
gs_avs
10010
gs_avs
udp/ipv4
gs_avs
10012
gs_avs
udp/ipv4
gs_avs
10013
gs_avs
udp/ipv4
gs_avs
10014
gs_avs
udp/ipv4
gs_avs
10015
gs_avs
udp/ipv4
gs_avs
10018
gs_avs
udp/ipv4
gs_avs
10019
gs_avs
udp/ipv4
gs_avs
10020
gs_avs
udp/ipv4
gs_avs
6066
Python
udp/ipv4
python
3306
Mysqld
tcp/ipv4
mysqld
45678
Python
udp/ipv4
python
8439
Lighttpd
tcp/ipv4
HTTP
8088
asterisk
tcp/ipv4
SIP
8888
Pbxmid
tcp/ipv4
pbxmid
25
Master
tcp/ipv4
master
636
Slapd
tcp/ipv4
SLDAP
4569
asterisk
udp/ipv6
SIP
42050
asterisk
udp/ipv6
SIP
7681
Pbxmid
tcp/ipv4
pbxmid
UCM630X Firewall🡪Static Defense🡪Current Service
For typical firewall settings, users could configure the following options on the UCM630X.
Ping Defense Enable
If enabled, ICMP response will not be allowed for Ping requests. The default setting is disabled. To enable or disable it, click on the check box for the LAN or WAN (UCM630X) interface.
SYN-Flood Defense Enable
Allows the UCM630X to handle excessive amounts of SYN packets from one source and keep the web portal accessible. There are two options available and only one of these options may be enabled at one time.
eth(0)LAN defends against attacks directed to the LAN IP address of the UCM630X.
eth(1)WAN defends against attacks directed to the WAN IP address of the UCM630X.
SYN Flood Defense will limit the amount of SYN packets accepted by the UCM from one source to 10 packets per second. Any excess packets from that source will be discarded.
Ping-of-Death Defense Enable
Enable to prevent Ping-of-Death attack to the device. The default setting is disabled. To enable or disable it, click on the check box for the LAN or WAN (UCM630X) interface.
Typical Firewall Settings
Under “Custom Firewall Settings”, users could create new rules to accept, reject or drop certain traffic going through the UCM630X. To create a new rule, click on the “Create New Rule” button and a new window will pop up for users to specify rule options.
Right next to the “Create New Rule” button, there is a checkbox for the option “Reject Rules”. If it is checked, all the rules will be rejected except the firewall rules listed below. In the firewall rules, only when there is a rule that meets all the following requirements, the option “Reject Rules” will be allowed to check:
Action: “Accept”
Type “In”
The destination port is set to the system login port (e.g., by default 8089)
The protocol is not UDP
Create New Firewall Rule
Rule Name
Specify the Firewall rule name to identify the firewall rule.
Action
Select the action for the Firewall to perform.
ACCEPT
REJECT
DROP
Type
Select the traffic type.
IN
If selected, users will need to specify the network interface “LAN” or “WAN” (for UCM630X) for the incoming traffic.
OUT
Interface
Select the interface to use the Firewall rule.
Service
Select the service type.
FTP
SSH
Telnet
HTTP
LDAP
Custom
If “Custom” is selected, users will need to specify Source (IP and port), Destination (IP and port), and Protocol (TCP, UDP, or Both) for the service. Please note if the source or the destination field is left blank, it will be used as “Anywhere”.
Source IP Address and Port
Configure a source subnet and port. If set to “Anywhere” or left empty, traffic from all addresses and ports will be accepted. A single port or a range of ports can be specified (e.g., 10000, 10000-20000).
Destination IP Address and Port
Configure a destination subnet and port. If set to “Anywhere” or left empty, traffic can be sent to all addresses and ports. A single port or a range of ports can be specified (e.g., 10000, 10000-20000).
Protocol
Select the protocol for the rule to be used.
Firewall Rule Settings
Save the change and click on the “Apply” button. Then submit the configuration by clicking on “Apply Changes” on the upper right of the web page. The new rule will be listed at the bottom of the page with sequence number, rule name, action, protocol, type, source, destination, and operation. More operations are below:
Click on to edit the rule.
Click on to delete the rule.
Dynamic Defense
Dynamic defense is supported on the UCM630X series. It can blacklist hosts dynamically when the LAN mode is set to “Route” under Web GUI🡪SystemSettings🡪Network Settings🡪Basic Settings page. If enabled, the traffic coming into the UCM630X can be monitored, which helps prevent massive connection attempts or brute force attacks to the device. The blacklist can be created and updated by the UCM630X firewall, which will then be displayed on the web page. Please refer to the following table for dynamic defense options on the UCM630X.
Dynamic Defense Enable
Enable dynamic defense. The default setting is disabled.
Blacklist Update Interval
Configure the blacklist update time interval (in seconds). The default setting is 120.
Connection Threshold
Configure the connection threshold. Once the number of connections from the same host reaches the threshold, it will be added to the blacklist. The default setting is 100.
Dynamic Defense Whitelist
Allowed IPs and ports range, multiple IP addresses, and port range.
For example:
192.168.2.100-192.168.2.105, 1000:9999
UCM630X Firewall Dynamic Defense
The following figure shows a configuration example like this:
If a host at IP address 192.168.5.7 initiates more than 20 TCP connections to the UCM630X it will be added to the UCM630X blacklist.
This host 192.168.5.7 will be blocked by the UCM630X for 500 seconds.
Since IP range 192.168.5.100-192.168.5.200 is in the whitelist if a host initiates more than 20 TCP connections to the UCM630X it will not be added to the UCM630X blacklist. It can still establish a TCP connection with the UCM630X.
Configure Dynamic Defense
Geo-IP Access Control
This feature allows administrators to control access to the UCM based on the source country or region of incoming IP addresses. When enabled, access from selected countries can be restricted for all external services, including Web GUI access, API access, SIP signaling, and extension registration.
The country/region IP database can be updated manually or automatically to ensure accurate IP-to-location mapping.
UCM Geo IP Access Control Page
Country/Region IP Defense supports two enforcement methods, which determine how and when traffic from blocked countries is handled.
Non-Strict Defend Mode: In this mode, Country/Region IP Defense is enforced with business priority. Traffic from blocked countries is rejected at the application/service layer. The UCM returns explicit responses (for example, SIP error responses or HTTP error pages). Services remain reachable, but access is denied.
Strict Defend Mode: In this mode, Country/Region IP Defense is enforced with security priority. Traffic from blocked countries is dropped at the network level, and no SIP, HTTP, or HTTPS response is returned. Requests do not reach the Web server, SIP stack, API services, or Wave services.
Notes:
The defense priority is: Static Defense (firewall rules) → Country/Region IP Defense (Strict) → Dynamic Defense → Fail2Ban → Extension/Service ACLs → Country/Region IP Defense (Non-Strict).
Strict Defend Mode is disabled by default. Enabling or disabling this option may reload the Web service and interrupt active management sessions.
Fail2ban
Fail2Ban feature on the UCM630X provides intrusion prevention for authentication errors in SIP REGISTER, INVITE and SUBSCRIBE. Once the entry is detected within “Max Retry Duration”, the UCM630X will act to forbid the host for a certain period as defined in “Banned Duration”. This feature helps prevent SIP brute force attacks on the PBX system.
Note
Fail2ban is enabled by default.
Fail2ban Settings
The table below descibes the main parameters of the Fail2Ban feature:
SIP Defense
If enabled, which is the default setting, The UCM will monitor failed SIP registration attempts and heartbeat timeouts based on the security logs.
Once the number of failed attempts from an IP address has reached SIP Defense’s configured Max Retries value, the IP address will banned for the amount of time configured in the Banned Duration field.
Login Attack Defense
When enabled, which is the default setting, once the number of login attempts from an IP address has reached the Max Retries value configured for this defense, the IP address will banned for the amount of time configured in the Banned Duration field.
Customer Service System Call Defense
Once the number of call attempts from an IP address has reached the Max Retries value configured for this defense, the IP address will banned for the amount of time configured in the Banned Duration field.
Live Chat Protection
Once the number of chat attempts from an IP address has reached the Max Retries value configured for this defense, the IP address will banned for the amount of time configured in the Banned Duration field.
Banned Duration (s)
Configure the duration (in seconds) that an IP address is banned. 0 indicates a permanent ban.
Fail2ban Allowlist
Configure IP address, CIDR mask or DNS host in the allowlist. Fail2ban will not ban the host with matching address in this list.
Blocklist
Users will be able to manually add or view the IPs that have been automatically blocked by the UCM.
SSH Access
SSH switch now is available via Web GUI and LCD. Users can enable or disable SSH access directly from Web GUI or LCD screen. For web SSH access, please log in to UCM630X web interface and go to Web GUI > System Settings > Security Settings>SSH Access.
The “Enable SSH access” option is for system debugging. If you enable this option, the system will allow SSH access. The SSH connection require using the username “admin” and the super administrator’s password. This option is turned off by default. It is recommended to turn off this option when debugging is not required.
Tick “Enable remote SSH” option, the system will allow remote SSH access via the GDMS platform. This option is turned off by default, and it is strongly recommended to turn off this option when remote troubleshooting is not required.
SSH Access
Enable SSH Access
This option is used for system debugging. Once enabled, UCM will allow SSH access. The SSH connection requires super administrator's username and password. The default setting is "No". It is recommended to set it to "No" if there is no need for debugging.
SSH Port
Define the SSH service port.
GDMS Remote SSH
Please enter the token to request SSH data.
Access Token
Enter the token to establish SSH access.
Data/File Encryption
The UCM6300 Series offers encryption for your data stored on the internal storage space of the UCM or on the attached storage units (e.g., SD Card, USB HDD/SSD, USB Flash Drive). This feature will harden the security and confidentiality of your data, which renders it impossible to read data in case they end up acquired by unauthorized parties. To access this feature, please navigate to PBX Settings > Security Settings > Data/File Encryption.
DataFile Encryption
Note
Encrypting the data stored on attached storage units will prevent the user from browsing the data directly from the UCM USB/SD Card file explorer.
Enabling Data/File Encryption
To choose which files are going to encrypted, use the following settings to enable the encryption for specific types of data.
FileData Type
Once the user chooses which data to encrypt, the user can save the setting. This means that any data created after this configuration will be encrypted, however, all the data which has been created prior to this configuration is not encrypted. To encrypt it please see the sections below.
Encrypting Files
When the user click on “Export” button, a file which contains the secret key will be downloaded. This key can be stored safely and used to decrypt the data later on.
Secret Key ExportUpdate
You can update the secret key using the “Update” button, this would require entering the administrator’s password to allow the user to change the secret key.
Note
Please note that only the super administrator can change the secret key.
Critical
If the key has been updated after it has been exported, this will render the old key obsolete and the user will not be able to decrypt the data. We highly recommend that you do not change the encryption key after it has been backed up. In case you need to change the encryption key, please make sure to export the new one and store it safely.
In the following section, the user can view the status of the files, whether they are encrypted or not. The user can also select the different data types to encrypt. This will encrypt the existing data.
DataFile Encryption Status
The user can select the types of stored files to encrypt, then use the button to start the encryption. Or you can encrypt the files using the following encrypting button .
To open and play encrypted audio/video files outside of the UCM system, users need a decryption tool (found on the Grandstream Tools page), a key file and the password for it (set when exporting the key file).
For more information on how to use the decryption tool, please refer to the following guide :
In an HA environment, the Primary UCM’s key will be used as the Master Key, and this will be synced with the Secondary UCM so both UCMs will use the same key to encrypt and decrypt files.
Files on the standby machine are not automatically encrypted so users will need to manually re-encrypt all new files that were created before the failover.
Critical
Downgrading from a firmware version with data encrypted to a firmware version which does not support data encryption will require the user to perform a factory reset.
Backing up the data of the PBX before upgrading the firmware is highly recommended to avoid the possibility of data corruption/loss.
LDAP Server
The UCM630X has an embedded LDAP/LDAPS server for users to manage the corporate phonebook in a centralized manner.
By default, the LDAP server has generated the first phonebook with PBX DN “ou=pbx,dc=pbx,dc=com” based on the UCM630X user extensions already.
Users could add new phonebook with a different Phonebook DN for other external contacts. For example, “ou=people,dc=pbx,dc=com”.
All the phonebooks in the UCM630X LDAP server have the same Base DN “dc=pbx,dc=com”.
Term Explanation:
cn= Common Name
ou= Organization Unit
dc= Domain Component
These are all parts of the LDAP Data Interchange Format, according to RFC 2849, which is how the LDAP tree is filtered.
If users have the Grandstream phone provisioned by the UCM630X, the LDAP directory will be set up on the phone and can be used right away for users to access all phonebooks.
Additionally, users could manually configure the LDAP client settings to manipulate the built-in LDAP server on the UCM630X. If the UCM630X has multiple LDAP phonebooks created, in the LDAP client configuration, users could use “dc=pbx,dc=com” as Base DN to have access to all phonebooks on the UCM630X LDAP server, or use a specific phonebook DN, for example “ou=people,dc=pbx,dc=com”, to access to phonebook with Phonebook DN “ou=people,dc=pbx,dc=com ” only.
UCM can also act as an LDAP client to download phonebook entries from another LDAP server.
To access the LDAP server and client settings, go to Web GUI🡪Settings🡪LDAP Server.
LDAP Server Configurations
The following figure shows the default LDAP server configurations on the UCM630X.
LDAP Server Configuration
Enable LDAP Server
Enable LDAP Server
LDAP Port
Enter the port number for LDAP service. The default port number is 389. The allowed range is 1 - 65535
LDAPS Port
LDAPS server port is predefined and cannot be set by the user. The default port number is 636. The allowed range is 1 - 65535
Base DN
Specifies the location in the directory where the search is requested to begin. It is predefined and cannot be modified.
PBX DN
Specifies the location in the directory where the search for PBX entry is requested to begin. It narrows the search scope and decreases directory lookup time.
Root DN
Specifies the location in the directory where the search for the admin user entry is requested to begin. It narrows the search scope and decreases directory lookup time.
Root Password
Defines the root password for authentication.
Confirm Root Password
Confirms the root password for authentication.
LDAP CA Cert
Upload the LDAPS certification authority certificate.
TLS Compression
If this option is enabled, compression will be performed when transmitting the data. Enabling this option is not recommended since it may present a security risk.
Note: This option is disabled by default.
LDAP Cert
Upload the LDAP server certificate
LDAP Private Key
Upload the LDAP private key.
Certificate & Private Key
Click this button to reset the certificate and key configuration.
The UCM630X LDAP server supports anonymous access (read-only) by default. Therefore, the LDAP client does not have to configure a username and password to access the phonebook directory. The “Root DN” and “Root Password” here are for LDAP management and configuration where users will need to provide for authentication purposes before modifying the LDAP information.
The default phonebook list in this LDAP server can be viewed and edited by clicking on/for the first phonebook under LDAP Phonebook.
The UCM630X support secure LDAP (LDAPS) where the communication is encrypted and secure.
LDAP Phonebook
Users could use the default phonebook, edit the default phonebook, add new phonebook, import phonebook on the LDAP server as well as export phonebook from the LDAP server.
LDAP Server > LDAP Phonebook
Local Phonebook
The user can use the search bar on the top right corner of page, please see the screenshot below.
You can enter the extension number or the name of the contact; if you are unsure about the name or the extension, the search feature supports fuzzy matching.
LDAP Phonebook Search Bar
Add new phonebook
A new sibling phonebook of the default PBX phonebook can be added by clicking on “Add” under “LDAP Phonebook” section.
Add LDAP Phonebook
Configure the “Phonebook Prefix” first. The “Phonebook DN” will be automatically filled in. For example, if configuring “Phonebook Prefix” as “people”, the “Phonebook DN” will be filled with “ou=people,dc=pbx,dc=com”.
Once added, users can select to edit the phonebook attributes and contact list (see figure below) or select to delete the phonebook.
Edit LDAP Phonebook
Import phonebook from your computer to LDAP server
Click on “Import Phonebook” and a dialog will prompt as shown in the figure below.
Import Phonebook
The file to be imported must be a CSV, VCF, XLSX, or XML file with UTF-8 encoding. Users can open the file with Notepad and save it with UTF-8 encoding.
Here is how a sample file looks like. Please note “Account Number” and “Phonebook DN” fields are required. Users could export a phonebook file from the UCM630X LDAP phonebook section first and use it as a sample to start with.
Phonebook CSV File Format
The Phonebook DN field is the same “Phonebook Prefix” entry as when the user clicks on “Add” to create a new phonebook. Therefore, if the user enters “phonebook” in “Phonebook DN” field in the CSV file, the actual phonebook DN “ou=phonebook,dc=pbx,dc=com” will be automatically created by the UCM630X once the CSV file is imported.
In the CSV file, users can specify different phonebook DN fields for different contacts. If the phonebook DN already exists on the UCM630X LDAP Phonebook, the contacts in the CSV file will be added into the existing phonebook. If the phonebook DN does not exist on the UCM630X LDAP Phonebook, a new phonebook with this phonebook DN will be created.
The sample phonebook CSV file in above picture will result in the following LDAP phonebook in the UCM630X.
LDAP Phonebook After Import
As the default LDAP phonebook with DN “ou=pbx,dc=pbx,dc=com” cannot be edited or deleted in LDAP phonebook section, users cannot import contacts with Phonebook DN field “pbx” if existed in the file.
Export phonebook to your computer from UCM630X LDAP server
Select the checkbox for the LDAP phonebook and then click on “Export Selected Phonebook” to export the selected phonebook. The exported phonebook can be used as a record or a sample CSV, VFC, XLSX, or XML file for the users to add more contacts in it and import to the UCM630X again.
Export Selected LDAP Phonebook
LDAP Settings
Prerequisites to support contacts sync-up to IP Phones, UCM needs to support the following:
If Cloud IM is enabled, UCM can send remote UCM’s contacts to each end device.
Contacts from remote UCM can be synced by Cloud IM or LDAP sync via trunk. The contacts data must be complete and consistent.
If Cloud IM is enabled, the contacts sent from UCM to end device should integrate Cloud IM contacts.
If Cloud IM is disabled, the contacts sent from UCM to end device should only contain contacts on the UCM.
To support contacts sync-up to Wave, it allows Wave to obtain enterprise contacts from Cloud IM or LDAP. On UCM SIP peer trunk, if LDAP sync is enabled, end point can obtain remote UCM extensions’ info via LDAP. Also, it will allow configuring whether to sync up LDAP contacts on Wave so that Wave doesn’t receive duplicate contacts info.
Under UCM webUI>System Settings>LDAP Server, click on “LDAP Settings”, option “Wave enable LDAP phonebook” is available for configuration. If enabled, all Wave users on this UCM will display LDAP contacts. Otherwise, it will not display.
LDAP Settings
Please note the LDAP contacts displayed on Wave will exclude the duplicate contacts from Cloud IM.
Display LDAP Contacts on Wave
LDAP Client Configurations
The configuration on LDAP client is useful when you use other LDAP servers. Here we provide an example on how to configure the LDAP client on the UCM.
Assuming the remote server base dn is“dc=pbx,dc=com”, configure the LDAP client as follows:
LDAP Client Type
Phonebook Name
Enter a name for the phonebook
Server Address
The IP address of the LDAP server
Base DN
Enter the base domain name.
Username
Enter the username used to authenticate into the LDAP server, if authentication is required.
Password
Enter the password used to authenticate into the LDAP server, if authentication is required.
Filter
Enter the filter. Ex: (|(CallerIDName=%)(AccountNumber=%))
Port
Enter the port number. Default port is 389
LDAP Number Attributes
Enter the number attributes for the remote server.
Automatic Update Cycle
If "None" is selected, LDAP phonebooks will not automatically update. Otherwise, LDAP phonebooks will automatically update at 00:00 / 12:00 AM with the selected frequency.
LDAP Name Attributes
Enter the name attributes for the remote server.
Client Type
Choose the client type. For encrypted data transfer please choose LDAPS.
LDAP Client CA Cert
LDAP Client Public Certification
LDAP Client Private Key
LDAP Client Private Certification
The UCM can automatically update the phonebook, by configuring the ‘LDAP Automatic Update Cycle’. Available options are: 1 day/2days/7 days. It is set to ‘None’ by default.
The following figure gives a sample configuration for UCM acting as a LDAP client.
LDAP Client Configurations
To configure Grandstream IP phones as the LDAP clients for UCM, please refer to the following example:
Server Address: The IP address or domain name of the UCM
Base DN: dc=pbx,dc=com
Username: cn=admin,dc=pbx,dc=com
Password: admin (by default)
LDAP Name Attribute: CallerIDName Email Department FirstName LastName
LDAP Number Attribute: AccountNumber MobileNumber HomeNumber Fax
LDAP Number Filter: (AccountNumber=%)
LDAP Name Filter: (CallerIDName=%)
LDAP Display Name: AccountNumber CallerIDName
LDAP Version: If existed, please select LDAP Version 3
Port: 389
The following figure shows the configuration information on a Grandstream GXP2170 to successfully use the LDAP server as configured in [LDAP Server Configurations].
GXP2170 LDAP Phonebook Configuration
The UCM63xx LDAP server is no longer supporting the anonymous binding of the LDAP client.
AD Client Type
Phonebook Name
Enter a name for the phonebook
Server Address
The IP address of the AD server
Base DN
Enter the base domain name.
Username
Enter the username used to authenticate into the LDAP server, if authentication is required.
Password
Enter the password used to authenticate into the LDAP server, if authentication is required.
Filter
Enter the filter. Ex: (|(CallerIDName=%)(AccountNumber=%))
Port
Enter the port number. Default port is 389
AD Attributes
AccountNumber must be included if the default configuration is used.
Automatic Update Cycle
If "None" is selected, LDAP phonebooks will not automatically update. Otherwise, LDAP phonebooks will automatically update at 00:00 / 12:00 AM with the selected frequency.
Host Name
Enter the host name of the remote AD server.
Time Settings
Automatic Date and Time
The current system time on the UCM630X can be found under Web GUI🡪SystemStatus🡪Dashboard🡪PBX Status.
To configure the UCM630X to update time automatically, go to Web GUI🡪SystemSettings🡪Time Settings🡪Automatic date and Time.
The configurations under Web GUI🡪Settings🡪Time Settings🡪 Automatic date and Time page require reboot to take effect. Please consider configuring auto time updating related changes when setting up the UCM630X for the first time to avoid service interrupt after installation and deployment in production.
Automatic Date and Time Settings
Parameter
Description
Remote NTP Server
Configure the NTP server address to synchronize the time and date from.
Enable DHCP Option 2
If enabled, DHCP Option 2 will override the Time Zone setting on the PBX.
Enable DHCP Option 42
If enabled, DHCP Option 42 will override the NTP server configured on the PBX.
Time Zone
Choose the correct time zone according to your location.
Update Time Zone List
Clicking this button updates the list of timezones.
Scheduled Update
Configure schedule time zone update.
Set Date and Time
To manually set the time on the UCM630X, go to Web GUI🡪SystemSettings🡪Time Settings🡪Set Date and Time. The format is YYYY-MM-DD HH:MM:SS.
Time Auto Updating
Note: Manually setup time will take effect immediately after saving and applying change in the Web GUI. If users would like to reboot the UCM630X and keep the manually setup time setting, please make sure “Remote NTP Server”, “Enable DHCP Option 2” and “Enable DHCP Option 42” options under Web GUI>Settings>Time Settings>Auto Time Updating page are unchecked or set to empty. Otherwise, time auto updating settings in this page will take effect after reboot.
NTP Server
The UCM630X can be used as an NTP server for the NTP clients to synchronize their time with. To configure the UCM630X as the NTP server, set “Enable NTP server” to “Yes” under Web GUI > SystemSettings > Time Settings > NTP Server. On the client side, point the NTP server address to the UCM630X IP address or host name to use the UCM630X as the NTP server.
Office Time
On the UCM630x, the system administrator can define “office time” which can be used to configure time condition for extension call forwarding and inbound rules. To configure office time, log in to the Web GUI, enter the System Settings > Time Settings > Office Time, and click the “Add” button to see the following configuration page.
Create New Office Time
Start Time
Configure the start time for office hour.
End Time
Configure the end time for office hour
Week
Select the workdays in one week.
Show Advanced Options
Check this option to show advanced options. Once selected, please specify “Month” and “Day” below.
Month
Select the months for office time.
Day
Select the workdays in one month.
Create New Office Time
Select “Start Time”, “End Time” and the day for the “Week” for the office time. The system administrator can also define month and day of the month as advanced options. Once done, click on “Save” and then “Apply Change” for the office time to take effect. The office time will be listed in the web page as the figure shows below.
Settings🡪Time Settings🡪Office Time
Click on to edit the office time.
Click on to delete the office time.
Click on “Delete” to delete multiple selected office times at once.
Holiday
On the UCM, the system administrator can define Holidays, which can be used by Inbound Routes, Call Forwarding, and other time based features such as Paging/Intercom. To configure holidays, log in to the Web GUI and navigate to System Settings→Time Settings→Holiday.
From this page, the administrator can:
Configure new new holidays using the “Add” button.
Edit existing holidays by clicking the “Edit” icon for a specific holiday.
Delete a single holiday by clicking the “Delete” icon.
Delete multiple holidays at once by selecting them and clicking the “Delete” button.
Import holiday configurations using the “Import” button.
Export holiday configurations using the “Export” button.
Holiday Settings
When creating/editing a holiday, users can configure the parameters described in the table below:
Create a New Holiday Entry
Name
Specifies the name of the holiday. Used to identify the holiday in related features.
Description
Optional description for the holiday.
Year
Specifies the year in which the holiday applies. Select Allto configure a recurring annual holiday.
Month
Select the month in which the holiday occurs.
Configuration Method
Defines how the holiday date is determined. The options are:
By Date: Used for holidays with a fixed calendar date.
By Week: Used for holidays defined by a weekday pattern within a month (for example, the fourth Thursday of a month).
Day
Displayed when Configuration Method is “By Date”. Choose one or more calendar dates within the selected month to be treated as holidays.
Sequence
Displayed when Configuration Method is “By Week”. Select the occurrence of the weekday within the month, such as First, Second, Third, Fourth, or Fifth.
Week
Displayed when Configuration Method is “By Week”. Select the day of the week (Sunday through Saturday).
Time
Specifies the effective time range of the holiday. The holiday is active from the start time to the end time on the configured date(s).
Custom Time Groups
Users can create custom time frames which can be used as a routing condition in the inbound routes. Multiple time ranges can be added and the frequency can be customized to be every specific weekday or every specific day/week of the selected months.
To access Custom Time Groups, please navigate to System Settings > Time Settings > Custom Time Groups
Custom Time Groups
Parameter
Description
Name
Enter the name of the time group.
Description
Enter the description of the time group.
Time Groups
Time
Select the time period for this group.
Frequency
Select the frequency of this group per week/month.
Email Settings
Email Settings
The Email application on the UCM630X can be used to send out alert event Emails, Voicemail (Voicemail-To-Email) etc. The configuration parameters can be accessed via Web GUI🡪SystemSettings🡪Email Settings🡪Email Settings.
Parameter
Description
Mail Server Providers
Select the mail server provider type.
Common: Select this option when integrating email service such as Gmail and on-premise email servers.
Microsoft: Select this option when integrating email service provided by Microsoft Outlook.
Note: The settings below appear when selecting "Common".
TLS Enable
If enabled, TLS will be used when forwarding emails to the SMTP server.
Type
MTA: Mail Transfer Agent. The configured domain will be used in the sender address. Warning: Emails sent by MTA may be considered spam by the destination SMTP server.
Client: Send emails to the configured SMTP server, which will then forward the emails to the destination address.
Email Template Sending Format
Select the email template format to be sent. The "HTML" format is compatible with most mail clients and is recommended. If the mail client does not support the "HTML" format, please select the "Plain Text" format.
SMTP Server
Enter the SMTP server. For example, smtp.mydomain.com:587. Port number is optional.
Enable SASL Authentication
Toggles SASL authentication. If disabled, IPPBX will not use the username and password for email client authentication. Most email servers require login authentication while private email servers may allow anonymous login. If using Microsoft Exchange Server or if credentials are not required, please disable this option.
Username
Enter the username of the email account.
Password
Enter the password of the email account. It is highly recommended to use HTTPS when saving and applying password changes.
Enable Email-to-Fax
Monitors the inbox of the configured email address for the specified subject. If detected, the IPPBX will get a copy of the attachment from the email and send it to the XXX extension by fax. The attachment must be in PDF/TIF/TIFF format.
Email-to-Fax Blocklist/Allowlist
The user can enable the Email-to-Fax Blacklist or Email-to-Fax Whitelist.
Email-to-Fax Subject Format
Select the email subject format to use for emails to fax. XXX refers to the extension that the fax will be sent to. This extension can only contain numbers.
Fax Sending Success/Failure Confirmation
If enabled, the UCM will send an email notification to the sender about the fax sending result.
Internal Block/Allowlist
Email address blacklist/whitelist for local extensions.
This option is displayed after enabling Email-to-Fax Blocklist/Allowlist.
External Blocklist/Allowlist
Email address blacklist/whitelist for non-local contacts. Separate multiple addresses with semicolon (;) (i.e.”xxx;yyy”).
This option is displayed after enabling Email-to-Fax Blocklist/Allowlist.
POP/POP3 Server Address
Enter the IP address of the POP/POP3 server.
POP/POP3 Server Port
Enter the port of the POP/POP3 server.
Display Name
Enter the name of the PBX that will be displayed in sent emails.
Sender
Enter the email used to send the emails.
Email Settings
Use "Test" button to test if the email integration is working correctly.
Note: Before running the test, please save the configuration first by clicking on "Save" then "Apply Changes".
Parameter
Description
Mail Server Providers
Select the mail server provider type.
Common: Select this option when integrating email service such as Gmail and on-premise email servers.
Microsoft: Select this option when integrating email service provided by Microsoft Outlook.
Note: The settings below appear when selecting "Microsoft".
Server Authorization
Redirect URIs
Enter a redirect URI which will receive the OAuth2 token. Make sure that the URI is secure and is accessible.
Tenant ID
Enter the ID of the tenant of the directory in Microsoft Entra
Username
Enter Microsoft Entra login username.
Application (Client) ID
Enter the ID of the application created on Microsoft Entra
Client Password
Enter the client secret of the application created on Microsoft Entra.
Email Delivery Settings
Email Template Sending Format
Select the email template format to be sent. The "HTML" format is compatible with most mail clients and is recommended. If the mail client does not support the "HTML" format, please select the "Plain Text" format.
Display Name
Enter the name of the PBX that will be displayed in sent emails.
Email Settings
Use "Test" button to test if the email integration is working correctly.
Note: Before running the test, please save the configuration first by clicking on "Save" then "Apply Changes".
The following figure shows a sample Email setting on the UCM630X, assuming the Email is using 192.168.6.202 as the SMTP server.
UCM630X Email Settings
Once the configuration is finished, click on “Test”. In the prompt, fill in a valid Email address to send a test email to verify the Email settings on the UCM630X.
Email Template
The Email templates on the UCM630X can be used for email notification, the configuration parameters can be accessed via Web GUI→System Settings→Email Settings→Email Templates.
On this page, users can customize email templates for password reset, voicemail, meeting scheduling, extensions, fax, meeting report, PMS, CDR, emergency call, missed calls, alert events, call queue statistics and etc.
Click on the “Edit” icon to edit the template.
For more detailed information about each template variable and Email configuration, please refer to the Email Templates Guide.
Email Template
Email Footer Hyperlink
Under UCM Web GUI🡪System Settings🡪Email Settings🡪Email Footer Hyperlink, users could edit the text and URL to modify the email footer hyperlink.
Email Footer Hyperlink
Email Send Log
Under UCM Web GUI🡪System Settings🡪Email Settings🡪Email Send Log, users could search, filter, and check whether the Email is sent out successfully or not. This page will also display the corresponding error message if the Email is not sent out successfully.
Email Send Log
Start Time
Enter the start time for the filter
End Time
Enter the end time for the filter
Receivers
Enter the email recipient, while searching for multiple recipients, please separate them with a comma and no spaces.
Send Result
Enter the status of the send result to filter with
Return Code
Enter the email code to filter with
Email Send Module
Select the email module to filter with from the drop-down list, which contains:
All Modules
Extension
Voicemail
Conference Schedule
User Password
Alert Events
CDR
Test
Email Log – Display Filter
Email logs will be shown at bottom of the “Email Send Log” page, as shown in the following figure.
Email Logs
Below are the codes returned when sending emails and their description:
Email Codes:
Code
Description
250
Mail sent successfully
501
Address format parsing error, 501 will be returned when there are unacceptable characters in the recipient’s email address in MTA mode. Please check if the recipient’s email address format is correct. The “sender” configured on the client is your mail account.
535
The username and password verification in the client mode is incorrect. Please check whether the username and password are configured correctly.
550
Possible reasons:
The recipient’s mailbox username does not exist or is in a banned state, please check whether the email recipient is the correct email address.
The number of destination addresses sent by the sender exceeds the maximum limit per day and is temporarily blacklisted. Please reduce the sending frequency or try again the next day.
The sender’s IP does not pass the SPF permission test of the sending domain. Emails sent in MTA mode may return this error code even if they are sent.
552
The sent email is too large or the email attachment type is prohibited
553
The sender and the email account are inconsistent, please configure the sender as your email account correctly.
554
The email was identified as spam. Please reduce the sending frequency or try again the next day
none
This indicates that there is no return code.
If the sending result is “deferred”, the general reason is that the mail service area is configured incorrectly. Please check whether the server configuration is correct.
If the sending result is “bounced”, the general reason is that the receiving email address domain name is wrong, please check whether the email recipient is the correct email address. If it is in MTA mode, please check whether the “domain” is configured to be in the same domain name as the “recipient”.
HA
Dual-system hot standby provides a highly reliable and fault-tolerant solution for enterprises using the UCM6300 series/UCM6300A series. Based on two UCM devices of the same product model and software version, one of them is in the “Active” working state in real-time, and the other is in the “Standby” working state. The daily data on the host server will be synchronized to the standby machine in real-time, and the standby machine always monitors the running status of the host. When the host fails, including hardware failures and severe software failures, the standby machine will immediately take over the business and enter the “Active” working state, and Upgrade to a host to ensure that the business is not interrupted, and the call will automatically resume.
The HA function provides two modes of operating. The first mode of function is Local Hot Standby, which offers a deployment that switches dynamically when the primary UCM encounters an issue. The second mode is Remote Disaster Recover, it offers deploying a back up UCM remotely, this offers an architecture that would not be affected by any disaster that might occur on the geolocation of the primary UCM.
Important Note
In order to set HA, both UCMs should have static IP addresses.
HA Settings
The users can configure the HA under System Settings→HA settings page.
Local Hot Standby Settings
This table describes parameters used when configuring local HA between two UCM systems within the same site.
Parameter
Description
High Available Enable
Enables/disables the HA functionality. By default, it’s disabled.
Force Switch
Clicking the button will immediately force a switchover to the standby UCM.
Hot Standby Station Type
Used for the initial assignment of the HA active/standby role of the UCM system. If set to Primary, the current UCM system will be assigned as the intial active device. If set to Secondary, the peer UCM system will be assigned as the initial standby device. The roles of the UCM systems may change as HA switchovers occur.
Hot Standby Cluster IP
Used in single-NIC mode. This is the shared virtual IP address used by both active and standby UCMs. The IP must be static and must not match the local IP of either device.
Hot Standby Cluster IP 1
Displayed in Dual-NIC mode. Cluster virtual IP used for the LAN1 subnet. Mandatory. Must not match the local LAN1 IP and must be unique.
Hot Standby Cluster IP 2
Displayed in Dual-NIC mode. Cluster virtual IP used for the LAN2 subnet. Mandatory. Must not match the local LAN2 IP and must be unique.
Hot Standby Peer IP
Local IP address of Hot Standby peer device.
Hot Standby Peer MAC Address
The MAC address of Hot Standby peer device.
Heartbeat Port
The number of the heartbeat port should be consistent with the peer heartbeat port.
Heartbeat Timeout Period (s)
Upon timeout, the Standby UCM will take over services.
Network Detection
Enable/Disable Network Detection feature. When enabled, the active device continuously checks reachability to the configured detection node(s).
If the active device loses connectivity to any configured detection node a switchover is triggered and the standby device assumes the active role.
Note: HA settings on both the active and standby UCM must be consistent. In case of inconsistency, the settings on the active device will be prioritized.
Network Detection Node
Displayed in Switch and Route mode. If connectivity to this node is lost on the active device, a switchover is triggered.
Notes:
The standby device does not initiate switchover on its own.
Only IP addresses are supported.
For correct operation, this setting must be configured identically on active and standby devices.
Network Detection Node 1
Displayed in Dual mode. This detection node associated with Cluster IP1 / LAN1. If connectivity to this node is lost on the active device, a switchover is triggered.
Notes:
The standby device does not initiate switchover on its own.
Only IP addresses are supported.
For correct operation, this setting must be configured identically on both devices.
Network Detection Node 2
Displayed in Dual mode. Detection node associated with Cluster IP2 / LAN2. If configured, loss of connectivity to this node on the active device will also trigger a switchover.
Notes:
The standby device does not initiate switchover on its own.
Only IP addresses are supported.
For correct operation, this setting must be configured identically on both devices.
Software Fault Switch
Enable Software Fault Switch.
Hardware Fault Switch
If issues are detected with the selected connection interfaces, the backup UCM will take over services after the master/slave handover. If not checked, UCM will send only a fault alarm.
Enable IPv6
If enabled, HA on UCM can be used with IPv6 while compatible with IPv4.
Scan External Storage Files
Only applicable if there are more than 5000 UCM files in external storage such as SD card, USB, or NAS. Users can click this button to scan those paths in order to display all available files on the UCM web UI. Configured file storage paths can be viewed on the File Manager page.
It is recommended to configure external storage data synchronization when forming HA for the first time, If HA is configured, files created after HA setup will be automatically displayed on the UCM web UI and do not need to be scanned for.
Local Hot Standby
The table below describes parameters used for Remote Disaster Recovery HA, where two UCM systems are deployed at different sites.
Remote Disaster Recovery Settings
Parameter
Description
Network Port Domain Name
Selects the network domain used for remote disaster recovery. In single NIC mode, available options are WAN and LAN. In dual NIC mode, available options are LAN1 and LAN2, corresponding to the two physical LAN interfaces.
Force Switch
Clicking the button will immediately force a switchover to the standby UCM.
Remote Disaster Recovery Station Type
Used for the initial assignment of the HA active/standby role of the UCM system. If set to Primary, the current UCM system will be assigned as the intial active device. If set to Secondary, the peer UCM system will be assigned as the initial standby device. The roles of the UCM systems may change as HA switchovers occur.
Remote Disaster Recovery Peer MAC Address
The MAC address of Remote Disaster Recovery peer device
Heartbeat Port
The heartbeat port should be the same as the peer device’s heartbeat port.
Heartbeat Timeout Period (s)
Upon timeout, the Standby UCM will take over services.
Local Heartbeat IP
Fill in the IP address of the heartbeat port of the local site, in the format: xxx.xxx.xxx.xxx, which is used for the peer end to detect the local machine status, heartbeat negotiation, and communication address for data synchronization.
Local Heartbeat Gateway IP
Fill in the IP address of the local heartbeat gateway for remote disaster recovery, in the format: xxx.xxx.xxx.xxx
Local Heartbeat Address Subnet Mask
Fill in the subnet mask of the heartbeat address of the remote disaster recovery local end, in the format: xxx.xxx.xxx.xxx, such as: 255.255.255.0.
Peer Heartbeat IP
Fill in the IP address of the heartbeat port of the peer site, in the format: xxx.xxx.xxx.xxx, which is used to detect peer status, heartbeat negotiation, and communication address for data synchronization.
Network Detection
Enable/Disable Network Detection feature. When enabled, the active device continuously checks reachability to the configured detection node(s).
If the active device loses connectivity to any configured detection node a switchover is triggered and the standby device assumes the active role.
Note: HA settings on both the active and standby UCM must be consistent. In case of inconsistency, the settings on the active device will be prioritized.
Network Detection Node
Displayed in Switch and Route mode. If connectivity to this node is lost on the active device, a switchover is triggered.
Notes:
The standby device does not initiate switchover on its own.
Only IP addresses are supported.
For correct operation, this setting must be configured identically on both devices.
Network Detection Node 1
Displayed in Dual mode. This detection node associated with Cluster IP1 / LAN1. If connectivity to this node is lost on the active device, a switchover is triggered.
Notes:
The standby device does not initiate switchover on its own.
Only IP addresses are supported.
For correct operation, this setting must be configured identically on both devices.
Network Detection Node 2
Displayed in Dual mode. Detection node associated with Cluster IP2 / LAN2. If configured, loss of connectivity to this node on the active device will also trigger a switchover.
Notes:
The standby device does not initiate switchover on its own.
Only IP addresses are supported.
For correct operation, this setting must be configured identically on both devices.
Scan External Storage Files
Only applicable if there are more than 5000 UCM files in external storage such as SD card, USB, or NAS. Users can click this button to scan those paths in order to display all available files on the UCM web UI. Configured file storage paths can be viewed on the File Manager page.
It is recommended to configure external storage data synchronization when forming HA for the first time, If HA is configured, files created after HA setup will be automatically displayed on the UCM web UI and do not need to be scanned for.
Remote Disaster Recovery
HA Status
Once the HA is configured, the user can view its status under System Settings 🡪 HA 🡪 HA Status as shown below
HA Status
HA Log
The user can view the HA log through the system settings 🡪 HA 🡪 HA log page. The HA log effectively records the execution results of past full backup actions, as well as the history records that triggered the active/standby switchover.
Note
The UCM63xx series suppots SNMP to be able to use 3rd party monitoring tools to monitor both UCMs in HA setup.
Cluster
Clustering allows the user to deploy many units in the same environment to handle telephony features collectively. This allows the user to enact a system that is capable with a higher processing bandwidth that many calls require. By clustering multiple UCM devices, the system will be able to offer more concurrent calls and meeting participants.
Important
Cluster feature is supported only on the UCM6304 and UCM6308
The user can deploy a maximum of 5 media servers.
Each cluster deployment requires at least one business server and one media server.
To configure the cluster, we will need two types of servers; a Business server, which is a one and only server that will be used for the administration of the operations. And a media server, which can either be one singular server, or for deployments that require more resource, the user can deploy up to 5 UCM units as media server. Media server will handle media related traffic.
Notes
All the UCM units that form the media cluster must be under the same switch, and their IP addresses must be in the same network segment.
The Business server and the Media servers must use the same firmware version.
Please ensure that IP addresses reservation is created for the business server and the media server(s) in the DHCP server to ensure that the servers will use the same IP addresses to communicate. In the case the IP addresses have been changed, the cluster needs to be rebuilt.
Business Server
To configure Business server, please access the UCM web UI then navigate to System Settings > Cluster, then tick the option “Enable Media Cluster”, and choose “Business Server” as the Device Role.
Parameter
Description
Enable Media Cluster
Enable Media Cluster feature.
Device Role
Configure the device role.
Business Server: Choosing this role will make the UCM as the main server for operations.
Media Server: Choosing this role will make the UCM as a media server only. All the PBX related features will be disabled.
Multicast Network Port
Choose the network port which will be used for the multicast.
Multicast IP Address
The allowed multicast IP address range is 224.0.1.0 - 238.255.255.255
Multicast Address Port Start Value
Enter the multicast address port start value. The port number value can be within the range 1024 - 65535.
Note: The multicast address port start value must be lower or equal to the multicast address port end value.
Multicast Address Port End Value
Enter the multicast address port end value. The port number value can be within the range 1024 - 65535.
Note: The multicast address port end value must be greater or equal to the multicast address port start value.
Business Server Listening Port
The port on which the business server listens and receives information reported by the media server. The value of the listening port value can be within 1024 - 65535.
Sync Media NAT Traversal Settings
If enabled, all media servers in the cluster will use the same Media NAT Traversal settings as the business server. If disabled, each server will need to be configured individually.
Media Server IP
Enter the IP address of the media server. The user can pair up to 5 media servers with one Business server.
The statuses of the media servers are indicated using three colors:
Green: The server is available.
Yellow: The server is in use.
Gray: The server is offline.
Memory Usage Threshold (%)
When the memory usage of this media server is exceeded, media services will be assumed by another media server in the cluster with the lowest usage at the time.
CPU Usage Call Control Threshold (%)
When the CPU usage of this media server is exceeded, media services will be asssumed by another media server in the cluster with the lowest usage at the time.
Memory Usage Threshold (%)
When this server's memory usage exceeds the specified threshold, service from this server will be temporarily paused.
CPU Usage Call Control Threshold (%)
When this server's CPU usage exceeds the specified threshold, service from this server will be temporarily paused.
Disk Available Space (MB)
When the percentage of available space in the device's disk data partition falls below the set value, this server will not be used until the amount of available space is above the threshold again.
Media Server
To configure Media server, please access the web UI then navigate to System Settings > Cluster, then tick “Enable Media Cluster”.
Enable Media Cluster
Enable Media Cluster feature.
Device Role
Configure the device role.
Business Server IP and Port
Enter the IP address of the business server with the listening port.
If the business server is using HA Local Hot Standby, the Hot Standby Cluster IP address must be used.
If the business server is using HA Remote Disaster Recovery, the primary UCM and secondary UCM must have their own respective cluster environments.
In order to avoid inconsistencies between the configurations of the media server and the business server in a cluster, the following configuration parameters can be synchronized:
Basic Call Features → Multimedia Meeting
For media servers, all the configuration options on this page are greyed out to display the information configured on the business server.
PBX Settings → SIP Settings → ToS
This page for media servers shows the RTP related configurations of the business server.
PBX Settings → RTP Settings
The following media NAT Traversal parameters will only be visible on the business server:
The remaining settings will be greyed out on the media server’s side. Only the configuration on the business server will be taken into consideration.
Note:
The SRTP Debugging option to allow decryption of packet captures will not be available on the media server under Maintenance → Network Troubleshooting → Ethernet Capture.
SNMP
SNMP integration in the UCM allows the administrator to monitor the components of the UCM remotely. SNMP is a useful integration to have a centralized monitoring dashboard that shows all the devices on your network, with that status of internal component. To configure the SNMP integration, please navigate to the web GUI of the UCM, then go to System Settings → SNMP → SNMP Settings
SNMP Settings
SNMP Settings
Enable
Tick this box to enable SNMP.
Device Name
Enter the device name.
Location
Enter the location.
Contact Email Address
Enter the email address used to send the SNMP alerts to.
Enable SNMP Trap Proxy
Tick this box to enable a proxy for SNMP Trap.
SNMP Trap Proxy Listening Port
The port number on which the SNMP Trap Proxy is listening on.
SNMP Community
You can also create SNMP communities and affect a certain level of access. An SNMP community is a group created to aggregate many management stations. The community name is used to authenticate and identify these machines in the NMS (Network Management System).
Create SNMP Community
Name
Enter a name for the community
Access Level
Select an access level:
Read Only: The SNMP community will be able only to read SNMP messages.
SNMP Traps Destination
SNMP Traps is a very useful feature when there are many network components to manage. Instead of sending requests to all the machines in the network in order to view their SNMP logs risking slowing down or bringing the network to a complete halt, SNMP Traps can be configured so these machines can send unrequested messages to the manager to notify it about critical events and general failures.
Create SNMP Trap Destination
Name
Enter a name of your SNMP Trap destination.
IP Address
Enter the SNMP Trap destination's IP address.
Port
Enter the port of the SNMP Trap destination.
Community
Select the community that you want
Type
Select the type of SNMP:
Trapsink: Select this option if you want to send SNMP v1 traps.
Trap2sink: Select this option if you want to send SNMP v2 traps.
Informsink: Select this option if you want to send "Inform" notifications only.
SNMP Version 3
UCM63xx also supports SNMP v3 in case the system administrator decides to add more security to the monitoring process. SNMP v3 is a very good solution to monitor devices that interface directly with Internet. SNMP v3 offers more security than its predecessors by hashing the authentication information, encrypting the SNMP messages exchanged between the managed devices and the network management system which prevent eavesdropping. Also, it prevents any data tampering which protects the integrity of the data exchanged.
SNMP V3 Configuration
Name
Set the user's name
Authentication Protocol
Select the authentication protocol:
MD5
SHA
Authentication Password
Set the authentication password.
Privacy Protocol
Select the protocol to use to encrypt the data
DES
AES-128
AES-192
AES-256
Privacy Password
Set the privacy password.
Group Level
Set the group level:
Read Only.
Read/Write.
SNMP Trap Proxy
SNMP Trap Proxy
Name
Enter a name for the proxy server.
IP Address
Enter the proxy server’s IP address.
Port
Enter the proxy server’s port.
RADIUS
The UCM6300 offers Radius-based authentication for the super administrator and other administrators. This requires configuring a Radius server then enabling Radius client on the UCM6300 which can be found under System Settings → RADIUS
Enable Radius Web Access Control
Enable or disable Radius.
As Default Login Method
Enable Radius as the default login method to the web UI of the UCM
Radius Auth Server Address
Enter the IP¨address/hostname of Radius server.
Radius Auth Server Port
Enter the port of radius server
Default port number is: 1812
Radius Shared Secret
Enter Radius Shared Secret
Maximum Number of Retransmission
Enter the number of retransmissions. The interval is 1 to 5.
Radius Timeout (s)
The maximum seconds before a session expires if there is no response from the server. The interval is between 1 to 30 seconds.
TR-069
To configure TR-069 on Grandstream devices, set the following parameters:
Parameter
Description
Enable TR-069
Toggle it on to enable TR-069. It is enabled by default
ACS URL
URL for TR-069 Auto Configuration Servers (ACS), e.g., http://myacs.grandstream.com
TR-069 Username
ACS username for TR-069 must be the same as in the ACS configuration.
TR-069 Password
ACS password for TR-069 must be the same as in the ACS configuration.
Verify ACS Server
Enables verification of the server certificate when interacting with GDMS. For security purposes, it is recommended to enable this option. However, verification is not needed for self-signed certifications.
Enable Periodic Inform
If enabled, Inform messages will be sent periodically based on the Inform Interval value.
Enable Periodic Inform
Enables periodic inform. If set to Yes, the device will send inform packets to the ACS.
Inform Interval (s)
A periodic time when PBX will send inform packets to TR-069 ACS server
This option is specified in seconds.
The default value is 86400.
ACS Connection Request Username
The username for the ACS to connect to PBX.
ACS Connection Request Password
The password for the ACS to connect to the PBX.
ACS Connection Request Port
Port for incoming connection requests.
The default value is 7547.
CPE Cert File
The Cert file for PBX to connect to the ACS via SSL.
CPE Cert Key
The Cert key for PBX to connect to the ACS via SSL.
CONTACTS
Address book management is under UCM web UI->Maintenance, and it has two sections “Contact Management” and “Department management”.
Contact Management
Contact management page displays extension contacts and external contacts information.
Extension contacts
Extension contacts page shows all the extensions that has “Sync Contact” option enabled in extension settings page. The extension contacts here can be edited or deleted individually or in batch. No new extension contact can be added directly from this page. If an extension contact is deleted from this page, “Sync Contact” option is disabled from this extension. This will not delete the extension from UCM.
Note
“Delete” extension contact will only remove this extension from extension contact page and it will not sync to contacts on UCM. The extension itself still exists on UCM.
Extension Contacts
Note
“Delete” extension contact will only remove this extension from extension contact page and it will not sync to contacts on UCM. The extension itself still exists on UCM.
Click Edit icon to configure name, department, email address and etc for each extension contact.
Edit Extension Contact
Extension
Displays extension number.
First Name
Configure first name for the extension contact.
Last Name
Configure last name for the extension contact.
Department
Select department for the extension contact. Department can be created in “Department Management” page.
Department Title
Configure the job title for the extension contact.
Email Address
Configure email address for the extension contact.
Mobile Phone Number
Configure mobile phone number for the extension contact.
Home Number
Configure home number for the extension contact
Fax
Configure Fax for the extension contact.
Same as Department Contact Privileges
When this option is enabled, the contact extension will inherit the same privilege as the department it belongs to.
Contact View Privileges
This option allows configuring privileges for the contact extension.
Note: This option will be disabled if "Same as Department Contact Privileges" has been enabled.
External contacts
On external contacts page, the admin can create single external contact, import contacts in batch, edit contacts, delete contacts and export contacts.
External Contacts
Click on “Export” icon, a file will be generated with the current external contacts.
Click on “import” icon, then follow the steps below to add external contacts in batch:
Step 1: For option “On Duplicate External Contacts”, select whether to skip duplicate contact on the imported CSV file or update the duplicate UCM contact with the information in the CSV.
Step 2: Choose file from local PC to upload.
Step 3: Click on “Upload”.
Step 4: Click on “Apply” to complete importing external contacts.
Import External Contacts
Department Management
Departments are organizational units that allows organizing extensions within groups that specify the specialty of a the extension owners within a company. This makes finding contacts easier within the UCM contact books.
Department Management
Click on “Add” to create a new department. Configure the department name and select the superior department. By default the superior department is the root directory. If the UCM has cloud IM configured, the root directory will be the department in cloud IM.
On the department list:
Click on to create sub department.
Click on to add member to the department.
Click on to edit the department.
Edit Department
If the UCM has Cloud IM enabled and configured, the following options will be available:
Set as Shared Department: Toggles the shared status of the department. If there are existing cross-server members in this department, this option will be grayed out.
Share to Following Sites: Select the sites (servers) to that will be allowed to move their extensions in and out of the shared deparmtent.
Apply Settings to Sub-Level Departments: Only available when editing an exisiting deparmtent. Apply the same sharing settings to its sub-department. If a department has sharing enabled and is configured to be shared with specific sites, its sub-department will also have sharing enabled and be shared with the same sites.
Shared departments can be distinguished by an icon next to their name.
Shared Department Symbol
There are 3 potential marks in the center of that icon that represent the permission level that the current UCM has for that site
: The + symbol indicates that the current UCM is the creator of the shared department. It has full management priviliges over it, which include the ability to edit it, delete it, add sub-departments under it, add its own extensions to it and remove any extensions from it, including extensions from other servers.
: The checkmark symbol indicates that the department was shared to the current UCM has been authorized to move its own extensions in and out of department.
: No symbol indicates that the department is from a UCM that is under the same Cloud IM account as the current UCM, but it has not been shared to the current UCM for management. The current UCM can only view this shared department and its members but cannot interact with it unless the shared depratment has the current UCM’s extensions as members. In this case, the current UCM can still remove members from the shared department.
Notes
Removing a member from a shared department will move it to the root directory of its original site.
A shared department cannot be deleted unless all cross-server memebers are removed from it
If a UCM with a shared depratment no longer wants to use CloudIM, it must first do the following:
If there are no cross-server memebers in its shared departments, it must set them as local departments and assign new parent departments to them.
If there are existing cross-server members in its shared departments, it must assign the shared departments to another site for management.
Assign Shared Department
If the UCM re-enables Cloud IM, it will not reclaim ownership of its original shared departments.
Note
The user can create up to 100 departments with up to 4 levels of nested departments.
Important
To be able to use shared department, the UCM devices will have to be subscribed to a RemoteConnect plan that offers Cloud IM service. For more information please refer to: https://ucmrc.gdms.cloud/plans
Shared Departments
Share departmens offer a centralized way for administrators to manage departments and members across multiple servers using the same Cloud IM account. To get started, make sure that the UCM has Cloud IM enabled and configured. Then, navigate to Contacts →Department Management, then add/edit a specific department.
Tick the option Set as Shared Department, then select the sites to which the department will be shared. If the user wishes to apply the same sharing settings to the departments nested under the parent department, please tick the option Apply Settings to Sub-Level Departments.
Edit Department
Privilege Management
The user can configure custom privileges other than the default ones (All contacts, Departments and sub-departments contacts). These custom privileges allow more flexible ways of allowing contacts to view all or specific contacts from other departments.
UCM admin can add or edit Privilege Management; under UCM web UI🡪Contacts Privilege Management, there are 2 default privileges:
Visible to all contacts.
Only the contact person’s department and sub-department contacts are visible.
When Cloud IM is enabled on the UCM, a third privilege becomes available to choose:
Local Contacts: Restricts the contacts shown to the contacts of the local UCM.
Privilege Management
DEVICE MANAGEMENT
Onsite Meeting
For workplaces that require employees to return to physical offices for work, The UCM6300 Series offers the Onsite Meetings feature, a new way to stay organized and keep up-to-date with in-person meetings. This feature allows administrators to create and manage onsite meeting rooms, specify meeting room locations, schedule meetings, and add conferencing equipment. The new feature can be found under the Device Management > Onsite Meeting page. The first page that appears is the Scheduled Meetings page and tab page, which provide an overview of all created meeting rooms. It provides information about the rooms’ meeting schedules for the day, their locations, their member capacity, and their equipment.
Schedule Onsite Meetings
The Pending Meeting tab and Meeting History tab show detailed information about upcoming meetings and previous meetings respectively. From the Pending Meeting tab, users can delete upcoming meetings and extend the duration of ongoing meetings. The Meeting History tab will display the last 6 months of onsite meetings.
Pending Onsite Meetings
When a meeting is scheduled the invitees will receive an invitation via email which contains all the information regarding the onsite meeting. The email will be attached with an .ics file which can be imported to a calendar to mark your calendar of the onsite meeting, please see the screenshot below.
Onsite Meeting Email Invitation
IP Camera Devices
The UCM admin can add IP camera devices and edit accessible extensions so these extensions can view the surveillance streams for the IP camera devices.
Click on “Add” to add IPC device.
IPC Devices
IPC Devices Settings
Device Number
The number that allowed members can dial to access the IP camera.
Device Name
Enter the name that you want to allocate for the device.
Protocol
The media control protocol used.
RTSP
IP Address
Enter the IP address of the IP camera.
Port
Enter the port of the IP camera. The default is 554
Channel Path
If you want to view the stream of the specified channel, please configure the path of this stream.
Username
If a username and password are set on this device, fill in this field to allow the UCM to access the device.
Password
If a username and password are set on this device, fill in this field to allow the UCM to access the device.
Transmission Protocol
Transport protocol of the IP camera. Default is UDP.
Heartbeat Detection
If enabled, the PBX will regularly send RTSP OPTIONS to check of the device is still online.
Allowed Members
Extensions, Extension Groups, and Departments can be selected to access this IP camera by dialling the configured Device Number.
Zero Config
Overview
Grandstream SIP Devices can be configured via Web interface as well as via configuration file through TFTP/HTTP/HTTPS download. All Grandstream SIP devices support a proprietary binary format configuration file and XML format configuration file.
The UCM630x provides a Plug and Play mechanism to auto-provision the SIP devices in a zero-configuration manner by generating an XML config file and having the device download it within the LAN area. This allows users to finish the installation with ease and start using the SIP devices in a managed way.
Zero Config supports centralized provisioning for Grandstream SIP devices and selected third-party enterprise SIP phones. Supported third-party devices can be discovered, configured, and managed using the same Zero Config workflow, except where explicitly limited.
To provision a phone, three steps are involved, i.e., discovery, configuration, and provisioning. This section explains how Zero Config works on the UCM630x. The settings for this feature can be accessed via Device Management→Zero Config.
Zero Config Supported Devices
The following table lists all Grandstream and third-party SIP device series that support Zero Config.
Note:
Availability of specific models depends on whether the corresponding model template package is installed.
Vendor
Supported Device Series
Grandstream
GXP Series
GRP Series
GXV Series
GHP Series
GVC Series
GAC Series
GSC Series
GDS Series
GXW Series
HT Series
DP Series
WP Series
Cisco
CP-78xx
CP-88xx
DP-98xx
Poly
Edge-E
Edge-B
VVX (non-OBi)
Yealink
AX Series
T4 Series
T5 Series
T7 Series
T8 Series
Configuration Architecture for Endpoint Device
The end point device configuration in ZeroConfig is divided into the following three layers with priority from the lowest to the highest:
Global
This is the lowest layer. Users can configure the most basic options that could apply to all SIP devices during provisioning via Zero config.
Model
In this layer, users can define model-specific options for the configuration template.
Device
This is the highest layer. Users can configure device-specific options for the configuration for the individual device here.
Each layer also has its own structure at different levels. Please see the figure below. The details for each layer are explained in sections [Global Configuration], [Model configuration] and [Device Configuration].
Zero Config Configuration Architecture for End Point Device
The configuration options available in the Model and Device layers fully include those defined in the Global layer. In other words, the Global layer options are a subset of the options available at both the Model and Device layers.
When the same option is configured in multiple layers with different values, the value from the higher-priority layer overrides those from lower-priority layers. Layer priority is as follows (from lowest to highest): Global→Model→Device.
Example: if English is selected as the language in the Global Policy, and Spanish is selected in the Default Model Template, the device being provisioned will use Spanish, because the Model layer has higher priority than the Global layer.
Auto-Provisioning Settings
By default, the Zero Config feature is enabled on the UCM630x for auto-provisioning. Three methods of auto-provisioning are used.
UCM630X Zero Config
SIP SUBSCRIBE
When the phone boots up, it sends out SUBSCRIBE to a multicast IP address in the LAN. The UCM630x discovers it and then sends a NOTIFY with the XML config file URL in the message body. The phone will then use the path to download the config file generated in the UCM630X and take the new configuration.
DHCP OPTION 66
Route mode needs to be set to use this feature. When the phone restarts (by default DHCP Option 66 is turned on), it will send out a DHCP DISCOVER request. The UCM630X receives it and returns DHCP OFFER with the config server path URL in Option 66, for example, https://192.168.2.1:8089/zccgi/. The phone will then use the path to download the config file generated in the UCM630X.
To start the auto-provisioning process, under Device Management→Zero Config→Zero Config Settings, fill in the auto provision information.
Zero Config Settings Page
The table below explains all the configurable parameters that can be found on the Zero Config Settings page:
Basic Settings
Enable Zero Config
Enable or disable the zero-config feature on the PBX. The default setting is enabled.
Enable Automatic Configuration Assignment
By default, this is disabled. If disabled, when the SIP device boots up, the PBX will not send the SIP device the URL to download the config file, and therefore the SIP device will not be automatically provisioned by the PBX.
Manage 3rd Party Phones
This option controls whether third-party SIP phones can be provisioned using Zero Config. When enabled, port 69 (TFTP) and port 6970 (HTTP) are automatically opened on the UCM for non-encrypted provisioning communication.
Only the phone models listed under the [Zero Config Supported Devices] section can be provisioned using this feature.
To allow third-party SIP phones to be provisioned, configure the DHCP server in the phone’s network with the following options:
DHCP Option 66:UCM IP address
DHCP Option 160:http://<UCM-IP>:6970/zccgi
Notes :
All supported third-party enterprise phones share the same DHCP Option 66 and Option 160 configuration.
DHCP Option 66 and Option 160 must be placed before any other identical DHCP options in the DHCP server configuration.
HTTP provisioning traffic is not encrypted.
Port 6970 is reserved for Zero Config provisioning and cannot be modified.
Auto Assign Extension
Auto Assign Extension
If enabled, when the device is discovered, the PBX will automatically assign an extension within the range defined in “Zero Config Extension Segment” to the device. The default setting is disabled.
Zero Config Extension Segment
Click on the link “Zero Config Extension Segment” to specify the extension range to be assigned if “Automatically Assign Extension” is enabled. The default range is 5000-6299. Zero Config Extension Segment range can be defined in Web GUI→PBX Settings→General Settings→General page→Extension Preference section: “Auto Provision Extensions”.
Enable Pick Extension
If enabled, the extension list will be sent out to the device after receiving the device’s request. This feature is for the GXP series phones that support selecting extensions to be provisioned via the phone’s LCD. The default setting is disabled.
Pick Extension Segment
Click on the link “Pick Extension Segment” to specify the extension list to be sent to the device. The default range is 4000 to 4999. Pick Extension Segment range can be defined in Web GUI→PBX Settings→General Settings→Generalpage→Extension Preference section: “Pick Extensions”.
Pick Extension Period (hour)
Specify the number of minutes to allow the phones being provisioned to pick extensions.
Network Settings
Subnet Allowlist
This feature allows the UCM to provision devices in different subnets other than the UCM network.
Enter subnets IP addresses to allow devices within these subnets to be provisioned. The syntax is <IP>/<CIDR>.
Examples: 10.0.0.1/8, 192.168.6.0/24
Notes
Only private IP ranges(10.0.0.0 | 172.16.0.0 | 192.168.0.0) are supported.
Up to 10 subnets can be configured in the allowlist
Note:
Please make sure an extension is manually assigned to the phone or “Automatically Assign Extension” is enabled during provisioning. After the configuration on the UCM630x Web GUI, click on “Save” and “Apply Changes”. Once the phone boots up and picks up the config file from the UCM630X, it will take the configuration right away.
Discovery
SIP endpoints are automatically discovered after bootup. Users could also manually discover devices by specifying the IP address or scanning the entire LAN network. Three methods are supported to scan the devices.
PING
ARP
SIP Message (NOTIFY)
To start the discover process:
Click on “Auto Discover” under Device Management→Zero Config→Zero Config.
Choose the “Scan Method” and enter the “Scan IP”. The IP address segment will be automatically filled in based on the network mask detected on the UCM630X. If users need to scan the entire network segment, enter 255 (for example, 192.168.40.255) instead of a specific IP address.
Click on “Save” to start discovering the devices within the same network. To successfully discover the devices, “Zero Config” needs to be enabled on the Device Management→Zero Config→Auto Provisioning Settings.
Auto Discover
The following figure shows a list of discovered phones, displaying the MAC address, IP address, extension (if assigned), version, vendor, model, connection status, Create Config option, and available actions (Edit, Delete, Update, Reboot, and Access Device Web GUI).
Zero Config Main Page
Firmware
In the Firmware tab, users can upload and manage endpoint firmware. Upgrades are performed per device, not per MAC address.
Note:
The uploaded files must use the .bin extension and must not exceed 1.5 GB in size
Firmware Zero Config Page
After you click “Upload”, a window appears displaying the configuration parameters below.
Upload New Firmware Window
Enable: toggles whether the UCM will provision this firmware to endpoints if they are using the UCM as the firmware server. If not enabled, the UCM will reject requests from endpoints for this firmware.
Choose File to Upload: Select the firmware file to upload from the user’s PC. The file name must match the firmware file name requested by the endpoint.
Model: The device model for which this firmware is intended for. Only for self-reference and has no effect on provisioning.
Firmware: The firmware version of the file being uploaded. Only for self-reference and has no effect on provisioning.
Remark: Add a comment about the uploaded firmware. Only for self-reference and has no effect on provisioning.
Uploading Devices List
Besides the built-in discovery method on the UCM, users could prepare a list of devices on a xlsx or csv file and upload it by clicking on the button ”Import”, after which a success message prompt should be displayed.
Users need to make sure that the CSV file respects the format as shown on the following figure and that the entered information is correct (valid IP address, valid MAC address, device model, and an existing account), otherwise the UCM will reject the file and the operation will fail:
Device List CSV file Sample
Note
Please ensure that the file is encoded in UTF-8 to be able to import the devices correctly into the UCM.
Managing Discovered Devices
Users can manage the discovered devices in the Zero Config tab as follows:
Sorting: Press or to sort per MAC Address, IP Address, Version, Vendor, Model or Create Config columns from lower to higher or higher to lower, respectively.
Filter: Select a filter to display corresponding results. Users can filter by registration staus, models, or vendors. The “All” filter displays all discovered devices.
Search: Search in the list of discovered devices by model, extension number, MAC address, or IP address.
Add: Use the “Add” button to add a new device to the Zero Config database using its MAC address.
Delete: Use the “Delete” button delete selected devices from the Zero Config database.
Edit: Modify selected devices by clicking the “Edit” button.
Upgrade: Upgrade the software of the discovered devices to the latest version. Select the devices which you want to upgrade. If no devices are selected, all the discovered devices will be upgraded.
Update Config: Batch update a list of devices, the UCM on this case will send SIP NOTIFY message to all selected devices to update them at once.
Reboot: Use the “Reboot” option for selected devices (the selected devices should have provisioned extensions since the phone will authenticate the server sending the reboot command).
More: Perform additional action like:
Import: Import a list of devices. Devices with duplicate MAC addresses can either be skipped, replaced or updated. The imported file should be in CSV or XLSX format.
Export: Export the list of the discovered devices in CSV or XLS format. Select the devices before exporting. If no devices are selected, all the discovered devices will be exported.
Reset: Reset the discovered devices. Select the devices to reset before clicking this button. If no devices are selected, all the discovered devices will be reset to their initial configuration.
Copy: Copy the configuration across devices.
Managing Discovered Devices
Global Configuration
The global configuration will apply to all the connected SIP endpoint devices in the same LAN with the UCM630x regardless of the device model. It is divided into two levels:
Global Policy
Global Templates
Global Templates configuration has higher priority to Global Policy configuration.
Global Policy
Global Policy can be accessed in Device Management→Zero Config→Global Policy page. On the top of the configuration table, users can select a category in the “Options” dropdown list to quickly navigate to the category or they can also complete the configuration by importing/exporting. The categories are:
Localization: configure display language, data, and time.
Phone Settings: configure the dial plan, call features, NAT, call progress tones, etc.
Contact List: configure LDAP and XML phonebook download.
Maintenance: configure upgrading, web access, Telnet/SSH access, and Syslog.
Network Settings: configure the IP address, QoS, and STUN settings.
Customization: customize LCD screen wallpaper for the supported models.
Communication Settings: configure Email and FTP settings
Select the checkbox on the left of the parameter you would like to configure to activate the dropdown list for this parameter.
Global Policy Page
The following tables list the Global Policy configuration parameters for the SIP end device sorted by category.
Language Settings
Language
Select the LCD language on the SIP device.
Date and Time
Date Format
Configure the date display format on the SIP end device’s LCD.
Time Format
Configure the time display in 12-hour format on the SIP end device’s LCD.
Enable NTP
Enables NTP service.
NTP Server
Configure the URL or IP address of the NTP server. The SIP device may obtain the date and time from the server.
NTP Update Interval
Configure the NTP update interval.
Time Zone
Configure the time zone used on the SIP end device.
Enable Daylight Time
Select either to enable or disable the DST.
Global Policy Parameters – Localization
Default Call Settings
Dial Plan
Configure the default dial plan rule. For syntax and examples, please refer to the user manual of the SIP devices to be provisioned for more details.
Enable Call Features
When enabled, “Do Not Disturb”, “Call Forward” and other call features can be used via the local feature code on the phone. Otherwise, the ITSP feature code will be used.
Use # as Dial Key
If set to “Yes”, pressing the number key “#” will immediately dial out the input digits.
Auto Answer by Call-info
If set to “Yes”, the phone will automatically turn on the speaker phone to answer incoming calls after a short reminding beep, based on the SIP Call-Info header sent from the server/proxy.
The default setting is enabled.
NAT Traversal
Configure if NAT traversal mechanism is activated.
User Random Port
If set to “Yes”, this parameter will force random generation of both the local SIP and RTP ports.
General Settings
Call Progress Tones
Configure call progress tones including ring tone, dial tone, second dial tone, message waiting tone, ring back tone, call waiting tone, busy tone, and reorder tone using the following syntax:
Frequencies are in Hz and cadence on and off are in 10ms).
“on” is the period (in ms) of ringing while “off” is the period of silence. Up to three cadences are supported.
Please refer to the user manual of the SIP devices to be provisioned for more details
HEADSET Key Mode
Select “Default Mode” or “Toggle Headset/Speaker” for the Headset key. Please refer to the user manual of the SIP devices to be provisioned for more details.
Global Policy Parameters – Phone Settings
LDAP Phonebook
Source
Select “Manual” or “PBX” as the LDAP configuration source.
If “Manual” is selected, the LDAP configuration below will be applied to the SIP end device.
If “PBX” is selected, the LDAP configuration built-in from UCM630X Web GUI🡪System Settings🡪LDAP Server will be applied.
Address
Configure the IP address or DNS name of the LDAP server.
Port
Configure the LDAP server port. The default value is 389.
Base DN
This is the location in the directory where the search is requested to begin. Example:
dc=grandstream, dc=com
ou=Boston, dc=grandstream, dc=com
Username
Configure the bind “Username” for querying LDAP servers. The field can be left blank if the LDAP server allows anonymous binds.
Password
Configure the bind “Password” for querying LDAP servers. The field can be left blank if the LDAP server allows anonymous binds.
Number Filter
Configure the filter used for number lookups. Please refer to the user manual for more details.
Name Filter
Configure the filter used for name lookups. Please refer to the user manual for more details.
Version
Select the protocol version for the phone to send the bind requests. The default value is 3.
Name Attribute
Specify the “name” attributes of each record that are returned in the LDAP search result.
Example:
gn
cn sn description
Number Attribute
Specify the “number” attributes of each record that are returned in the LDAP search result.
Example:
telephoneNumber
telephoneNumber Mobile
Display Name
Configure the entry information to be shown on the phone’s LCD. Up to 3 fields can be displayed.
Example:
%cn %sn %telephoneNumber
Max Hits
Specify the maximum number of results to be returned by the LDAP server. The valid range is 1 to 3000. The default value is 50.
Search Timeout
Specify the interval (in seconds) for the server to process the request and the client waits for the server to return. The valid range is 0 to 180. The default value is 30.
Sort Results
Specify whether the searching result is sorted or not. The default setting is No.
Incoming Calls
Configure to enable LDAP number searching when receiving calls. The default setting is No.
Outgoing Calls
Configure to enable LDAP number searching when making calls. The default setting is No.
Lookup Display Name
Configures the display name when LDAP looks up the name for an incoming call or outgoing call.
It must be a subset of the LDAP Name Attributes.
XML Phonebook
Phonebook XML Server
Select the source of the phonebook XML server.
Disable
Disable phonebook XML downloading.
Manual
Once selected, users need to specify downloading protocol HTTP, HTTPS, or TFTP and the server path to download the phonebook XML file. The server path could be an IP address or URL, with up to 256 characters.
Local UCM Server
Once selected, click on the Server Path field to upload the phonebook XML file. Please note after uploading the phonebook XML file to the server, the original file name will be used as the directory name and the file will be renamed as phonebook.xml under that directory.
Phonebook Download Interval
Configure the phonebook download interval (in minutes). If set to 0, the automatic download will be disabled. The valid range is 5 to 720.
Remove manually edited entries on download
If set to “Yes”, when XML phonebook is downloaded, the entries added manually will be automatically removed.
Global Policy Parameters – Contact List
Upgrade and Provision
Firmware Source
Firmware source via ZeroConfig provisioning could be a URL for external server address, local UCM directory, or USB media if plugged into the UCM630X. Select a source to get the firmware file:
URL
If selected to use URL to upgrade, complete the configuration for the following four parameters: “Upgrade Via”, “Server Path”, “File Prefix” and “File Postfix”.
Local UCM Server
Firmware can be uploaded to the UCM630X internal storage for firmware upgrade. If selected, click on the “Manage Storage” icon next to the “Directory” option, upload the firmware file, and select a directory for the end device to retrieve the firmware file.
Local USB Media
If selected, the USB storage device needs to be plugged into the UCM630X and the firmware file must be put under a folder named “ZC_firmware” in the USB storage root directory.
Local SD Card Media
If selected, an SD card needs to be plugged into the UCM630X and the firmware file must be put under a folder named “ZC_firmware” in the USB storage root directory.
Upgrade via
When URL is selected as firmware source, configure upgrade via TFTP, HTTP, or HTTPS.
Server Path
When URL is selected as firmware source, configure the firmware upgrading server path.
File Prefix
Configure the Config Server Path.
Config Server Path
When URL is selected as firmware source, configure the firmware file postfix. If configured, only the configuration file with the matching encrypted postfix will be downloaded and flashed into the phone.
Allow DHCP Option 43/66
If DHCP option 43 or 66 is enabled on the LAN side, the TFTP server can be redirected.
Automatic Upgrade
If enabled, the end point device will automatically upgrade if a new firmware is detected. Users can select automatic upgrading by day, by week, or by minute.
By week
Once selected, specify the day of the week to check the HTTP/TFTP server for firmware upgrades or configuration files changes.
By day
Once selected, specify the hour of the day to check the HTTP/TFTP server for firmware upgrades or configuration files changes.
By minute
Once selected, specify the interval X that the SIP end device will request for new firmware every X minutes.
Firmware Upgrade Rule
Specify how firmware upgrading and provisioning requests are to be sent.
Zero Config
Select either to enable or disable Zero Config.
Web Access
Admin Password
Configure the administrator password for admin-level login.
End-User Password
Configure the end-user password for the end-user level login.
Web Access Mode
Select HTTP or HTTPS as the web access protocol.
Web Server Port
Configure the port for web access.
The valid range is 1 to 65535.
RTSP Port
Configure the RTSP Port.
Enable UPnP Discovery
Select either to enable or disable Enable UPnP Discovery
Login Settings
Configure the login settings.
User Login Timeout
Configure User Login Timeout.
Maximum Consecutive Failed Login Attempts
Configure Maximum Consecutive Failed Login Attempts.
Login Error Lock Time
Configure Login Error Lock Time.
Security
Disable Telnet/SSH
Enable Telnet/SSH access for the SIP end device. If the SIP end device supports Telnet access, this option controls the Telnet access of the device; if the SIP end device supports SSH access, this option controls the SSH access of the device.
Syslog
Syslog Server
Configure the URL/IP address for the Syslog server.
Syslog Level
Select the level of logging for Syslog.
Send SIP Log
Configure whether the SIP log will be included in the Syslog message.
Global Policy Parameters – Maintenance
Basic Settings
IP Address
Configure how the SIP end device shall obtain the IP address. DHCP or PPPoE can be selected.
DHCP
Once selected, users can specify the Host Name (option 12) of the SIP end device as DHCP client, and Vendor Class ID (option 60) used by the client and server to exchange vendor class ID information.
PPPoE
Once selected, users need to specify the Account ID, Password, and Service Name for PPPoE.
Host Name
Specify the name of the client. This field is optional but may be required by Internet Service Providers.
Vendor Class ID
Used by clients and servers to exchange vendor class ID.
Account ID
Enter the PPPoE account ID.
Password
Enter the PPPoE Password.
Service Name
Enter the PPPoE Service Name.
Advanced Setting
Layer 3 QoS
Define the Layer 3 QoS parameter. This value is used for IP Precedence, Diff-Serv, or MPLS. The valid range is 0-63.
Layer 3 QoS For RTP
Assign the priority value of the Layer 3 QoS for RTP packets.
The valid range is 0 -63.
Layer 3 QoS For SIP
Assign the priority value of the Layer 3 QoS for SIP packets.
The valid range is 0 -63.
Layer 2 QoS Tag
Assign the VLAN Tag of the Layer 2 QoS packets.
The valid range is 0 -4095.
Layer 2 QoS Priority Value
Assign the priority value of the Layer 2 QoS packets.
The valid range is 0-7.
STUN Server
Configure the IP address or Domain name of the STUN server. Only non-symmetric NAT routers work with STUN.
Keep-Alive
Select either to enable or disable Keep Alive.
Keep Alive Interval
Specify how often the phone will send a blank UDP packet to the SIP server to keep the “ping hole” on the NAT router open. The valid range is 10-160.
Register Expiration
Specify the Register Expiration.
Local SIP Port
Configure Local SIP Port.
Local RTP Port
Configure Local RTP Port.
Auto On-Hook Timer(s)
Configure Auto On-Hook Timer(s).
Ring Timeout
Configure Ring Timeout.
SIP Transport
Select either UDP, TCP, or TLS/TCP as SIP transport protocol.
Direct IP Call
Select either to disable or enable Direct IP Call support.
SIP Proxy Compatibility Mode
Select either to disable or enable SIP Proxy Compatibility Mode.
Unregister On Reboot
Select either to disable or enable Unregister On Reboot.
Whitelist
Whitelist
Select either to enable or disable Whitelist
SIP Phone Number Whitelist
Configure the SIP Phone Number Whitelist.
Global Policy Parameters – Network Settings
Email Settings
SMTP Settings
Check this option to configure the email settings that will be sent to the provisioned phones:
Server
The IP address of the SMTP server
Port
SMTP server port
From E-Mail address
Email address
Sender Username
Username of the sender
Password Recovery Email
Email where the recovered password will be sent
Alarm receive Email 1
Email address where alarms notifications will be sent
Alarm receive Email 1
Email address where alarms notifications will be sent
Enable SSL
Enable SSL protocol for SMTP
FTP
FTP
Check this option to configure the FTP settings that will be sent to the provisioned phones:
Storage Server Type
Either FTP or Central Storage
Server
FTP server address
Port
FTP port to be used
Username
FTP username
Path
FTP Directory path
Global Policy Parameters – Customization
Wallpaper
Screen Resolution 1024 x 600
Check this option if the SIP end device shall use 1024 x 600 resolution for the LCD screen wallpaper.
Source
Configure the location where wallpapers are stored.
File
If “URL” is selected as the source, specify the URL of the wallpaper file. If “Local UCM Server” is selected as the source, click to upload wallpaper file to the UCM630X.
Screen Resolution 800 x 400
Check this option if the SIP end device shall use 800 x 400 resolution for the LCD screen wallpaper.
Source
Configure the location where wallpapers are stored.
File
If “URL” is selected as the source, specify the URL of the wallpaper file. If “Local UCM Server” is selected as the source, click to upload wallpaper file to the UCM630X.
Screen Resolution 480 x 272
Check this option if the SIP end device shall use 480 x 272 resolution for the LCD screen wallpaper.
Source
Configure the location where wallpapers are stored.
File
If “URL” is selected as the source, specify the URL of the wallpaper file. If “Local UCM Server” is selected as the source, click to upload wallpaper file to the UCM630X.
Screen Resolution 320 x 240
Check this option if the SIP end device supports 320 x 240 resolution for the LCD screen wallpaper.
Source
Configure the location where wallpapers are stored.
File
If “URL” is selected as the source, specify the URL of the wallpaper file. If “Local UCM Server” is selected as the source, click to upload wallpaper file to the UCM630X.
Global Policy Parameters – Communication Settings
Global Templates
Global Templates can be accessed in Device Management→Zero Config→Global Templates. Users can create multiple global templates with different sets of configurations and save the templates, or click on the “Import/Export” button to add multiple global templates.
When the user configures the device in the Edit Device dialog→Advanced Settings, they can select to use one of the global templates for the device. Please refer to section [Manage Devices] for more details on using the global templates.
When creating a Global Template, users can select the categories and specific parameters within each category to include in the template. Both the Global Policy and the selected Global Template are applied when generating the configuration file. However, for overlapping configuration options, the Global Template takes precedence over the Global Policy.
Click on “Add” to add a global template. Users will see the following configurations.
Create New Global Template
Template Name
Create a name to identify this global template.
Description
Describe the global template. This is optional.
Active
Check this option to enable the global template.
Create New Template
Click on the “Edit” icon to edit the global template.
In the “Options” field, after entering the option name keyword, the options containing the keyword will be listed. Users could then select the options to be modified under the global template.
Global Template Configuration Settings
Enter or select the value for each option to be used in the global template.
On the left side of each added option, click the “Trash” icon to delete this option from the template, or click on the “Reset” icon to reset the option value to the default value.
Click on “Save” to save this global template.
The created global templates will show in the Device Management→Zero Config→Global Templates page. Users can delete one or multiple templates or click on “Toggle Selected Template Status” to toggle between enabled/disable status for the selected templates.
Model Configuration
Model templates
The Model layer configuration allows users to apply model-specific settings to devices. Users can create, edit, or delete Model Templates through the Web GUI at Device Management→Zero Config→Model Templates.
If multiple Model Templates are created and enabled, users can select a specific template for a device in the Edit Device dialog under Advanced Settings. The selected Model Template is then applied to that device.
For each Model Template, users can designate it as the default template. When a Model Template is set as the default, its configuration values are applied to all devices of the corresponding model.
Note:
Only one default Model Template can be assigned at any given time on the UCM630x.
Both the default Model Template and the selected Model Template are applied during configuration generation. For overlapping options, the selected Model Template takes precedence and overrides the default Model Template.
To configure a model template:
Click on “Add” to add a model template, and configure the following parameters:
Create New Model Template
Model
Select a model to apply this template. The supported Grandstream models are listed in the dropdown list for selection.
Template Name
Create a name for the model template.
Description
Enter a description for the model template. This is optional.
Default Model Template
Select to assign this model template as the default model template. The value of the option in the default model template will be overridden if another selected model template has a different value for the same option.
Active
Check this option to enable the model template.
Create New Model Template
Click on the “Edit” icon to edit the model template. The editing window for a model template is shown in the following figure.
Edit Model Template
On the left side of each added option, click the “Trash” icon to delete this option from the template, or click on the “Reset” icon to reset the option value to the default value.
In the “Options” field, enter the option name key word, the option that contains the keyword will be listed. The user could then select the option to be modified under the model template.
Model Template Options
Use “Add New Field” to add a P-value number and the value to the configuration. The following figure shows setting P-value “P1362” to “en”, which means the display language on the LCD is set to English.
Click on Save when done. The model template will be displayed on Device Management→Zero Config→Model Templates page.
Click on the “Trash” icon to delete the model template or use the “Delete” button delete multiple selected templates at once.
Click on “Toggle Selected Template Status” to toggle between enabled/disable status for the selected templates.
Use the “Import/Export” buttons to upload/export the model template list in CSV or XLS format.
The filter option allows to search through the model templates. Please see the screenshot below:
Model Template Search Filter
Model Update
UCM630x Zero Config feature supports provisioning all models of Grandstream SIP end devices including OEM device models, and supported third-party models.
OEM Models
Users can associate OEM device models with their original Grandstream-branded models, allowing these OEM devices to be provisioned appropriately.
Click on “Add OEM Models” button.
In the Source Model field, select the Grandstream device that the OEM model is based on from the dropdown list.
For the Destination Model and Destination Vendor field, enter the custom OEM model name and vendor name.
The newly added OEM model should now be selectable as an option in Model fields.
Add OEM Models
Model Template Package List
Templates for most of the Grandstream models are built-in with the UCM630X already. Templates for Wave, Grandstream surveillance products, and third-party devices require users to download and install under Device Management→Zero Config→Model Update first before they are available in the UCM630X for selection.
After downloading and installing the model template to the UCM630x, it will show in the dropdown list for “Model” selection when editing the model template.
Click on the “Download” icon to download the template.
Click on “Upgrade” to upgrade an existing model template.
Model Template Package List
Upload Model Template Package
By default, third-party model templates are not available on the UCM630x and must be uploaded manually through the Web GUI.
In environments with restricted Internet connectivity, Grandstream model packages must also be uploaded manually.
Contact Grandstream customer support to obtain the required model template packages.
Upload Model Template Package
Device Configuration
On Web GUI, page Device Management→Zero Config→Zero Config, users could create a new device, delete existing device(s), make special configuration for a single device, or send NOTIFY to an existing device(s).
Create New Device
Users can directly create a new device and configure basic settings before the device is discovered by the UCM630X. Once the device is plugged in, it can then be discovered and provisioned. This gives the system administrator adequate time to set up each device beforehand.
Click on “Add” and the following dialog will show. Follow the steps below to create the configurations for the new device.
Firstly, select a model for the device to be created and enter its MAC address, IP address, and firmware version (optional) in the corresponding field.
Basic settings will show a list of settings based on the model selected in step 1. Users could assign extensions to accounts, assign functions to Line Keys and Multiple-Purposed Keys if supported on the selected model.
Click on “Save” to save the configuration for this device.
Create New Device
Manage Devices
The device manually created or discovered from Auto Discover will be listed in the Device Management→Zero Config→Zero Config page. Users can see the devices with their MAC address, IP address, vendor, model, etc.
Manage Devices
Click on “Access Device Web UI” to access the Web GUI of the device.
Click on the “Edit” icon to edit the device configuration.
A new dialog will be displayed for the users to configure “Basic” settings and “Advanced” settings. “Basic” settings have the same configurations as displayed when manually creating a new device, i.e., account, line key, and MPK settings; “Advanced” settings allow users to configure more details in a five-level structure.
Edit Device
A preview of the Advanced Settings is shown in the figure above. There are five configuration levels, as described in items (1) through (5) below, ordered from lowest to highest priority. All configuration levels are applied to the device.
If the same option is defined at multiple levels with different values, the value from the higher-priority level overrides the value from the lower-priority level.
Global Policy
This is the lowest level configuration. The global policy configured in Device Management→Zero Config→Global Policy will be applied here. Clicking on “Modify Global Policy” to redirect to page Device Management→Zero Config→Global Policy.
Global Templates
Select a Global Template and click the right arrow to add it to the device. Multiple Global Templates can be selected, and their priority can be adjusted using the up and down arrows. All selected templates take effect.
If the same option is defined in multiple selected Global Templates, the value from the higher-priority template overrides that of the lower-priority template. Click the left arrow to remove a Global Template from the selected list.
Default Model Template
Default Model Template will be applied to the devices of this model. Default model template can be configured in the model template under Device Management→Zero Config→Model Templates page. Please see the default model template option in [Create New Model Template].
Model Templates
Select a Model Template to apply to the device and click the right arrow to add it. Multiple Model Templates can be selected, and their priority can be adjusted using the up and down arrows. All selected templates take effect.
If the same option is defined in multiple selected Model Templates, the value from the higher-priority template overrides that of the lower-priority template. Click the left arrow to remove a Model Template from the selected list.
Customize Device Settings
This is the highest-level configuration for the device. Click on “Modify Customize Device Settings” and the following dialog will show.
Edit Customize Device Settings
Scroll down in the dialog to view and edit device-specific options. To add options that are not included in the predefined list, click Add New Field and specify the P-value and its corresponding value.
In the example shown above, P-value P1362 is set to en, which configures the LCD display language to English. The warning message on the right indicates that a predefined option matching this P-value already exists; clicking it navigates to the corresponding option.
Select multiple devices that need to be modified and then click on ”Update Config” to batch modify devices.
If selected devices are of the same model, the configuration dialog is like the following figure. Configurations in five levels are all available for users to modify.
Modify Selected Devices Same Model
If selected devices are of different models, the configuration dialog is like the following figure. Click on the arrows to view more devices of other models. Users are only allowed to make modifications to the Global Templates and Global Policy level.
Modify Selected Devices Different Models
Performing batch operation will override all the existing device configuration on the page.
After the above configurations, save the changes and go back to Device Management→Zero Config→Zero Config page. Users could then click on the “Update” icon to send NOTIFY to the SIP end point device and trigger the provisioning process. The device will start downloading the generated configuration file from the URL contained in the NOTIFY message.
On this web page, users can also click on “Reset All Extensions” to reset the extensions of all the devices.
Sample Application
Assuming in a small business office where there are 8 GXP2140 phones used by customer support and 1 GXV3275 phone used by customer support supervisor. 3 of the 8 customer support members speak Spanish and the rest speak English. We could deploy the following configurations to provision the office phones for the customer support team.
Go to Device Management→Zero Config→Zero Config Settings, select “Enable Zero Config”.
Go to Device Management→Zero Config→Global Policy, configure Date Format, Time Format, and Firmware Source as follows.
Zero Config Sample Global Policy
Go to Device Management→Zero Config→Model Templates, create a new model template “English Support Template” for GXP2170. Add option “Language” and set it to “English”. Then select the option “Default Model Template” to make it the default model template.
Go to Device Management→Zero Config →Model Templates, create another model template “Spanish Support Template” for GXP2170. Add option “Language” and set it to “Español”.
After 9 devices are powered up and connected to the LAN network, use the “Auto Discover” function or “Create New Device” function to add the devices to the device list on Device Management→Zero Config→Zero Config.
On Web GUI→Device Management→Zero Config→Zero Config page, users could identify the devices by their MAC addresses or IP addresses displayed on the list. Click on the “Edit” icon to edit the device settings.
For each of the 5 phones used by English-speaking customer support, in “Basic settings” select an available extension for account 1 and click on “Save”. Then click on the “Advanced settings” tab to bring up the following dialog. Users will see the English support template is applied since this is the default model template. A preview of the device settings will be listed on the right side.
Zero Config Sample Device Preview 1
For the 3 phones used by Spanish support, in “Basic settings” select an available extension for account 1 and click on “Save”. Then click on the “Advanced settings” tab to bring up the following dialog.
Zero Config Sample Device Preview 2
Select “Spanish Support Template” in “Model Template”. The preview of the device settings is displayed on the right side and we can see the language is set to “Español” since Model Template has the higher priority for the option “Language”, which overrides the value configured in the default model template.
For the GXV3275 used by the customer support supervisor, select an available extension for account 1 on “Basic settings” and click on “Save”. Users can see the preview of the device configuration in “Advanced settings”. There is no model template configured for GXV3275.
Zero Config Sample Device Preview 3
Click on “Apply Changes” to apply saved changes.
On the Device Management→Zero Config→Zero Config page, click on the “Update” icon to send NOTIFY to trigger the device to download the config file from UCM630x.
Now all the 9 phones in the network will be provisioned with a unique extension registered on the UCM630X. 3 of the phones will be provisioned to display Spanish on LCD and the other 5 will be provisioned to display English on LCD. The GXV3275 used by the supervisor will be provisioned to use the default language on the LCD display since it is not specified in the global policy.
MAINTENANCE
User Management
User management is on Maintenance > User Management page. User could create multiple accounts for different administrators to log in the UCM630X Web GUI. Additionally, the system will automatically create user accounts along with creating new extensions for extension users to login to the Web GUI using their extension number and password. All existing user accounts for Web GUI login will be displayed on User Management page as shown in the following figure.
User Management Page Display
User Information
When logged in as Super Admin, click on ”Add” to create a new account for Web GUI user. The following dialog will prompt. Configure the parameters as shown in below table.
Create New User
Username
Configure a username to identify the user which will be required in Web GUI login. Letters, digits, and underscore are allowed in the username.
User Password
Configure a password for this user which will be required in Web GUI login. English input is allowed without space,’ and “.
Note: The password should contain at least 10 characters, with at least, one lower-case letter, one upper-case letter, one numeral, and one special character.
Email Address
Configure the email address for the user. This is optional.
Privilege
This is the role of the Web GUI user. When super admin creates new user, “Adminstrator” or customized privilege can be selected.
Multi-Factor Authentication
If enabled, the user account will be required to enter an MFA code in addition to login credentials when logging into the UCM management web portal.
Mobile Number
The user's mobile phone number. This can be used for scenarios such as SMS verification code login and resetting password. It is recommended to configure country code to avoid potential SMS sending issues.
When the super admin creates new user, the email address for the new user is optional. However, when the admin user created by super admin logs in to edit user information, email address is mandatory. This email address is the same and will be sync up with the email address configured in login settings.
Once created, the Super Admin can edit the users by clicking on or delete the user by clicking on .
Multi-Factor Authentication
To enhance the security for UCM, super admin and admin can select to use multi-factor authentication method for login to protect the login information. Virtual MFA and hardware MFA are supported and can be selected. Once enabled, the user must use MFA code to verify before login.
Note:
The user cannot enable or disable MFA for another different user.
Super admin can edit user settings for admin but cannot edit Multi-Factor Authentication option. MFA option is only viewable for super admin when super admin edits other users.
When the user sees MFA enabled, only this user can disable or enable it again.
Email address and email settings are required before enabling Multi-Factor Authentication. Please ensure email setting has “Client” type configured. Otherwise, MFA cannot be enabled.
Please refer to MFA how to guide here for more information.
MFA Settings
Custom Privilege
By default, three levels are supported: Super Administrator, Administrator, Wave Administrator:
Super Administrator
This is the highest privilege. Super Admin can access all pages on UCM630X Web GUI, change configuration for all options and execute all the operations.
Super Admin can create, edit, and delete one or more users with the “Admin” privilege
Super Admin can edit and delete one or more users with the “Consumer” privilege
Super Admin can view operation logs generated by all users.
By default, the user account “admin” is configured with the “Super Admin” privilege and it is the only user with the “Super Admin” privilege. The Username and Privilege level cannot be changed or deleted.
Super Admin could change its own login password on Maintenance→Login Settings page.
Super Admin could view operations done by all the users in Maintenance→User Management→Operation Log
The Super Admin can allow administrators to view SFTP, NAS and Email Account passwords.
Password Visibility Toggle
Administrator
Users with “Admin” privilege can only be created by “Super Admin” user.
“Admin” privilege users cannot create new users for login.
“Admin” privilege users are by default not allowed to access the following pages:
Maintenance🡪Backup
Maintenance 🡪 Upgrade
RemoteConnect
Settings🡪User Management🡪Operation Log
Note: By default, administrator accounts are not allowed to access backup menu, but this can be assigned to them by editing the option “Maintenance→User Management→CustomPrivilege” then press the “Edit” icon to edit the “Admin” account and include backup operation permission for these types of users.
Assigning Permissions to Admin Users
Wave Administrator
This permission type does not support editing or deletion.
This includes management of Wave-related function settings only and does not involve access to the UCM module.
Users can set the Wave Admin privilege for specific extension under Extension/Trunk→Extensions→Edit Extension.
The Super Admin user can create users with different privileges
API Configuration
Backup
Callback
Call Queue
Queue Statistics
Queue Recordings
CDR Recordings
CDR Records
CDR Statistics
Dial By Name
DISA
Emergency Calls
Event List
Extensions
Extension Groups
Outbound Routes
Inbound Routes
Fax/T.38
Fax Sending
Feature Codes
IVR
Paging/Intercom
Parking Lot
Pickup Groups
PMS – Wakeup Service
PMS – Room Management
PMS – Room Status
PMS – Housekeeper
Ring Groups
Restrict Calls
SCA
Speed Dial
Music on Hold
System Status
System Events
LDAP Server
Time Settings
Multimedia Meeting
Voicemail
Voice Prompt
Scheduled Call
Contacts
Zero Config
Announcement
UCM RemoteConnect
Create New Custom Privilege
Log in UCM630X as super admin and go to Maintenance→UserManagement→CustomPrivilege, create privilege with customized available modules.
When you add CDR Records and CDR Recording Files custom privileges, additional privileges will appear (All Deletion of CDR and Allow Deletion of CDR Recordings, respectively). This offers more flexibility on the privileges that the admin assigns to the user.
CDR Related Custom Privileges
To assign custom privilege to a sub-admin, navigate to UCM Web GUI→Maintenance→UserManagement→UserInformation→Create New User/Edit Users, select the custom privilege from “Privilege” option.
Concurrent Multi-User Login
When there are multiple Web GUI users created, concurrent multi-user login is supported on the UCM630X. Multiple users could edit options and have configurations take effect simultaneously. However, if different users are editing the same option or making the same operation (by clicking on “Apply Changes”), a prompt will pop up as shown in the following figure.
Multiple User Operation Error Prompt
Note
Only one session can be opened per user. If a new session has been opened for an account that had already been opened. The older session will be terminated upon the login of the user.
User Portal/Wave Privileges
The administrator can create customized privileges related to an extension’s User Portal and Wave. The created privilege can be affected to the extensions to limit or allow them to use certain functionalities related to Wave and the User Portal.
After the creation of the privilege, the administrator can assign the privilege to a specific extensions by navigating to Extension/Trunk→Extensions→Basic Settings→User Portal/Wave Privileges.
User PortalWave Configuration
Wave Permissions
Under Wave Permissions category, the user can configure the various permissions for the basic features of Wave such as using the chat, making audio/video calls, meeting, use application store, etc…
Wave Permissions Tab
Chat: Toggles ability to use the Wave Chat feature.
Delete Chat Session: Toggles support for Wave to delete chats and chat history. This data will only be deleted on the Wave client side.
Delete Message: Controls whether Wave users will be allowed to delete messages that have been sent. Deleted messages will not be visible to anyone.
Send File: Toggles file/image sending support in Wave chat. If disabled, users will still be able to download, view and forward chat files.
Download Chat Logs: If enabled, chat logs will be downloadable from the Wave client, including chat logs from Wave/WhatsApp/Telegram/LiveChat sessions.
End-to-End Encrypted Chat*: Toggles ability to use the Wave End-to-End Encrypted Chat feature.
Wave App Screenshot and Screen Recording: Controls whether users are allowed to take screenshots and perform screen recordings in the Wave mobile app.
Video Call: Toggles ability to use the Wave Video Call feature.
Meeting: Toggles ability to use the Wave Meeting feature.
Start Video During Meeting: Toggles ability to use the Wave Start During Meeting feature.
Online Status: Toggles ability to set Wave online status such as “Busy”, “Appear Away”, “Do Not Disturb”, “Appear Offline”, etc. If unchecked, the status will be displayed as only either “Online” or “Idle”.
Login Settings
Multi-client Login Settings: If enabled, users will be allowed to enable or disable the option “Allow Simultaneous Logins from the Same Client Type”.
Remote Logout: If enabled, Wave users will be able to log out of their accounts from other logged-in devices.
Recording Status: Controls whether the recording status is displayed in all calls/conferences of the extensions. Note: If the call recording prompt is enabled, it will be played as this setting affects the indicator that shows that a call is being recorded on Wave.
Clear Recent Call History: Toggles ability to delete recent call history entries and entire recent call history on Wave.
Application: Toggles ability to access the “Applications” page under Wave Desktop and Wave Web.
Smart Devices: Toggling off privileges will hide the corresponding pages and options in Wave.
Door System
Monitor
Call Device (CTI)
3rd Party Applications
App Store: Toggles ability to install applications from Wave application store. If unchecked, the application store will be hidden, but installed apps can still be used.
User Portal/Wave Privileges
Under User Portal/Wave Privileges, the administrator can configure the access privileges to certain settings and feature such as adjusting account settings, changing SIP/IAX password and AuthID, setting DND. Or access to personal data such accessing the CDR of the user, configuring Follow me or Voicemail, etc…
User PortalWave Privilieges
Account Settings: If unchecked, the User Portal -> Basic Information -> Account Settings page and the Wave -> Sidebar -> User -> Account Settings option will be hidden.
Extension Settings: If unchecked, the extension’s User Portal->Basic Information->Extensions page and the Wave->Sidebar->User->Call Settings option will be hidden.
Do Not Disturb: Toggles ability to set DND through the User Portal.
SIP/IAX Password & AuthID: Toggles ability to access the SIP/IAX Password and AuthID settings under the User Portal->Basic Information->Extensions->Basic Settings page.
Configuration Voicemail
Manage Recordings: Toggles ability to view recordings through the User Portal and Wave, including the recordings in call logs, meeting details, and Wave application.
Deleting Recordings: Toggles ability to delete recordings through the User Portal and Wave. For Wave, this includes the ability to delete call logs, meeting details,and recordings.
Personal Data: Toggling off privileges will hide the corresponding pages and options in the User Portal and Wave.
CDR
Follow Me
Voicemail
Recordings files
Fax Files
SCA
Other Features: Toggling off privileges will hide the corresponding pages and options in the User Portal and Wave.
Fax Sending
Call Queue
Schedule Call
*: Features which are marked by an asterisk are a part of RemoteConnect plans.
Administration Privileges
Under Administrator Privileges, the administrator can configure enabling certain extensions to view a designated team’s CDR.
Administrator Privileges
View Team CDRs and Recordings: Define whether certain extensions can view each other’s CDR. Click on “Team” to designate the extensions.
Download Team Recording: When this option is enabled, the extensions selected in the team will be allowed to access each other’s CDR and call recording files.
Pre-intalled Plugins
The administrator can set the plug-ins which will be installed when the user logs into Wave Desktop.
To configure the pre-installed plugins, follow the steps below.
Navigate to Maintenance > User Management > User Portal/Wave Privileges then click “Pre-installed Plug-ins”.
Click on “Add Add-in” button.
Pre installed Plug ins
Add Pre installed Plug ins
Parameter
Description
Add-in
Select an add-in.
Act! CRM
Bitrix24
Capsule CRM
Dynamics 365
Freshdesk
Google Drive
Hubspot
IPVideoTalk
Less Annoying CRM
Monday Sales CRM
Odoo CRM
Office365
OfficeRnD Hybrid Work
Oracle NetSuite
Salesforce
SugarCRM
Telegram
Vtiger CRM
Whatsapp Business
Zendesk
Zoho CRM
Zoho Desk
Configure Parameters
Enter the configuration parameters. The configuration parameters consist of authentication information, database name, webhook url etc…
Note: Please note that only JSON format is supported.
Extension Login Management allows the administrator to review the logged-in sessions of SIP devices and Wave.
Extension Login Management
For Wave sessions, the administrator can click on to terminate a Wave session. SIP sessions cannot be logged out.
User Endpoint Access History
The User Endpoint Access History tab allows the administrator to view the access history of all extensions, the time on which the access has occurred, the IP addresses from which the extensions were accessed, and whether they were accessed from the User Portal, Wave Web/Desktop, or mobile. Extension access from the SIP endpoints won’t be logged in this page.
User Endpoins Access History
Login Settings
Change Password / Email
Change Password
After logging in the UCM630X Web GUI for the first time, it is highly recommended for users to change the default password to a more complicated password for security purpose. Follow the steps below to change the Web GUI access password.
Go to Maintenance > Login Settings > Change Password / Email page.
Enter the old password first.
Enter the new password and re-type the new password to confirm. The new password has to be at least 4 characters. The maximum length of the password is 30 characters.
Configure the Email Address that is used when login credential is lost.
Click on “Save” and the user will be automatically logged out.
Once the web page comes back to the login page again, enter the username “admin” and the new password to login.
Change Password
Enter Old Password
Enter the Old Password for UCM630X.
Change Password
Enable Change Password.
Enter New Password
Enter the New Password for UCM630X.
Note: The password should contain at least 10 characters, with at least one lower-case letter, one upper-case letter, one numeral, and one special character.
The password must not contain an ascending or descending consecutive numeric sequence, or a consecutive sequence of the same number/letter.
Re-enter New Password
Retype the New Password for UCM630X.
Change Username
Enable Change Username.
Email Address
The Email address is the User Email Address. It is used for receiving password information if the user forgets his password.
Change Username
UCM630X allows users now to change Super Administrator username.
Change Username
Change Email Address
UCM630X allows user to configure binding email in case login password is lost. UCM630X login credential will be sent to the designated email address. The feature can be found under Maintenance> Login Settings > Change Password / Email
Change Binding Email
Email Address
Email Address is used to retrieve password when password is lost
Change Binding Email option
Login Security
After the user logs in the UCM630X Web GUI, the user will be automatically logged out after certain timeout, or he/she can be banned for a specific period if the login timeout is exceeded. Those values can be specified under UCM630X Maintenance > Login Settings > Login Security page.
The “User Login Timeout” value is in minute and the default setting is 10 minutes. If the user does not make any operation on Web GUI within the timeout, the user will be logged out automatically. After that, the Web GUI will be redirected to the login page and the user will need to enter username and password to log in.
Login Timeout Settings
Login Settings
Login Timeout (m)
Set login timeout (in minutes) for user. If there is no activity within the specified amount of time, the user will be logged out, and the system will jump to the login page automatically. If set to 0, the user will not be logged out automatically. Valid range is 0 to 60 and default value is 0.
SMS OTP Login
If enabled, users will be able to log in and reset password via SMS verification code. Mobile phone numbers will need to be configured for administrators and extensions.
Login Security Policy
Enable Login Security
Enable login security measure to prevent authentication attacks.
Max Login Attempts (per IP address)
The max allowed number of consecutive failed login attempts from an IP address. Once exceeded, no users will be able to log in from that IP address.
Note: The valid range is between 5 to 100 attempts.
Maximum number of login attempts (per user)
The maximum number of consecutive failed login attempts. When exceeded, the user will not be able to log in for the amount of time specified in "User ban period".
Note: The valid range is between 1 to 100 attempts.
Ban Period (m)
The amount of minutes that a user will be banned for after exceeding the maximum allowed number of consecutive failed login attempts.
Note: The valid range is between 0 and 10000 minutes, with 0 indicating a permanent ban.
Login Banned User List
List of IP addresses which are banned from making any further login attempts.
Login Whitelist
List of IP addresses which can make unlimited login attempts.
Remote Login
This feature allows the user to manage trusted login locations, also, verifying where login sessions were initiated from, this is very important since, in this type of scenario, the UCM6300 would be directly connected to the Internet, and the public IP address would be used for the remote login. This feature adds a layer of visibility and control, thus enhacing the security of the UCM.
In this tab there are two types of lists of locations:
Trusted Login Locations: These are the trusted login locations that are added manually by the admin. Any added trusted login location will not generate any remote login alert upon the first time login.
Other Login Location: This list will show all the remote login locations that are not trusted, logging in for the first time from an untrusted login location will generate an alert, but the subsequent remote logins from the same location will not generate alerts.
Remote Login
To add a trusted login location, the user must click on
Then add the public IP address of the location, click on “Check Location” to verify if it’s the correct location then click “OK“.
Note
The system administrator can add up to 5 Trusted Login Locations, while Other Login Locations can have an unlimited number of entries.
Operation Log
Super Admin has the authority to view operation logs on UCM630X Settings > User Management > Operation Log page. Operation logs list operations done by all the Web GUI users, for example, Web GUI login, creating trunk, creating outbound rule etc. There are 7 columns to record the operation details “Date”, “Username”, “IP Address”, “Results”, “Page Operation”, “Specific Operation” and “Remark”.
Operation Logs
The operation log can be sorted and filtered for easy access. Click on or at the top of each column to sort. For example, clicking on for “Date” will sort the logs according to newer operation date and time. Clicking on for “Date” will reverse the order.
Date
The date and time when the operation is executed.
Username
The username of the user who peformed the opertation
IP Address
The IP address and geographical location from which the operation has been made.
Results
The result of the operation.
Page Operation
The page where the operation is made. For example, login, logout, delete user, create trunk and etc.
Specific Operation
Click on the hyperlinked operation detail to reveal more details.
Remark
Allows users to add notes and remarks to each operation.
User could also filter the operation logs by time condition, IP address and/or username. Configure these conditions and then click on ”Display Filter”.
Operation Logs Filter
The above figure shows an example that operations made by user “support” on device with IP 192.168.40.173 from 2014-11-01 00:00 to 2014-11-06 15:38 are filtered out and displayed.
To delete operation logs, users can perform filtering first and then click on to delete the filtered result of operation logs. Or users can click on to delete all operation logs at once.
Syslog
On the UCM630X, users could dump the syslog information to a remote server under Maintenance>Syslog. Enter the syslog server hostname or IP address and select the module/level for the syslog information as well as Process Log Level.
The default syslog level for all modules is “error”, which is recommended in your UCM630X settings because it can be helpful to locate the issues when errors happen.
Some typical modules for UCM630X functions are as follows and users can turn on “NOTICE” and “VERBOSE” levels besides “error” level.
pbx: This module is related to general PBX functions.
pjsip: This module is related to SIP calls.
chan_dahdi: This module is related to analog calls (FXO/FXS).
Syslog is usually for debugging and troubleshooting purpose. Turning on all levels for all syslog modules is not recommended for daily usage. Too many syslog prints might cause traffic and affect system performance.
The reserved size for Syslog entries on the cache memory of the UCM is 50M, once this sized is reached the UCM will clean up 2M of the oldest Syslog entries to allow to save new logs.
System Events
The UCM630X can monitor important system events, log the alerts, and send Email notifications to the system administrator.
Alert Log
Under Maintenance > System Events > Alert Log, system messages from triggered system events are listed as alert logs. The following screenshot shows system reboot alert logs.
System Events > Alert Log
User could also filter alert logs by selecting a certain event category, type of alert log, and/or specifying a certain time period. The matching results will be displayed after clicking on . Alert logs are classified into two types by the system:
Generate Alert: Generated when alert events happen, for example, alert logs for disk usage exceeding the alert threshold.
Restore to Normal: Generated when alert events being cleared, for example, logs for disk usage dropping back below the alert threshold.
User could filter out alert logs of “Generate Alert” or “Restore to Normal” by specifying the type according to need. The following figure shows an example of filtering out alert logs of type of “Restore to Normal”.
Filter for Alert Log
Alert Events List
The system alert events list can be found under Maintenance > System Events > Alert Events List. The following event and their actions are currently supported on the UCM630X which will have alert and/or Email generated if occurred:
Alert Event List
For users who have purchased a GDMS package, once the option Alert Events Sync is enabled under RemoteConnect, the triggered events will be pushed to their GDMS platform.
Click on to configure the parameters for each event. See the descriptions below.
Security
Fail2ban Blocking
If the system Fail2ban is blocking, the event will be recorded in the alert log.
Flood Attacks
An alert will be generated in case a DDoS attack attempt is detected by the UCM. The event will be registered in the alert log and it will be pushed to the GDMS.
Network Traffic Storm
An alert will be generated in case there is an excessive amount of packets on the LAN. Network Traffic Storms consume the resources of the network components and saturate the bandwidth, which will bring the whole network to a halt. This event will be registered in events log and a notification will be pushed to the GDMS.
User Login Banned
If user login is blocked, the event will be recorded in the alert log.
Remote Login
An alert will be generated upon a remote login.
User Login Success
Successful user login events will be recorded in the alert log.
User Login Failed
User login failure events will be recorded in the alert log.
Modify Super Admin Password
An alert will be generated when the super admin password is changed.
System
System Crash
The UCM will detect the event at each cycle based on the specified time. Users can enter the number and then select second(s)/minute(s)/hour(s)/day(s) to configure the cycle.
System Update
Once the system is upgraded, the system upgrade event will be recorded in the alarm log.
System Reboot
UCM will detect the system restart and will send an alert for it. Users can see the device’s MAC address, the reason for the reboot and the initiator of the reboot. There are two kinds of reboots that the UCM detects:
Manual restart: refers to when the administrator reboots the system through the Web U or when the device is restarted via the LCD or through GDMS.
Automatic restart: this reboot is done automatically due to several reasons some of which are firmware upgrade, HA switchover, factory reset, power failure, change of certain settings, etc.
CPU Usage Call Control
The CPU flow control threshold is defined under System Settings > General Settings, and the default value is 90%. When the traffic exceeds the predetermined value, the event will be recorded in the alert log and new calls will be prohibited.
Memory Usage
If the detected value exceeds the configured threshold (in percentage), the UCM630X system will send the alert.
TLS Cert Expiration
Starting 7 days before the HTTP Server TLS certificate in the UCM device expires, an expiration countdown notification is sent every day; the certificate has expired, an expiration notification is sent; after the alarm notification is generated, a valid new certificate is uploaded, and a notification to restore the TLS certificate is generated.
Cloud IM Abnormal
An alert message will be generated f the Cloud IM encounter any issue or exhibit any abnormal behavior.
Data Sync Backup
If the system performs data synchronization and backup abnormalities, the event will be recorded in the alert log.
Restore Config
Once the system configuration is restored, the configuration restoration event will be recorded in the alert log.
HA
HA Failure
After the HA dual-system hot backup disaster recovery function is enabled in the UCM device, the HA fault alarm is automatically turned on. When the device has a software and hardware related fault, an HA fault alarm is generated.
HA Switch
Once a switch between primary UCM device and secondary UCM has been detected, an alert event will be sent.
HA Data Sync Failure
In case of Data Sync failure in HA deployment, the UCM device will generate an alert event.
Storage
Local Disk Usage
The UCM630X will perform the Local disk usage detection based on a configured cycle. If the detected value exceeds the threshold (in percentage), the UCM630X system will send the alert.
Note: If the threshold is exceeded, any behavior of operating the disk will be rejected, including stopping file upload, IM writing, recording and CDR recording.
External Disk Usage
The UCM630X will perform the External disk usage detection based on a configured cycle. If the detected value exceeds the threshold (in percentage), the UCM630X system will send the alert.
External Disk Status
If the external disk of the system is Connected/Disconnected, the event will be recorded in the alarm log.
Switching File Storage Path
Once the file storage path on the UCM device is changed, an alert will be sent.
GDMS Cloud Storage
This alert will be triggered if cloud backup to GDMS fails.
Call Features
Emergency Calls
If the system generates an emergency call, the event will be recorded in the alert log.
SIP Outgoing Call through Trunk Failure
If the system SIP trunk outgoing call fails, the event will be recorded in the alert log.
SIP Internal Call Failure
If the system SIP extension call fails within the office, the event will be recorded in the alert log.
Remote Concurrent Calls
If the remote concurrent call fails, the event will be recorded in the alert log.
Excessive Outbound Calls
When an extension initiates calls frequently, an alert will be logged in the alert log and a notification will be pushed.
Outbound Call Duration
This alert is triggered if a call reaches the duration limit set on the outbound rule.
Trunk Outbound Call Duration Usage
This alert is triggered if a call reaches the duration limit set on the trunk.
Trunk Concurrent Calls
This alert is triggered if the number of concurrent calls is reached on a specific trunk.
Extension/Trunk Status
Register SIP trunk failed
The UCM will detect the failure of SIP trunk registration at a set interval.
SIP Peer Trunk Status
If the SIP peer trunks status is abnormal, the event will be recorded in the alert log.
Register SIP failed
Configure the sending period of the SIP registration failure alert. The first registration failure alert of the same IP to the same SIP account will be sent immediately, and then no alerts will be sent for similar failure warnings in the cycle time. After the cycle time expires, an alert will be sent again to count the number of occurrences of similar SIP registration failure alerts during the cycle. When set to 0, alerts are always sent immediately.
SIP Lost Registration
If System SIP extension registration is lost, the event will be recorded in the alert log.
Clicking on the edit button, the user can access to enable or disable Ignore Wave App Registration Loss.
1+N Media Cluster Connection Status
Users can enable a connection status alarm (1+N Media Cluster Connection Status) to be notified when a media resource server goes online/offline.
Trunk Outbound Call Duration Usage
When the system detects that the number of concurrent calls of a certain relay exceeds the threshold set by the relay within a certain period of time, the event will be recorded in the alarm log. Calls are not restricted if the threshold is exceeded.
Trunk Concurrent Calls
If the threshold of all incoming and outgoing concurrent calls through a trunk is exceeded, the UCM will generate an alert event.
Alert Contact
This feature allows the administrator to be notified when one of the Alert events mentioned above happens. Users could add administrator’s Email address under Maintenance > System Events > Alert Contact to send the alert notification to an email (Up to 10 Email addresses can be added) or also specify an HTTP server where to send this alert.
Alert Contact
Email Notification
Email Notification
Alert email notification delivery method:
Real-time: Notifications will be sent out as soon as the alerts are generated.
Periodic: Alerts generated within the configured "Notification Interval" time window will be queued up and sent all at once in a single notification.
Notification Interval
When the notification delivery method chosen is Periodic, this option will be available.
The sending frequency of alert email notifications. All alert events that have occurred within a send cycle will be sent.
Super Admin Email
Configure the email addresses to send alert notifications to.
Up to 10 email addresses can be added.
Admin Email
Configure the email addresses to send alert notifications to.
Send alert notifications via SMS. Multiple phone numbers are supported.
Admin Phone Number
Send alert notifications via SMS. Multiple phone numbers are supported.
SMS Template
Click on the link to access the SMS templates page.
HTTP Notification
Protocol
Protocol used to communicate with the server. HTTP or HTTPS.
Default one is HTTP.
HTTP Server
The IP address or FQDN of the HTTP/HTTPS server.
HTTP Server Port
HTTP/HTTPS port
Warning Template
Customize the template used for system warnings.
By default: {“action”:”${ACTION}”,”mac”:”${MAC}”,”content”:”${WARNING_MSG}”}
Alarm Notification
Alert notification delivery method:
Real-time: Notifications will be sent out as soon as the alerts are generated.
Periodic: Alerts generated within the configured "Notification Interval" time window will be queued up and sent all at once in a single notification.
Notification Interval
When Alarm Notification method is set to Periodic, this option will be available.
The frequency at which HTTP alert notifications are sent. All alert events that have occurred within a send cycle will be sent.
Resource Usage Notification Template
Customize the notification template to receive relevant alert information.
By default: {“action”:”${ACTION}”,”cpu”:”${CPU_USED}”,”memery”:”${MEM_USED}”,”disk”:”${DISK_USED}”,”external_disk”:”${EXTERNAL_DISK_USED}”}
Note: The notification message with “action:0” will be sent periodically if Notification Interval is set.
Notification Interval
Modifies the frequency at which notifications are sent in seconds.
No notifications will be sent if the value is “0”. Default value: 20
Template Variables
${MAC} : MAC Address
${WARNING_MSG} : Warning message
${STATUS} : Alarm Status
${TIME} : Current System Time
${CPU_USED} : CPU Usage
${MEM_USED} : Memory Usage
${ACTION} : Message Type
${DISK_USED} : Local Disk Usage
${EXTERNAL_DISK_USED} : Disk Usage
Task Management
The Task Management feature allows users to schedule various tasks to be performed at a configured date and time. Each task can be set to run either once or repeatedly, depending on user requirements.
The tasks that can be scheduled include:
Paging/Intercom: Schedule automated paging or intercom announcements at specific times.
Backup: Schedule automatic backups of system data to USB, SD card, SFTP server, NAS, or Amazon S3. Users can configure multiple backup tasks, each with its own schedule and storage location.
Data Sync: Schedule synchronization of system data with remote servers to ensure data consistency.
Cleaner: Schedule cleaning tasks for system data, such as CDR records, reports, IM messages, and other files, to maintain storage efficiency.
Detect New Firmware: Schedule automatic checks for new firmware versions.
Update Country/Region: Schedule updates for system country/region settings, which are used for Geo-IP Access Control.
Update Time Zone: Schedule updates for the system time zone configuration.
Task List
In the Task List, users can schedule tasks to be performed either once or repeatedly all of the above task types can be scheduled with specific parameters.
To schedule a task, please follow the steps below:
Navigate to Maintenance→Task Management→Task List→Pending Task
Click on the “Add” button.
Add Task
Select the type of task from the drop-down menu.
Click Next and configure the required parameters for the task, such as date, time, frequency, and additional options specific to the task type.
Create New Task
The Pending Tasks section displays all tasks that have been scheduled but not yet executed. Users can review, edit, or delete tasks from this list before execution.
Pending Tasks
The Task History section logs all tasks that have been performed, including execution time, task type, and status. Users can use this log to verify completed tasks and troubleshoot any issues.
Task History
Scheduled Paging/Intercom
The user can configure a paging or intercom to be initiated automatically according to a schedule. Refer the configuration explained in the table below to be able to configure this feature successfully.
Create New Scheduled Paging
Paging/Intercom
Select pre-existing paging/intercom groups and multicast communities.
Name
Specify the name of the Paging/Intercom schedule.
Caller
When the scheduled time arrives, the system will call this extension. If the call is answered, the paging/intercom will be initiated, if rejected, the paging/intercom will be cancelled.
If no caller is specified, the paging/intercom will be directly initiated.
Start Date
Select the start date.
Start Time
Select the start time
Repeat
Select the repeating frequency.
No Repeat
Every Day
Weekly
Monthly
Sync to Google Calendar
Enabling this option will automatically synchronize the paging/intercom event to the administrator Google Calendar.
Note: This requires that the Google Service integration is configured in this specific UCM.
Scheduled Backup
Scheduled backup task management allows the user to schedule regular backups with a specific interval. This provides an efficient and reliable archiving process which can prevent any accidental loss of data.
Create New Scheduled Backup
Parameter
Description
Name
Enter the name of the scheduled task.
Choose Storage Location
Choose storage location.
NAS
SFTP Server
USB Disk
SD Card
Amazon S3
Date
Specifies the calendar date when the backup task should be executed. Users can select a single date for a one-time backup or a start date for recurring backups.
Time
Defines the exact time of day when the backup task will run. Scheduled backup times must be at least one hour apart from other tasks to avoid conflicts.
Repeat
Determines how often the backup should occur. Options include Every Day, Weekly, Monthly, or Custom for more advanced recurrence settings.
Choose Backup Files
Select the types of files to include in the backup.
All
Config File
IM Message
IM Files
CDR Records
Recording Files
Fax Files
Voicemail
Voice Prompt Files
Queue Statistics Report
Zero Config Storage
Meeting Report
GDS Manager Data
Scheduled Data Sync
Scheduling Data Sync allows the administrator to automate the task of synchronizing the data. When this feature is configured, the UCM will synchronize data to an SFTP server in an incremental way.
Create New Scheduled Data Sync
Parameter
Description
Name
Enter the name of the data sync scheduling.
Choose Data Sync Files
Choose the type of data to synchronize.
CDR Records
Recording Files
Voicemail
Fax
Account
Enter the username of the account created on the SFTP server.
Password
Enter the password of the account created on the SFTP server.
Server Address
Enter the server address. The port number is not mandatory.
Destination Directory
Enter the directory name on which the data will be store for this specific IPPBX.
Sync Time
Select the time when the synchronization is triggered. We recommend that the synchronization is required outside of the production hours.
Scheduled Cleaner
Scheduled Cleaner allows the user to automate the process of cleaning the files stored in the UCM as well as the attached storage of the UCM.
The following is the list of the types of the cleaner which can be configured for scheduling.
Scheduled Cleaner (CDR)
Scheduled Cleaner (Report)
Scheduled Cleaner (IM Data)
Scheduled Cleaner (File)
CDR Cleaner
Parameter
Description
Name
Enter the name of the data sync scheduling.
Choose Data Sync Files
Choose the type of data to synchronize.
CDR Records
Recording Files
Voicemail
Fax
Account
Enter the username of the account created on the SFTP server.
Password
Enter the password of the account created on the SFTP server.
Server Address
Enter the server address. The port number is not mandatory.
Destination Directory
Enter the directory name on which the data will be store for this specific IPPBX.
Sync Time
Select the time when the synchronization is triggered. We recommend that the synchronization is required outside of the production hours.
Report Cleaner
Parameter
Description
Name
Configure the name of the scheduled task.
Cleaner Type
If Scheduled Cleaner (Report) is selected.
Data Type
Select the type of the report to clean automatically.
Queue Statistics Report
Meeting Call Statistics Report
Meeting History
Clean Time
Select the time when the cleaning is triggered.
Cleaning Conditions
Select the factor of triggering the cleaning.
By Schedule: If the value is set to 3, the cleaning will performed every three days, and will delete all the CDR entries which were generated in the 3 days prior.
Keep Last X Records: This option sets a threshold of the number of entries to keep stored. E.g., if set to 50000 entries and the CDR reaches that threshold, the UCM will start deleting the older records.
Keep Last X Days: Keep the reports which are within this period of time.
Corresponding Parameter to "Cleaning Conditions"
When By Schedule is selected as cleaning condition, enter the Clean Interval as number of days.
When Keep Last X Records is selected, enter the number of records as a threshold.
When Keep Last X Days records is selected, the user can configure how long before the cleaner deletes all the files.
IM Data Cleaner
Parameter
Description
Name
Configure the name of the scheduled task.
Cleaner Type
If Scheduled Cleaner (IM Data) is selected.
Data Type
Select the type of the data to clean automatically.
IM Files
IM Message
Clean Time
Select the time when the cleaning is triggered.
Cleaning Conditions
Select the factor of triggering the cleaning.
By Schedule: If the value is set to 3, the cleaning will performed every three days, and will delete all the CDR entries which were generated in the 3 days prior.
Keep Last X Records: This option sets a threshold of the number of entries to keep stored. E.g., if set to 50000 entries and the CDR reaches that threshold, the UCM will start deleting the older records.
Keep Last X Days: Keep the files within this period of time.
Corresponding Parameter to "Cleaning Conditions"
When By Schedule is selected as cleaning condition, enter the Clean Interval as number of days.
When Keep Last X Records is selected, enter the number of records as a threshold.
When Keep Last X Days records is selected, the user can configure how long before the cleaner deletes all the files.
File Cleaner
Parameter
Description
Name
Configure the name of the scheduled task.
Cleaner Type
If Scheduled Cleaner (File) is selected.
Clean Files In External Storage
If enabled, files in the external storage currently being used will be cleaned as configured.
Choose Cleaner Files
Select the file systems for the cleaning.
Basic Call Recordings
Record Meeting
Meeting Video Recordings
Paging/Intercom Recordings
Paging/Intercom Video Recordings
Queue Recordings
Voicemail Files
Emergency Recordings
Fax
SCA Recordings
Backup Files
Clean Time
Select the time when the cleaning is triggered.
Cleaning Conditions
Select the factor of triggering the cleaning.
By Schedule: If the value is set to 3, the cleaning will performed every three days, and will delete all the CDR entries which were generated in the 3 days prior.
Keep Last X Records: This option sets a threshold of the number of entries to keep stored. E.g., if set to 50000 entries and the CDR reaches that threshold, the UCM will start deleting the older records.
Keep Last X Days: Keep the files which are within the period range.
Corresponding Parameter to "Cleaning Conditions"
When By Schedule is selected as cleaning condition, enter the Clean Interval as number of days.
When Keep Last X Records is selected, enter the number of records as a threshold.
When Keep Last X Days records is selected, the user can configure how long before the cleaner deletes all the files.
Scheduled Detect New Firmware
Task scheduling for detecting new firmware allows the user to automate the process of verifying the availability of a new firmware update. Using this feature can ensure that the administrator is notified as soon as there is a new update of the UCM6300 Series software.
Create New Scheduled Detect New Firmware
Parameter
Description
Name
Configure the name of the scheduled task.
Upgrade Method
Select the action when a new firmware is detected.
Notify When a New Firmware is Available
Auto Download and Upgrade Firmware
Email Reminder Before Upgrade (m)
This option appears when you select Auto Download and Upgrade Firmware.
Date
Select the date when the firmware detection first starts.
Time
Select the time when the firmware is detected.
Repeat
Select the frequency of the detection.
No Repeat
Every Day
Weekly
Monthly
Scheduled Update of Country/Region List
Scheduling a regular update of the Country/Region List ensures keeping the list for Geo-IP Access Control up to date with any emergence of new countries or name-change of existing countries. This also allows receiving the update without having to wait for a new firmware release.
Create New Scheduled Update CountryRegion
Parameter
Description
Name
Enter the name of a scheduled task
Date
Enter the date
Time
Enter the time
Repeat
Select the frequency of the update
No Repeat
Every Day
Weekly
Monthly
Schedule Update Time Zone
Scheduling update for timezones ensures that the list can be updated regularly and without the need to wait for a new firmware release.
Create New Scheduled Update Time Zone
Parameter
Description
Name
Enter the name of the data sync scheduling.
Choose Data Sync Files
Choose the type of data to synchronize.
CDR Records
Recording Files
Voicemail
Fax
Account
Enter the username of the account created on the SFTP server.
Password
Enter the password of the account created on the SFTP server.
Server Address
Enter the server address. The port number is not mandatory.
Destination Directory
Enter the directory name on which the data will be store for this specific IPPBX.
Sync Time
Select the time when the synchronization is triggered. We recommend that the synchronization is required outside of the production hours.
Task Schedule
To get an overview about all the tasks which have been scheduled, the user can click on Task Schedule tab to view the full schedule.
Upgrade
During its lifetime, the UCM6300 Series models will receive regular updates. These updates include new features and functionalities, bug fixes, security patches, and general improvements to the security and performance of the device. It is highly recommended that you keep the firmware of your UCM up to date.
Before proceeding with the firmware upgrade, please visit https://www.grandstream.com/support/firmware and download the latest firmware available for the UCM. Once the file has been download, please decompress the file, you will get a .bin file, that’s the file which will uploaded to the UCM.
To upgrade the firmware of the UCM6300 Series, please access the web UI of the UCM, then navigate to Maintenance > Upgrade
Upgrade Firmware
On this page, the user can view the firmware version which is installed on the UCM. Clicking “Detect” will initiate firmware version verification, if there is a newer version, a prompt will appear to confirm downloading and installing the firmware.
The user can also schedule detection of the firmware version by clicking on “Schedule Task”. For more information regarding scheduling tasks, please refer to [Task Management] section.
Click on “Choose File to Upload” field in front of “System Firmware (.bin)”
Use the window to navigate to where the firmware file is located then select it.
Once the firmware file has been selected, the file will be uploaded to the UCM and the upgrade will begin.
A prompt will appear to reboot the device to finalize the upgrade.
Backup
Backup/Restore
Click on the “Upload” to upload backup file from the local device to UCM630x. The uploaded backup file will also be displayed in the web page and can be used to restore the UCM630x.
The Scheduled Backup feature enables UCM to automatically back up selected data according to defined schedules. Users can configure multiple backup tasks, each with its own schedule and storage destination, while ensuring that no two backups run simultaneously. Supported storage options include USB, SD card, SFTP server, NAS, and Amazon S3 storage.
To configure a scheduled backup, please refer to the steps below:
Access the Schedule Backup feature either by clicking the “Schedule Backup” button on the Maintenance→Backup page or by creating a new task in the Maintenance→Task Management page.
Check the Schedule Backup option checkbox to activate backup scheduling.
Enter a name for the task (should be between 2 and 64 characters. Names can include alphanumeric characters, Chinese characters, spaces, and the special characters _ and –).
Select the desired storage destination, such as USB, SD card, SFTP server, NAS, or Amazon S3. The same location can be used for multiple tasks as long as each task is scheduled at a different time.
Specify the date and time for the backup. Scheduled backup times must be at least one hour apart.
Note:
The system does not allow two backup tasks to be scheduled at the same time. If users attempt to create overlapping tasks, the configuration will be blocked because simultaneous backups can affect system performance.
Choose how often the backup should occur: Every Day, Weekly, Monthly, or Custom.
Choose which data to include in the backup. Options include: All, Config File, IM Message, IM Files, CDR Records, Recording Files, Fax Files, Voicemail, Voice Prompt Files, Queue Statistics Report, ZeroConfig Storage, Meeting Report, and GDS Manager Data.
Users can view both scheduled backup tasks and completed backup tasks in the Maintenance→Task Management page. Within this page, the Task List displays all the pending and completed tasks, while the Task Schedule shows the timing and recurrence of upcoming backups.
Restore Configuration from Backup File
To restore the configuration on the UCM630X from a backup file, users could go to Maintenance→Backup→Backup/Restore.
A list of previous configuration backups is displayed on the web page. Users could click on the “Clock” icon of the desired backup file and it will be restored to the UCM630X.
If the backup was stored on GDMS, it will be displayed under Backups GDMS Cloud Storage, that can be restored by clicking on the “Clock” icon.
If users have other backup files on PC to restore on the UCM630X, click on “Upload Backup File” first and select it from local PC to upload on the UCM630X. Once the uploading is done, this backup file will be displayed in the list of previous configuration backups for restore purpose. Click on the “Clock” icon to restore from the backup file.
Restore UCM630X from Backup File
The uploaded backup file must be a .tar or .tgz file with no special characters like *,!,#,@,&,$,%,^,(,),/,\,space in the file name.
The uploaded backup file size must be under 100MB.
Data Sync
Besides local backup, users could backup the voice records/voice mails/CDR in a daily basis to a remote server via SFTP protocol automatically under Maintenance>Backup>Data Sync.
The client account supports special characters such as @ or “.” Allowing the use email address as SFTP accounts. It allows users as well to specify the destination directory on SFTP server for backup file. If the directory does not exist on the destination, UCM630X will create the directory automatically
Data Sync
Enable Data Sync
Enable the auto data sync function. The default setting is “No”.
Account
Enter the Account name on the SFTP backup server.
Password
Enter the Password associate with the Account on the SFTP backup server.
Server Address
Enter the SFTP server address.
Destination Directory
Specify the directory in SFTP server to keep the backup file. Format: ‘xxx/xxx/xxx’, If this directory does not exist, UCM will create this directory automatically.
Sync Time
Enter 0-23 to specify the backup hour of the day.
Data Sync Configuration
Before saving the configuration, users could click on . The UCM630X will then try connecting the server to make sure the server is up and accessible for the UCM630X. Save the changes and all the backup logs will be listed on the web page. After data sync is configured, users could also manually synchronize all data by clicking on instead of waiting for the backup time interval to come.
System Cleanup/Reset
Reset and Reboot
Users could perform reset and reboot under Maintenance >System Cleanup/Reset> Reset and Reboot.
To reboot the device, click on reboot icon.
To factory reset the device, click on reset icon, then all the configurations and data will be reset to factory default.
Reset and Reboot
User can also verify UCM certificate under the same path.
Cleaner
Users can configure the system to clean Call Detail Records (CDRs), voice recordings, voicemails, reports, chat data, meeting history, fax files, backup files, and other stored data either manually or automatically. The Cleaner feature is available under Maintenance→System Cleanup/Reset→Cleaner.
UCM provides the ability to manually clean a variety of data types, including CDRs, report data, chat messages and shared files, recording files, meeting history records, voicemails, fax files, and backup files. Report data includes queue statistics reports and conference call statistics, meeting history includes audio and video conference appointment records.
The following screenshot illustrates the settings and parameters available for configuring the Manual Cleaning feature on UCM630X.
Manual Cleaning Tab
Automatic cleanup is not enabled by default. When configured, automatic cleanup supports scheduled deletion of file data based on parameters such as cleanup time, cleanup conditions, and cleanup intervals.
Users can configure Automatic Cleaning by navigating to Maintenance→System Cleanup/Reset→Cleaner→Automatic Cleaning, or by creating an automated cleaning task under Maintenance→Task Management.
The following screenshot shows some available parameters for configuring automatic cleanup on UCM630X.
Automatic Cleaning Tab
The table below describes all the configurable options that can be configured for automatic cleaning:
CDR Cleaner
Enable Cleaner
Enable the CDR Cleaner function.
Clean Time
Enter 0-23 to specify the hour of the day to clean up CDR.
Cleaning Conditions
By Schedule: If the clean interval is 3, cleaning will be performed every 3 days to remove all records that were generated in the past 3 days.
Keep Last X Records: If the max number of CDR has been reached, CDR will be deleted starting with the oldest entry at the configured cleaning time. (Note: The amount of records displayed on the page of call queue statistics is not one-to-one with the actual amount of records in the database.)
Keep Last X Days: Delete all entries older than X days.
Clean Interval (d)
Enter 1-30 to specify the day of the month to clean up CDR when By Schedule is selected as Cleaning Conditions.
Max Entries
Set the maximum number of CDR entries to keep when Keep Last X Records is selected as Cleaning Conditions.
Default is 50000. Valid range: 10000 – 100000.
Keep Last X Days
Enter the number of days of call log entries to keep when Keep Last X days is selected as Cleaning Conditions.
Default is 30. Valid range: 1 – 100.
Report Cleaner
Enable Cleaner
Enable scheduled queue log cleaning.
Data Type
Select a type of data to clean.
Queue Statistics Report
Meeting Call Statistics Report
Multimedia Meeting History
Clean Time
Enter the hour of the day to start the cleaning. The valid range is 0-23.
Cleaning Conditions
By Schedule: If the clean interval is 3, cleaning will be performed every 3 days to remove all records that were generated 3 days ago.
Keep Last X Records: If the max number of Queue Statistics Report entries has been reached, Queue Statistics Report entries will be deleted starting with the oldest entry at the configured cleaning time. (Note: The amount of records displayed on the page of call queue statistics is not one-to-one with the actual amount of records in the database.)
Keep Last X Days: Delete all entries older than X days.
Clean Interval
Enter how often (in days) to clean queue logs when By Schedule is selected as Cleaning Conditions. The valid range is 1-30.
Max Entries
Set the maximum number of Queue Statistics Report entries to keep when Keep Last X Records is selected as Cleaning Conditions.
Default is 50000. Valid range: 10000 – 100000.
Keep Last X Days
Enter the number of days of Queue Statistics Report entries to keep when Keep Last X days is selected as Cleaning Conditions.
Default is 30. Valid range: 1 – 730.
IM Data Cleaner
Enable Cleaner
Enable IM data cleaner
Clear Chat Data from Endpoint
This option allows users to clean endpoint chat data and is only available when the selected data type includes IM messages. It is disabled by default.
Data Type
Select a type of file to clean.
IM Files
IM Messages
Clean time
Enter the hour of the day to start the cleaning. The valid range is 0-23.
Cleaning Conditions
By Schedule: If the clean interval is 3, cleaning will be performed every 3 days to remove all records that were generated 3 days ago.
Keep Last X Records: If the max number of Conference Call Statistics Report has been reached, Conference Call Statistics Report will be deleted starting with the oldest entry at the configured cleaning time. (Note: The amount of records displayed on the page of call queue statistics is not one-to-one with the actual amount of records in the database.)
Keep Last X Days: Delete all entries older than X days.
Clean Interval
Enter how often (in days) to clean queue logs when By Schedule is selected as Cleaning Conditions. The valid range is 1-30.
Max Entries
Set the maximum number of CDR Conference Call Statistics Report entries to keep when Keep Last X Records is selected as Cleaning Conditions.
Default is 50000. Valid range: 10000 – 100000.
Keep Last X Days
Enter the number of days of Conference Call Statistics Report entries to keep when Keep Last X days is selected as Cleaning Conditions.
Default is 30. Valid range: 1 – 100.
File Cleaner
Enable Cleaner
Enabling files cleaning.
Clean Files in External Device
If enabled the files in external device will be automatically cleaned up as configured.
Choose Cleaner File
Select the files for system automatic clean.
Basic Call Recording Files
Meeting Recording Files
Meeting Video Recordings
Paging/Intercom Recordings
Paging/Intercom Video Recordings
Call Queue Recording Files
Voicemail Files
Emergency Calls Recording Files
Fax
Backup Files
SCA Recording Files
Clean Time
Enter the hour of the day to start the cleaning. The valid range is 0-23.
Cleaning Conditions
By Schedule: If the clean interval is 3, cleaning will be performed every 3 days to delete all files.
By Threshold: Check at the configured cleaning time every day to see if the storage threshold has been exceeded and perform cleaning of all files if it has.
Keep LastX Days: Delete all files older than X days.
File Clean Interval
Enter 1-30 to specify the day of the month to clean up the files.
File Clean Threshold
Enter the internal storage disk usage threshold (in percent). Once this threshold is exceeded, the file cleanup will proceed as scheduled. Valid range is 0-99.
Keep Last X Days
Automatically delete all recordings older than this x days when the threshold is reached. If not set, all data is cleared. Valid range: 1 – 100.
Record History
Name
Shows the identifier for the cleanup task.
Type
Specifies the category of cleanup the task performs
Task Status
Shows the final state of the cleanup task.
Start Time
The exact date and time when the cleanup task was triggered.
Repeat
Indicates the schedule for automatic repetition (if enabled).
Options
Provides the available actions for each task, such as Info and Delete. The Delete action removes the task from the record history, while the Info action displays details about the cleaned files.
When automatic cleaning tasks run, the system logs the cleaning results, allowing users to review each task results, including the total size cleaned and number of items removed, by checking either the Cleaner page or the Task Management sections (Task History).
Checking Cleaning Records from the Cleaner Page
Checking Cleaning Records from Task History
Network Troubleshooting
On the UCM630X, users could capture traces, ping remote host and traceroute remote host for troubleshooting purpose under Maintenance>NetworkTroubleshooting.
The following sections shows the steps to capture different types of traffic traces for analysis purposes.
Ethernet Capture
Ethernet Capture allows capturing the traffic of the UCM for troubleshooting purposes. To access Ethernet Capture feature, please navigate to Maintenance > Network Troubleshooting > Ethernet Capture
Ethernet Capture
The capture packets can be stored locally and downloaded for analysis. However, if the user is diagnosing a randomly-occurring issue, he/she can run a continuous packet capture which can be limited by the size of the packet capture and the number of packet capture instances
Important
When the maximum packet capture file size is reached, a new packet capture file will be created. When the maximum number of capture files number is reached, then the UCM will delete the oldest file created file and replace it with the new one.
Parameter
Description
Capture Type
Ethernet Capture: Gets a packet capture of all network traffic going through the device.
WebSocket Capture: Gets a packet capture of WebSocket protocol. Mainly used for troubleshooting Wave Web calling and conferencing issues.
Interface Type
Select the network interface to monitor.
Capture Filter
Enter the filter to obtain the specific types of traffic, such as (host, src, dst, net, proto…).
Storage Location
Local: Store the captured packets in the local storage.
SFTP Server: Save the capture trace to a SFTP server. Please make sure that SFTP is correctly configured under PBX Settings -> Online Storage -> SFTP Server
External Storage: Save the capture trace in a usb flash drive or an SD card. This requires that a USB flash drive or SD card to be plugged into the PBX. File formats supported are FAT32 and ExFat.
Save to External Storage
When or more external storage units are connected to the PBX, the user will be able to pick which one to use. Note: This option is available only when you choose "External Storage" as the storage destination of the capture trace.
Destination Directory
When SFTP is selected, this option will appear. Please enter the directory path in which you would like to store the captured packets.
Packet Capture Size
This option appears only when "External Storage" or "SFTP" options are selected. Define the packet capture size, the option available are: 50MB, 100MB, and 200MB.
Number of Packet Capture
Define the maximum number of the packets captured. The available options are 5, 10, and 20 packets.
TLS Key
SSL/TLS packets can be decrypted through Wireshark. The packet capture must contain the TLS handshake process.
Download the captured packets. This option can only be used when the captured packets are stored locally.
Enable SRTP Debugging
Check this box to troubleshoot calls encrypted with TLS/SRTP.
The output result is in .pcap format. Therefore, users could specify the capture filter as used in general network traffic capture tool (host, src, dst, net, protocol, port, port range) before starting to capture the trace.
Capture files saved on external devices will now have “capture” prepended to file names.
IP Ping
Enter the target host in host name or IP address. Then press “Start” button. The output result will dynamically display in the window below.
Ping
Traceroute
Enter the target host in host name or IP address. Then press “Start” button. The output result will dynamically display in the window below.
Traceroute
Record Meeting for Diagnosis
Enter the target meeting, support the ongoing meeting, and then click the “Start” button to capture the recording diagnosis of the meeting members in progress. The output result will be automatically displayed below, click the “download” button to download to the local. After the download is complete, immediately click the “Delete” button to clear the system content.
Record Meeting for Diagnosis
Signaling Troubleshooting
Analog Record Trace
Analog Record Trace
Analog record trace can be used to troubleshoot analog trunk issue, for example, the UCM630X user has caller ID issue for incoming call from Analog trunk. Users can access analog record trance under Web GUI🡪Maintenance🡪Signal Troubleshooting.
Here is the step to capture trace:
Select FXO or FXS for “Record Ports”. If the issue happens on FXO 1, select FXO port 1 to record the trace.
Click on “Start”.
Make a call via the analog port that has the issue.
Once done, click on “Stop”.
Click on “Download” to download the analog record trace.
Troubleshooting Analog Trunks
A key Dial-up FXO
Users can directly set a PSTN number on the “External Extension” text box to troubleshoot issues related to the analog trunk easily, the following steps shows how to use this feature:
Configure analog trunk on UCM, including outbound route.
Enter a reachable external number in “External Extension”.
Press “Start” button. The call will be initiated to the external number.
Answer and finish the call before pressing “Stop” button.
The trace will be available for analysis to download after output result shows “Done! Click on Download to download the captured packets”.
A Key Dial up FXO
When using a Key Dial-up FXO feature the outbound trunk for the analog trunk need to have internal permission. As well as it should be the trunk with the highest outbound route priority.
After capturing the trace, users can download it for basic analysis. Or you can contact Grandstream Technical support in the following link for further assistance if the issue is not resolved.
Enable Service Check to periodically check UCM630X. Check Cycle is configurable in seconds and the default setting is 60 sec. Check Times is the maximum number of failed checks before restart the UCM630X. The default setting is 3. If there is no response from UCM630X after 3 attempts (default) to check, current status will be stored and the internal service in UCM630X will be restarted.
Service Check
CDR
CDR
CDR (Call Detail Record) is a data record generated by the PBX that contains attributes specific to a single instance of phone call handled by the PBX. It has several data fields to provide detailed description for the call, such as phone number of the calling party, phone number of the receiving party, start time, call duration, etc. On the UCM630X, the CDR can be accessed under Web GUI🡪CDR🡪CDR. Users could filter the call report by specifying the date range and criteria, depending on how the users would like to include the logs to the report. Click on “Filter” button to display the generated report.
CDR Filter
Call Type
Groups the following:
Inbound calls: Inbound calls are calls originated from a non-internal source (like a VoIP trunk) and sent to an internal extension.
Outbound calls: Outbound calls are calls sent to a non-internal source (like a VoIP trunk) from an internal extension.
Internal calls: Internal calls are calls from one internal extension to another extension, which are not sent over a trunk.
External calls: External calls are calls sent from one trunk to another trunk, which are not sent to any internal extension.
Status
Filter with the call status, the available statuses are the following:
Answered
No Answer
Busy
Failed
Source Trunk Name
Select source trunk(s) and the CDR of calls going through inbound the trunk(s) will be filtered out.
Destination Trunk Name
Select destination trunk(s) and the CDR of calls going outbound through the trunk(s) will be filtered out.
Action Type
Filter calls using the Action Type, the following actions are available:
Announce
Announcement page
Dial
Announcements
Callback
Call Forward
Conference
DISA
Follow Me
IVR
Page
Parked Call
Queue
Ring Group
Transfer
VM
VMG
Video Conference
VQ_Callback
Wakeup
Emergency Call
Emergency Notify
SCA
Extension Group
Specify the Extension Group name to filter with.
Export File Data
Select the fields that will be exported, the following fields are available:
Account Code
Session
Premier caller
Action type
Source trunk name
Destination trunk name
Caller number
Caller ID
Caller name
Callee number
Answer by
Context
Start time
Answer time
End time
Call time
Talk time
Source channel
Dest channel
Call status
Dest channel extension
Last app
Last data
Ama Flags
Unique ID
Call type
NAT
Cost
Account Code
Select the account Code to filter with. If pin group CDR is enabled, the call with pin group information will be displayed as part of the CDR under Account Code Field.
Start Time
Specify the start time to filter the CDR report. Click on the calendar icon on the right and the calendar will show for users to select the exact date and time.
End Time
Specify the end time to filter the CDR report. Click on the calendar icon on the right and the calendar will show for users to select the exact date and time.
Caller Number
Enter the caller number to filter the CDR report. CDR with the matching caller number will be filtered out.
User could specify a particular caller number or enter a pattern. ‘.’ matches zero or more characters, only appears in the end. ‘X’ matches any digit from 0 to 9, case-insensitive, repeatable, only appears in the end.
For example:
3XXX: It will filter out CDR that having caller number with leading digit 3 and of 4 digits’ length.
3.: It will filter out CDR that having caller number with leading digit 3 and of any length.
Caller Name
Enter the caller name to filter the CDR report. CDR with the matching caller name will be filtered out.
Callee Number
Enter the callee number to filter the CDR report. CDR with the matching callee number will be filtered out.
Note: The “Callee Number” filter field supports specifying Pattern (example: 3XXX) or using Leading digits (example: 3.) as filtering options.
The call report will display as the following figure shows.
Call Report
The CDR report has the following data fields:
Start Time: Format: 2019-12-11 09:53:03
Action Type: IVR, DIAL, WAKEUP, etc…
Call From: Example format: 5555
Call To: Example format: 1000
Call Time: Format: 0:00:11
Talk Time: Format: 0:00:06
Account Code: Example format: Grandstream/Test
Status: Answered, Busy, No answer, or Failed.
Sort by “Start Time”: Click on the header of the column to sort the report by “Start Time”. Clicking on “Start Time” again will reverse the order.
Download Searched Results: Click on “Download Search Result(s)” to export the records filtered out to a .csv file.
Download All Records: Click on “Download All Records” to export all the records to a .csv file.
Delete All: Click on button to remove all the call report information.
Delete Search Result: On the bottom of the page, click on button to remove CDR records that appear on search results. Note: When deleting CDR, a prompt will now appear asking whether to delete all recording files or not.
Play/Download/Delete Recording File (per entry)
If the entry has audio recording file for the call, the three icons on the rightest column will be activated for users to select. In the following picture, the second entry has audio recording file for the call.
Click on
to play the recording file; click on
to download the recording file in .wav format; click on
to delete the recording file (the call record entry will not be deleted).
Call Report Entry with Audio Recording File
Automatic Download CDR Records
User could configure the UCM630X to automatically download the CDR records and send the records to multiple Email recipients in a specific hour. Click on “Automatic Download Settings” and configure the parameters in the dialog below.
Automatic Download Settings
To receive CDR record automatically from Email, check “Enable” and select a time period “By Day” “By Week” or “By Month”, select Hour of the day as well for the automatic download period. Make sure you have entered an Email or multiple email addresses where to receive the CDR records.
users have the option to delete the sent records “Delete Sent Records”
Starting from UCM630X firmware 1.0.10.x, transferred call will no longer be displayed as a separate call entry in CDR. It will display within call record in the same entry. CDR new features can be found under Web GUI🡪CDR🡪CDR. The user can click on the option icon for a specific call log entry to view details about this entry, such as premier caller and transferred call information.
CDR Report
Detailed CDR Information
Downloaded CDR File
Caller number, Callee number
“Caller number”: the caller ID.
“Callee number”: the callee ID.
If the “Source Channel” contains “DAHDI”, this means the call is from FXO/PSTN line.
Downloaded CDR File Sample
Context
There are different context values that might show up in the downloaded CDR file. The actual value can vary case by case. Here are some sample values and their descriptions.
from-internal: internal extension makes outbound calls.
ext-did-XXXXX: inbound calls. It starts with “ext-did”, and “XXXXX” content varies case by case, which also relate to the order when the trunk is created.
ext-local: internal calls between local extensions.
Source Channel, Dest Channel
Sample 1:
Downloaded CDR File Sample Source Channel and Dest Channel 1
DAHDI means it is an analog call, FXO or FXS.
For UCM6302, DAHDI/(1-2) are FXO ports, and DAHDI(3-4) are FXS ports.
For UCM6304, DAHDI/(1-4) are FXO ports, and DAHDI(5-6) are FXS ports.
For UCM6308, DAHDI/(1-8) are FXO ports, and DAHDI(9-10) are FXS ports.
Sample 2:
Downloaded CDR File Sample Source Channel and Dest Channel 2
“SIP” means it is a SIP call. There are three format:
(a) PJSIP/NUM-XXXXXX, where NUM is the local SIP extension number. The last XXXXX is a random string and can be ignored.
(c) PJSIP/trunk_X/NUM, where trunk_X is the internal trunk name, and NUM is the number to dial out through the trunk.
(c) PJSIP/trunk_X-XXXXXX, where trunk_X is the internal trunk name and it is an inbound call from this trunk. The last XXXXX is a random string and can be ignored.
There are some other values, but these values are the application name which are used by the dialplan.
IAX2/NUM-XXXXXXX: it means this is an IAX call.
Local/@from-internal-XXXXX: it is used internally to do some special feature procedure. We can simply ignore it.
Hangup: the call is hung up from the dialplan. This indicates there are some errors or it has run into abnormal cases.
Playback: play some prompts to you, such as 183 response or run into an IVR.
ReadExten: collect numbers from user. It may occur when you input PIN codes or run into DISA
Note: The language of column titles in exported CDR reports and statistics reports will be based on the UCM’s display language
CDR Export Customization
Users can select the data they want to see in exported CDR reports by first clicking on the Filter button on the CDR page under CDR🡪CDR and selecting the desired information in the Export File Data field.
CDR Export File data
Call Rate
In Call Rate, the user can set call billing for outbound calls. The user can choose to include the call rate onfigured in Carrier or configure rates for calls which are identified through a prefix.
Note
If Using Carrier Call Rates has not been enabled, the UCM will fall back to the Other Call Rates table.
Call Rate
To add specific rates, click on “Add Rate”.
Parameter
Description
Name
Enter the name of the call rate.
Match Prefix
Enter the matching prefix of the outgoing number dialed to match the corresponding rate. The prefix entered must match the outgoing mode of the outgoing route. Leave this field blank if you want to calculate every call using this rate. The matching will be done before any digit stripping or prepending is done.
Starting Cost
Configure the starting flat fee to charge for calls. If the length of the external call does not exceed the start time, only this fee will be charged.
Starting Time (seconds)
Sets the starting time period for call billing. If the length of an external call does not exceed the starting time, only the starting cost amount will be charged.
Example1: If the starting cost is set to 0.2, and the starting time is set to 60, the first 60 seconds of a call will be charged a flat amount of 0.20 dollars (or other currency). If the starting cost is set to 0 instead, the first 60 seconds will be free.
Example 2: If the starting cost is set to 0.2 and the starting time is set to 0, the call billing will start upon dialing with an initial cost of 0.2 currency unit.
Example 3: If the starting cost is set to 0 and the billing time is set to 0, the billing will start upon dialing with no initial cost.
Rate
Sets the billing rate of a call after the starting time period has ended. This is used with Billing Unit (sec) to calculate the cost of a call (Call Charge = Starting Cost + Rate x Amount of Time Exceeding Start Time).
Billing Unit (sec)
Sets the billing unit used after the starting time period has ended. This is used with Rate to calculate the cost of a call (Call Charge = Starting Cost + Rate x Amount of Time Exceeding Start Time). Partial units are rounded up (e.g., If the billing unit is set to 60 seconds, and the call lasted 90 seconds (1.5 units), the guest will be billed for 120 seconds (2 units)).
Start Time
Define the starting time. After this time, this rate will be applied.
End Time
Define the end time. After this time, this rate will not be applied.
Disable the rate
Ticking this box will disable this rate. Unticking this box means that this rate will apply.
The UCM provides a comprehensive CDR analytics framework for monitoring, analyzing, and reporting voice traffic across the system. This module is designed to give administrators operational visibility into call patterns, resource utilization, user behavior, and cost distribution.
CDR Statistics
UCM supports the function of concurrent call statistics. This function provides users with statistics on the number of concurrent calls of all VoIP trunks (SIP trunks and IAX trunks). Users can set search criteria to generate custom charts. Select the trunk and time to view the chart of the maximum number of concurrent calls corresponding to the trunk in a certain day or month.
CDR Statistics Tab
Action Type
Select one of the following trunk type
All
SIP Calls
PSTN Calls
Time Range
Select the time period to use for filtering
By month (of the selected year)
By week (of the selected year)
By day (of the specified month for the year)
By hour (of the specified date)
By range. Example: 2016-01 to 2016-03
Call Type
Select one or more in the following checkboxes.
All Calls
Inbound Calls
Outbound Calls
Internal Calls
External Calls
Remote Calls
Concurrent Call Statistics
In this tab, the administrator can view the statistics regarding the concurrent calls. The administrator can choose to view the statistics per day, month, and year. The user can also view all calls, inbound calls, or outbound calls; or a combination of all of them together.
Concurrent Call Statistics Tab
Call Charges Statistics
In call Charges Statistics tab, the administrator can view the charges applied to the calls represented in a graph. The administrator can search by time interval, they can also filter per extension, extension group, by department. Once the administrator sets the intended parameters in the filter, they can display and download the filtered statistics.
Call Charges Statistics Tab
Call Reports
The Call Reports section provides analytics based on different operations within the PBX. These reports allow administrators to analyze how calls are distributed, handled, and processed across extensions, trunks, and system components.
Extension Call Statistics
This report displays insights into call volume associated with selected:
Extensions
Extension groups
Departments
Administrators can filter by time period and call type (inbound, outbound, internal, etc.) to analyze how traffic is distributed across users or organizational units.
Extension Call Statistics
Extension Call Activity
This report focuses on how calls and selected call types were handled by the specified extensions/extension groups/departments over the specified time periods.
Extension Call Activity
PBX Call Activity
This report provides a system-wide view of call activity across selected trunks, which include or exclude internal calls (extension-to-extension) and can be filtered by call direction.
This enables comparison between internal PBX traffic and external trunk usage, helping identify overall system load distribution and trunk utilization patterns.
PBX Call Activity
Outbound Caller ID Activity
This report provides visibility into outbound call usage based on the selected trunk and caller ID configuration.
It displays how outbound calls are distributed across:
Trunks
Caller IDs
Outbound Caller ID Activity
IVR Report
This option provides analysis of IVR interactions over a selected time period and supports two reporting modes:
Standard Mode: Captures key press events (0–9, *, #), including invalid inputs and timeout events, providing detailed per-key interaction statistics.
Custom Mode: Supports multi-digit or combined key inputs. Reports aggregate IVR activity, including total call entries, invalid inputs, and timeouts.
Standard IVR Report
Custom IVR Report
The report can be exported in two formats:
Basic List: Lists all IVRs and the trigger counts of their key press events.
Detailed List: Includes the caller information, triggered key press events, the time of the events, and how long the callers were in the IVRs. In addition to the information in the Basic report
IVR Report Export Types
Ring Group Statistics
This report provides performance metrics for ring groups, including total calls received, answered calls, and answer rate.
It enables evaluation of call distribution efficiency and group responsiveness across configured ring groups.
Ring Group Statistics
Call Queue Reports
The Call Queue Reports section provides comprehensive, dedicated analytics for call queue performance, agent activities, and queue response metrics across the UCM. Administrators can use these reports to analyze call flow efficiency, monitor agent productivity, and track queue responsiveness over selected time periods.
To access these reports, please navigate to CDR → Statistics → Call Queue Report and select a report type from the drop-down menu to view its detailed metrics.
Agent Call Summary
Measures individual agent call statistics throughout a specified date range and queue. It displays total calls handled, answered volume, total talk time, average wait time, average talk time, and average handling time per agent.
Agent Login Report
Lists individual agent login activity throughout a selected date range for a specific call queue, allowing administrators to track attendance, active duration, and login/logout timestamps.
Agent Unanswered Report
Displays individual agent unanswered calls throughout a date range. It provides visibility into the number of missed calls, attempts, and caller number.
Agent Pause Report
Lists individual agent pausing activity throughout a date range, tracking pause durations, reasons, and total offline time during operational hours.
Agent Performance
Measures individual agent performance listed and grouped directly under their respective queues throughout a date range, enabling direct performance comparisons within specific teams.
Queue Average Wait Time & Talk Time
Displays a graph showing caller wait time and talk time hourly, daily, or monthly for selected queues, averaging the data across the chosen time frame to help optimize queue staffing levels.
Queue Callback Report
Lists individual queue callback activity throughout a date range and specified queue, detailing requested callbacks, execution timestamps, and call results.
Queue Callback Summary
Displays a graphical representation of queue callback statistics over a specified date range. It provides visual insights into overall callback performance, comparing successful connections against failed callback attempts across the selected queues.
Queue Performance
Measures individual queue performance throughout a date range, focusing on total wait duration, average handling time, and overall service levels per queue.
Queue Performance Activity
Provides a time-based breakdown (hourly, daily, or monthly) of call queue activity. Administrators can use this report to evaluate traffic distribution, monitor answer rates and average wait times, and track SLA performance over a selected period.
Agent Activity Report
Provides a comprehensive performance breakdown for each agent across selected queues over a specified date range. It details total call volume, answer rates, unanswered calls, wait times, talk duration, and average handling times per agent.
Queue Record Report
Lists every individual call made to the selected queues throughout a specified date range. It details the caller number, queue status, number of call attempts, answering agent, call timestamp, total wait duration, and total talk time.
Agent Inbound Queue Record Report
Displays a granular call log for each agent within selected queues over a date range, tracking individual interactions, ring duration, talk time, wait time, and whether the agent answered or missed the call.
Queue Analysis Report
Sorts and measures call statistics on an hourly, daily, or monthly basis, displaying a dedicated row for each individual queue during every time interval. This provides per-queue trends, unlike Queue Performance Activity, which summarizes total system traffic.
Queue Statistics Report
Generates a satisfaction breakdown for selected queues within a date range, categorizing caller rating scores into levels 1 to 5 alongside counts for non-surveyed calls.
Scheduled Report
The Scheduled Report tab allows administrators to create automated report delivery schedules and have reports sent via email at regular intervals.
Note:
This feature is limited to call queue reports.
Note:
In order to receive the scheduled reports, administrators must correctly configure Email Settings.
To configure an automated report schedule:
Navigate to CDR → Statistics → Scheduled Report.
Click Add to open the creation window (or click Email Template to customize the notification layout).
Under Report Data, select the Report Type, Time frame, target Queues, Agents, and customize the List Fields to include in the output.
Under Schedule Information, enter the schedule Name, recipient Email, preferred Export Type (XLSX, CSV, PDF), and execution recurrence pattern (Repeat interval and time).
Once configured, all active schedules are listed on this page for quick editing or management.
Schedule Records
The Schedule Records tab provides full historical tracking and audit logging for all automated email report transmissions. On this page users can:
Review historical entries including the schedule Name, transmission Send Status (e.g., Sent successfully), and exact Send Time.
Click the Info icon (i) under the Options column to preview the sent report in a different tab.
Select individual or multiple log entries to delete historical records as needed.
Recordings
This page lists all the recording files recorded by “Auto Record” per extension/ring group/call queue/trunk, or via feature code “Audio Mix Record”. If external storage device is plugged in, for example, SD card or USB drive, the files are stored on the external storage. Otherwise, internal storage will be used on the UCM630X.
CDR > Recording Files
Click on “Download” to batch-download the selected recording files.
Click on “Download All” to download all the recording files.
Click on “Delete” to batch-delete the selected recording files.
Click on “Clear” to delete all the recording files.
Click on “Scan” to retrieve the file information and display all the recording files on external storage. The UCM automatically retrieves the info of the first 5000 files from external storage already. This button can be used when the number of files stored on the external storage exceeds 5000 files and it requires manual file scanning.
Select either “USB Disk” or “Local” to show recording files stored on external or internal storage, depending on selected storage space.
Select whether to show call recordings, queue recordings or conference recordings.
Click on to download the recording file in .wav format.
Click on to delete the recording file.
To sort the recording file, click on the title “Caller”, “Callee” or “Call Time” for the corresponding column. Click on the title again can switch the sorting mode between ascending order or descending order.
Note:
If Data/File encryption is enabled for audio/video call recordings, scanning the external storage for recordings via the Scan button will automatically encrypt all the found recordings.
PROVISIONING
UCM6300 Series supports configuration provisioning via GDMS, enabling users to configure a single UCM6300 Series device or perform batch configurations using predefined templates to ensure consistency and increase efficiency.
This section describes in detail how UCM6300 Series leverages GDMS to facilitate efficient configuration provisioning for both individual devices and large-scale deployments.
Configuration Parameters
To give users a better understanding of the configuration possibilities, the following diagram outlines the key configuration parameters available in UCM6300 through GDMS.
UCM6300 Series Configuration Template Parameters
Creating UCM6300 Configuration Template
UCM6300 Series supports provisioning using two types of templates:
Model Template
After adding a UCM6300 model template, the configuration will be pushed to the selected site automatically, except for UCM6300 series where push configuration has been disabled. (See image below)
In order to add a UCM6300 model template, please follow these steps:
Go to Organization → Device Template → By Model and click on
Enter a name for this template and select UCM6300 from the Model list.
Select The Model
Choose whether to automatically push this template to a specific site, all sites or none. Users can also add a description for this template (optional).
Select Sites
Configure the model template parameters and click Save. A prompt will appear, confirming the change and offering the option to push the configuration to the entire site or to specific devices.
Group Template
Users can configure a group of UCM6300 devices and apply settings to the entire group simultaneously by following the instructtions below:
Under Organization → Device Template → By Group, click on
Name the group and choose the UCM6300 series from the Type dropdown list. Writing a description is optional.
Add Group Template
Select the target devices by checking the boxes or by entering their MAC Address.
Add Devices To The Group Template
Pushing Configuration For UCM6300 Series
There are several methods available for users to push configurations to a UCM6300 device. This section will explain each method in detail, but first, it is important to highlight some important notes.
Notes
If a required configuration parameter fails (e.g. invalid voicemail password), the configuration will be considered unsuccessful.
If a restart is needed, it will be performed immediately.
When using a configuration template for a new UCM6300 Series device, the setup wizard will still appear upon the first login and cannot be skipped.
Warning
The enabled fields in template configuration will override the configuration configured on the UCM. Reviewing your configuration before pushing it to the UCM is mandatory to avoid any misconfiguration.
Setting Parameters for a Single UCM6300 Series
The user can edit the configuration for a single UCM6300 by going to UCMRC > On-Premise PBX.
Then click on then click on “Set Parameters” as shown below in the screenshot.
UCM6300 Series Set Parameters
Automatically Pushing the Configuration
When adding a UCM6300 Series device and the selected site has an associated UCM6300 Series model template, a prompt will appear with the option to allow the automatic push configuration.
Push Configuration When Adding a New Device
As mentioned previously, users can disable/enable push configuration anytime for a specific UCM6300 Series. The following table includes the icons related to automatic push configuration:
Icon
Description
Push configuration is prohibited.
Configuration is being pushed.
Last push configuration has failed. (Users can click on this icon to try again)
Manually Pushing The Configuration
It is possible to manually push model configuration templates or group configuration templates to multiple UCM6300 Series. This can be done by clicking on the Push Configuration Update icon that can be found under Organization > Device Template > By Model/By Group.
Push Configuration Manually
Select the device from the list, as shown in the screenshot below, or select Enter MAC Address to type the MAC address of the target device.
Choose a Device
REMOTECONNECT
An integrated and essential component of Grandstream’s GDMS cloud-based device management service, UCM RemoteConnect runs on Amazon Web Services (AWS) and provides high-availability remote communication and collaboration services.
UCM RemoteConnect enables work from home and mobile users to securely access UCM services using Grandstream Wave softphones, with license-free WebRTC-based communication, automatic NAT traversal, and centralized cloud-based management. In addition, RemoteConnect provides GDMS cloud storage, Cloud IM, AI Services, and other collaboration and management features.
The RemoteConnect service can be configured from the UCM Web GUI under the RemoteConnect tab.
This section provides an overview of the RemoteConnect service associated with the UCM, including service description, current subscription status, and configurable plan options.
Service Description
After the UCM is added to GDMS, RemoteConnect enables automated SIP extension synchronization, Media NAT Traversal, and basic statistics without requiring manual configuration. These services allow remote users and devices to connect reliably through the cloud.
This tab provides an overview of the UCMRC services and displays the current subscription plan, as well as related links and learning resources for the services supported by RemoteConnect.
RemoteConnect Service Description Tab
My Plan
This page displays detailed information about the currently active RemoteConnect subscription, including plan name, expiration date, concurrent session limits, remote registration limits, call time limits, allocated GDMS cloud storage space, Wave RemoteConnect addresses, and support status for Wave add-ins, Cloud IM Server, and AI features.
RemoteConnect My Plan Tab
Plan Settings
This tab allows administrators to configure how the UCM interacts with UCMRC services, including SIP synchronization, NAT traversal, cloud storage, backups, and remote access behavior. All settings on this page take effect immediately after saving and directly impact how the UCM integrates with GDMS and cloud services.
RemoteConnect Plan Settings Tab
The table below describes the configurable parameters on this page.
Subscription
Subscription Package Status
Once enabled, the configured email address will receive notifications about the UCMRC package status such as expiration or low balance.
Email
The email entered in this field will receive updates regarding subscription status.
General
SIP Extension Sync
Enables synchronization of SIP extensions between the UCM and GDMS. When enabled, all SIP extensions on the UCM are automatically exported to GDMS.
Media NAT Traversal Service
Enables automatic TURN based NAT traversal for remote users and devices. When enabled, any defined NAT traversal or TURN settings configured locally on the UCM are overridden.
Automatically Update the External Host Address for Wave
Controls whether the Wave external host address is automatically synchronized from UCMRC. Disable this option to retain a user defined Wave domain or external address.
Alert Events Sync
Synchronizes alarm and event information generated on the UCM to the GDMS platform.
Remote Login Settings
Opens the configuration page for managing passwordless remote access to the UCM.
Storage & Backup
GDMS Cloud Storage
Enables cloud storage services provided by GDMS. This option must be enabled to use cloud-based storage features.
Notes:
Even if this option is disabled, users will still be able to retrieve data/files stored on GDMS.
The UCM will automatically turn on the GDMS Cloud Storage alert event option if this feature is enabled.
CDR Stored in GDMS Cloud
If enabled, UCM CDR data will be synced to the GDMS server at 2 AM on the 1st of each month based on the UCM’s system time.
Back up to GDMS
Opens the backup configuration page, allowing UCM configuration backups to be stored in GDMS cloud storage.
Recordings Stored in GDMS Cloud
Opens the file manager configuration page, where administrators can control if call recordings are stored in GDMS cloud storage.
Chat Data Cloud Storage
Opens the file manager configuration page, where administrators can control the chat data storage, allowing instant messaging data to be stored in GDMS cloud storage.
Passwordless Remote Access
Enable Passwordless Remote Access
Allows authorized GDMS users to access the UCM without entering the local UCM account password.
When “SIP Extension Sync” is enabled, the accounts synchronized to GDMS platform can be viewed on the GDMS→VoIP Account→SIP Account page. As shown in the figure below:
UCM SIP Extensions synchronized to GDMS
Note
Deleting an account on GDMS only removes the association between the account and the device, and does not delete the SIP account information on UCM.
Any creation, deletion or modification of the SIP account on UCM will be automatically synchronized to the GDMS cloud platform.
AI Services
This section displays AI related service status and usage information for the UCM. It provides visibility into the active AI plan, its validity period, and detailed usage statistics. Users can also jump to configure AI Settings from this page.
Supported AI features include:
AI Voice Message to Text
AI Generated Speech (Text-to-Speech)
AI Call Transcription and Summary
AI Conference Transcription and Summary
Usage statistics show monthly consumption per feature and total usage versus the available quota, helping administrators monitor AI resource usage.
RemoteConnect AI Services Page
Integrated Customer Service
This section allows administrators to configure web-based customer service features that integrate voice communication into websites. It provides access to SDK downloads and configuration options for customer service interactions.
Click2Call can be enabled to allow website visitors to initiate calls directly from a web browser. Calls can be routed to call queues or specific extensions. Live Chat customer service integration is also supported through this section.
RemoteConnect Integrated Customer Service Page
Enterprise UI Customization
With a RemoteConnect plan, the Enterprise UI Customization page allows administrators to apply customized branding across the UCM and Wave interfaces. From this page, the company name can be configured and multiple logo images can be uploaded to replace the default branding in supported system interfaces.
The system supports different logo sizes and formats to ensure proper rendering in various locations as described below
Logo 1 (80×80px): Replaces the Grandstream logo on the top left corner of the Wave Web interface and UCM management interface. The recommended format is PNG, and the maximum file size is 2 MB.
Logo 2 (256×64px): Replaces the Grandstream banner on the top left corner of the login page and emails. The recommended format is PNG, and the maximum file size is 2 MB.
Logo 3 (64×64px): Replaces Browser tab icon. The recommended format is .ico, and the maximum file size is 2 MB.
A built-in preview panel is provided on the right side of the page, allowing administrators to review how the configured company name and logos will appear in different interfaces.
Note:
To ensure optimal visibility and contrast with the system UI, it is recommended not to use blue, black, or white as the primary logo color.
RemoteConnect Enterprise UI Customization Page
Statistics
The Statistics page provides an overview of RemoteConnect usage by displaying historical data on maximum concurrent remote sessions. This information helps administrators monitor RemoteConnect capacity usage and understand how remote access services are consumed over time.
Usage statistics can be viewed by month, week, or day. When viewing data by month, the system displays the highest number of concurrent remote sessions recorded during each month of the selected year.
When the correspondent RemoteConnect plan is active, the user can access to a GDMS Cloud Storage Space to get an overview about how the storage space is being used. The data is represented in four categories of file types: CDR Data, Backup Data, Recording Files, and IM Files.
The user is also able to see the names of all the files stored in the GDMS Cloud Storage Space.
RemoteConnect GDMS Cloud Storage Space Page
On this page the user can obtain the file key by clicking on the following hyperlink.
The AI Settings page allows administrators to configure the usage of AI services provided through the RemoteConnect AI service. These features enable automatic speech recognition, transcription, summarization, and text-to-speech processing for calls, conferences, and voice messages.
AI services are a purchaseable add-on and subject to usage limits defined by the active RemoteConnect plan. The administrator can enable each AI feature independently and define whether it applies to all extensions or only selected extensions.
The following AI capabilities are supported on the UCM:
AI Call Transcription and Summary
AI Conference Transcription and Summary
AI Voice Message to Text
AI Generated Speech
AI Settings Page
AI Call Transcription and Summary
This feature enables AI-based transcription and summarization for one-to-one calls. When enabled globally, the administrator defines whether the feature applies to all extensions or only selected extensions. Only extensions included in this scope are eligible for call transcription and summarization.
AI Call Transcription and Summary General Setting
At the extension level, the Automatic Transcribing and Summarizing option determines whether calls for that extension are processed automatically. When enabled, all calls made or received by the extension are automatically transcribed and summarized.
The recognition language can be configured globally under AI Settings (Beta)→AI Call Transcription and Summary and followed by the extension, or explicitly set per extension.
Extension Automatic Call Transcription
Generated transcripts and summaries can be viewed by users through the Wave client, as shown below.
Call Transcript on Wave
AI Meeting Transcription and Summary
This feature enables AI-based transcription and summarization for conference calls and meetings. When enabled, meeting audio is processed by the AI service and a transcript and summary are generated after the meeting ends. The administrator can define whether the feature applies to all extensions or only selected extensions participating in conferences.
AI Meeting Transcription and Summary Setting
When scheduling a meeting, the meeting organizer can explicitly choose whether the conference will be transcribed or not. This selection applies only to the scheduled meeting and does not affect global or extension-level AI settings.
AI Transcription Support for Scheduled Meeting
Meeting transcripts and summaries can be accessed by participants through supported Wave clients and user portals.
Meeting Transcript on Wave
AI Voice Message to Text
This feature converts voice messages (voicemail) into text using AI speech recognition. When enabled globally, voice messages left for eligible extensions can be transcribed.
AI Voice Message to Text General Setting
At the extension level, the Automatic Transcription option determines whether voice messages for that extension are automatically converted into text.
The recognition language can follow the global configuration or be explicitly specified for the extension.
Extension Automatic Voicemail Transcription
Transcribed voicemail content can be viewed in supported Wave clients and may also be included in voicemail notifications, depending on system configuration.
Voicemail Transcript Email
Voicemail Transcript on Wave
AI Generated Speech
The AI Generated Speech feature provides text-to-speech (TTS) capabilities powered by the AI service, allowing administrators to generate voice prompt audio directly from text. This feature is primarily used for IVR prompts, queue announcements, and other system voice prompts, eliminating the need to manually record or upload audio files.
Before using this feature, AI Generated Speech must be enabled on the AI Services page. Once enabled, administrators can generate AI-based voice prompts from multiple entry points in the system.
AI Generated Speech General Setting
The feature can be accessed from PBX Settings→Voice Prompt→Custom Prompt by clicking the AI Generated Speech button, which opens the AI generation window.
AI Generated Speech Option in Custom Prompt
It is also accessible while configuring features that require voice prompts (such as call queues). In those cases, selecting AI Generated Speech from the prompt selection dropdown redirects the user to the same AI generation window used in the Voice Prompt page.
Call Queue AI Generated Prompt Option
When creating an AI-generated voice prompt, the following settings are available:
AI Generated Speech Configuration Options
Name
Defines the name of the generated voice prompt. This name is used to identify the prompt in the system and must be unique. The field supports 2–64 characters, including letters, numbers, and special characters.
Text
Specifies the text content that will be converted into speech. The text length supports up to 5,000 characters.
Language
Specifies the language used for text-to-speech processing.
Voice
Selects the voice profile used to generate the speech. Different voice options may be available depending on the selected language.
A preview option is provided, allowing administrators to listen to the voice style before generating the prompt.
Speech Speed
Controls the playback speed of the generated speech. The speed can be adjusted from slower to faster relative to normal speaking speed.
Volume
Adjusts the output volume level of the generated audio. The value can be set from 0 to 100 to accommodate different playback environments.
Pitch
Controls the pitch of the generated voice. Higher values produce a higher-frequency voice, while lower values produce a deeper tone. The pitch range can be set from 0 to 100.
After configuring the parameters, clicking AI Generate produces the audio preview. Once satisfied, the generated prompt can be saved and reused like any other system voice prompt.
API Configuration
The UCM630X supports third party billing interface API for external billing software to access CDR and call recordings on the PBX. The API uses HTTPS to request the CDR data and call recording data matching given parameters as configured on the third-party application.
API Configuration Parameters
Before accessing the API, the administrators need enable API and configure the access/authentication information on the UCM630X first under Integrations🡪API Configuration. The API configuration parameters are listed in the tables below.
Note
You can create multiple users with different login credentials to access to the HTTPS API.
Note
The old version of the API interface only supports cdrapi, recapi and pmsapi functions, and will be removed, please use the new HTTPS API instead.
Username
The username for API Authentication.
Password
The password for API Authentication.
IP Address Allowlist
If enabled, only addresses in the list below will be allowed access.
If disabled, geo-ip access control will be used instead.
API Interface Permissions
Select the API interface permissions. The permissions which can be selected with their respective parameters are listed below.
Call Control
CDR
Contacts
Device Management
Extensions
Extension Group
Files
Inbound Routes
IVR
Multimedia Meeting
Outbound Rules
Paging/Intercom
PIN Groups
PMS
Queues
Recordings
Status
Trunk
User Information
HTTPS API Settings (Old)
Basic Settings
Enable
Enable/Disable API. The default setting is disabled.
TLS Bind Address
Configure the IP address for TLS server to bind to. “0.0.0.0” means binding to all interfaces. The port number is optional, and the default port number is 8443. The IP address must match the common name (host name) in the certificate so that the TLS socket will not bind to multiple IP addresses.
The default setting is 0.0.0.0:8443.
Username
Configure the username for TLS authentication.
Password
Configure the password for TLS authentication.
Permitted IP(s)
Specify a list of IP addresses permitted to use the API. This creates an API-specific access control list. Multiple entries are allowed.
For example, “192.168.40.3/255.255.255.255” denies access from all IP addresses except 192.168.40.3.
By default, this is blank, which indicates that no IP addresses are allowed to use this API.
Other Settings
TLS Private Key
Upload TLS private key. The size of the key file must be under 2MB. This file will be renamed as ‘private.pem’ automatically.
TLS Cert
Upload TLS cert. The size of the certificate must be under 2MB. This is the certificate file (*.pem format only) for TLS connection. This file will be renamed as “certificate.pem” automatically. It contains private key for the client and signed certificate for the server.
API Module
CDR API
Enable/disable CDR API module.
REC API
Enable/disable REC API module.
PMS API
Enable/disable PMS API module.
Configuration Parameters (Old)
For more details on CDR API (Access to Call Detail Records), REC API (Access to Call Recording Files) and PMS API, please refer the document in the link here:
The new API supports now new queries listed below which will accomplish certain requests and get data about different modules on UCM630X.
getSystemStatus
addInboundRoute
listPaginggroup
getSystemGeneralStatus
getInboundRoute
addPaginggroup
listAccount
updateInboundRoute
getPaginggroup
getSIPAccount
deleteInboundRoute
updatePaginggroup
updateSIPAccount
playPromptByOrg
deletePaginggroup
listVoIPTrunk
listBridgedChannels
MulticastPaging
addSIPTrunk
listUnBridgedChannels
MulticastPagingHangup
getSIPTrunk
Hangup
listIVR
updateSIPTrunk
Callbarge
addIVR
deleteSIPTrunk
listQueue
getIVR
listOutboundRoute
getQueue
updateIVR
addOutboundRoute
updateQueue
deleteIVR
getOutboundRoute
addQueue
cdrapi
updateOutboundRoute
deleteQueue
recapi
deleteOutboundRoute
loginLogoffQueueAgent
pmsapi
listInboundRoute
pauseUnpauseQueueAgent
queueapi
mute
Unmute
hold
unhold
dialExtension
dialOutbound
callTransfer
transferNumberInbound
transferNumberOutbound
dialIVR
dialIVROutbound
dialQueue
dialRinggroup
dialOutboundTwo
listUser
getUser
updateUser
listExtensionGroup
listPinSets
refuseCall
acceptCall
applyChanges
addAnalogTrunk
getAnalogTrunk
listAnalogTrunk
updateAnalogTrunk
deleteAnalogTrunk
addSLATrunk
updateSLATrunk
deleteDigitalTrunk
addDigitalTrunk
getDigitalTrunk
listDigitalTrunk
updateDigitalTrunk
listDepartment
addContact
updateContact
deleteContact
CDR Real-time Output Settings
Enable
Enables real-time CDR output module. This module connects to selected IP addresses and ports and posts CDR strings as soon as it is available.
Server Address
CDR server IP address
Port
CDR server IP port
Upload Prompts User Configuration
Username
Username used to upload prompts.
Password
Password used to upload prompts.
API Configuration Parameters
Upload Voice Prompt via API
Customers now can use the “Upload Prompts User Configuration” to upload/replace voice prompt files as an alternative method to the manual upload method on UCM PBX Settings🡪 Voice Prompt🡪 Custom Prompt.
The workflow of the prompt file upload goes as:
An HTTP/HTTPS request is sent to the UCM to upload/replace a voice prompt file, the request should include authentication details to the UCM and the name of the file to be uploaded. Then the UCM will contact an FTP server that should be hosted on the same IP address of the HTTP/HTTPS requester and download the prompt file from the FTP server. The steps and conditions to upload the voice prompt via API are listed below:
Configure the prompt User under Integrations 🡪 API Configuration 🡪 Upload Prompts User Configuration. By default, the username and password for voice prompt user are “Username: uploader; Password: uploader123”.
Upload Prompt User Configuration
Hash the password of the user configured to an MD5 Encryption format.
Set the permission on the FTP server to Anonymous on the local computer hosting the FTP server and make sure that the default FTP port 21 is used.
Send an HTTP/HTTPS command to trigger the Prompt file upload on the UCM. If UCM’s HTTP server is set to HTTPS, the example of the request sent to the UCM is:
If the File name on the HTTP/HTTPS request exists already on the UCM’s Custom voice prompts list the existing file will be overwritten by the new file downloaded from the FTP server.
For more details on CDR API (Access to Call Detail Records) and REC API (Access to Call Recording Files), please refer the document in the link here:
The UCM630X supports AMI (Asterisk Manager Interface) with restricted access. AMI allows a client program to connect to an Asterisk instance commands or read events over a TCP/IP stream. It is particularly useful when the system admin tries to track the state of a telephony client inside Asterisk.
User could configure AMI parameters on Integrations > AMI. For details on how to use AMI on UCM630X, please refer to the following AMI guide:
Please do not enable AMI on the UCM630X if it is placed on a public or untrusted network unless you have taken steps to protect the device from unauthorized access. It is crucial to understand that AMI access can allow AMI user to originate calls and the data exchanged via AMI is often very sensitive and private for your UCM630X system. Please be cautious when enabling AMI access on the UCM630X and restrict the permission granted to the AMI user. By using AMI on UCM630X you agree you understand and acknowledge the risks associated with this.
CTI Server
UCM does support CTI server capabilities which are designed to be a part of the CTI solution suite provided by Grandstream, including GXP21XX and GXP17XX enterprise IP phones along with GS Affinity app.
Mainly the UCM will by default listening on port TCP 8888 for the connections from GS affinity application in order to interact, modify and serve data requests by the application which includes setting call features for the connected extension as call forward and DND.
Users can change the listening port under the menu page, Integrations > CTI Server as shown on below screenshot:
CTI Server Listening port
More information about GS affinity and CTI Support on Grandstream products series please refer to the following link:
Customer Relationship Management (CRM) is a term that refers to practices, strategies and technologies that companies use to manage and analyze customer interactions and data throughout the customer lifecycle, with the goal of improving business relationships with customers.
The UCM630X support the following CRMs: SugarCRM, VtigerCRM, Salesforce CRM and ACT! CRM, which allows users to look for contact information in the Contacts, Leads and / or Accounts tables, shows the contact record in CRM page, and saves the call information in the contact’s history.
Sugar CRM
Configuration page of the SugarCRM can be accessed via admin login, on Integrations>CRM.
SugarCRM Basic Settings
Select “SugarCRM” from the CRM System Dropdown in order to use SugarCRM.
CRM System
Select a CRM system from the dropdown menu.
CRM Server Address
Enter the IP address of the CRM server.
Add Unknown Number
Add the new number to this module if it cannot be found in the selected module.
Contact Lookups
Select from the “Available” list of lookups and press
to select where the UCM can perform the lookups on the CRM tables, Leads, Accounts, and Contacts.
SugarCRM Settings
Once settings on admin access are configured:
Click on and .
Logout from admin access.
Login to the UCM as user and navigate under “User Portal🡪Other Feature🡪CRM User Settings”.
Click on “Enable CRM” and enter the username/password associated with the CRM account then click on
and
. The status will change from “Logged Out” to “Logged In”. User can start then using SugarCRM features.
CRM User Settings
Vtiger CRM
Configuration page of the VtigerCRM can be accessed via admin login, on the UCM WebGUI🡪Integrations🡪CRM.
VtigerCRM Basic Settings
Select “Vtiger CRM” from the CRM System Dropdown in order to use Vtiger CRM.
CRM System
Select a CRM system from the dropdown menu.
CRM Server Address
Enter the IP address of the CRM server.
Add Unknown Number
Add the new number to this module if it cannot be found in the selected module.
Contact Lookups
Select from the “Available” list of lookups and press
to select where the UCM can perform the lookups on the CRM tables, Leads, Organizations, and Contacts.
VtigerCRM Settings
Once settings on admin access are configured:
Click on and .
Logout from admin access.
Login to the UCM as user and navigate under “User Portal🡪Other Features🡪CRM User Settings”.
Click on “Enable CRM” and enter the username/password associated with the CRM account then click on and . The status will change from “Logged Out” to “Logged In”. User can start then using SugarCRM features.
CRM User Settings
Bitrix24 CRM
The UCM6300 Series supports integration with Bitrix24 CRM, allowing the system to query CRM records during calls, display contact information, and automatically create CRM records for unknown numbers based on configuration.
For detailed step-by-step instructions on preparing the Bitrix24 account, generating webhooks, and completing the integration, refer to the Bitrix24 CRM Configuration Guide.
Bitrix24 CRM Settings
The table below describes the configurable parameters for this integration.
CRM System
Select “Bitrix24CRM” from the CRM System dropdown menu to enable Bitrix24 integration.
CRM Server Region
Specify the Bitrix24 server region or domain associated with the Bitrix24 account. This value must match the region or URL used when configuring the Bitrix24 webhook.
Add Unknown Number
Specifies how the UCM handles incoming or outgoing calls from phone numbers that do not exist in Bitrix24 CRM.
None: No CRM record is created when an unknown number is detected.
Contacts: Automatically creates a new Contact record in Bitrix24 when the number is not found in existing CRM records.
Leads: Automatically creates a new Lead record in Bitrix24 when the number is not found.
Accounts: Automatically creates a new Account record in Bitrix24 when the number is not found.
Contact Lookups
Select from the “Available” list and move items to the “Selected” list to define where the UCM performs contact lookups in Bitrix24.
Supported lookup tables include Contacts, Leads, and Organizations. When multiple tables are selected, the lookup order determines the priority of the search.
Once the Bitrix24 CRM settings on the admin interface are configured:
Click Save and Apply Changes.
Log out from the admin account.
Log in to the UCM as a user and navigate to User Portal→Other Features→CRM User Settings.
Enable CRM and enter the Bitrix24 account credentials information as required.
Click Save to complete the login process.
After successful login, the CRM status will change from Logged Out to Logged In, and the user can start using Bitrix24 CRM features during calls.
Salesforce CRM
Configuration page of the Salesforce CRM can be accessed via admin login, on the UCM Web GUI🡪Integrations🡪CRM”.
Salesforce Basic Settings
Select “Salesforce” from the CRM System Dropdown in order to use Salesforce CRM.
CRM System
Select a CRM system from the dropdown menu.
Add Unknown Number
Add the new number to this module if it cannot be found in the selected module.
Contact Lookups
Select from the “Available” list of lookups and press
to select where the UCM can perform the lookups on the CRM tables, Leads, Accounts, and Contacts.
Salesforce Settings
Once settings on admin access are configured:
Click on and .
Logout from admin access.
Login to the UCM as user and navigate under “User Portal🡪Other Features🡪CRM User Settings”.
Click on “Enable CRM” and enter the username, password and Security Token associated with the CRM account then click on and . The status will change from “Logged Out” to “Logged In”. User can start then using Salesforce CRM features.
Salesforce User Settings
ACT! CRM
Configuration page of the ACT! CRM can be accessed via admin login, on Integrations > CRM”.
The configuration steps of the ACT! CRM are as follows:
Navigate to Integrations > CRM and select the “ACT! CRM” option.
Enabling ACT CRM
Log into the UCM as a regular user and navigate to Integrations > CRMUser Settings and check “Enable CRM” option and enter the username and password, which will be the ACT! CRM account’s API Keyand Developer Key, respectively. To obtain these, please refer to the ACT! CRM API developer’s guide here: https://www.act.com/
Enabling CRM on the User Portal
Odoo CRM
The UCM6300 Series supports integration with Odoo CRM. To enable Odoo CRM, please access the UCM’s web UI then navigate to Integration > CRM.
Odoo CRM
Click “Save” then “Apply Changes”.
Once Odoo CRM is enabled, the user can log into the user portal by access the UCM web UI and entering their username and password, then they can navigate to Other Features > CRM User Settings, then they configure their account using username and password created on Odoo platform.
CRM User Settings
PMS (Property Management System)
UCM630X supports Property Management System PMS, including check-in/check-out services, wakeup calls, room status, Do Not Disturb which provide an ease of management for hotel applications. This feature can be found on Web GUI→Integrations🡪PMS.
The PMS integration on UCM is currently supported only with one of the five following solutions.
The PMS module built-in the UCM supports the following features based on each solution:
Feature
Mitel
char pmslink
HSC
IDS
Oracle OPERA
Check-In
Yes
Yes
No
Yes
Yes
Check-out
Yes
Yes
No
Yes
Yes
Wake-up Call
Yes
Yes
No
Yes
Yes
Name Change
Yes
No
No
No
Yes
Update
No
Yes
No
Yes
Yes
Set Credit
Yes
No
No
No
No
Set Station Restriction
Yes
No
No
No
No
Room Status
No
Yes
No
Yes
Yes
Room Move
No
Yes
No
Yes
Yes
Do Not Disturb
No
Yes
Yes
No
Yes
Mini Bar
No
Yes
No
Yes
Yes
MSG
No
Yes
No
No
No
MWI
No
No
Yes
No
No
Unconditional Call Forward
No
No
Yes
No
No
Char pmslink
In this mode, the system leverages the char pmslink cloud middleware to integrate the UCM with a wide variety of Property Management System (PMS) software.
The communication flow is divided into three parts:
PMS (Property Management System): Your hotel’s management software.
charpmslink (Middleware): Acts as the universal interface, translating messages between the PMS and the PBX.
PBX (UCM6300): The Grandstream UCM, which receives commands from the PMS via charpmslink to execute hospitality features.
This integration enables a large variety of hotel features such as: Check-in, Check-out, set Room Status, Wake-up call, and more.
The following figure illustrates the communication flow between the UCM and PMS software, which is done through a middleware system (char pmslink) acting as an interface between both parties.
UCM Char pmslink interaction
HSC PMS
In this mode, the system can be divided into two parts:
PMS (Property Management System)
PBX
Grandstream UCM6XXX series has integrated HSC PMS providing the following features:
Changing Display Name
Set Station Restriction
Call forwarding
DND
Name Change
MWI
Notes:
Added support for receiving HTTP GET keep-alive messages from HSC PMS. This will allow the PMS to be aware of its connection to the UCM and take the appropriate actions such as raising alarms, sending notifications, etc.
Added support for HTTP GET requests from HSC PMS to retrieve UCM extension information. UCM can provide the following information:
extension – UCM extension number
name – extension display name / CID name
mwi – MWI state
permission – permission level of the extension
cfwt – call forwarding always number
dnd – DND state
language – display language of the extension in ISO 639-1 format
The UCM should respond with either 200 OK or 404 responses.
Added HTTPS support
The following figure illustrates the communication flow between the PBX (Grandstream UCM630x Series) and PMS software (HSC). The communication between both parties is direct with no middleware.
UCM HSC PMS interaction
Mitel PMS
In this mode, the system can be divided into two parts:
PMS (Property Management System)
PBX
Grandstream UCM630x series has integrated Mitel PMS providing the following hospitality features: Check-in, Check-out, set Room Status, Wake-up call, and more.
The following figure illustrates the communication flow between the PBX (Grandstream UCM630x Series) and PMS software (Mitel). The communication between both parties is direct with no middleware.
UCM Mitel PMS interaction
IDS PMS
In this mode, the system can be divided into two parts:
PMS Clients – These are the hotel management applications such as the front desk system, reservation software, or any client that normally communicates with a PMS server.
UCM PBX – Instead of acting as a client or middleware, the UCM directly emulates an IDS PMS server.
With this setup, PMS clients connect directly to the UCM through its PMS port. The UCM listens for incoming requests and responds as if it were the IDS PMS server. This allows hotel staff to perform operations such as setting room status (clean, occupied, available), posting Mini Bar charges, scheduling and managing wake-up calls, or enabling and disabling dialing permissions.
By integrating IDS PMS in this way, the UCM simplifies deployment since no external IDS PMS server or additional middleware is required—the PBX itself provides the PMS server functionality.
UCM IDS PMS interaction
PMS API
The PMS API allows users to use their middleware to work with PMS systems instead of currently supported integrations.
Additionally, this API allows access to read and modify certain UCM parameters that current supported PMS integrations cannot. To use this, users must first enable and configure the HTTPS API settings.
The UM603x series integrates directly with Oracle Hospitality OPERA PMS to manage room statuses and extensions from within the OPERA interface. This connection is established using the IFC_PBX interfacing protocol.
To configure the integration, first select the pre-built interface, “Oracle Hospitality OPERA TMS Interface for UCM Series PBX by Grandstream Networks,” within the OPERA software. Once enabled, you can complete the setup from the CloudUCM admin portal.
Data exchange between the UCM and the OPERA server is handled by the Fidelio Interface Application Specification (FIAS) protocol. FIAS uses specific attributes to define the data being transmitted. For example:
“RN” represents the Room Number.
“RS” represents the Room Status.
“RU” is used as an update indicator to initiate a room status change.
A typical FIAS message to update a room’s status would be formatted as follows: RU|RN211|RS3
In this example, room 211 is updated to status code 3.
In addition, The UCM630x supports Oracle OPERA’s Youth Hostel Mode. This feature allows a single room to be partitioned into multiple independent units, enabling management of separate groups with distinct extensions and individual billing records within the same physical room.
Oracle Hospitality OPERA
General
PMS Module
Select “Oracle Hospitality OPERA”
PMS URL
Enter the URL of the Oracle Hospitality Opera server.
PMS Port
Enter the PMS server port.
Note: The allowed range 1 – 65535.
Protocol Type
Select the transport protocol to use.
TCP: The connection is established using only TCP handshake.
Simple SSL: Authentication is required to establish the connection. The identity is verified only on the Oracle OPERA Hospitality server.
Mutual SSL: Authentication is required to establish the connection. The identity of both parties is verified by having both parties exchanging their certificates. This reinforces the security by ensuring that only the authorized parties are allowed to contact the server.
Prompt
Wakeup Prompt
Upload the prompt to play when a wakeup call is answered, or used the default prompt.
The audio file must be less than 30 MB in file size with a file extension of .mp3/. wav/. ulaw/. alaw/. gsm. WAV files must be PCM encoded, 16 bit mono, and 8000Hz. For better audio quality, it is recommended to upload mp3 files with 44.1kHz/48kHz sampling rate.
Compressed files must be .tar/.tgz/.tar.gz format and cannot exceed 50 MB in file size.
File name can only contain alphanumeric characters and special characters -_
Mp3 and WAV formats are supported. If the user uploads an mp3 recording, it will be converted to WAV.
Room Status Update Prompt
Select the prompt to play when the room status is updated, or use the default prompt.
The audio file must be less than 30 MB in file size with a file extension of .mp3/. wav/. ulaw/. alaw/. gsm. WAV files must be PCM encoded, 16 bit mono, and 8000Hz. For better audio quality, it is recommended to upload mp3 files with 44.1kHz/48kHz sampling rate.
Compressed files must be .tar/.tgz/.tar.gz format and cannot exceed 50 MB in file size.
File name can only contain alphanumeric characters and special characters -_
Automatically Clear/Reset
Automatically Clear Phone Call History
Select when to clear phone call history.
None: The phone call history will not be cleared.
Check Out: The phone call history of the guest will cleared upon checking-in.
Check In: The phone call history will be cleared when checking-in a new guest.
Automatically Clear Wake Up Calls
Select when to clear scheduled Wakeup calls.
None: The wake-up call configuration will not be cleared.
Check In/Out: The wake-up call configuration will cleared upon either checking-in or checking-out.
Check Out: The wake-up call configuration will cleared upon checking-out.
Check In: The wake-up call configuration will cleared upon checking-in.
Automatically Clear Wave Chat History
Select when to clear Wave chat history.
None: Wave chat history will not be cleared.
Check Out: Wave chat history will cleared upon checking-out.
Check In: Wave chat history will cleared when checking-in a new guest.
Automatically Reset User/Wave Password
If enabled, the User/Wave password of the room extension will be automatically reset to a random password upon check-out.
Billing
Type of Call Billing
Select the type of billing the call fees for the guests.
Send to Oracle PMS: The call details will be sent and calculated on Oracle Opera.
PBX Direct Billing: The billing will be calculated by the UCM and synchronized with Oracle Opera.
Mini Bar Billing Type
Select the type of billing the mini bar
Send to Oracle PMS: The consumed mini bar goods will be pushed to Oracle Opera where they will be processed for the billing.
PBX Direct Billing: The consumed mini bar goods will be processed for billing on the UCM, and the bill will be synchronized with Oracle Opera.
Other
Back Up Voicemail Recordings
Back up voicemail recordings to external storage after check-out. When this option is enabled, the user can select the storage location option, SD Card, USB 1, USB 2, NAS, or SFTP Server.
The user can also specify an email address to send voicemail recordings for archiving purpose.
Sync Guest Name to Phone
Provisions the name of checked-in guests to endpoints via Zero Config. Requires endpoints to be discoverable and provisionable by Zero Config.
Local PMS
The UCM630x includes an integrated on-premise Property Management System, providing essential hotel management capabilities without the need for a separate software purchase. This local PMS solution allows users to perform core operations such as Room Management, check-in/check-out procedures, Wake-up Services, and Housekeeper management directly from the web interface.
In addition, the UCM local PMS automates important check-out tasks, including backing up guest voicemail recordings, automatically clearing wake-up calls and Wave chat history, and resetting Wave passwords.
For detailed descriptions of PMS features, workflows, and configuration steps, refer to the UCM63XX Local PMS Guide.
The configuration parameters available on the local PMS basic settings are explained in the table below:
Parameter
Description
Prompt
Wakeup Prompt
A customized prompts that can be played when the wakeup call is answered. To customize it please navigate to PBX Settings→Voice Prompt→Custom Prompt
Room Status Update Prompt
Choose a previously uploaded prompt or upload the prompt which will be played when the room status is changed.
If the room status codes have been change, please update the Room Status accordingly.
Automatically Clear/Reset
Automatically Clear Phone Call History
Configures whether or not the call history of phones will be automatically cleared upon check-in or check-out. Currently only supported on Grandstream phones.
None: Call history will not be deleted after checking-in or checking-out.
Check Out: Call history will be delete when the guest checks-out.
Check In: Call history will be delete when a new guest checks-in.
Automatically Clear Wakeup Calls
Scheduled wakeup calls for rooms can be cleared upong checking in or checking out.
None: The wakeup calls won’t be automatically cleared.
Check out: The wake up calls assigned to the guest will be cleared when they check out.
Check In: The wake up calls assigned to a guest will be cleared when a new client checks in.
Automatically Clear Wave Chat History
If enabled, room Wave chat history will be automatically cleared upon check-in or check-out.
Automatically Reset User/Wave Password
If enabled, the User/Wave password of the room extension will be automatically reset to a random password upon check-out.
Self-service Settings
Self-Check-In Via Email
Enables the system to automatically send a self check-in email with a link prior to the guest’s arrival.
Advance sending time (hours)
Defines how many hours before the scheduled check-in time the self check-in email will be sent.
Self-Check-Out Via Email
Allows the system to automatically send a self check-out email with a link prior to departure.
Advance sending time (hours)
Defines how many hours before the scheduled check-out time the email will be delivered.
Check-out is allowed when the bill is not settled
Controls whether guests are allowed to complete self check-out even if their bill is not fully paid.
Enabled: The guest may check out before completing the payment
Disabled: Payment must be settled before self-check-out is allowed.
This option is disabled by default.
Other
Back Up Voicemail Recordings
Configures automatic backup of voicemail recordings to external storage after check-out. When this feature is enabled, users can specify the storage destination.
Storage Location
Select the storage location for voicemail recordings. The available options are:
SFTP Server
NAS
USB
SD Card
Note: To configure storage devices, go to PBX Settings→Storage Device Management.
Email Address
Enter the destination email address where the system will deliver backup files.
Sync Guest Name to Phone
Provisions the name of the checked-in guests to endpoints via Zero Config. Requires endpoints to be discoverable and provisinable by Zero Config.
Review Bill at Check-Out
If enabled, a pop-up window with all the charges will appear during guest check-out for reviewing purposes.
Currency Unit
The currency unit for the call rate.
These are the supported options which you can choose from:
American Dollar
Euro
Sterling Pound
Yen
Won
Hong Kong Dollar
Australian Dollar
Canadian Dollar
Baht
Singapore Dollar
Swiss Franc
Swedish Krona
Danish Krone
Norwegian Krone
New Zealand Dollar
South African Rand
Brazilian Rial
Indian Rupee
Russian Ruble
Vietnamese Dong
Polish Zolty
Czech Koruna
Turkish Lira
Custom: Enter the currency unit.
Periodically Email Recordings
If enabled, new recordings will be automatically sent to the specified email inbox periodically at the specified intervals.
Type
Configures the type of recordings that should be sent periodically
Wakeup Service
Check-in/Check-out History
CDR Records
Period
Specifies the automatic download period. The default option is “By Day”. At the specific time of each day, week or month, the last cycle of new records will be sent to the user.
By Day
By Week
By Month
Email
Specifies the automatic download period. The default option is “By Day”. At the specific time of each day, week or month, the last cycle of new records will be sent to the user.
Customer Email
Enables the system to send automated emails to guests. This includes reservation updates and billing information.
Note: Email notifications will not be sent if the customer’s email address is missing.
Reservation Notification
When enabled, the guest will automatically receive an email whenever a reservation is created, modified, or cancelled.
Billing Notification
If enabled, billing-related emails will be sent automatically to the guest.
QueueMetrics
The QueueMetrics docking tool provides an interface for UCM system and QM docking. Pass the UCM call queue report to QueueMetrics in a richer form. QueueMetrics is a call center control platform that supports login and logout of frequently used agents in the call center, provides call reports, real-time queue monitoring and other functions.
QueueMetrics
Parameter
Description
Enable QueueMetrics Integration
Tick this box to enable QueueMetrics integration module.
QueueMetrics URL
Enter the URL of the QueueMetrics on-premise server you have installed. (i.e. http://xxx.xxx.xxx.xxx:8080/queuemetrics.).
Username
Please enter the username used to interface with QueueMetrics. This is typically the QueueMetrics webqloader user. Please confirm that the user is enabled to avoid connection failure.
Webqloader Password
Please enter the webqloader password.
Partition
Enter the data storage partition identifier
Outbound Call Tracking
If enabled, QueueMetrics will track the outgoing calls of all extensions.
Note: Outbound Call Tracking is available only on the PBX.
Configuring the Google Services integration allows the user to automatically and synchronously events, such as, scheduled meeting and scheduled paging, on Google Calendar of the user upon creating one of the aforementioned events.
Google Calendar Authorization
In this page, the user can configure the OAuth2.0 authentication information to establish the integration successfully. The user can create the authentication ID and the client secret in Google API console, then use them on the UCM.
Google Calendar Authorization
Google Calendar Settings
On this page, the user can configure the refresh interval of the information in Google Calendar. Periodically, the UCM will send the updated/created information to Google Calendar.
The user can also create calendar labels which are use to distinguish the different kinds of events which are synchronized. For example, the user can choose to give different labels to scheduled meetings and to scheduled paging, to easily distinguish the type of event synchronized to Google Calendar.
The Third-Party Database Integration feature allows the UCM to connect to external databases (such as MySQL) to query contact information when calls are received. When a matching record is found, the caller name is displayed. Optionally, contacts can be synchronized into the UCM LDAP phonebook for centralized management.
For comprehensive details on this integration, its workflows, and configuration steps, please refer to the following guide.
LDAP phonebooks synced from third-party databases support up to 500,000 contacts.
This feature is configured under Integrations→3rd Party Database Integration.
3rd Party Database Integration Basic Settings
The Basic Settings tab is used to configure and enable the database connection. The table below describes the parameters on this page:
3rd Party Database Integration
Enable or disable 3rd party database integration. When enabled, the UCM queries the configured database for contact information.
Database Type
Select the database engine:
SQL Server
MySQL
Server Address
Enter the IPv4 address of the database server.
Port
Enter the port used by the database service. Valid range: 1–65535
Database Name
Enter the name of the database used for establishing the connection.
Connection Timeout (s)
Set the time (in seconds) to wait before a connection attempt times out. Please enter a value between 1 and 300. The default value is 5.
Username
Enter the username used to connect to the database.
Password
Enter the password for the specified username.
Character Set
Specifies the character set for MySQL connections.
ASCII
UTF-8
GBK
GB2312
UTF8MB4
Test Connection
Click to test connectivity and authentication to the configured database.
After the database connection is successfully established, an additional Contact Synchronization tab becomes available, which enables synchronization of database contacts into the UCM LDAP phonebook.
3rd Party Database Integration Contacts Sync
The configurable parameters on this page are described in the table below:
Contacts Sync
Enables synchronization of database contacts into the UCM LDAP phone book. When disabled, real-time caller lookup remains available, but contacts are not synchronized.
Table
Enter the database table containing contact records.
Phonebook Name
Choose the display name of the LDAP phone book created on UCM.
Attribute Mapping
Maps the 3rd party database fields to UCM LDAP attributes (max 10).
Scheduled Sync
Defines automatic synchronization schedule.
Integration of Collaboration Platforms
The UCM6300 Series supports integration with enterprise collaboration and identity platforms to centralize user management, authentication, and directory synchronization. These integrations allow administrators to synchronize user identity information from external platforms into the UCM, associate users with extensions or system accounts, and enable Single Sign-On for simplified and secure access to the UCM web interface.
Supported platforms include:
Microsoft Entra ID (Azure AD)
Windows Active Directory
Google Workspace
Integration of Collaboration Platforms Page
Each integration provides configurable options for user synchronization scope, user linking behavior, LDAP directory integration, and authentication methods. The following sections describe the configuration and usage of each platform.
Microsoft Entra ID (Azure AD)
Microsoft Entra (formerly Azure Active Directory) is a cloud platform which provides access management and identity provision. When integrated with the UCM6300 Series, it allows synchronizing the identity information with the UCM which can be used to log into the UCM’s user interface.
The Microsoft Entra ID configuration page consists of the following tabs:
Basic Settings
User Settings
Single Sign-On (SSO)
Each tab is described below.
Basic Settings
This tab defines the connection between the UCM and Microsoft Entra ID.
Microsoft Entra ID Basic Settings
Parameter
Description
Microsoft Entra ID Authorization
Enable Microsoft Entra ID
Redirect URIs
Enter a URI to return Microsoft tokens.
Application (Client) ID
Enter the application ID
Client Password
Enter the client password. If the client’s password expires, this will interrupt Microsoft user synchronization. Ensure that the password is updated in a timely manner.
Tenant ID
Enter the tenant ID provided by Microsoft. This can be found in the admin center of Microsoft Entra ID.
User Settings
This tab controls how Microsoft users are synchronized to the UCM.
The table below describes the parameters available on this tab
Get Microsoft User
Get Microsoft User
Enable to retrieve users from Microsoft Entra ID. When enabled, Microsoft users can be associated with UCM users/extensions. When disabled, synchronization is stopped.
User Range
Defines the scope of Microsoft users to retrieve. Options include retrieving all users or specifying user types.
User Type
Available when “Specify Type User” is selected. Defines which Entra user types (e.g., Members, Guest) will be retrieved. Only selected types are synchronized.
Add User to LDAP
When enabled, synchronized Microsoft users are added to the UCM LDAP directory, allowing them to appear in LDAP searches and dialing features.
Linked User Settings
Linked UCM
Enable to associate Microsoft Entra users with existing UCM users/extensions. When enabled, the linked UCM user’s information will be overwritten by the Microsoft user’s information.
Linking Method
Defines how Microsoft users are linked to UCM users.
Automatic Link: The system automatically matches Microsoft users to UCM users based on defined matching rules.
Manual Link: Administrator must manually associate users.
Linked User Range
Specifies which UCM users are eligible for linking. Options include linking all users or only selected user types.
Linked User Type
Available when “Specify Type User” is selected. Defines the Entra user categories (e.g., Members) that are eligible for linking.
Link Policy
Defines how the extension number is assigned during automatic linking. Available options are:
Automatic Allocation: assigns extensions sequentially, starting from a specified number.
Read Attribute Value: The extension number is taken from a specified Microsoft Entra user attribute.
Starting Extension
Specifies the initial extension number used when Automatic Allocation is enabled under the linking policy.
Attribute Name
Available when Read Attribute Value is selected. Specifies which Microsoft Entra attribute will be used to determine the extension number.
Microsoft User
Sync Now
Manually triggers immediate synchronization with Microsoft Entra ID based on the defined User Range.
Sync Settings
Opens synchronization configuration options.
Microsoft User List
Displays all retrieved Microsoft Entra users with the following fields:
Microsoft Entra username (typically UPN).
Display Name
First Name
Last Name
Job Title
Email (Entra ID Contact Email)
Mobile Number
Business Phone
Link UCM User
Single Sign-on (SSO)
The SSO tab allows users to log into the UCM Web UI and Wave using Microsoft Entra authentication.
Windows AD
Integrating AD with the UCM allows the system to fetch and manage user data directly from the AD server, making it easier to maintain consistent user information across platforms. Contacts can be imported into the UCM’s LDAP phonebook, and AD users can be linked to UCM extensions or system accounts for unified user administration. The integration also supports automatic and scheduled synchronization, reducing manual workload and keeping user records up to date.
Additionally, enabling Single Sign-On (SSO) allows AD users to log in to the UCM web interface using their domain credentials, enhancing security and simplifying password management.
Enter the port to use. The port number must be within the range 1 – 65535
Username
Enter the username.
Password
Enter the password.
Filter
Enter the filter which can be an object class.
Base DN
Information about the AD node to be pulled, for example,dc= pbx,dc=com.
Phonebook Name
Enter the phonebook name.
AD Properties
Select the AD properties which can be used by the UCM.
Google Workspace Integration
The Google Workspace Integration allows the UCM Series to connect with a Google Workspace domain in order to synchronize user identity information and enable Single Sign-On (SSO). When enabled, Google users can be associated with UCM system users or extensions, optionally synchronized into the UCM LDAP directory, and used for authentication when accessing the UCM web interface.
This feature is configured under Integrations→Integration of Collaborative Office Platforms→Google Workspace.
Integration of Collaborative Office Platforms Page
The Google Workspace integration module consists of three tabs:
The Basic Settings tab is used to configure OAuth authorization between the UCM and Google Workspace. This step is mandatory before any user synchronization or SSO functionality can be enabled.
Google Workspace Basic Settings Tab
The table below describes the parameters of this page:
Parameter
Description
Google Workspace Authorization
Enables or disables Google Workspace integration on the UCM.
Redirect URIs
OAuth redirect URI used to receive authorization tokens from Google. This value must exactly match the redirect URI configured in the Google Cloud Console application.
Application (Client) ID
OAuth Client ID generated in Google Cloud Console for the Workspace application.
Client Password
OAuth Client Secret associated with the Client ID. If the client secret expires or is regenerated, it must be updated here to avoid authorization failure.
User Settings
The User Settings tab controls how Google Workspace users are retrieved, synchronized, and linked to UCM users or extensions. The settings on this page are grouped into three categories:
Google User
Linked User Settings
Google User Management
The sections below describe each of the Google Workspace user settings tab categories.
Google Workspace User Settings Tab
Google User
This section defines how Google Workspace users are retrieved from the domain and whether they are synchronized into the UCM system.
User Settings Google User
Parameter
Description
Get Google User
Enables/disables retrieval of users from the connected Google Workspace domain. When enabled, Google users can be listed and managed on the UCM.
User Range
Specifies the scope of Google Workspace users to retrieve. The available options are:
All Users: Retrieves all users from the Google Workspace domain.
Users within the designated organizational unit: Retrieves users from a specific Google Workspace organizational unit.
Users within the designated group: Retrieves only users who belong to one or more specified Google Workspace groups.
Organizational Unit
Specify the Google Workspace Organizational Units whose users will be retrieved.
Groups
Specify the Google Workspace Groups whose users will be retrieved.
Add User to LDAP
When enabled, retrieved Google Workspace users are synchronized into the UCM LDAP directory under the “ou=google,dc=pbx,dc=com” phone book.
Linked User Settings
This section controls how Google Workspace users are associated with UCM users or extensions.
User Settings Linked User Settings
Parameter
Description
Linked UCM
Enables linking between Google Workspace users and UCM system users or extensions. When enabled, selected Google user attributes (such as first name, last name, email address, mobile number, and job title) can be applied to the linked UCM user.
Linking Method
Defines how the association between Google users and UCM users is performed:
Automatic Link: The UCM automatically links Google users to existing UCM users or extensions based on the selected link policy.
Manual Link: Administrators manually associate Google users with UCM users or extensions from the Google User list.
Link Policy
Defines how the UCM determines the target UCM user or extension when Automatic Link is selected. Available options include:
Automatic Allocation: The UCM automatically assigns available UCM users or extensions to Google users.
Read Attribute Value: The UCM reads a specific Google user attribute (such as extension number or mobile number) and uses it to match an existing UCM user or extension.
Starting Extension
This field is displayed when Link Policy is set to Automatic Allocation. It defines the starting extension number that the UCM uses when automatically assigning extensions to Google Workspace users.
Attribute Name
Displayed when Read Attribute Value is selected. Specifies the Google Workspace user attribute that the UCM will use for automatic matching.
Note: When Read Attribute Value is used for automatic linking, the UCM only evaluates the Work Number attribute from Google Workspace users. Mobile and Home numbers are ignored for automatic binding.
Google User List
This section displays the list of retrieved Google Workspace users and provides controls for synchronization and user linking.
User Settings Google User List
Parameter
Description
Sync Now
Immediately retrieves the latest user information from Google Workspace based on the current User Settings configuration.
Sync Settings
Opens the Google Workspace Sync Settings page, which allows configuration of automatic extension deletion policies (for deleted, paused, or unlinked Google users), scheduled synchronization, and provides visibility into synchronization history.
Batch Link
Available when Manual Link is selected. Allows multiple Google users to be linked to UCM users or extensions in a single operation.
Google User List
Displays retrieved Google Workspace users along with key attributes such as:
User (email address)
First Name
Last Name
Mobile Number
Job Title
Linked UCM User
Note: For manually linked users, the Options column provides controls to link, modify, or remove the association with a UCM user or extension.
The Sync Settings page is used to define how Google Workspace user data is synchronized with the UCM and how linked extensions are handled during synchronization events. This page is accessed by clicking Sync Settings from the Google User List section.
Google Workspace Sync Settings
The Extensions section controls automatic cleanup behavior for UCM extensions based on Google Workspace user status:
Deleted Google Workspace users: Automatically deletes the linked UCM extension when the corresponding Google Workspace user is deleted.
Paused Google Workspace users: Automatically deletes the linked UCM extension when the corresponding Google Workspace user is suspended or paused.
Unlinked Users: Automatically deletes UCM extensions that are no longer linked to any Google Workspace user.
Extensions Sync Settings
The Google User Data Sync section controls how and when Google Workspace user data is synchronized. When Scheduled Sync is enabled, the UCM automatically retrieves the latest Google Workspace users and updates the association between Google users and UCM users or extensions according to the current configuration.
Note:
Data synchronization may temporarily impact system performance. It is recommended to perform synchronization during non-office hours.
Google User Data Sync Settings
The Sync History section displays historical records of Google Workspace synchronization activities. The following information is shown for each synchronization event:
Sync Time: Date and time when the synchronization was executed.
Sync Mode: Indicates whether the sync was triggered manually or by schedule.
Results: Displays the synchronization result (Success, Partial Success, or Failed).
Options: Provides access to detailed synchronization logs for troubleshooting purposes.
Google Workspace Sync History
Single Sign-On (SSO)
The Single Sign-On (SSO) tab controls Google-based authentication for accessing the UCM web interface.
This page is used to enable or disable Google Workspace SSO and define how Google-authenticated users are mapped to UCM system users.
Note:
For Google Workspace SSO to function, at least one Google Workspace user must be successfully linked to a UCM system user. SSO authentication will fail if no linked user exists.
Google Workspace SSO requires the UCM to be accessed using a valid domain name (FQDN). Accessing the UCM via a private IP address is not supported and will trigger a warning during OAuth authorization.
Google Workspace Single Sign on SSO Tab
If SSO is enabled, the Sign in with Google option will appear on the UCM login page.
Log in with Google Option for UCM
Detailed configuration flows, and OAuth authorization steps for Google Workspace SSO are covered in the Google Workspace Integration Guide.
Wave Integration
In this page, the user can refer to links which include features and add-ons which provide powerful tools for communication and collaboration.
RFC 3323 A Privacy Mechanism for the Session Initiation Protocol (SIP)
RFC 3550 RTP: A Transport Protocol for Real-Time Applications
CHANGELOG
This section documents significant changes from previous versions of the UCM630X user manuals. Only major new features or major document updates are listed here. Minor updates for corrections or editing are not documented here.
Added support for scheduling call queue reports. [Scheduled Report]
Firmware Version 1.0.33.32
No major changes.
Firmware Version 1.0.33.30
Added AI configuration tab to SIP extensions, allowing per-extension control of Automatic AI Transcription. [Create a New SIP Extension]
Added scheduled meeting configuration with AI transcription option, allowing organizers to enable or disable AI transcription per meeting. [Schedule Meeting]
Added AI Settings (Beta) page to centrally manage AI services. [AI Settings (Beta)]
Added RemoteConnect AI Services page to display AI service status, plan validity, and detailed usage statistics [AI Services]
Added support for Google Workspace integration to synchronize user identity information between Google Workspace and the UCM Series. [Google Workspace Integration]
Added Google Workspace Single Sign-On (SSO) support for UCM web interface authentication. [Google Workspace Integration]
Updated the Local PMS wake-up service prompt to dynamically use the language configured during room check-in. [Local PMS]
Optimized Local PMS check-in and check-out actions to take effect immediately without requiring “Apply Changes”. [Local PMS]
Added option to control Wave app Screenshot and Screen Recording permission. [Wave Permissions]
Added support for configuring whether the Wave external host address is automatically synchronized from UCMRC. [Plan Settings][HTTP Server]
Added support for Bitrix24 CRM integration. [Bitrix24 CRM]
Added support for network abnormality HA switchover. [HA Settings]
Firmware Version 1.0.31.7
Added support for third-party SQL database integration for phonebook lookup and synchronization. [3rd Party Database Integration]
Updated the Inbound Routes→3rd Party Database Search page to align with the new third-party SQL database integration feature. [Inbound Routes: 3rd Party Database Search]
Added support for enabling local HA while operating in Dual network mode. [HA Settings]
Added a guest list for centralized customer profile management, including search, import/export. [Local PMS]
Added email templates for reservation notifications, cancellation notices, and billing emails. [Email Template]
Added multiple check-in workflows, supporting check-in from reservation list, from room list (immediate check-in), and hourly or full-day room selection. [Local PMS]
Added room change (house switch) functionality to move checked-in guests to another available room while preserving guest and billing data. [Local PMS]
Added a room availability calendar with visual status indicators, booking and check-in actions, hover-based detail display. [Local PMS]
Added bill printing with detailed room charges, minibar costs, call charges, tax breakdowns, and prepayment deductions. [Local PMS]
Added wake-up service management with support for room group based scheduling. [Local PMS]
Added support for self-service check-in and chek-out via email for guests with valid reservations. [Local PMS]
Added configurable email delivery timing for self-service check-in and check-out messages relative to arrival and departure times. [Local PMS]
Added tracking of check-in and check-out methods, distinguishing between front-desk and self-service operations in history records. [Local PMS]
Added automatic room assignment during self-service check-in when reservations are not pre-assigned to specific rooms. [Local PMS]
Some general call failure prompt tones (e.g., no-answer, user-busy, no-permission, wrong-number, general-failed) can now be used for SIP trunk call failure messages. [SIP Trunk Prompt Tone]
Firmware Version 1.0.29.19
Added Advanced Messaging page under the Sidebar→Messaging section. [Advanced Messaging]
Added option to the PBX→General Settings page to set prefixes that will allow the UCM to distinguish and definitively label different types of calls (i.e., local calls, long-distance calls, and international calls) for call billing purposes (Only applicable for Oracle Hospitality’s OPERA PMS). [International Call Prefix] [Domestic Long Distance Call Prefix] [Local Area Code]
Added support for Oracle Hospitality OPERA’s Youth Hostel Mode, which divides individual rooms into multiple units to account for multiple different groups and separate billing within the same room. [Oracle Hospitality OPERA]
Firmware Version 1.0.29.11
UCM6300 Series now support provisioning through GDMS Unified Communications. [PROVISIONING]
Added Least Cost Routing policy to Outbound Routes [Carrier]
The administrator can choose to prioritize call pattern matching or outbound route priority order as the criteria for call routing [Outgoing Routing Priority]
Added a configuration field to enter maximum concurrent calls allowed by a SIP trunk. [VoIP Trunks]
Added ability to select the error message to display when the number of maximum concurrent calls is achieved. [VoIP Trunks]
Added support for enabling/disabling sending the diversion header on a particular trunk. [VoIP Trunks]
Added support for Microsoft Entra ID integration, this allows synchronizing SIP accounts from LDAP or Active Directory for single sign-on. [Microsoft Entra ID (Azure AD)]
Added support for Active Directory to synchronize user accounts (user portal and Wave login) and admin accounts. [Windows AD]
Added support for detecting new firmware directly from the web UI, regular firmware version checking can be scheduled on the webUI. [Upgrade]
Added prompt language configuration in Call Queue [Add Call Queue]
Call Queue Chairman can now view the CDR of their queues
Added option to disable RPID in the Call Queue [Add Call Queue]
ELIN field in Emergency calls now can be configured with more character, letters and numbers [Emergency Location Mapping]
Add the ability to support Emergency Location Mapping based on a single Extension approach for the Emergency calls feature [Emergency Location Mapping]
Added LinkedID to CDR AMI event reporting for improved call tracking and management
Added Premium Code and and Premium Code Prompt option to Advanced Settings page. The user can use the premium code to increase their priority in the queue. [Add Call Queue]
Administrators can now choose either dial plan accuracy or outbound route priority list as the criteria for call routing. [Outgoing Routing Priority]
Added support for backing up video files to GDMS [File Manager]
Firmware Version 1.0.27.20
Added support for Microsoft Outlook SMTP OAuth2 authentication. [Email Settings]
Firmware Version 1.0.27.15
No major change
Firmware Version 1.0.27.10
Added QR code to email template for quick SIP registration [Email Template]
The name of the agent will now be displayed in the switchboard. [Switchboard]
Agent pause can now be performed quickly by dialing the respective feature code and the corresponding pause reason without having to interact with the IVR. [Configure Call Queue]
Agent pause reason will now be displayed in the switchboard. [Switchboard]
Added support for enabling the welcome prompt to be played simultaneously with background music while the agent phone is ringing. [Configure Call Queue]
Firmware Version 1.0.19.10
Specific time configuration is now included in extension exports
If a storage device is full, the UCM will mark it as unavailable and automatically change file storage path to the next available location based on the Storage Path Priority. Previously, UCM would change the file storage path to its own local storage if external storage was full. [File Manager]
Added the Default Certificate Auto Renewal option. If enabled, the default browser certificate will be automatically renewed after 398 days (the max certificate validity period of Chrome, Firefox, and Safari browsers). User-defined certificates are not affected. [HTTP Server]
Added ability to sync local IM data to Cloud IM [Cloud IM Service]
Added Chat Data from Endpoint option to the Maintenance -> System Cleanup/Reset -> Cleaner page. If enabled, this option will clean out chat data from Wave clients at the same time as the UCM’s server-side automatic/manual cleaning of chat data. [Cleaner]
Added support for meeting room passwords. However, meetings cannot be scheduled for rooms with meeting password enabled. [Multimedia Room Configurations]
Meeting kick warning interval has been changed from 30 mins to 20 mins. Note: This kick warning will only play when there is only 1 person in a meeting room, and if they do not opt to stay in the meeting room after the warning, they will be removed from the meeting room after 5 minutes.
ARP will now be used instead of ping to check NAS connectivity.
Upgrade logs will now contain firmware version information.
Added ability to control whether to use failover trunks based on the call response codes [Failover Trunk Toggles]
Added support for H.264 with multiple payload types in SDP
When receiving an INVITE with no SDP, following INVITEs with SDP will offer H.264 1080p resolution by default.
In the scenario where an inbound external call is forwarded from an extension to an external number, the Contact header will now use the CID of the forwarding extension instead of the caller’s CID.
Removed External Device Usage Threshold option. If a connected NAS has only 1GB remaining available storage space, it will be considered unavailable and trigger the external disk usage alert. [NAS]
Dial Trunk option has been renamed to Dial External Number and moved to the Dial Other Extensions section
The Wave Welcome email will now use the port number configured in System Settings->HTTP Server->Wave Settings->Port if the Wave Settings->External Host value is not a RemoteConnect address or does not contain a port number.
Added links to relevant online documentation to various pages of the UCM webUI.
Added Phonebook VMPK mode to GRP261x template
Added Firmware tab for improved firmware management [Firmware]
Added ability delete downloaded base model templates in the Model Update page
Added ability to search for templates via the device model name
Added ability to select either LAN1 or LAN2 to scan for devices on when using dual network method
Firmware Version 1.0.17.11
Several system process optimizations
Firmware Version 1.0.17.8
Updated python version to 3.8 and related processes.
Improved speed of applying changes
Updated lighttpd version to 1.4.61
The Privilege Name field now supports parenthesis ()
The Contacts page has been moved to its own category in the sidebar
Added Channel Path option for accessing specific IP camera channels via URL [Device Management]
Improved alert email sending process
Updated Remote Registration email template
Emergency calls will no longer be restricted by the RemoteConnect call limit.
The default highest priority codec is now G.722.
Added Remote Extension Privilege Update feature code and Remote Extension Privilege Update Whitelist field to allow specified users to remotely change extensions’ privileges. [Feature Codes]
Automatic file migration after file storage path failure to the next storage location in the storage priority path.
Users can now customize the storage path priority for recordings, video recordings, and IM files. [File Manager]
FXO FSK CID detection now uses spandsp.
If SIP extensions synced from UCMs are deleted on GDMS, they will no longer be synced again.
If HA is enabled, the HA cluster IP address will now be provisioned as the config server to endpoints instead of the active UCM’s IP address.
Added support for configuring inbound route blacklist via HTTPS API.
If dialing into a Dial by Name directory, the call will end automatically after failing 3 times.
Added Server Type option to the LDAP Server→LDAP Phonebook→Phonebook Download Configurations page. Users can select between LDAP and Active Directory. [LDAP Server]
Added Department field to LDAP phonebook contacts. [LDAP Server]
Added meeting room extensions to LDAP phonebooks. [LDAP Server]
External Contacts created from the Contacts page will now be added to the system’s internal LDAP phonebook. [LDAP Server]
Added Remote Login tab to the Maintenance→Login Settings page. [Maintenance]
Created new Meetings Settings page under the Multimedia Meetings page and moved several meeting-related options to it. [Multimedia Meeting]
Regular meeting participants can now invite other members to join the meeting by dialing 1 if “Allow User Invite” is enabled. [Multimedia Meeting]
Meetings will become “Pending” after rescheduling.
Pending meetings are now sorted by start time by default.
Added the Allowed to Override Host Mute option to the Edit Meeting Room and Schedule Meeting pages to allow participants to unmute themselves even after the meeting host mutes them. [Multimedia Meeting]
Operation Log entries will now contain the IP address and location information from which the operation originated. [Operation Log]
Added option Automatically Clear Wakeup Calls for deleting scheduled wakeup calls after either guest check-in and check-out. [PMS Features]
Users can now dial the Update PMS Room Status feature code, the maid code, and the room status code all at once to change room status. [PMS Features]
Added a Scan button to manually retrieve the list of recordings on external storage. The UCM automatically displays up to 5000 recordings on attached external storage, but pressing this button will allow the UCM to display more. [Recordings Files]
Added ability to batch delete cloud storage files.
If IP endpoints cannot connect to the GDMS TURN server via UDP, UCM will use TCP to connect them.
Added Trunk Registration Period (s) option to SIP Settings->Misc. [SIP Settings]
Added option Special Attributes to the Extension/Trunk→VoIP Trunks→Edit SIP Trunk→Advanced Settings page. If enabled, the following attributes will be included in the SIP SDP: ssrc, msid, mid, ct, as, tias, record. Enabling this may cause compatibility issues with non-Grandstream devices. [VoIP Trunk Configuration]
Added CEI msid for audio calls.
Added trickle-ice param to SIP OPTION’s 200 OK.
profile-level-id will be added to 200 OK when receiving INVITEs without SDP.
Added ability to import/export speed dials. [Speed Dial]
Improved processes to avoid duplicate alerts for the following events: Registered SIP Trunk failed, Local Disk Usage and External Disk Usage.
Separated Allow Deletion of CDR and Recordings option to Allow Deletion of CDR and Allow Deletion of CDR Recordings. [User Management]
Added the Call Waiting option to the User Portal.
Added support for voicemail message seeking. When listening to voicemail, users can press star (*) to rewind 3 seconds or pound (#) to fast forward 3 seconds. [Voicemail]
Added Line Selection Strategy option for Trunk Groups. [VoIP Trunks]
Changed register trunk Username field name to Trunk Registration Number. [VoIP Trunks]
General web UI improvements
Added Help option under the username dropdown menu that will redirect to the UCM6300 Series FAQ.
Updated some tooltips.
Optimized search functionality
Added GMT+2:00 (Israel) option to Time Zone drop down list in all Zero Config pages.
Added support for an email reminder when editing the time of a scheduled meeting. [Email Reminder (m)]
Improved extension status syncing process to the IM server.
Firmware Version 1.0.7.9
Statistics and alarm settings of the maximum number of concurrent calls on the trunk. [Enable Concurrent Call Alert] [Enable Concurrent Call Alert]
Add ability to enable/disable Ring Group Voicemail and make Ring Group Voicemail have configurable voicemail prompts. [Voicemail]
Add ability to import/export pickup groups and time settings. [PICKUP GROUPS]
Add option to set a holiday as fixed. [Year]
Support DOD digit manipulation based on extension. [Direct Outward Dialing (DOD)]
Support to join the scheduled meeting 10 minutes in advance and is controlled by conference resources. [Meeting Schedule]
Clean up the history of audio and video schedule meetings regularly. [Cleanup Type]
Record the actual member information in the meeting history details.
Support to initiate a random meeting in a scheduled/instant-meeting room. [Meeting Schedule]
The host password for the scheduled meeting is randomly generated. [Meeting Schedule]
Add the “Download Client” link to the extension email template and add the Wave promotion guide in the setup wizard. [Email Templates] [Setup Wizard]
Added support for Integrated Customer Service SDK. [Integrated Customer Service SDK]
Support customer service system call (Click2Call) service provides SDK download for customers to integrate into the website and set up security defense Fail2ban. [Customer Service System Call Defense]
Support to use Cloud IM service. [IM]
Add email reminder configuration in the audio meeting room. [Email Reminder (m)]
Added support for custom prompts under Voicemail Group. [Busy Prompt][Greet Prompt][Temporary Prompt][Unavailable Prompt]
The dashboard shows eMMC lifetime and the number of public/random video meetings. [PBX Status]
Added some System Alert Events. [Alert Events List]
Firmware Version 1.0.5.4
Added support for v-Fax, Fax-sending, Email2Fax. [FAX SERVER]
Added ability to restore backups remotely stored on GDMS [Restore Configuration from Backup File]
Added support for STIR/SHAKEN. [SIP Settings/STIR/SHAKEN] [VoIP Trunk Configuration]
Added ability to restrict calls and features based on CPU usage and data partition usage. [General Settings]
Added NAT option to the Export File Data filtering option. [Export File Data]
Wave desktop client is now supported. [Wave Desktop]
Added support for IAX. [IAX SETTINGS] [EXTENSIONS] [VoIP Trunk Configuration]
Improved audio and video conference pages. A list of the meetings that have not started and a meeting history list have been added. [Meeting Schedule]
Support sending post-meeting reports to the host after scheduling a meeting. [Meeting Schedule]
Added the SRTP Debugging option to the Ethernet Capture page. [Enable SRTP Debugging]
Updated the System Cleanup/Reset page interface. [System Cleanup/Reset]
Added manual cleaning. [Cleaner]
Added ability to add a custom browser tab icon and custom logos on various pages of the web management portal and Wave Web portal. [UI Customization]
Improved push notification for Wave mobile.
Added Instant Messaging functionality to Wave Web. [Wave Web]
LDAP phonebook information will now be synchronized when viewing the Contacts page. [Wave Web]
UCM can now synchronize system event alerts to GDMS. [Plan Settings]
Added threshold-based Call Control & Data Write Control. [General Settings]
Added Layer 3 QoS for SIP and Layer 3 QoS for RTP options to global policy and relevant templates. [Layer 3 QoS For RTP] [Layer 3 QoS For SIP]
Improved device list import support and added the ability to export devices on the ZeroConfig Device List page. [Managing Discovered Devices]
Firmware Version 1.0.3.10
Added RemoteConnect Mode option in SIP trunk. [RemoteConnect Mode]
Cloud Storage for CDR Backup and Record. [CDR in GDMS Cloud]
Add support for IDS PMS interface. [IDS PMS]
Add ability to enable PMS Wakeup call from remote extensions. [PMS Remote Wakeup Service]
Add ability to configure local country code for an outbound route. [Local Country Code]
Add support for Pattern and Leading digit filtering options in Callee Number. [Callee Number]
Added description of SSH switch options in LCD menu. [Use the LCD Menu]
Add the ability to import/export DOD. [Direct Outward Dialing (DOD)]
Add the ability to enable auto record per inbound/outbound route. [Auto Record] [Auto Record]
Add the ability to Enable Recording Whitelist. [Enable Recording Whitelist]
Add the ability to select missed call type to be sent via email. [Missed Call Type]
The Filter action is now supported in AMI sessions. [ASTERISK MANAGER INTERFACE]
Added command to delete call recordings after downloading them. [recapi]
Added commands to add, edit, and delete PIN groups. [addPinSets] [getPinSets] [updatePinSets] [deletePinSets]
Added External Disk Status alert event for monitoring external storage connection status. [Alert Events List]
The language of column titles in exported CDR reports and statistics reports will now be based on the UCM’s display language. [Downloaded CDR File]
Added Parking Lot Timeout Alert-Info option. This will add the specified alert-info header value to parking timeout callbacks. [Parking Lot Timeout Alert-Info]
Updated HMobile Mini Bar request. [HMobile PMS Connector]
Added several updates to HSC PMS. [HSC PMS]
Added the ability to specify the reason for agent pause (*83 by default). [Agent Pause]
Added CDR Stored in GDMS Cloud option for RemoteConnect Plan Settings. [UCM RemoteConnect]
GDMS Cloud Storage has been added as a recording storage location in the PBX. [PBX Settings/]
After adding a UCM to GDMS, its RemoteConnect address will automatically be added as a SIP server to the GDMS account. [UCM RemoteConnect]
Added the Ringback Tone option. Users can now select a custom prompt to play as a ringback tone for callers dialing in via the selected inbound route. [Ringback tone]
Ring Group Voicemail can now be set as a routing destination and an IVR key press destination. [Default Destination]
Added the following custom privileges: LDAP Server, UCM RemoteConnect, and Announcement. [Custom Privilege]
Added a Forgot Password option to the Wave Web login page. [Wave Web]
Added a new command to set the same-day wakeup service by dialing *36. [Wakeup Service]
and confirming the reset functionality. Once done, all settings on the Basic Settings page will be restored to default values except for Concurrent Registrations. User voicemail password will be reset to Random Password. User voicemail prompts and recordings will be deleted. User Management settings will also be restored to default except for usernames and custom privileges 
, “Reboot” 
and “Delete” 
are available per extension. Users can search for an extension by specifying the extension number to find an extension quickly. 
Green: Idle
Blue: Ringing
Yellow: In Use
Grey: Unavailable (the extension is not registered or disabled on the PBX)
to start editing the extension parameters.
to reset the extension parameters to default (except concurrent registration).
to send NOTIFY reboot event to the device which has a UCM630X extension already registered. To successfully reboot the user, “Zero Config” needs to be enabled on Device Management > Zero Config > Zero Config Settings. 
to delete the extension. Or select the checkbox of the extension and then click on “Delete Selected Extensions”.
to change the ringing priority of the members selected on the group. 
button and configuring the username, password, and authentication ID fields. 
to arrange the order. If there are multiple trunks selected, when there are calls on those trunks at the same time, pressing the LINE key on the phone will pick up the call on the first trunk here.
, the following figure shows to configure the new PIN. 
on the Outbound Routes page.
under the “Inbound Routes” page, check the “Global Inbound Multi-Mode” option, and change “Inbound Default Mode” and “Inbound Mode 1” values (By default, *61 and *62 respectively). 
for option “Invite a participant”. Click on it and enter the number of the party you would like to invite. Then click on “Add”. A call will be sent to this number to join it into the conference. 
to download the recording or click on 
to delete the recording. Users could also delete all recording files by clicking on “Delete All Recording Files” or delete multiple recording files at once by clicking on “Delete” after selecting the recording files. 
button. They can also set up automatic email deliveries of these statistics at regular intervals by clicking on 
button.
. Then decide from one digit up to four digits combination used for Speed Dial and select a dial destination from “Default Destination”. The supported destinations include extension, voicemail, conference room, voicemail group, IVR, ring group, call queue, page group, DISA, Dial by Name and external number.
. Configuration parameters are listed in the following table. 
to download the language to the UCM630X. The installation will be automatically started once the downloading is finished. 
button, select the file you want to upload, then click on “choose file to upload” to start uploading. Once uploaded, the file will appear in the Custom Prompt web page.
to edit signaling preference for FXS port or configure ACIM settings for FXO port. 
button to start the encryption. Or you can encrypt the files using the following encrypting button 
.
to edit the phonebook attributes and contact list (see figure below) or select 
to delete the phonebook. 
icon to edit the template.
icon to edit the template.
or delete the user by clicking on 
. 
to terminate a Wave session. SIP sessions cannot be logged out.
or 
at the top of each column to sort. For example, clicking on 
for “Date” will sort the logs according to newer operation date and time. Clicking on 
for “Date” will reverse the order. 
to delete the filtered result of operation logs. Or users can click on 
to delete all operation logs at once. 
. Alert logs are classified into two types by the system: 
to configure the parameters for each event. See the descriptions below. 
. The UCM630X will then try connecting the server to make sure the server is up and accessible for the UCM630X. Save the changes and all the backup logs will be listed on the web page. After data sync is configured, users could also manually synchronize all data by clicking on 
instead of waiting for the backup time interval to come. 
to play the recording file; click on
to download the recording file in .wav format; click on
to delete the recording file (the call record entry will not be deleted).
Go to Organization → Device Template → By Model and click on 
Go to Organization → Device Template → By Model and click on 
then click on “Set Parameters” as shown below in the screenshot.
to select where the UCM can perform the lookups on the CRM tables, Leads, Accounts, and Contacts.
and
. The status will change from “Logged Out” to “Logged In”. User can start then using SugarCRM features.
to select where the UCM can perform the lookups on the CRM tables, Leads, Organizations, and Contacts.
and 
. The status will change from “Logged Out” to “Logged In”. User can start then using SugarCRM features. 
to select where the UCM can perform the lookups on the CRM tables, Leads, Accounts, and Contacts.
and 
. The status will change from “Logged Out” to “Logged In”. User can start then using Salesforce CRM features. 
