Configuring desk phone provision templates in zoom App

Zoom Phone admins can deploy templates to desk phones as part of the Zoom Phone account management platform, which allow them to customize settings for individual phones, multiple sites, a group of phones, or the entire account as a whole. It is possible to modify, reassign, and remove provision templates easily. To do so, key-value pairs can be used to specify the settings for provision templates.

Important:

• Before you use the provision templates, please carefully read this guide.
• Administrators who are familiar with the parameters in provision templates should read this article. In creating and assigning provision templates, administrators are fully responsible for the outcomes.
• Desk phone manufacturers (such as Poly and Yealink) determine the parameters of the provision template. The Zoom software does not support the parameters contained within the template.
• ATAs from AudioCodes are capable of supporting incremental provisioning as well. Resyncing the Zoom web portal won’t affect the local parameters on your devices or effect your ongoing calls, as a resync will not wipe out the local parameters on your devices. Additionally, incremental provisioning eliminates the need to bind a custom provision template to specify the local parameters, especially if the local parameters have not been cleared by the resync process.
  Limitation:
• As soon as a device is provisioned for the first time, it will clear any local parameters that differ from the defaults. It is still necessary for users to set any desired local parameters on their devices after successful provisioning has occurred. In the event that a subsequent resync is carried out, the device’s local parameters will not be cleared.

Prerequisites

• Account types: Pro, Business, and Education
• Admins or account owners
• Licensed to use Zoom
• Desk phones that support provision templates

Limitations of provision templates

• The maximum number of characters in a provision template is 102,400. A unique template name is required.
• Only desk phones can use provision templates. Models by Cisco and end-of-sale cannot be used.
• Since each manufacturer has different parameters, each template can only be applied to one manufacturer. You can edit the template by visiting the manufacturer’s support site and using the parameters each manufacturer supports.
• Changing the order of priority of supported codecs or adding unsupported codecs to the list of supported codecs is not recommended. The audio quality will likely be affected.
• It is important that the desk phones run the recommended firmware and are supported for best results. Before creating provision templates, make sure the desk phones have the supported features.
• There are a limited number of parameters associated with SIP registration. If the administrator attempts to change or overwrite any parameters related to SIP registration, the provision template will not be able to be saved.
• There is only support for key-value pairs in the provision template section. The addition of fields to Zoom is not restricted or controlled, except for SIP-related parameters. Creating and assigning provision templates is entirely the responsibility of account owners and administrators.
• If you provision or re-sync the assigned phone, the provision template will be applied.
• Here are the reserved parameters:

Account.[1-9]
CONFIG_FILES
DMS.enable
Feature.obitalk.enabled
Msg.MWI
Obitalk.accountCode
Reg.[1-9]
Security/CA_certificate
Sec.TLS.customCaCert
Sip.* (except sip.ld)
Static.auto_provision.server.url
Static.trusted_certificates.url
System/type
Voice_mail.number
Voip/line/[1-9]
Voip/signalling/sip

Creating a provision template

1. Log in to Zoom.
2. Select Phone System Management from the navigation panel and then Company Info from the drop-down menus.
3. Then click on Account Settings.
4. Click Manage under Provision Template in the Desk Phone section.
5. Select Add.
6. Enter the following information:
   • Name:
   • Identify the template by its display name. As each template can only be applied to one manufacturer, include the name of the manufacturer.
   • Description (optional):
   • You may choose to provide a description to make it easier for others to identify the template.
   • Template:
   • Enter key-value pairs that are supported by the manufacturer when creating the template. You can find more details about the supported parameters in the parameter examples.

Supported parameters

Please visit the manufacturer’s support page for detailed specifications of all parameters:

• SoundCodes
• Polyphonic
• Yaesu

Provision templates can be used to configure some frequently requested features:

• VPN
  • Policy
• Including digit map / dial plan
  • The company
  • Called “Yealink”

Parameter formatting examples

You should follow these formatting instructions to the letter. Different desk phone manufacturers use different key-value pairs formats.

Following are examples of how the firmware version control parameter should be formatted:

AudioCodes

• Key name for firmware:
• https://provisioning/firmware/url
• Value when firmware version control is not needed:
• Remove the value.
• Formatting:
• The values should not have double quotes (” “) or spaces between them.

Provisioning/firmware/url=https://...
Provisioning/firmware/url=

Polycom

• Key name for firmware:
• MODELNAME_APP_FILE_PATH
  • Example:
  • VVX250_APP_FILE_PATH
• Value when firmware version control is not needed:
• Add a blank string (” “).
• Formatting:
• Values should be enclosed in double quotes (” “)

APP_FILE_PATH_VVX250 = "http://downloads.polycom.com/voice/software/UC_Software_5_x_x_release_sig_split/xxxx-xxxxx-001.sip.ld"
APP_FILE_PATH_VVX250 = " "

Yealink

• Key name for firmware:
• http://static.firmware.url
• Value when firmware version control is not needed:
• %NULL%
• Formatting:
• Values should not be enclosed in double quotes. Separate the key from the value by putting a space between them.

Static.firmware.url = https://...
Static.firmware.url = %NULL%

Assigning a provision template to a provisioned desk phone

1. Zoom’s web portal must be logged in.
2. To access Phone System Management, click Phones & Devices in the navigation menu.
3. Locate the telephone you wish to assign a template to.
4. Select Bind Provision Template by clicking the ellipsis (…) in the far-right column.
   Note:
5. The provision template can only be assigned to one desk phone at a time. It is possible to remove an already assigned template from the desk phone by clicking Unbind Provision Template, or you can change the provision template previously assigned.
6. Select the template to be assigned from the Target Template drop-down menu, then click Bind.
7. In order to finish assigning the template, you will need to re-sync the desk phone.

Assigning a provision template to multiple desk phones or all desk phones in a site

1. Access the Zoom web portal by signing in.
2. Go to Phone System Management and then select Phones & Devices from the navigation menu.
3. To view associated desk phones, select a site from the Site drop-down menu at the top-right of the screen.
4. You can select all desk phones listed in the first column of the header row by clicking the checkbox.
5. Click Bind under Provision Template.
6. Choose the template to assign from the drop-down menu, then click Bind.
7. Once the provision template has been assigned, sync the desk phones again.

Batch assigning provision templates

Whenever you import or update phone users or import unassigned devices, you can batch assign provision templates. To assign provision templates, you need to use a CSV file.

Assigning a provision template during provisioning

1. Add a desk phone by following the steps.
   Note:
2. You need to ensure that the desk phone you choose supports provisioning templates. Unless the desk phone supports provision templates, you will not be able to select one.
3. You can select the template you wish to assign from the Provision Template (Optional) drop-down list, then click Save.
   Once the template has been successfully applied, the desk phone will automatically start receiving default settings.

Changing or removing an assigned provision template

Alternatively, you may remove the existing template if you have already assigned a provision template to the phone.

1. Access Zoom’s web portal by signing in.
2. Select Phone System Management then Phones & Devices from the navigation menu.
3. Change the name of the desk phone.
4. Choose from the templates provided below:
   • Edit:
   • Give the phone a different template. Click Bind after selecting a provision template from the Target Template drop-down menu.
   • Unbind:
   • The template is unbound from the phone. You can still assign the template.
5. To apply changes, resync the desk phone. After several restarts, it will take effect.