Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Insert excerpt
_ExcerptWhatAreUsers
_ExcerptWhatAreUsers
nopaneltrue
 For more information about users, see User Admin.

If enabled for your account, you can import a CSV file to create or edit multiple users in the account you are logged in to at the same time. In this file each row represents a new or existing user. If the username already exists in Vonage Contact Center, importing the file should result in an update to the existing user. If the username does not already exist in the Vonage Contact Center, importing the file should result in the creation of a new user.

Insert excerpt
_ExcerptAddingLinkedAccountsInUserAccess
_ExcerptAddingLinkedAccountsInUserAccess
nopaneltrue

...

  1. Go to the Users tab in User Admin. For information about accessing User Admin, see Accessing and finding your way around User Admin.
  2. Click the menu icon (Image RemovedImage Added) and then click Export in the menu that appears. Your browser downloads a CSV file containing your existing users to your default downloads location. The file name begins with your account name, contains the date and time of the download (as determined by your browser settings), and is appended with _users. For example, TechAuthor_7_20_2017_09_29_58_163_users.csv. or TestAccount_25_07_2017_12_56_03_167_users.csv.

...

  • If you are mostly creating new users, download a template which contains the required columns and some examples of valid users.
    To download a template for creating users, perform the following steps:
    1. Go to User Admin, Users tab. For information about accessing User Admin, see Accessing and finding your way around User Admin.
    2. Click the menu icon (Image RemovedImage Added) and then click Download Template in the menu that appears. Your browser downloads users-template.csv to your default downloads location.
  • If you are mostly updating existing users, you should start by exporting the existing users and make your edits in the exported file. For information about exporting the CSV file, see section above Exporting the file

...

Expand
titleExpand | Collapse

Importing a file processes the following columns:

ColumnDescription
Username

A username for the user. The username must be unique in the account. The user uses this username to log in to the VCC Admin Portal or ContactPad.

Username can only contain alphanumeric characters, underscores (_), hyphens (-) or @ symbols.

Username cannot contain spaces.

You cannot edit an user's username after you have saved the user.

NameThe name of the user. If the user is also an agent, Name appears when the agent is logged in to ContactPad.
Email

The user's email address.

SSO External IdUsed for single sign-on
User ActiveDetermines whether this user is active or not.
LicenseThe user's license which, along with the user's type, determines which tasks the user can perform.
ID

A unique ID for the user if access to ContactPad enabled. If you do not provide a value when you create a user, VCC will automatically generate one for you.

You cannot edit a user's ID after you have saved the user.

Physical LocationThe country code relating to the ContactPad user's telephone number. Physical Location (for example, GB) sets the international dialing prefix for the user's phone number (for example, +44).
Phone NumberThe telephone number of the user's phone that will ring when a call is assigned to them. Provide the telephone number in national format.
Virtual LocationThe virtual location that the ContactPad user is operating from. Using Vonage Contact Center, a ContactPad user can make and receive calls from anywhere. For example, if the user is in France but they are receiving calls from the United Kingdom, set the virtual location to United Kingdom. The virtual location determines the format of the telephone numbers that appear in ContactPad. In this example:
  • telephone numbers appear in UK format
  • when the user makes an outbound call:
    • the number that appears on the handset of the target is in UK format
    • the user can dial a UK number as if from the UK without using the international prefix
VBC UsernameThe VBC Username column is only available if your Vonage Contact Center account is linked to a Vonage Business Communications account. For information about using VBC Username, see Configuring Vonage Contact Center and Vonage Business Communications integration.
In Country DisplayDetermines whether phone numbers are displayed in national or international format in ContactPad.ContactPad enabled
Allow to act as agentDetermines whether the user can access and use ContactPad.
Web RTC
(if WebRTC is available for your account)
Determines whether the user uses WebRTC as a ContactPad user.
Enforced Disposition Codes
(if enforced disposition codes are available for your account)
Determines whether this ContactPad user must provide a disposition code for an interaction.
Transcribe Calls
(if call transcription is available for your account)
Determines whether Vonage Contact Center should transcribe the calls made and received by this ContactPad user.
Screen Recording
(if screen recording is available for your account)
Determines whether this ContactPad user's screens will be recorded while handling a call.
Telephony RegionThe telephony region in which the ContactPad user is located. Vonage Contact Center uses a user's telephony region to determine the telephony server to use when the user makes an outbound call.
Callback NumbersThe callback numbers available to the user as a ContactPad user. Enclose callback numbers in double-quotes and separate multiple callback numbers with new lines.
SkillsThe IDs of the skills that are assigned to this ContactPad user. Enclose skills IDs in double-quotes and separate multiple skill IDs with new lines.
GroupsThe IDs of the groups that this ContactPad user is in. Enclose group IDs in double-quotes and separate multiple group IDs with new lines.
IsAgentLevel
(if interaction capacity by agent is available for your account)
Determines whether custom interaction capacities are set for the user.

Live
(if interaction capacity by agent is available for your account)

The percentage of capacity that a live interaction, such as a phone call, uses. The value must be between 51 and 100 percent. The default value is 51.
Non-Live
(if interaction capacity by agent is available for your account)
The percentage of capacity that a non-live interaction, such as an email, uses. The value must be between 1 and 100 percent. The default value is 25.
Semi-Live
(if interaction capacity by agent is available for your account)
The percentage of capacity that a semi-live interaction, such as a chat, uses. The value must be between 1 and 100 percent. The default value is 33.

Whether you have downloaded a new template or exported your existing users, your import file must be a valid CSV file, must contain required values, and must not contain the same ID or Username value in more than one row. All values in the import file must be valid.

The file requires values in the following columns for all new and existing users:

  • Username
  • Name
  • Email
  • User Active
  • License

In addition to these, depending on other values in a row, you might also need to provide values in the following columns:

  • If you set the value of License in a row to 'agent', the following columns also require values:
    • Phone Number
    • ID
  • If you provide a value for ID in a row, the following columns require values for that row:
    • Phone Number
    • Country. If you do not provide a value, Vonage Contact Center uses the default country code for the account.
    • Location. If you do not provide a value, Vonage Contact Center uses the default location code for the account.
    • ContactPad enabled

If you do not provide required values, the row is not imported.

Values are subject to the following validation. If you do not provide valid values, any row with an invalid value is not imported.

ColumnValidation criteria
UsernameMust contain only alphanumeric or _-@. characters.
NameMust contain only alphanumeric or ASCII punctuation and symbols.
EmailMust be empty or contain a valid email address.
User ActiveMust contain 'true' and 'false'. 
LicenseMust contain 'NvmAdmin', 'Admin', 'Supervisor', 'Wallboard', or 'Agent'.
TypeMust be empty or contain 'Admin', 'Employee', 'Reseller', or 'Customer'.
IDMust be empty* or contain a number.
Physical LocationMust be empty** or a valid ISO 3166-1 alpha-2 country code.
Phone NumberMust be empty* or contain a number.
Virtual LocationMust be empty** or a valid ISO 3166-1 alpha-2 country code.
In Country DisplayMust be empty** or contain 'National' or 'International'.
ContactPad enabledMust be empty** or contain 'true' or 'false'.

Web RTC
(if WebRTC is available for your account)

Must be empty** or contain 'true' or 'false'.

Enforced Disposition Codes
(if enforced disposition codes are available for your account)

Must be empty** or contain 'true' or 'false'.

Transcribe Calls
(if call transcription is available for your account)
Must be empty** or contain 'true' or 'false'.
Screen Recording
(if screen recording is available for your account)
Must be empty** or contain 'true' or 'false'.
Callback NumbersMust be empty or contain valid callback numbers for your account.
LiveMust be a whole number in the range 51-100. Non-default values are ignored if IsAgentLevel is empty or 'false'.
Non-liveMust be a whole number in the range 1-100. Non-default values are ignored if IsAgentLevel is empty or 'false'.
Semi-liveMust be a whole number in the range 1-100. Non-default values are ignored if IsAgentLevel is empty or 'false'.

*The value must be empty if the user has never been given access to ContactPad. This value cannot be empty for user with an agent license.
**The value must be empty if the user has never been given access to ContactPad. If value is required, but not provided, Vonage Contact Center uses account defaults.

Note

When you save your CSV file, ensure that your file editor does not remove leading zeros from any number values. For example, you may have an Phone Number value of 00441234567890 and an ID of 007. Some editors will remove the leading zero resulting in an Phone Number value of 441234567890 and an ID of 7. Changing the format of the cell, or column, containing the number to text often solves this problem.


...

  1. Go to the Users tab in User Admin. For information about accessing User Admin, see Accessing and finding your way around User Admin.
  2. Click the menu icon (Image RemovedImage Added) and then click Import in the menu that appears. Upload file section appears.

    Upload users
  3. In the Upload file section, click Browse.... An Open dialog box appears. Locate and open your import file from the Open dialog box. Any validation messages or errors appear in the Check errors section.

...

The Check errors section contains messages about missing, duplicate or invalid values, redundant columns, license limits and so on. Some of these messages require you to take action; others are for information only.

Check errorsImage Modified

Whole-file upload messages

...