Configuring desk phone provision templates in Zoom App
By providing provision templates to Zoom Phone admins, Zoom Phone admins are able to customize desk phone settings and apply them to all of the desk phones or a single desk phone as needed. These templates can be applied to the entire account, to multiple sites, to a group of desk phones, or individually. There is an easy way to modify, reassign, or remove provision templates from the provisioning system. Using key-value pairs, it is possible to specify the settings in provision templates in order to achieve the desired results.
Important:
- Before using provision templates, please read this guide carefully.
- In this article, we will discuss provision template parameters for admins who have experience with them. Provision templates are created and assigned by admins, who are fully responsible for their outcomes.
- Desk phone manufacturers (such as Poly and Yealink) determine provision template parameters. Provision template parameters are not supported by Zoom.
- Incremental provisioning is supported by AudioCodes MP series ATAs. The local parameters on devices will not be cleared by resynching from Zoom’s web portal, and ongoing calls will remain unaffected. Resyncs will not clear local parameters if incremental provisioning is supported, thus eliminating the need to bind a custom provision template.
Limitation: - Any local parameters not set to the default values will be cleared when provisioning a device for the first time. It is still necessary for users to set their local parameters after the first successful provisioning. The device’s local parameters will not be cleared by any subsequent resyncs.
This article covers:
- Limitations of provision templates
- How to create a provision template
- Supported parameters
- Parameter formatting examples
- AudioCodes
- Poly
- Yealink
- How to assign a provision template to a desk phone
- How to assign a provision template to multiple desk phones or all desk phones in a site
- How to batch assign provision templates
- How to assign a provision template during provisioning
- How to change or remove a provision template assigned?
Contents
- 1 Prerequisites
- 2 Limitations of provision templates
- 3 How to create a provision template
- 4 Supported parameters
- 5 Parameter formatting examples
- 6 How to assign a provision template to a provisioned desk phone
- 7 How to assign a provision template to multiple desk phones or all desk phones in a site
- 8 How to batch assign provision templates
- 9 How to assign a provision template during provisioning
- 10 How to change or remove an assigned provision template
Prerequisites
- Accounts for Professionals, Businesses, and Schools
- Ownership or admin rights on the account
- License for Zoom Phone
- Support for provision templates on desk phones
Limitations of provision templates
- There is a limit of 102,400 characters per provision template. There should be a unique name for the template.
- Desk phones are the only devices covered by the provision template. We do not support Cisco models or models that have been end-of-sale.
- Due to the fact that each manufacturer supports different parameters, each template can only be applied to one manufacturer at a time. You can edit the template by following the parameters recommended by the manufacturer on the manufacturer’s support site, which can be found on the manufacturer’s website.
- Add the unsupported codec(s) to the supported codecs priority order or change their priority order is not recommended. Audio quality will likely be affected by changing codecs.
- It is recommended that desk phones run the recommended firmware in order to get the best results. Before creating provision templates, check the desk phone features that are supported.
- There are a limited number of parameters related to SIP registration. Admins who attempt to change or overwrite parameters related to SIP registration will not be able to save the provision template.
- Key-value pairs are the only types of templates supported in the provision template section. Zoom does not limit or control what can be added to the field except for SIP-related parameters. In creating and assigning provision templates, account owners and administrators are fully responsible for the outcomes.
- As soon as the phone is provisioned or re-synchronized, the provision template is applied.
- No changes can be made to the following 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
How to create a provision template
- Zoom’s web portal can be accessed by signing in.
- You can find Company Info in the navigation panel by clicking Phone System Management.
- Go to Account Settings.
- Click Manage under Provision Template in the Desk Phone section.
- Add a new item.
- The following information should be entered:
- Name:
- Identify the template by its display name. Every template can only be applied to one manufacturer, so include the name of the manufacturer.
- Description (optional):
- Give the template a description to make it easier to identify.
- Template:
- The manufacturer should support key-value pairs. Here are some examples of parameters and what parameters are supported.
Supported parameters
Please visit the manufacturer’s support site for a detailed specification of all parameters:
- AudioCodes
- Poly
- Yealink
Provision templates can be configured to provide the following frequently-requested features:
- VLAN
- Poly
- Dial plan / digit map
- Poly
- Yealink
Parameter formatting examples
Don’t forget to follow these formatting guidelines exactly. Key-value pairs for desk phones differ from manufacturer to manufacturer.
Here are examples of how firmware version control parameters should be formatted:
AudioCodes
- Key name for firmware:
- Provisioning/firmware/url
- Value when firmware version control is not needed:
- No value should be inserted.
- Formatting:
- Values should not be enclosed in double quotes (” “) or separated by spaces.
Provisioning/firmware/url=https://... Provisioning/firmware/url=
Poly
- Key name for firmware:
- MODELNAME_APP_FILE_PATH
- Example:
- VVX250_APP_FILE_PATH
- Value when firmware version control is not needed:
- A blank string (“”) should be inserted.
- 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:
- Static.firmware.url
- Value when firmware version control is not needed:
- %NULL%
- Formatting:
- Values should not be enclosed in double quotes. The key and value should be separated by spaces.
Static.firmware.url = https://... Static.firmware.url = %NULL%
How to assign a provision template to a provisioned desk phone
- Zoom’s web portal can be accessed by signing in.
- Then click Phones & Devices in the navigation menu.
- A template can be assigned to a desk phone by finding it.
- Choose Bind Provision Template from the far-right column by clicking the ellipses icon (…).
Note: - The provision template can only be assigned to one desk phone at a time. It is possible to change the provision template if there is already a template assigned, or you can unbind the template from the desk phone.
- Click Bind after selecting the template from the Target Template drop-down menu.
- Finish assigning the provision template by resyncing the desk phone.
How to assign a provision template to multiple desk phones or all desk phones in a site
- Zoom’s web portal can be accessed by signing in.
- Then click Phones & Devices in the navigation menu.
- To view associated desk phones for a specific site, select it in the Site drop-down menu in the top-right corner.
- In the header row, check the box next to the first column to select all desk phones.
- Select Bind from the drop-down menu on the Provision Template page.
- You will need to select the template to be assigned from the drop-down menu in the Target Template field, then click the Bind button.
- To finish assigning the provision template to the desk phones, make sure that you re-sync them.
How to batch assign provision templates
If you import or update phone users or import unassigned devices, you will be able to batch assign provision templates. In the CSV file, you must specify the name of the provision template that you wish to use.
How to assign a provision template during provisioning
- Add a desk phone by following these steps.
Note: - You should specify a desk phone capable of supporting provision templates. In the absence of a desk phone that supports provision templates, you can’t select one.
- Choose a provision template from the Provision Template drop-down menu, then click Save. The provision template will then be assigned to the account.
During the provisioning process, the template will be applied to the desk phone so that you can customize it to your liking.
How to change or remove an assigned provision template
To assign another provision template to a desk phone or to remove the current provision template that has already been assigned to that phone, follow these steps.
- To access the Zoom web portal, you will need to sign in.
- Click Phone System Management from the navigation menu, and then click Phones & Devices from the Phones & Devices menu.
- If you want to change the name of the desk phone, click on it.
- You can select one of the following options next to Provision Template:
- Edit: The phone can be assigned a different template if you wish. Select a provision template from the drop-down menu and click Bind in order for the template to be applied to the provision.
- Unbind: The template should be removed from the phone. You will still be able to assign the template to the project.
- To apply the changes to your desk phone, you will have to re-sync it. You will have to restart your desk phone several times in order to fix the problem.
FAQs?