Webex Calling hunt group CSV file format reference- Webex
Using a hunt group CSV, you can quickly add and manage multiple hunt groups all at once. This article describes the particular attributes and values that must be used for the CSV upload of Webex Calling hunt groups.
Known limitations and requirements
- Read the article “Bulk provisioning Webex Calling elements using CSV” before you upload your hunt group CSV so that you are familiar with the conventions of the CSV file format.
- You have the option of exporting the hunt groups that are currently active, which enables you to add, delete, or edit the data set that is already present, or you can export a sample set of hunt groups. After being edited, the file can then be submitted using the bulk options once they are available.
When exporting data to a CSV file, the number of records may be greater than 1000. This can be accomplished by exporting the file into the ZIP file format. When this occurs, the ZIP file is downloaded, which is the case even though the ZIP file just contains a single CSV file with the entire set of records. There is a separate folder that contains all of the data, and within that folder are numerous CSV files that each have fewer than 1000 records. These files are produced specifically so that administrators may easily import any updates and then post them.
- When filling out the CSV template, it is vital to be aware of the columns that are required and those that are optional, as well as the information that you will need to submit. The table that follows is a rundown of the individual fields that make up the hunt group CSV.
- One thousand hunt groups are the utmost that can be accommodated at any given place.
- The maximum number of rows is 1,000 (not including the header), but you can only have one row per column.
- Agents could also be referred to as users or workplaces. In the space designated for users, type in the user’s email address. In the section for workspaces, type the name of the workspace.
- A maximum of fifty agents can be seated in each row. For more information, see the section titled Add or edit more than 50 agents at once.
Prepare your CSV
You can use this table to establish which fields are required and which are optional, as well as what you need to decide before adding or changing many hunt groups at once.
There are two types of fields: required and optional. Columns can be either kind. This is dependent on whether you are using the CSV to add a new hunt group or edit an existing hunt group. Using the CSV to add a new hunt group is different than editing 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 |
Please provide the name of the group that will be hunting. It is necessary for the names of hunt groups to be easily distinguishable within the same location. It is possible for the hunt groups to have the same name even if they are in separate areas. |
Example: San Jose Hunt Group Character length: 1-30 |
||
|
Phone Number |
Mandatory (if extension is left blank) |
Optional |
Please enter the phone number for the hunt group. Either a phone number or an extension is required of you at this time. |
Only E.164 numbers are allowed for CSV import. Example: +12815550100
|
||
|
Extension |
Mandatory (if phone number is left blank) |
Optional |
Proceed to the extension for the hunt group. Either a phone number or an extension is required of you at this time. |
Two to six digit extension. 00-999999 |
||
|
Location |
Mandatory |
Mandatory |
Please enter the location to which this call hunt group should be assigned. |
Example: San Jose
|
||
|
Caller ID First Name |
Optional |
Optional |
Please provide the first name that will be displayed for the calling line ID (CLID) of the hunt group. When call forwarding is enabled and calls are redirected to another number, the caller ID will be used. |
Example: San
Character length: 1-30 |
||
|
Caller ID Last Name |
Optional |
Optional |
Please provide the surname that will be shown for the calling line ID (CLID) of the hunt group. When call forwarding is enabled and calls are redirected to another number, the caller ID will be used. |
Example: Jose
Character length: 1-30 |
||
|
Language |
Optional |
Optional |
Select the language that will be used for your hunt group’s announcements. |
Example: en_us |
||
|
Timezone |
Optional |
Optional |
Type in the key for the hunt group’s time zone. This time zone is utilized for the many timetables that are relevant to this hunting party. |
Example: America/Chicago Character length: 1-127 |
||
|
Call Routing Pattern |
Mandatory |
Optional |
The hunt group will now enter the routing pattern. Pick a plan out of the ones that are available. |
CIRCULAR, REGULAR, SIMULTANEOUS, UNIFORM, WEIGHTED |
||
|
Advance After Set Number of Rings Enable |
Optional |
Optional |
You can choose to allow or disallow calls to advance after a predetermined number of rings has rung. In the following column, if the feature is enabled, enter the number of rings. |
TRUE, FALSE |
||
|
Advance After Set Number of Rings |
Optional |
Optional |
Enter the number of rings that should be waited for an answer from the agent that is currently being pursued before moving on to the next available agent. |
Range: 1-20 |
||
|
Advance When Busy Enable |
Optional |
Optional |
If this option is selected, the hunt group will refrain from calling agents while they are already on the line with a customer. The call will now be transferred to the subsequent member of 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 after the call has been transferred to them. |
TRUE, FALSE |
||
|
Forward After Rings Enable |
Optional |
Optional |
Adjust the settings so that unanswered calls are automatically redirected to a certain phone number after a predetermined number of rings. |
TRUE, FALSE |
||
|
Forward Number |
Optional |
Optional |
Enter the phone number to which you want calls that go unanswered to be routed. |
Only E.164 numbers are allowed for CSV import. Example: +12815550100
|
||
|
Forward After Rings |
Optional |
Optional |
Enter the number of rings that should pass before the call is sent to the number that was designed. |
Range: 1-99 |
||
|
Forward After Rings Voicemail Enable |
Optional |
Optional |
You can enable or disable the feature that sends calls that go unanswered to voicemail after a predetermined number of rings. |
TRUE, FALSE |
||
|
Divert When Unreachable Enable |
Optional |
Optional |
Turn on or off the feature that redirects calls that go unanswered to a certain phone number. |
TRUE, FALSE |
||
|
Divert When Unreachable Number |
Optional |
Optional |
Enter the phone number that calls will be forwarded to if they are not answered. |
Only E.164 numbers are allowed for CSV import. Example: +12815550100
|
||
|
Divert When Unreachable Voicemail Enable |
Optional |
Optional |
You can choose to divert unanswered calls to a voicemail system or disable this feature. |
TRUE, FALSE |
||
|
Distinctive Ringing Enable |
Optional |
Optional |
Set the separate ringing for hunt group calls to either enabled or disabled. If this feature is on, agents who take calls from the search group will be greeted by a distinctive ringing sound. In the following column, if the option to enable distinctive ring patterns is selected, enter the sort of pattern you would like to use for those rings. |
TRUE, FALSE |
||
|
Distinctive Ringing Pattern |
Optional |
Optional |
Select the distinctive ringing ring pattern if the option to enable distinctive ringing is enabled. Pick one of the available choices from the list below. |
NORMAL, LONG_LONG, SHORT_SHORT_LONG, SHORT_LONG_SHORT |
||
|
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 |
Alternate numbers can have their own unique ringtone, which can be enabled or disabled. If the option is selected, the ring pattern should be entered into the column labeled “Alternate Numbers Ring Pattern.” |
TRUE, FALSE |
||
|
Alternate Numbers Action |
Optional |
Optional |
To add the alternative numbers that you have listed in this row, use the ADD key on your keyboard. To remove the alternate numbers that you have listed in the row, enter the REMOVE command. If you type REPLACE, you will delete all of the previously entered alternate numbers and replace them with the alternate numbers you are entering in this row only. If you do not enter REPLACE, you will keep the alternate numbers you have already entered. |
ADD, REMOVE, REPLACE |
||
|
Agent Action |
Optional |
Optional |
To add the agents that you have listed in this row, press the ADD button. To remove this agent from the list you have in the row, enter the REMOVE command. If you enter REPLACE, you will delete any previously entered agents and replace them with the agents you are adding in this row only. This will only occur if you enter REPLACE. |
ADD, REMOVE, REPLACE |
||
|
Alternate Number(s) |
Optional |
Optional |
Enter the supplementary number or numbers that should be assigned to the search group. |
Example: 1112223333
Character length: 1-23 |
||
|
Alternate Numbers Ring Pattern |
Optional |
Optional |
Select the distinctive ringing ring pattern if the option to have alternate numbers ring with a distinguishable tone is selected. Make your selection from among the available alternatives. |
NORMAL, LONG_LONG, SHORT_SHORT_LONG, SHORT_LONG_SHORT |
||
|
Agent1 ID, Agent2 ID… Agent50 ID |
Optional |
Optional |
Enter the names of the agents that you would like to be part of the hunt group. Agents could also be referred to as users or workplaces. In the space designated for users, type in the user’s email address. In the section for workspaces, type the name of the workspace. |
Example: test@example.com Character length: 1-161 |
||
|
Agent1 Weight, Agent2 Weight… Agent50 Weight |
Optional |
Optional |
Please specify the percentage weighting for the agent if the call routing policy for the hunt group uses weighting. |
Range: 0-100 |
Add or edit more than 50 agents at a time
In the first row of the hunt group that you are adding or updating, enter the 50 agents, as well as the call routing weight % that is linked with them (if it applies), that you would want to add or edit.
1. In the first row of the hunt group that you are adding or updating, enter the 50 agents, as well as the call routing weight % that is linked with them (if it applies), that you would want to add or edit.
2. To add or modify new agents, all you need to do is input information in the following columns located on the following row:
- Name—To add or change additional agents, use the same name as the row that is above it.
- Location—To add or amend other agents, enter their information in the same location as the row above.
- Agent Action—To add the agents that you have listed in this row, press the ADD button. To delete the agents that you have listed in this row, enter the delete command.
If you enter REPLACE, you will delete any previously entered agents and replace them with the agents you are adding in this row only. This will only occur if you enter REPLACE.
- Agent1, Agent2, etc.—Enter the email address or name of the workspace for the user whose account you want to add, remove, or change.
- Agent1 Weight, Agent2 Weight, etc.— Please specify the percentage weighting for the agent if the call routing policy for the hunt group uses weighting.
You can leave all other columns blank.
3. Continue to do this until you have added all of 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 mass, you will just need to download a blank CSV template and fill it out with the relevant information.
It is not possible to make bulk changes to the call forwarding settings for a hunt group. See Edit hunt group call forward settings for information on how to make changes to the way calls are forwarded for a hunt group.
1. Beginning in the customer view of https://admin.webex.com, navigate to the Services menu and select Calling > Features.
2. Select “Bulk Manage” under the Hunt Group menu.
3. Choose a location for the hunt group that you would like to add to your account.
4. Click on the Download.csv template button.
5. Complete the spreadsheet that you were given.
6. Drag and drop the CSV file onto the upload box, or choose the file by selecting the Choose a file button.
7. clicks will upload the file.
After the file has been successfully uploaded, you will be able to see the progress of the changes by clicking on the See Tasks Page for Details link.
Bulk edit hunt groups
To make widespread changes to hunt groups, you will first need to download the most recent CSV data and then make the appropriate modifications to the associated spreadsheet.
It is not possible to make bulk changes to the call forwarding settings for a hunt group. See Edit hunt group call forward settings for information on how to make changes to the way calls are forwarded for a hunt group.
1. Beginning in the customer view of https://admin.webex.com, navigate to the Services menu and select Calling > Features.
2. Select “Bulk Manage” under the Hunt Group menu.
3. Choose a location for the hunt group that you want to alter and click on it.
4. Select the Download data option
In the event that the data for the hunt group you’ve chosen exceeds the maximum (more than 10,000 rows for each CSV), you will be sent a zipped file that contains numerous CSV files as part of the package.
5. Edit the spreadsheet to reflect the modifications that are required.
6. Drag and drop the changed CSV file into the upload box, or click the Choose a file button to upload it.
7. clicks will upload the file.
After the file has been successfully uploaded, you will be able to see the progress of the changes by clicking on the See Tasks Page for Details link.