1. Zoom Support
  2. Zoom Phone System Support
  3. Settings and Configuration for Zoom Phone
  4. Provisioning Desk Phones and Devices

Related articles

Configuring desk phone provision templates

Last Updated:

Provision templates allows Zoom Phone admins to customize desk phone settings by creating templates with custom settings that can be applied to the entire account, multiple sites, a group of desk phones, or a single desk phone. Provision templates can be easily modified, reassigned, and removed. The settings in provision templates can be specified using key-value pairs.

Important:

  • Carefully read this guide before using provision templates.
  • This article is for admins that are familiar with provision template parameters. Admins take full responsibility for the outcomes of creating and assigning provision templates.
  • Provision template parameters are determined by the desk phone manufacturer (for example, Poly or Yealink). Zoom does not provide support for provision template parameters.
  • AudioCodes MP series ATAs support incremental provisioning. This means that a resync from Zoom web portal will not clear the local parameters on devices; and ongoing calls are not be affected. Incremental provisioning support also eliminates the need to bind a custom provision template to specify the local parameters since the resync will not clear the local parameters.
    Limitation: When provisioning a device for the first time, it will clear any local parameters that are non-default values. After the first successful provisioning, users are still required to set any desired local parameters on their device. Any subsequent resyncs will not clear the device's local parameters.

This article covers:

Prerequisites

Limitations of provision templates

  • Each provision template can contain no more than 102,400 characters. The template name should be unique.
  • The provision template only applies to desk phones. End-of-sale models are not supported.
  • Each template can only apply to one manufacturer, since each manufacturer supports different parameters. Visit the manufacturer's support site and edit the template by following each manufacturer's supported parameters.
  • Changing the order of supported codecs priorities or adding the unsupported codec(s) is not recommended. Changing codecs will likely cause audio quality issues.
  • For best results, make sure the desk phones are supported and running the recommended firmware. See the supported desk phone features before you create provision templates. 
  • The SIP registration-related parameters are limited. The provision template will not be able to save if the admin attempts to change or overwrite any SIP registration-related parameters.
  • The provision template section only supports key-value pairs. Other than the SIP-related parameters, Zoom does not have limitations or controls for what being added to the field. Account owners and admins take full responsibility for the outcomes of creating and assigning provision templates.
  • The provision template is applied to the assigned phone when you complete provisioning or re-sync the phone.
  • The following parameters are reserved and can't be changed:
account.[1-9]
CONFIG_FILES
dm.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

  1. Sign in to the Zoom web portal.
  2. In the navigation panel, click Phone System Management then Company Info.
  3. Click Account Settings.
  4. In the Desk Phone section, click Manage under Provision Template.
  5. Click Add.
  6. Enter the following:
    • Name: Enter a display name to identify the template. Include the manufacturer's name since each template can only apply to one manufacturer.
    • Description (optional): Enter a description to help you identify the template. 
    • Template: Enter key-value pairs supported by the manufacturer. For more details, see parameter examples and supported parameters.

Supported parameters

For detailed specification of all parameters, visit the support site of the desk phone manufacturer:

Here are some frequently-requested features that can be configured using provision templates:

Parameter formatting examples

Make sure you follow these formatting rules exactly as specified. Each desk phone manufacturer has a different format for key-value pairs.

These examples show the formatting required for the firmware version control parameter:

AudioCodes

  • Key name for firmware: provisioning/firmware/url 
  • Value when firmware version control is not needed: Do not insert a value.
  • Formatting: Do not insert double quotes (" ") for values or spaces between the key and value.
provisioning/firmware/url=https://...
provisioning/firmware/url=

Cisco

  • Key name for firmware: Upgrade_Rule
  • Value when firmware version control is not needed: Do not insert a value.
  • Formatting: Each XML tag represents a parameter in the phone.
<Upgrade_Rule ua="na">https://hybridupdate.zoom.us/pbx/cmterm-88xx.11-3-7MPP0101-284_REL/sip88xx.11-3-7MPP0101-284.loads</Upgrade_Rule>

<Upgrade_Rule ua="na"/>

Grandstream

GRP series provisioning template examples:

  • Example 1: Install non-Zoom certified firmware with the template.
<item name="provisioning.firmware.protocol">HTTP</item>
<!-- Firmware Server Path -->
<item name="provisioning.firmware.serverPath">your_local_file_server</item>
<!-- # NTP Server -->
<item name="dateTime.ntp.server.1">your_ntp_server_address</item>
<!-- # Secondary NTP Server -->
<!-- # String -->
<item name="dateTime.ntp.server.2">your_ntp_server_address</item>
  • Example 2: Change the NTP servers
<!-- # NTP Server -->
<item name="dateTime.ntp.server.1">your_ntp_server_address</item>
<!-- # Secondary NTP Server -->
<!-- # String -->
<item name="dateTime.ntp.server.2">your_ntp_server_address</item>

ATA HT8xx series examples:

For ATA HT8xx series, they only support P-Value format for configurations, so the provisioning template needs to be P-Value. Please refer to the Grandstream Configuration Template for specific parameters for ATA HT80xx and HT81xx series.

  • Example 1:
<!-- Codec settings: 0 - PCMU, 8 - PCMA, 4 - G.723, 18 - G.729, 2 - G.726-32, 97 - iLBC, 123 - OPUS, 9 - G722 -->
<P57>123</P57>
<P58>9</P58>
<P59>8</P59>
<P60>8</P60>
<P61>8</P61>
<P62>8</P62>
<P46>8</P46>
<P98>8</P98>
  • Example 2:
<!-- # NTP Server address-->
<P30>your_ntp_server_address</P30>

Poly

  • Key name for firmware: APP_FILE_PATH_MODELNAME
    • Example: APP_FILE_PATH_VVX250
  • Value when firmware version control is not needed: Insert a blank string (" ").
  • Formatting: Insert double quotes (" ") for values.
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: Do not insert double quotes for values. Insert spaces between the key and value.
static.firmware.url = https://...
static.firmware.url = %NULL%

How to assign a provision template to a provisioned desk phone

  1. Sign in to the Zoom web portal.
  2. In the navigation menu, click Phone System Management then Phones & Devices.
  3. Find the desk phone you want to assign a template to.
  4. Click the ellipses icon (...) in the far-right column, then click Bind Provision Template.
    Note: You can only assign one provision template to each desk phone. If there's already a template assigned, click Unbind Provision Template to remove the template from the desk phone, or you can change the assigned provision template.
  5. In the Target Template drop-down menu, select the template to assign, then click Bind.
  6. Re-sync the desk phone to finish assigning the provision template.

How to assign a provision template to multiple desk phones or all desk phones in a site

  1. Sign in to the Zoom web portal.
  2. In the navigation menu, click Phone System Management then Phones & Devices.
  3. In the Site drop-down menu located at the top-right area, select a site to view associated desk phones.
  4. Click the check box in the first column of the header row to select all desk phones listed.
  5. In the Provision Template drop-down menu, click Bind.
  6. In the Target Template drop-down menu, select the template to assign, then click Bind.
  7. Re-sync the desk phones to finish assigning the provision template.

How to batch assign provision templates

You can batch assign provision templates when importing/updating phone users or importing unassigned devices. You need to specify the provision template name in the CSV file.

How to assign a provision template during provisioning

  1. Follow the steps to add a desk phone.
    Note: Make sure you specified a desk phone that supports provision templates. You can't select a provision template if the desk phone doesn't support it.
  2. In the Provision Template (Optional) drop-down-menu, select the template to assign, then click Save.
    The template will be applied to the desk phone during the provisioning process.

How to change or remove an assigned provision template

If you already assigned a provision template to a desk phone, follow these steps to assign a different template or remove the current template.

  1. Sign in to the Zoom web portal.
  2. In the navigation menu, click Phone System Management then Phones & Devices.
  3. Click the desk phone name you want to change.
  4. Next to Provision Template, click one of these options: 
    • Edit: Assign a different template to the phone. In the Target Template drop-down menu, select a provision template, then click Bind.
    • Unbind: Remove the template from the phone. The template will still be available to assign.
  5. Re-sync the desk phone to apply changes. The desk phone will restart several times.

Zoom Community

Join the 100K+ other members in the Zoom Community! Login with your Zoom account credentials and start collaborating.