Headset Management on Cisco Unified Communications Manager Version 12.5(1) or Older

Headset Management on Older Versions of Cisco Unified Communications Manager

If you have a version of Cisco Unified Communications Manager older than 12.5(1)SU1, you can remotely configure your Cisco Headset 700 Series settings for use with on-premises phones.

Remote headset configuration on Cisco Unified Communication Manager version 10.5(2), 11.0(1), 11.5(1), 12.0(1), and 12.5(1) requires you to download a file from the Cisco Software Download website, edit the file, and then upload the file on the Cisco Unified Communications Manager TFTP server. The file is a JavaScript Object Notification (JSON) file. The updated headset configuration is applied to the enterprise headsets over a 10 to 30-minute time frame to prevent a traffic backlog on the TFTP server.


Note

You can manage and configure headsets through Cisco Unified Communications Manager Administration version 11.5(1)SU7.

Note the following as you work with the JSON file:

  • The settings aren't applied if you are missing a bracket or brackets in the code. Use an online tool such as JSON Formatter and check the format.

  • Set the updatedTime setting to the current epoch time or the configuration is not applied. Alternatively, you can increase the updatedTime value by +1 to make it larger than the previous version.

  • Do not change the parameter name or the setting will not be applied.

For more information on the TFTP service, see the "Manage Device Firmware" chapter of the Administration Guide for Cisco Unified Communications Manager and IM and Presence Service.

Upgrade your phones to the latest firmware release before you apply the defaultheadsetconfig.json file. The following table describes the default settings you can adjust with the JSON file.

Table 1. Cisco Headset 700 Series Parameters and Default Settings

Parameter

Range

Default

Notes

Upgrade Source

0 (UCM and Cloud) – 1 (UCM Only)

0

Limits the download source

Auto Mute

0 (Off) – 1 (On)

1

Controls the Auto Mute feature in the Cisco Headset 730. When Auto Mute is active, users can automatically mute active calls when they take off their headsets. Mute automatically turns off when users put their headsets back on.

Auto Play

0 (Off) – 1 (On)

1

Controls the Auto Play feature in the Cisco Headset 730. When Auto Play is active, users can automatically pause music playback when they take off their headsets. Music playback automatically resumes when users put their headsets back on.

Auto Answer

0 (Off) – 1 (On)

1

Controls the Auto Answer feature in the Cisco Headset 730. When Auto Answer is active, users can automatically answer incoming calls when they put their headsets on.

Sidetone

0 (Off) – 4 (Adaptive)

0

Controls how much of a user's own voice they can hear through their headset. 0 turns off sidetone while 3 means users receive much more feedback from their headset microphones. 4 turns on the adaptive sidetone feature. When adaptive sidetone is active, the headset automatically adjusts the sidetone level based on how loud the user talks.

Active Noise Cancellation

0 (Off) – 6 (Adaptive)

5

Controls how much noise cancellation a the headset . 0 turns noise cancellation off while 5 means users have much more noise cancellation. 6 turns on the Adaptive Noise Cancellation feature. When Adaptive Noise Cancellation is active, the headset automatically adjusts noise cancellation based on the surrounding environment.

Download the Default Headset Configuration File

Before configuring the headset parameters remotely, you must download the latest JavaScript Object Notation (JSON) sample file.

Procedure

Step 1

Go to the following URL: https://software.cisco.com/download/home/286325098.

Step 2

Choose Headset 700 Series.

Step 3

Select your headset series.
Step 4

Choose a release folder and select the zip file.

Step 5

Click the Download or Add to cart button, and follow the prompts.

Step 6

Unzip the file to a directory on your PC.

What to do next

Modify the Default Headset Configuration File

Modify the Default Headset Configuration File

Note the following as you work with the JavaScript Object Notation (JSON) file:

  • The settings aren't applied if you are missing a bracket or brackets in the code. Use an online tool such as JSON Formatter and check the format.

  • Set the "updatedTime" setting to the current epoch time or the configuration is not applied.

  • Confirm that firmwareName is LATEST or the configurations will not be applied.

  • Do not change a parameter name or the setting will not be applied.

Procedure

Step 1

Open the defaultheadsetconfig.json file with a text editor.

Step 2

Edit the updatedTime and the headset parameter values you wish to modify.

A sample script is shown below. This script is provided for reference only. Use it as a guide as you configure your headset parameters. Use the JSON file that was included with your firmware load. 

{
  "headsetConfig": {
    "templateConfiguration": {
      "configTemplateVersion": "1",
      "updatedTime": 1537299896,
      "reportId": 3,
      "modelSpecificSettings": [
        {
          "modelSeries": "530",
          "models": [
            "520",
            "521",
            "522",
            "530",
            "531",
            "532"
          ],
          "modelFirmware": [
            {
              "firmwareName": "LATEST",
              "latest": true,
              "firmwareParams": [
                {
                  "name": "Speaker Volume",
                  "access": "Both",
                  "usageId": 32,
                  "value": 7
                },
                {
                  "name": "Microphone Gain",
                  "access": "Both",
                  "usageId": 33,
                  "value": 2
                },
                {
                  "name": "Sidetone",
                  "access": "Both",
                  "usageId": 34,
                  "value": 1
                },
                {
                  "name": "Equalizer",
                  "access": "Both",
                  "usageId": 35,
                  "value": 3
                }
              ]
            }
          ]
        },
        {
          "modelSeries": "560",
          "models": [
            "560",
            "561",
            "562"
          ],
          "modelFirmware": [
            {
              "firmwareName": "LATEST",
              "latest": true,
              "firmwareParams": [
                {
                  "name": "Speaker Volume",
                  "access": "Both",
                  "usageId": 32,
                  "value": 7
                },
                {
                  "name": "Microphone Gain",
                  "access": "Both",
                  "usageId": 33,
                  "value": 2
                },
                {
                  "name": "Sidetone",
                  "access": "Both",
                  "usageId": 34,
                  "value": 1
                },
                {
                  "name": "Equalizer",
                  "access": "Both",
                  "usageId": 35,
                  "value": 3
                },
                {
                  "name": "Audio Bandwidth",
                  "access": "Admin",
                  "usageId": 36,
                  "value": 0
                },
                {
                  "name": "Bluetooth",
                  "access": "Admin",
                  "usageId": 39,
                  "value": 0
                },
                {
                  "name": "DECT Radio Range",
                  "access": "Admin",
                  "usageId": 37,
                  "value": 0
                }
                {
                   "name": "Conference",
                  "access": "Admin",
                  "usageId": 41,
                  "value": 0
              ]
            }
          ]
        }
      ]
    }
  }
}
Step 3

Save the defaultheadsetconfig.json.

What to do next

Install the default configuration file.

Install the Default Configuration File on Cisco Unified Communications Manager

After you edit the defaultheadsetconfig.json file, install it on Cisco Unified Communications Manager using the TFTP File Management tool.

Procedure

Step 1

From Cisco Unified OS Administration, choose Software Upgrades > TFTP File Management.

Step 2

Select Upload File.

Step 3

Select Choose File and navigate to the defaultheadsetconfig.json file.

Step 4

Select Upload File.

Step 5

Click Close.

Restart the Cisco TFTP Server

After you upload the defaultheadsetconfig.json file to the TFTP directory, restart the Cisco TFTP server and reset the phones. After about 10–15 minutes, the download process begins and the new configurations are applied to the headsets. It takes an additional 10 to 30 minutes for the settings to be applied.

Procedure

Step 1

Log in to Cisco Unified Serviceability and choose Tools > Control Center - Feature Services.

Step 2

From the Server drop-down list box, choose the server on which the Cisco TFTP service is running.

Step 3

Click the radio button that corresponds to the Cisco TFTP service.

Step 4

Click Restart.