- Home
- /
- Article
Webex Calling hunt group CSV file format reference
You can add and manage hunt groups in bulk using a hunt group CSV. This article covers the specific fields and values needed for the CSV upload of Webex Calling hunt groups.
Known limitations and requirements
-
Before uploading your hunt group CSV, make sure to read Bulk provisioning Webex Calling elements using CSV to understand the CSV conventions.
-
You can either export your current hunt groups, which allows you to add, delete, or modify your existing data set, or you can export a sample set of hunt groups. Once modified, the file can be uploaded through the bulk features.
Exporting CSV file into ZIP file format: When exporting data to a CSV file, the number of records may exceed 1000. In such cases, the ZIP file is downloaded, where the ZIP file contains the fullset of record(s) in a single CSV file. A separate folder containing all the data is brokendown into multiple CSV files with less than 1000 records. These files are generated for the administrators to quickly import any updates and upload.
-
It is important to know the mandatory and optional columns, and information that you’ll need to provide when filling out the CSV template. The specific fields for the hunt group CSV are found in the table below.
-
The maximum amount of hunt groups for each location is 1,000.
-
The maximum amount of rows is 1,000 (not including the header).
-
Agents can be users or workspaces. For users, enter the user’s email address. For workspaces, enter the workspace name.
-
Each row can hold a maximum of 50 agents. See Add or edit more than 50 agents at a time for more information.
Prepare your CSV
Use this table to see the mandatory and optional fields and determine what you need when adding or editing hunt groups in bulk.
Columns are either mandatory or optional fields. This varies depending on whether you are using the CSV to add a new hunt group or edit an existing hunt group.
Column |
Mandatory or optional (Add a hunt group) |
Mandatory or optional (Edit a hunt group) |
Description |
Supported values |
---|---|---|---|---|
Name |
Mandatory |
Mandatory |
Enter the name of the hunt group. Hunt group names within the same location must be uniquely identifiable. If the hunt groups are in a different location, they can have the same name. |
Example: San Jose Hunt Group Character length: 1–30 |
Phone Number |
Mandatory (if extension is left blank) |
Optional |
Enter the hunt group phone number. You must have either a phone number or an extension. |
The system allows only E.164 numbers for CSV import. Example: +12815550100 The phone number must be on the Numbers tab in Control Hub. |
Extension |
Mandatory (if phone number is left blank) |
Optional |
Enter the hunt group extension. You must have either a phone number or an extension. |
Two to ten-digit extension. 00-999999 |
Location |
Mandatory |
Mandatory |
Enter the location to assign this call hunt group. |
Example: San Jose Location must be on the Locations tab in Control Hub. |
Caller ID First Name |
Optional |
Optional |
Enter the first name to display for the hunt group’s calling line ID (CLID). The caller ID is used when call forward is enabled and calls are forwarded out. |
Example: San UTF-8 only characters are supported. Character length: 1–30 |
Caller ID Last Name |
Optional |
Optional |
Enter the last name to display for the hunt group’s calling line ID (CLID). The caller ID is used when call forward is turned on and calls are forwarded out. |
Example: Jose UTF-8 only characters are supported. Character length: 1–30 |
Language |
Optional |
Optional |
Enter the announcement language for your hunt group. |
Example: en_us |
Timezone |
Optional |
Optional |
Enter the hunt group time zone key. This time zone applies to the schedules applied to this hunt group. |
Example: America or Chicago Character length: 1–127 |
Call Routing Pattern |
Mandatory |
Optional |
Enter the hunt group routing pattern. Select one of the supported policies. |
CIRCULAR, REGULAR, SIMULTANEOUS, UNIFORM, WEIGHTED |
Advance After Set Number of Rings Enable |
Optional |
Optional |
Enable or disable calls to advance after a set number of rings. If enabled, enter the number of rings in the next column. |
TRUE, FALSE |
Advance After Set Number of Rings |
Optional |
Optional |
Enter the number of rings to wait for the currently hunted agent to answer before hunting to the next available agent. |
Range: 1–20 |
Advance When Busy Enable |
Optional |
Optional |
If this is enabled, the hunt group won't ring agents when they are on another call. The call advances to the next agent in the hunt group. If the agent has call waiting enabled, and the call is advanced to them, then the all waits until the agent becomes idle again. |
TRUE, FALSE |
Forward After Rings Enable |
Optional |
Optional |
Enable or disable unanswered calls to be forwarded to a designated phone number after a set number of rings. |
TRUE, FALSE |
Forward After Rings |
Optional |
Optional |
Enter the number of rings to wait before forwarding to the designed number. |
Range: 1–99 |
Forward Number |
Optional |
Optional |
Enter the phone number where unanswered calls are forwarded. |
The system allows only E.164 numbers for CSV import. Example: +12815550100 The phone number must be on the Numbers tab in Control Hub. |
Forward After Rings Voicemail Enable |
Optional |
Optional |
Enable or disable unanswered calls forwarding to a voicemail after a set number of rings. |
TRUE, FALSE |
Hunt Group Busy Enable |
Optional |
Optional |
Use this column to enable or disable hunt group busy. |
TRUE, FALSE |
Allow Agents to Change Hunt Group Busy Status |
Optional |
Optional |
Enable or disable the toggle to allow agents to change hunt group busy status. |
TRUE, FALSE |
Divert When Busy Enable |
Optional |
Optional |
Enable or disable the busy calls diverting to a defined phone number. |
TRUE, FALSE |
Divert When Busy Number |
Optional |
Optional |
Enter the phone number to divert calls to when lines are busy. |
Example: +12815550100 |
Divert When Busy Voicemail Enable |
Optional |
Optional |
Enable or disable the busy calls diverting to a defined voicemail. |
TRUE, FALSE |
Divert When Unreachable Enable |
Optional |
Optional |
Enable or disable unreachable calls diverting to a defined phone number. |
TRUE, FALSE |
Divert When Unreachable Number |
Optional |
Optional |
Enter the phone number to divert calls to when unreachable. |
Example: +12815550100 |
Divert When Unreachable Voicemail Enable |
Optional |
Optional |
Enable or disable unreachable calls diverting to a defined voicemail. |
TRUE, FALSE |
Hunt Group Enable |
Optional |
Optional |
Use this column to activate or deactivate the hunt group. |
ENABLED, DISABLED, enabled, disabled |
Alternate Number Distinctive Ringing Enable |
Optional |
Optional |
Enable or disable a distinctive ringing for alternate numbers. If enabled, enter the ring patter in the Alternate Numbers Ring Pattern column. |
TRUE, FALSE |
Alternate Numbers Action |
Optional |
Optional |
Enter ADD to add the alternate numbers you list in this row. Enter REMOVE to remove the alternate numbers you list in the row. If you enter REPLACE, you remove all previously entered alternate numbers and replace it with the alternate numbers you are adding in this row only. |
ADD, REMOVE, REPLACE |
Agent Action |
Optional |
Optional |
Enter ADD to add the agents you list in this row. Enter REMOVE to remove this agent you list in the row. If you enter REPLACE, you remove all previously entered agents and replace it with the agents you are adding in this row only. |
ADD, REMOVE, REPLACE |
Allow Agents To Use Hunt Group Number As Caller ID |
Optional | Optional |
Enable the toggle to allow the agents to use the hunt group number as the caller ID |
TRUE, FALSE |
Alternate Number1, Alternate Number2… Alternate Number10 |
Optional |
Optional |
Enter the alternate numbers to assign to the hunt group. |
Example: 1112223333 Phone number must be on the Numbers tab in Control Hub. Character length: 1–23 |
Alternate Number1 Ring Pattern, Alternate Number2 Ring Pattern… Alternate Number10 Ring Pattern |
Optional |
Optional |
If distinctive ringing is enabled for alternate numbers, choose the distinctive ringing ring pattern. Choose from one of the supported options. |
NORMAL, LONG_LONG, SHORT_SHORT_LONG, SHORT_LONG_SHORT |
Agent1 ID, Agent2 ID… Agent50 ID |
Optional |
Optional |
Enter the agents you’d like to assign to the hunt group. Agents can be users or workspaces. For users, enter the user’s email address. For workspaces, enter the workspace name. |
Example: test@example.com Character length: 1–161 |
Agent1 Weight, Agent2 Weight... Agent50 Weight |
Optional |
Optional |
If the call routing policy for the hunt group is weighted, enter the agent’s percentage weighting. |
Range: 0-100 |
Add or edit more than 50 agents at a time
Each row can hold a maximum of 50 agents and their associated call routing weight percentage (if applicable). A hunt group can have a maximum of 1,000 agents assigned. To add or edit more than 50 agents, using the CSV file, follow these steps.
1 |
Enter the 50 agents, and their associated call routing weight percentage (if applicable), that you’d like to add or edit on the first row for the hunt group you’re adding or editing. |
2 |
On the next row, you only have to enter information in the following columns to add or edit additional agents:
You can leave all other columns blank. |
3 |
Continue to do this until you've added all the agents you need to add or edit. A hunt group can have a maximum of 1,000 agents. |
Bulk add hunt groups
To add hunt groups in bulk, download and fill out a blank CSV template.
You can't modify call forwarding settings for a hunt group in bulk. To edit call forwarding for a hunt group, see Edit hunt group call forward settings.
1 |
Sign in to Control Hub. |
2 |
Go to . |
3 |
Go to the Hunt Group card and click Manage. |
4 |
Click . |
5 |
Select a location for the hunt group you'd like to add. |
6 |
Click Download .csv template. |
7 |
Fill out the spreadsheet. |
8 |
Upload the CSV file by dragging and dropping or clicking Choose a file. |
9 |
Click Upload. When successfully uploaded, you can click See Tasks Page for details to view the status of the changes. |
Bulk edit hunt groups
To modify hunt groups in bulk, download the current CSV data and make the necessary changes to the spreadsheet.
You can't modify call forwarding settings for a hunt group in bulk. To edit call forwarding for a hunt group, see Edit hunt group call forward settings.
1 |
Sign in to Control Hub. |
2 |
Go to . |
3 |
Go to the Hunt Group card and click Manage. |
4 |
Click . |
5 |
Select a location for the hunt group you’d like to modify. |
6 |
Click Download data. If the data for the hunt group you’ve selected exceeds the maximum (more than 10,000 rows for each CSV), you receive a zipped file with multiple CSV files included. |
7 |
Make the necessary changes to the spreadsheet. |
8 |
Upload the modified CSV file by dragging and dropping or clicking Choose a file. |
9 |
Click Upload. When successfully uploaded, you can click See Tasks Page for details to view the status of the changes. |