Skip to content

AP Device Settings

The Devices page displays a list of devices assigned to your account. Sort or 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

  1. Go to Advanced Provisioner > Devices.

  2. Click the settings icon on the device that you want to configure, and click Configure from the dropdown.

    ap_configuration

  3. Provision each section as required.

    ap_device_settings.png

  4. After you make the updates, reboot your device to receive the latest configuration.

Configuring lines

  1. Go to Advanced Provisioner > Devices.

  2. Click the settings icon on the device that you want to configure, and click Configure from the dropdown.

    ap_configuration

  3. 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 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)

encryption

Smart PBX > Devices > Edit > Advanced > Miscellaneous > Encrypt the audio

encryption_pbx

Configuring codecs

  1. Go to Advanced Provisioner > Devices.

  2. Click the settings icon on the device that you want to configure, and click Configure from the dropdown.

    ap_configuration

  3. 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

  1. Go to Advanced Provisioner > Devices.

  2. Click the settings icon on the device that you want to configure, and click Configure from the dropdown.

    ap_configuration

  3. 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

  1. Go to Advanced Provisioner > Devices.

  2. Click the settings icon on the device that you want to configure, and click Configure from the dropdown.

    ap_configuration

  3. 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 a customer or partner uses their 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) Enter a URL to upload a customer configuration file to overwrite provisioner settings.

Configuring network settings

  1. Go to Advanced Provisioner > Devices.

  2. Click the settings icon on the device that you want to configure, and click Configure from the dropdown.

    ap_configuration

  3. 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

Combo keys are the soft keys on your phone, usually under the display. Configure the soft keys to perform functions such as "speed dial" to a particular extension or use them as "parking" keys and so on.

Important

Any combo key settings configured in the Smart PBX Setting up combo keys will override those made here in the Advanced Provisioner application. Use EITHER Smart PBX or Advanced Provisioner application to manage combo key settings.

  1. Go to Advanced Provisioner > Devices.

  2. Click the settings icon on the device that you want to configure, and click Configure from the dropdown.

    ap_configuration

  3. Select the "Combo Keys" tab and click which key you want to configure. Combo key 1 is typically used as a line key so it's better not to configure this.

    combo
    Type By defaults, combo key 1 is used as a Line key.
    • Line: use combo key as a line key
    • BLF: configure the combo key as a indicator for a specific extension
    • Call park: use combo key to park calls
    • Conference: use combo key to dial into a conference room
    • Transfer: use combo key as a transfer key
    • Hold: use combo key to place calls on hold
    • DND: use combo key to activate do-not-disturb
    • Call return: use combo key to return calls
    • Voicemail: use combo key to access voicemail
    • Speed Dial: use combo key to speed dial another extension
    • Intercom
    Account Do not leave this as "inherit". Choose Account 1 normally, 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, voicemail box number, or phone number for example. For some combo key types, such as DND, you can leave value blank.
    Label Enter the (optional) label that you want the device to display for the key

  4. Apply your settings and click Save.

  5. Reboot to allow the new configuration to update.

Configure BLF key example

Set up a combo key as a BLF indicator for John Doe at extension 100. When John's extension is busy, you'll see an indicator flashing on your combo key.

  • Type: BLF
  • Account: 1
  • Value: 103 (this is the user extension for John)
  • Label: John

Configuring preferences

Provision general calling preferences for the device.

  1. Go to Advanced Provisioner > Devices.

  2. Click the settings icon on the device that you want to configure, and click Configure from the dropdown.

    ap_configuration

  3. 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.

  1. Go to Advanced Provisioner > Devices.

  2. Click the settings icon on the device that you want to configure, and click Configure from the dropdown.

    ap_configuration

  3. 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. Configure one or multiple "dialnow" rules on your phone. When the dialed number matches the "dialnow" string, the number will be dialed out automatically.

  1. Go to Advanced Provisioner > Devices.

  2. Click the settings icon on the device that you want to configure, and click Configure from the dropdown.

    ap_configuration

  3. 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

Exact match Replace a specific input number

  1. prefix=0, replace=0086 When you dial 0 out, the number will be replaced by 0086 automatically

  2. prefix=123, replace=0592 When you dial 123 out, the number will be replaced by 0592 automatically.

Partial match

If need to replace the unknown contents, then you can use (.) or (x). The content in () stands for a variable, the first variable is expressed by $1.

Examples:

  1. prefix=(xxxx), replace=9$1

    When you dial out any four characters on your phone, the IP phone will replace the number added with 9. For example, you dial 8742 out, the number will be replaced by 98742 automatically. If you dial 55555 out, the replace rule can't take effect.

  2. prefix=(.), replace=9$1

    When you dial out any number of characters on your phone, the IP phone will replace the number added with 9. For example, you dial 06612 out, the number will be replaced by 906612 automatically.

  3. prefix=9(.), replace=$1

    When you dial 9321 out, the number will be replaced by 321. If you dial 99987 out, the number will be replaced by 9987 automatically. And so on.

  4. prefix=13([0-9])(.), replace=913$1$2

    When you dial 1308765 out, the number will be replaced by 91308765. When you dial 91308765 out, the replace rule can't take effect.

  5. prefix=(21)([1,3]), replace=9$1$2

    When you dial 211, the number will be replaced by 9211. When you dial 214, the replace rule can't take effect. When you dial 121, the replace rule can't take effect. And so on.

  6. prefix=(xxx)(23), replace=8$1$2

    When you dial 55523, the number will be replaced by 855523. When you dial out 878723, the replace rule can't take effect. When you dial out 55513, the replace rule can't take effect. And so on.

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.

  1. Go to Advanced Provisioner > Devices.

  2. Click the settings icon on the device that you want to configure, and click Configure from the dropdown.

    ap_configuration

  3. 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 to dial out

If you want dial out on a second line, set up a second "device" for your user in the hosted PBX. The system will recognise the button as a device and allow you to dial out from it.

  1. Go to Smart PBX > Users
  2. Select your user and click the "Devices" column.
  3. Select +Add New Device > SIP phone.

  4. Select "The brand of my device is not listed here"

  5. To make it easy to find later, give the device a unique name.

  6. Copy the SIP username and password.

  7. Click Create Device

  8. Switch applications to Advanced Provisioner

  9. Click the settings icon on the device that you want to configure, and click Configure from the dropdown.

  10. Go to Lines, click "2" for Line 2.

  11. Enter the information as shown and paste in the SIP information.

  12. Go to Combo Keys, select the button that you want to configure and enter the information as shown.

  13. Click Save and then send the phone a restart request.

  14. Switch applications to Callflows.
  15. Go to Device and select the device you created from the list on the left.
  16. Go to Advanced > Caller ID.

  17. Modify the caller ID that you want to display when dialling out from the second line.

More information