Configuration Options #
Device #
Information #
The details below show information about the device which where provided when it was created or assign. The name of the device is configurable and is used internally on reports and in the directories etc.
| Configuration | Description |
|---|---|
| Name | The SIP username for this specific device |
| Device | (Read Only) The MAC address for the device |
| Manufacturer | (Read Only) The manufacturer of the device |
| Model | (Read Only) The model number of the device |
| Device Type | (Read Only) The type of device (User, Hotdesk or Phone Only) |
Status #
The details below show information about the device which where provided when it was created or assign. The name of the device is configurable and is used internally on reports and in the directories etc.
| Configuration | Description |
|---|---|
| Reboot | This action sends a SIP notify to the device asking it to reboot. This will only work if the device is currently online1. |
| Sync | This action sends a SIP notify to the device asking it to refresh its configuration. This will only work if the device is currently online1. |
| Enable | Toggle the enabled status of the device on the phone system. This can be used to disable a device on the phone system so that it cannot register, without having to remove it. |
| Registered | (Read Only) Shows the current SIP registration status of the device. |
-
A phone may be registered but not online. ↩︎
Configuration #
The configuration options below can be configured at customer and at device specific level and are passed to any managed devices during their provisioning.
Audio & Video #
Set the primary & secondary codecs which will be used by the phones. The table below lists the currently supported codecs.
| Area | Setting | Available Options | Default | Yealink | Poly | Mitel 68xx |
Mitel 53xx |
Cisco |
|---|---|---|---|---|---|---|---|---|
| Audio | Primary | PCMA, PCMU, G722, OPUS | PCMA | ✔ | ✔ | ✔ | ✔ | ✔ |
| Secondary | PCMA, PCMU, G722, OPUS | None | ✔ | ✔ | ✔ | ✔ | ✔ | |
| Video | Primary | VP8, H264 | VP8 | ✔ | ✘ | ✘ | ✘ | ✘ |
| Secondary | VP8, H264 | None | ✔ | ✘ | ✘ | ✘ | ✘ | |
| Volume | Headset auto reset volume | Enable / disable | Disable | ✔ | ✘ | ✘ | ✘ | ✘ |
| Handset auto reset volume | Enable / disable | Enable | ✔ | ✘ | ✘ | ✘ | ✘ | |
| Handsfree auto reset volume | Enable / disable | Enable | ✔ | ✘ | ✘ | ✘ | ✘ | |
| Headset TIA4965 | Enable / disable | Enable | ✔ | ✘ | ✘ | ✘ | ✘ | |
| Handset TIA4965 | Enable / disable | Enable | ✔ | ✘ | ✘ | ✘ | ✘ |
Call #
Set the primary & secondary codecs which will be used by the phones. The table below lists the currently supported codecs.
| Area | Setting | Available Options | Default | Yealink | Poly | Mitel 68xx |
Mitel 53xx |
Cisco |
|---|---|---|---|---|---|---|---|---|
| Call Settings | Call waiting | Enable or disable the call waiting feature on the device1 | Enable | ✔ | ✔ | ✔ | ✘ | ✔ |
| Call waiting tone | Enable or disable the call waiting tone on the device | Enable | ✔ | ✔ | ✔ | ✘ | ✔ | |
| Hotline / Autodial | Destination | To enable autodial, populate this setting with a number to dial | Disable | ✔ | ✔ | ✔ | ✔ | ✔ |
| Delay | Enter a delay for auto-dialing between 1 and 5 | 1 | ✔ | ✘ | ✔ | ✘ | ✔ | |
| Intercom | Allow | Enable or disable the intercom (auto-answer) feature on the device.2 | Enable | ✔ | ✔ | ✔ | ✘ | ✔ |
| Audio Mute | Enable or disable intercom audio mute | Enable | ✔ | ✔ | ✔ | ✘ | ✘ | |
| Video Mute | Enable or disable intercom video mute | Enable | ✔ | ✘ | ✘ | ✘ | ✘ | |
| Tone | Enable or disable intercom notification tone | Enable | ✔ | ✔ | ✔ | ✘ | ✘ | |
| Barge In | Enable or disable intercom barge in | Enable | ✔ | ✘ | ✔ | ✘ | ✔ | |
| BLF Config | Visual BLF Alerts | Enable or disable visual BLF alerts | Enable | ✔ | ✘ | ✔ | ✘ | ✘ |
| Audible BLF Alerts | Enable or disable audible BLF alerts | Enable | ✔ | ✘ | ✔ | ✘ | ✘ | |
| BLF Ring Type | Set the BLF ring type, 1 - 5. | 0 | ✔ | ✘ | ✔ | ✘ | ✘ |
-
Call waiting is also controlled via a user's ~.UcClient.~ client. To allow users to globally control call waiting on all their devices, call waiting set in ~.UcClient.~ will override any call waiting setting on the device/customer. ↩︎
-
Disabling intercom may affect other features such as quick-dial and steal. ↩︎
Date & Time #
Set the default date & time settings for a customer.
| Area | Setting | Available Options | Default | Yealink | Poly | Mitel 68xx |
Mitel 53xx |
Cisco |
|---|---|---|---|---|---|---|---|---|
| Time | Time Zone | Select the default time zone for all new customers | Inherited | ✔ | ✔ | ✔ | ✔ | ✔ |
| Format | Display time in 12 or 24 hour format | 24 Hour | ✔ | ✔ | ✔ | ✔ | ✔ | |
| Daylight Savings | Summer Time | Controls whether daylight sayings is enabled or not by default | Automatic | ✔ | ✔ | ✔ | ✔ | ✔ |
| Network Time Protocol | Primary Server | Provide a primary NTP server address | 0.pool.ntp.org | ✔ | ✔ | ✔ | ✔ | ✔ |
| Secondary Server | Provide a secondary NTP server address | 1.pool.ntp.org | ✔ | ✔ | ✔ | ✔ | ✔ |
Display #
Set the default date & time settings for a customer.
| Area | Setting | Available Options | Default | Yealink | Poly | Mitel 68xx |
Mitel 53xx |
Cisco |
|---|---|---|---|---|---|---|---|---|
| Screen Saver Setting | Screen saver enabled | Enable/disable the phone's screen saver | Enabled | ✔ | ✔ | ✔ | ✘ | ✔ |
| Screen saver wait time | If enabled, set the time before the screen saver is invoked | 10 minutes | ✔ | ✔ | ✔ | ✘ | ✔ | |
| Display Savings | Backlight time | Control the time before the backlight is switched off. | 2 minutes | ✔ | ✘ | ✔ | ✘ | ✔ |
| Key label length | Switch between different label length options | Default | ✔ | ✘ | ✘ | ✘ | ✘ | |
| Notifications | Missed call | Enable/disable missed call notifications | Enabled | ✔ | ✘ | ✔ | ✘ | ✔ |
Settings #
Set the default security setting for a customer's phones.
| Area | Setting | Available Options | Default | Device Level Only1 |
Yealink | Poly | Mitel 68xx | Mitel 53xx | Cisco |
|---|---|---|---|---|---|---|---|---|---|
| Web Access | Enable HTTP | Enable/disable access to the phone via HTTP | Disabled | ✔ | ✔ | ✔ | ✔ | ✔ | |
| Enable HTTPS | Enable/disable access to the phone via HTTPS | Enabled | ✔ | ✔ | ✔ | ✔ | ✔ | ||
| Action URI | Enable action URIs | Enable/disable access to the phone via HTTP | Disabled | ✔ | ✘ | ✘ | ✘ | ✘ | |
| Show action URI option | Enable/disable access to the phone via HTTPS | Enabled | ✔ | ✘ | ✘ | ✘ | ✘ | ||
| Limit access from specific IP address | Provide an administrator password for local Web Access | Random | ✔ | ✘ | ✘ | ✘ | ✘ | ||
| User | Handset PIN Code | User PIN for DECT handsets | ✔2 | ✘ | ✘ | ✘ | ✘ | ||
| Register PIN Code | Register PIN for DECT handsets | ✔2 | ✘ | ✘ | ✘ | ✘ | |||
| Passwords | Administrator Password | Provide an administrator password for local Web Access | Random | ✔ | ✔ | ✔ | ✔ | ✔ | |
| Advanced | Custom Configuration File | Optionally select a custom config file to provide the phone | None | ✔ | ✔ | ✘ | ✔ | ✘ | ✔ |
Network #
If required, update the default network configuration.
| Area | Setting | Available Options | Default | Customer Level Only1 |
Yealink | Poly | Mitel 68xx |
Mitel 53xx |
Cisco |
|---|---|---|---|---|---|---|---|---|---|
| IP Settings | DHCP | Enable or disable DHCP on the device. If disabled, configure static IP, Subnet & Gateway | Disabled | ✔ | ✔ | ✔ | ✘ | ✔ | |
| IPv4 Address | If DHCP is disabled, the IPv4 Static address can be set here | None | ✔ | ✔ | ✔ | ✘ | ✔ | ||
| Subnet | If DHCP is disabled, the IPv4 Static subnet can be set here | None | ✔ | ✔ | ✔ | ✘ | ✔ | ||
| Gateway | If DHCP is disabled, the IPv4 Static gateway can be set here | None | ✔ | ✔ | ✔ | ✘ | ✔ | ||
| DNS | Primary Server | Provide a primary DNS server address | None | ✔ | ✔ | ✔ | ✘ | ✔ | |
| Secondary Server | Provide a secondary DNS server address | None | ✔ | ✔ | ✔ | ✘ | ✔ | ||
| Other | PC Port | Enable or disable the PC port on the device | Enable | ✔ | ✔ | ✔ | ✔ | ✔ | |
| SIP | Proxy Server | Outgoing proxy server for the device | ✔ | ✔ | ✔ | ✔ | ✔ | ||
| Proxy Port | Outgoing proxy port for the device | 7000 | ✔ | ✔ | ✔ | ✔ | ✔ | ||
| Physical Handsets | Transport | Transport protocol for SIP connection (UDP/TCP/TLS) | UDP | ✔ | ✔ | ✔ | ✔ | ✔ | |
| Port | SIP registration port | 7000 | ✔ | ✔ | ✔ | ✔ | ✔ | ||
| Register Timeout | SIP registration timeout in seconds | 360 | ✔ | ✔ | ✔ | ✔ | ✔ | ||
| RTP Encryption (SRTP) | Enable or disable RTP encryption | Disable | ✔ | ✔ | ✔ | ✘ | ✔ | ||
| Allow provisioning over HTTP | Enable or disable physical device provisioning over HTTP2 | Disable | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | |
| ~.UcClient.~ Client | Transport | Transport protocol for SIP connection (UDP/TCP/TLS) | UDP | ✔ | n/a | n/a | n/a | n/a | n/a |
| Port | SIP registration port | 7000 | ✔ | n/a | n/a | n/a | n/a | n/a | |
| Register Timeout | SIP registration timeout in seconds | UDP | ✔ | n/a | n/a | n/a | n/a | n/a | |
| 802.1x | Type | Select the 802.1x Implementation Type (Not Configured, None, EAP-MD5, EAP-TLS, EAP-PEAP-MSCHAPV2) | Not Configured | ✔ | ✔ | ✔3 | ✘ | ✔ | |
| Identity | User id for 802.1X authentication | ✔ | ✔ | ✔ | ✘ | ✔ | |||
| Password | Password for 802.1X authentication (EAP-MD5 only) | ✔ | ✔ | ✔ | ✘ | ✔ | |||
| Root / Intermediate Certificate | Certification for EAP-TLS/EAP-PEAP-MSCHAPV2 | ✔ | ✔ | ✔ | ✘ | ✔ | |||
| Trusted Certificate | Certification for EAP-TLS/EAP-PEAP-MSCHAPV2 | ✔ | ✔ | ✔ | ✘ | ✔ | |||
| Private Key | Private Key for EAP-TLS | ✔ | ✔ | ✔ | ✘ | ✔ | |||
| Local Certificate | Certification for EAP-TLS | ✔ | ✔ | ✔ | ✘ | ✔ |
warning
An invalid DNS configuration will render the phones inoperable and may stop them receiving further configuration updates.
warning
Enabling provisioning over HTTP is NOT recommended. SIP credentials are passed in plain text to the phone, vastly increasing the possibility of phone hacking.
Security #
By default, the IP address the phones first connect from will be saved. Any future configuration requests will only be allowed from the same IP address.
If the device's external IP address changes, this IP address can be reset by unlocking the device from the main Devices grid.
If a device's external IP address is constantly changing, the IP address restrictions can be disabled here.
| Area | Setting | Available Options | Default | Yealink | Poly | Mitel 68xx |
Mitel 53xx |
Cisco |
|---|---|---|---|---|---|---|---|---|
| IP Address Restrictions | Enable IP address restrictions | Enable or disable device IP address restrictions. If enabled, a device's remote IP address is monitored. Any configuration request made by the device from a different address will fail. | Enable | ✔ | ✔ | ✔ | ✔ | ✔ |
| Default phones from unknown IP addresses | Enable or disable device defaulting. If enabled, any configuration request from a device from an unmatched IP address will result in the phone being wiped. When disabled, the configuration request will be ignored. | Disable | ✔ | ✔ | ✔ | ✔ | ✔ | |
| IP address allow list | Add individual or blocks of IP addresses that are automatically allowed for configuration requests. | None | ✔ | ✔ | ✔ | ✔ | ✔ |
Accounts #
~.Dimensions.~ automatically handles the configuration for a normal 'Line' keys added to a keymap for the associated Phone Only or User device. If there is a requirement to configure a Line or BLF key for an account on the different telephone system, the specific account registration details must be configured here.
info
Additional account configurations is only available for configuration on a device by device basis, not at customer level.
| Area | Setting | Description | Default | Device Level Only1 |
Yealink | Poly | Mitel 68xx |
Mitel 53xx |
Cisco |
|---|---|---|---|---|---|---|---|---|---|
| Additional Accounts | Account | Additional account number selection. Choose an account from 2-102 | n/a | ✔ | ✔ | ✔ | ✔ | ✘ | ✔ |
| Account Detail | Override | Enable or disable this account on the phone | Disabled | ✔ | ✔ | ✔ | ✔ | ✘ | ✔ |
| Username | Provide the username for the SIP account | None | ✔ | ✔ | ✔ | ✔ | ✘ | ✔ | |
| Password | Provide the password for the SIP account | None | ✔ | ✔ | ✔ | ✔ | ✘ | ✔ | |
| Server | Provide the server for the SIP account | None | ✔ | ✔ | ✔ | ✔ | ✘ | ✔ | |
| Port | Provide the port for the SIP account | None | ✔ | ✔ | ✔ | ✔ | ✘ | ✔ | |
| Display Name | Provide the display name for the SIP account | None | ✔ | ✔ | ✔ | ✔ | ✘ | ✔ | |
| Transport | Provide the transport protocol for the SIP account | None | ✔ | ✔ | ✔ | ✔ | ✘ | ✔ | |
| Proxy | Provide the outbound proxy address for the SIP account | None | ✔ | ✔ | ✔ | ✔ | ✘ | ✔ | |
| Proxy Port | Provide the proxy port for the SIP account | None | ✔ | ✔ | ✔ | ✔ | ✘ | ✔ |
warning
Not all device types support additional lines or do not support 10 in total. Please check your device type before using this feature.
Voice #
These settings are only available for Phone Only devices, not devices which have been assigned to a user.
| Configuration | Description |
|---|---|
| Extension Number | (Read Only) The internal extension number which has been assigned to this device |
| Ringing Timeout | The amount of time a call will ring at the device before giving up |
SIP #
The settings below are used by each device to successfully register and use SIP services. By default, these settings will be automatically populated and should not need to be changed.
If configuring a generic SIP device which is not supported by automatic provisioning, the details below will need to be manually configured on the SIP device.
| Configuration | Description |
|---|---|
| SIP Username | The SIP username for this specific device |
| SIP Password | The SIP password for this specific device |
| SIP Realm | (Read Only) Realm for SIP connections |
| SIP Proxy Address | (Read Only) Outbound Proxy Address |
SIP Proxy Address
If manually configuring a SIP connection (on a generic SIP device for example), the Outbound Proxy must be configured and use DNS SRV to ensure the call traffic routes correctly to the primary controller by default.
For example, on some devices to ensure DNS SRV is used the Outbound Proxy SIP port must be set to 0 or with MicroSIP there is an option within global settings to enable DNS SRV. If the device is not configured correctly to use DNS SRV it will still register, however calls may drop where traffic is not proxied correctly.
warning
Failure to configure the Outbound Proxy correctly can result in dropped calls/transfers.
Show Provisioning Information
By default, all supported devices should be automatically provisioned using the appropriate manufacturer's provisioning service (ZTP, RPS etc). If there is a problem with the provisioning service, the details below can be used to manually provide the device with the information required to connect to the system.
| Configuration | Description |
|---|---|
| Provisioning Username | (Read Only)The provisioning username for this specific device |
| Provisioning Password | (Read Only)The provisioning password for this specific device |
| Provisioning URL | (Read Only)The base provisioning URL |
tip
Please refer to the manufacturer specific section of the documentation for information on how to manually provision each type of device.
Recording #
If call recording is enabled on this account, the recording tab will appear for devices. The settings here can be used to override the ones set for recording at customer/user level.
| Configuration | Description |
|---|---|
| Device Call Recording | Controls recording of a device's calls. This will override what is set at user level. |
For more information on recording permissions, refer here.