AP Device Settings
The Devices page displays a list of devices assigned to your account. You can sort/search by device name to find the model that you want to provision. Customize the user experience through device-specific settings.
Important
After you make changes in Advanced Provisioner, you should always restart your device to download the latest configuration from our servers. Go to the list of devices, click the settings icon and choose "Restart".
Provisioning devices
- Go to Advanced Provisioner > Devices.
-
Click the settings icon on the device that you want to configure, and click Configure from the dropdown.
-
Provision each section as required.
-
After you make the updates, reboot your device to receive the latest configuration.
Configuring lines
- Go to Advanced Provisioner > Devices.
-
Click the settings icon on the device that you want to configure, and click Configure from the dropdown.
-
Select the "Lines" tab and click the line that you want to configure.
| Type | Setting | Description |
|---|---|---|
| Basic | Enable | Is the line enabled or disabled. "Inherit" uses the setting that was applied at account level |
| Display name | Indicates the name that is displayed on the device. | |
| Transport | Indicates the transport layer for the device. See Transport Layer for more information. | |
| Expire time | Indicates the default expiration time (in seconds) of each phone registration. If the registration time expires due to the phone being turned off or if it doesn't reregister automatically, the phone is considered offline unless it registers again. IP Telecom recommends leaving this value at the default 360 seconds (6 minutes). | |
| Voicemail number | Enter a custom shortcode to access voicemail. This value should always match the "Check Voicemail" shortcode that is set up in your account feature codes. | |
| SIP | Do not modify | Default values are always recommended here and changing these values might cause your phone to stop working with our service. |
| Advanced | Show Missed Calls | Indicates if the phone should display missed calls. |
| RTP Encryption (SRTP) | Indicates if voice encryption is enabled on this phone. This only works if the PBX is also enabled for this feature. See Voice Encryption. | |
| RPort | Indicates that the server sends responses back to the source IP. IP Telecom recommends leaving this setting "Enabled". CAUTION: If this is disabled, the server responds to the first IP address in the header which might cause the packets to be dropped by an intermediate service, or servers can't respond and the phone might stop working. | |
| UDP Keep Alive | Indicates if keep-alive data packets are sent through the device to keep communication open. IP Telecom recommends leaving this setting at the default "Enabled". | |
| Keep Alive Interval | Indicates the timeout limit (in seconds) on keep-alive packets. If you are using UDP as the transport layer, the you should set to to a value that is less than the "UDP Keep Alive". |
IMPORTANT:
- The "Advanced" settings should be set to the defaults that are already configured. Changing any of "Advanced" settings (except "Show Missed Calls") might cause your phone to stop working.
- SRTP must be enabled if the device on the SmartPBX or Callflows is set to use Encrypted Voice/Encrypted RTP (See Voice Encryption).
Transport layer
- SRV/NAPTR - IP Telecom recommends using SRV/NAPTR because it uses dynamic records from DNS to determine where it needs to connect the phone to. During a failover, this setting allows for a quick and seamless transition of the SIP connection making sure that the endpoint stays connected.
- UDP - uses the configured port or the default SIP port to connect to our servers. If your phone is behind a firewall that has limited settings for UDP timeouts, then you can configure the "Keep Alive Interval" setting under "Advanced" to a value that is less than the "UDP Keep Alive" timeout. NOTE: This only applies to the SIP negotiations, so RTP (voice data) is still carried over UDP.
- TLS - If you want to use Secure SIP Messaging then transport should be set to TLS.
- TCP - is not recommended because it adds to the size of the data packets being transmitted.
Voice encryption
If you provision voice encryption in the Advanced Provisioner app, you must also make sure it is enabled on the device settings in the Smart PBX app.
Advanced Provisioner > Devices Settings > Lines > Advanced > RTP Encryption (SRTP)
Smart PBX > Devices > Edit > Advanced > Miscellaneous > Encrypt the audio
Configuring codecs
- Go to Advanced Provisioner > Devices.
-
Click the settings icon on the device that you want to configure, and click Configure from the dropdown.
-
Selectthe "Codecs" tab at the top and click the line you want to configure.
Important
A codec compresses audio data during phone calls and determines how your voice is transmitted. The quality of your VoIP calls depend on which codec you have selected for the transmission and on the bandwidth of your internet connection. Codecs can vary in how much bandwidth they use.
| Setting | Description |
|---|---|
| Primary Codec | Indicates the primary codec for this device. The primary codec supports audio playback. These settings are inherited from the Smart PBX, if you add or change a codec here, you must also change it in the Smart PBX under Devices. |
| Secondary Codec | Supports playback. |
| Tertiary Codec | Supports capture only. |
| Quarternary codec | Supports both playback and capture. |
Note
G711a (PCMA) is the preferred codec everywhere except in the Unites States where they use G711μ (PCMU). For HD voice, IP Telecom typically recommends G722. G729 has lowest bandwith usage but won't have a very high audio quality.
Configuring date and time
- Go to Advanced Provisioner > Devices.
-
Click the settings icon on the device that you want to configure, and click Configure from the dropdown.
-
Select the "Date and Time" tab at the top and click the line you want to configure.
| Type | Setting | Description |
|---|---|---|
| Time | Format | Indicates the time format to display on the device. |
| Timezone | Indicates the timezone for the device. NOTE: This timezone only influences the device itself, the UI retains UI settings or detected settings from the browser. | |
| DHCP Offset | If DHCP time offset is enabled, it specifies the offset of the account timezone in seconds from Coordinated Universal Time (UTC). | |
| Daylight Savings | Summer Time | Indicates if DST should be automatically updated on the device. |
| Network Time Protocol | Primary Server | Indicates the server used for network timezones. |
| Secondary Server | Indicates the secondary server used for network timezones. | |
| Date | Format | Indicate the date format to display on the device. |
Configuring general settings
- Go to Advanced Provisioner > Devices.
-
Click the settings icon on the device that you want to configure, and click Configure from the dropdown.
-
Select the "Settings" tab and click the line you want to configure.
| Type | Setting | Description |
|---|---|---|
| HTTP | HTTP | Allows user access to the web UI of the phone using HTTP. |
| HTTPS | Allows user to access the web UI of the phone using HTTPS. | |
| Admin | Password | Specifies the password for admin login to the phone. NOTE: If the default password is incorrect, then verify that the password in Advanced Provisioner > Account Settings is set to xxxx there; if not, update it. Then click Save and Yes to rebuild all files. If you only hit save on the device itself it will use the existing defaults. |
| Username | Specifies the username for admin login to the phone. | |
| Factory Reset Password | Indicates if password is required for factory reset. | |
| DHCP Option | IP Telecom recommends leaving this as default setting "Disabled". After a phone is configured, the provisioning URL changes to a device specific URL. If this option is enabled, the phone will always request the original provisioning URL from DHCP. This should only be enabled when a custom URL is used on location. | |
| White Labeling URLS | Provisioning URL | IP Telecom recommends leaving this as default URL. This URL ensures that phones can connect with their account specific username/password. This setting is only changed if you use your own own proxy. |
| Dialplan | Area Code | The dialplan defines an area code rule for the device to allow local dialling. For example, if your local area has a 2-digit area code plus a 7-digit number, when you dial the 7-digit number only, the area code is automatically added. |
| Minimum length | The minimum number of digits that the caller must dial to invoke the area code rule. This is typically the number of digits in your local area phone numbers. If your local numbers have 6 digits, then enter 6. | |
| Maximum length | The maximum number of digits that the caller can dial to invoke the area code rule. If your local number is 6 digits, then enter 7 as the maximum. After you dial more than 7 numbers, the device does not trigger the area code rule and simply dials the number that you enter. | |
| Lines | Enter the lines that you want to apply the area code rule to, separated by commas. | |
| Dialplan Digitmap (V81+ firmware Only) | Enabled | IP Telecom recommends leaving this as default "Disabled". The dialplan digitmap is a more advanced method of handling dialplans. Use the instructions provided by the device manufacturer to configure if required. |
| Hotline | Number | Enter a number that the phone dials automatically upon picking up the receiver. |
| Delay | Enter the delay (in seconds) that should occur before the phone dials the hotline number. | |
| Use User Settings | Enabled | Indicates if the user settings on the phone should be preserved during auto provisioning. If you disable this feature, then autoprovisioning might override what the user has set on the phone itself. |
| Logo | Mode | Configures the logo for the LCD screen of the device. |
| URL | Configure the access URL for the custom logo file. | |
| Firmware | Select Firmware Version | Firmware version. |
| Remote Call Directory | Enabled | Enables the company directory on the device. |
| Call Directory Name | Name of the phonebook. | |
| Call Directory URL | URL of the remote phonebook. | |
| Configuration Settings | Custom Config File URL (V81+firmware only) | Internal Use Only |
Configuring network settings
- Go to Advanced Provisioner > Devices.
-
Click the settings icon on the device that you want to configure, and click Configure from the dropdown.
-
Select the "Network" tab and click the line you want to configure.
Important
IP Telecom recommends using the default network settings. These settings should only be modified by advanced users.
| Type | Setting | Description |
|---|---|---|
| IP Configuration | IP Address Mode | Specifies static or DHCP IP address mode. |
| IP Address | If IP mode is static, this setting indicates the IPV4 or IPV6 address. | |
| Netmask | If IP mode is static, this setting indicates the IPV4 or IPV6 subnet mask. | |
| Gateway | If IP mode is static, this setting indicates the IPV4 or IPV6 default gateway. | |
| DNS | Primary server | If IP mode is static, this setting indicates the primary DNS server. |
| Backup server | If IP mode is static, this setting indicates the secondary DNS server. | |
| Static DNS | If enabled, the manually configured (static) DNS server overrides any DNS servers provided by DHCP. | |
| TTL Enable | Enables or disables the phone to use time-to-live (TTL) in the A record. Time-to-live (TTL) is a value in an IP packet that tells a network router whether or not the packet has been in the network too long and should be discarded. The A record is a basic DNS record used to point a domain or subdomain to an IP address. | |
| VLAN | VOIP VLAN Enabled | Enables or disables VLAN for the internet. |
| VOIP VLAN ID | VLAN ID, value between 1 and 1094. | |
| PC VLAN Enabled | Enables or disables VLAN for the PC. | |
| PC VLAN ID | VLAN ID for the PC port, value between 1 and 1094. | |
| VLAN Priority | Configures VLAN priority for the internet. | |
| PC Port Priority | Configures VLAN priority for the PC. | |
| LLDP Enable | Enables or disables the phone to use LLDP. | |
| LLDP Interval | Configures how often the phone sends LLDP requests (in seconds). Min = 1, Max = 3600 | |
| CDP Enable | Enables or disables the phone to use CDP | |
| CDP Interval | Configures how often the phone sends CDP requests (in seconds). Min = 1, Max = 3600 | |
| General | MTU | The maximum transmission unit of the network, between 128 and 1500. |
| Ports | PC Port | Enables or disables the PC (LAN) port. |
| RTP Ports | Minimum | The minimum local RTP port. Value between 1042 and 65535. |
| Maximum | The maximum local RTP port. Value between 1042 and 65535. | |
| DSCP | The quality of service DSCP (differentiated service code point) for voice packets. |
Configuring combo keys, speed dials and BLF
Combo keys allow you to set up a function or indicator to the keys on your device. IP Telecom recommends setting up your combo keys in the Smart PBX application, see Setting up Combo Keys.
Important
Any settings you apply in the Smart PBX will override updates made here in the Advanced Provisioner application.
- Go to Advanced Provisioner > Devices.
-
Click the settings icon on the device that you want to configure, and click Configure from the dropdown.
-
Select the "Combo Keys" tab and click the line you want to configure.
Type Specify which combo key to use. Choose "BLF" or "Speed Dial" Account The account on the phone that should be used to dial to value. Typically, you should choose Account 1, but if you have a second account and want to use in this, then select Account 2. Value Enter the destination number; this might be a starcode, extension or phone number for example Label Enter the label that you want the device to display -
Apply your settings and then save. After you reboot, the new configuration should update.
Combo key example
Set up a combo key for John Doe at extension 100. When you press the BLF field, it will call John Doe at extension 100.
- Type: BLF
- Account: 1
- Value: 100
- Label: John
Configuring preferences
Provision general calling preferences for the device.
- Go to Advanced Provisioner > Devices.
-
Click the settings icon on the device that you want to configure, and click Configure from the dropdown.
-
Select the "Preferences" tab and click the line you want to configure.
| Type | Setting | Description |
|---|---|---|
| Caller ID | Format | Indicates how the caller ID is displayed during a call |
| Voicemail Alert | Play Tone | Indicates if an alert tone should be played when voicemail is received |
| Hold Alert | Play Tone | Specifies if the phone plays a tone to indicate that there is a call on hold |
| Delay | The interval (in seconds) between hold tones being played | |
| Intercom | Allow | Indicates if and incoming intercom call should be automatically answered |
| Play Tone | Indicates if a warning tone should play when there is an incoming intercom call | |
| Answer Muted | Indicates if microphone should be muted when an intercom call is received | |
| Barge | Indicates if an intercom call can interrupt an ongoing call | |
| Call Waiting | Allow | Enable or disable call waiting |
| Play Tone | Indicates if a warning tone plays when a call is waiting | |
| Distinctive Ringtone | Internal Ringtone | Custom ringtone for internal incoming calls. For more steps see Yealink - Internal and External Ringtone. |
| External Ringtone | Custom ringtone for external incoming calls | |
| Voice Send Gain | Speaker | Indicates the loudness of the speaker |
| Handset | Indicates the volume on the handset | |
| Headset | Indicates the volume on the headset |
Configuring block out rules
This rule prevents the user from dialling the blocked number.
- Go to Advanced Provisioner > Devices.
-
Click the settings icon on the device that you want to configure, and click Configure from the dropdown.
-
Select the "Block Out Rules" tab and click the line you want to configure.
| Setting | Description |
|---|---|
| Number | Enter the number that you want to block. |
| Lines | Enter the lines this rule should apply to, separated by commas |
Configuring dialnow and replace rules
Dialnow and replace rules allow you to program certain numbers to dial when you press keys. Any pattern that the user dials that match these settings are automatically dialled. You can configure one or more "dialnow" rules on your phone. When the dialed number matches the "dialnow" string, the number will be dialed out automatically.
- Go to Advanced Provisioner > Devices.
-
Click the settings icon on the device that you want to configure, and click Configure from the dropdown.
-
Select "Dialnow and Replace Rules" tab and click the line you want to configure.
| Type | Setting | Description |
|---|---|---|
| Dialnow | Rule | Enter the rule values. For example, if you configure a "dialnow" rule as "2xx", then if a user enters a three-digit string beginning with 2, it will be dialed out automatically on the phone. |
| Lines | Enter each line this should apply to, separated by commas | |
| Replace | Prefix | Enter the keys that should be replaced. For example if you set the "Prefix" as 0 and "Replace" as 0086, when you dial 0 out, the number will be replaced by 0086 automatically. |
| Replacement | Enter the keys that they should be replaced with | |
| Lines | Enter which lines the replace rules applies to, separated by commas |
Configuring sidecars
The Sidecar is an attachment to your telephone, which allows you to speed-dial internal and external phone lines with the press of a single button. The phone numbers programmed into the sidecar should be the most frequently used numbers used throughout the day.
NOTE: Configuration for sidecars is provided on Yealink devices that support sidecars.
- Go to Advanced Provisioner > Devices.
-
Click the settings icon on the device that you want to configure, and click Configure from the dropdown.
-
Select the "Sidecars" tab and click the line you want to configure.
| Type | Setting | Description |
|---|---|---|
| Key | Type | Enter the type of speed dial sidecar is being configured |
| Account | Enter which account this sidecar will be used for | |
| Value | Enter the key to press for the speed dial | |
| Label | Freetext field to describe the type of speed-dial setting |
Adding a second line
Before you add your second line in Advanced Provisioner, you must create a second line in Smart PBX.
- Go to Apps > Smart PBX > Devices.
- See Adding a device to a user.
- Save the SIP details from your configuration somewhere or keep the screen open.
To add the second line in AP:
- Go to Your Apps > Advanced Provisioner.
- Select the device that you want to manage.
-
Click the settings icon and select "Configure".
-
From the "Lines" tab, check the next line available. In the example, the next line is "2".
-
Apply the settings per the screenshot.
- Enter the details of the SIP username and password that you saved when you created the device.
- Save your new line settings.
- Restart your device using Advanced Provisioner (select your device, click the settings icon and select "Restart") to download the new configuration from our servers.