Configuring Desk Phone Provision Templates Follow

Overview

Note: Before adding a desk phone, see an overview of the provisioning process.

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.

We highly recommend that admins read this guide carefully before using this feature. Admins take full responsibility for the outcomes of creating and assigning provision templates.

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. Cisco models and 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.

Creating a provision template

  1. Sign in to the Zoom web portal.
  2. In the navigation panel, click Phone System ManagementCompany 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.

Parameter examples

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

The following 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.
#Firmware URL:
provisioning/firmware/url=https://...

#Do not allow firmware upgrade:
provisioning/firmware/url=

Polycom

  • 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.
#Firmware URL:
APP_FILE_PATH_VVX250 = "http://downloads.polycom.com/voice/software/UC_Software_5_x_x_release_sig_split/xxxx-xxxxx-001.sip.ld"

#Do not allow firmware upgrade:
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.
#Firmware URL:
static.firmware.url = https://...

#Do not allow firmware upgrade:
static.firmware.url = %NULL%

Supported parameters

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

Assigning a provision template to a provisioned desk phone

  1. Sign in to the Zoom web portal.
  2. Click Phone System ManagementPhones & 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.

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

Note: You can't specify a provision template when batch adding desk phones.

  1. Sign in to the Zoom web portal.
  2. Click Phone System ManagementPhones & 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, select 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.

Assigning a provision template during provisioning

  1. Follow the steps to add a desk phone. 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.

Changing or removing 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. Click Phone System ManagementPhones & 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.
    • Unbind: Remove the template from the phone. The template will still be available to assign.
  5. Re-sync the desk phone to apply changes.
Was this article helpful?