In this API, user refers to all non-agent users of the LiveVox Portal. Currently, the Configuration API supports Create, Read, Update, Delete, List, and Get List Info methods for LiveVox user objects. There is also a Find Matching LiveVox Users method that returns a list of LiveVox users that match specific criteria.

To use the methods listed that perform operations on LiveVox User objects, the user of the API must belong to either the Sysadmin or Superuser role. These roles are defined in the LiveVox Portal and correspond to users who can administer users through the LiveVox user interfaces. Members of the Superuser role cannot perform operations on users that are members of the Sysadmin role, nor will Sysadmin users appear in the results of the List methods described below, when performed by Superusers.

optionalExcludedPowers and optionalManagerPowers Properties

The optionalManagerPowers and optionalExcludedPowers properties are used in User API methods to allow the additional powers or exclude the powers for users. 

This section describes the values that you can specify for these properties and their corresponding mapping.

The  optionalManagerPowers are being deprecated and LiveVox recommends you use the optionalExcludedPowers.

Accepted / Returned Values by the optionalExcludedPowers Property

The optionalExcludedPowers property provides an option to exclude the powers for the LiveVox user. The valid values for this property are provided in the following table.

PropertyAccepted Value
optionalExcludedPowers






























































































































































































































































































manage_dnc

cell

acd

manage_dialing_strategies

manage_segmentations

upload_campaigns

manage_services

manage_contacts

cost
reports

real_time_report

service_efficiency_report

campaign_line_summary_report

billing_duration_report

call_recording_report

downloading_call_recording

listen_to_call_recording

manage_campaign_templates

downloading_screen_recording

ticketing
accounts

voicemail_recording_report

listen_voicemail_recording

downloading_voicemail_recording

downloading_email_attachament

bi_analytics

accounts_read_accounts

accounts_manage_accounts

accounts_read_account_config

accounts_manage_account_view

accounts_manage_account_settings

accounts_manage_account_slas

accounts_manage_account_screen

contacts_manage_contact_views

designer_manage_desktop

designer_manage_scripts

designer_manage_function_library

designer_manage_image_library

kb_manage_config

kb_manage_content_library

kb_view_content_library

kb_search

pdas_read_pdas

pdas_update_pdas

ticketing_read_tickets

ticketing_manage_tickets

ticketing_read_ticket_config

ticketing_manage_ticket_views

ticketing_manage_ticket_settings

ticketing_manage_ticket_workflow

ticketing_manage_ticket_form

ticketing_manage_ticket_screen

elearning_manage_content

elearning_read_content_library

elearning_manage_elearning_assignments

elearning_read_elearning_assignments

elearning_manage_elearning_config
elearning_read_elearning_config

performance_mgmt_read_performance_config

performance_mgmt_dashboard

performance_mgmt_reports

speechiq_qm_admin_client_integration

speechiq_read_admin_interation_logging

speechiq_mass_user_skill_scorecard

speechiq_qm_admin_redaction_extraction

speechiq_requeue_automated_scorecards

speechiq_requeue_transcriptions

speechiq_bulk_external_agent_loading

speechiq_qm_omit_scorecard_data

speechiq_qm_release_scorecards_to_agent

speechiq_manage_interaction_intents

speechiq_manage_filter_group

speechiq_manage_saved_searches

speechiq_manage_scorecards

speechiq_manage_scorecards_categories

speechiq_manage_scorecards_grades

speechiq_manage_skill

speechiq_manage_searches_company_level

speechiq_manage_key_word_list

speechiq_manage_synonyms

speechiq_manage_assesors

speechiq_manage_arbitrators

speechiq_manage_audio_note_categories

speechiq_manage_manual_scorecards

speechiq_manage_tasks

speechiq_approved_powers_enabled_for_viewing_interaction

speechiq_read_approved_agents

speechiq_read_automated_reports

speechiq_manage_qm_agents

speechiq_add_media

speechiq_read_key_word_lists

speechiq_read_synonyms

speechiq_read_interaction_intents

speechiq_read_assessors

speechiq_read_arbitrators

speechiq_read_audio_note_categories

speechiq_read_word_cloud

speechiq_qm_manual_scoring

speechiq_read_tasks

speechiq_read_scorecards

speechiq_qm_dashboard

speechiq_qm_agent_dashboard

speechiq_billing_statistic_report

speechiq_agent_statistic_report

speechiq_interaction_intent_report

speechiq_keyword_by_agent_report

speechiq_keyword_usage_report

speechiq_keyword_usage_click_report

speechiq_keyword_summary_report

speechiq_primary_interaction_intent_report

speechiq_scorecard_statistics_report

speechiq_scorecard_statistics_click_report

speechiq_skills_statistics_report

speechiq_scorecard_queue_report

speechiq_agent_statistics_trend_report

speechiq_qm_downloads_report

speechiq_filter_by_agent

speechiq_filter_by_interaction_intent

speechiq_filter_by_conditional_keyword

speechiq_filter_by_phone_number

speechiq_filter_by_dates_of_interaction

speechiq_filter_by_date_added

speechiq_filter_by_metadata

speechiq_filter_by_minimum_call_duration

speechiq_filter_by_recording_id

speechiq_filter_by_scorecard

speechiq_filter_by_scorecard_grade

speechiq_filter_by_scorecard_assesor

speechiq_filter_by_sentiment

speechiq_filter_by_silence_duration

speechiq_filter_by_skill

speechiq_filter_by_tags

speechiq_filter_by_talk_over_percentage

speechiq_filter_by_interaction_type

speechiq_share_interaction_review_via_email

speechiq_share_interaction_review_via_url

speechiq_action_panel_alerts

speechiq_manual_scoring

speechiq_tag_of_interaction_while_scoring

speechiq_manage_interaction_review_comment

speechiq_score_new_interactions_only

speechiq_hide_completed_scorecards

speechiq_hide_assesor

speechiq_enable_interactions_tab

speechiq_rescore_auto_scorecards

speechiq_read_interaction_scorecard_comments

speechiq_read_interaction_scorecard_history

speechiq_read_interaction_metadata

speechiq_read_interaction_transcript

speechiq_view_only_agent_ackowleded_interactions

speechiq_manage_automated_reports

speechiq_download_qm_recording

speechiq_view_interaction_intent_types

speechiq_view_grade_templates

speechiq_manage_grade_templates

speechiq_manage_interaction_intent_types

speechiq_view_skills

speechiq_manage_qm_admin_client

speechiq_assign_clients_to_shared_config_phonics

speechiq_setup_word_replacement_list

speechiq_run_calibration_report

speechiq_manage_tags

speechiq_view_tags

speechiq_requeue_from_logger

agent_scheduling_manage_agent_schedules

agent_scheduling_manage_agent_scheduling_config

agent_scheduling_read_agent_scheduling_config

agent_scheduling_read_wfm_forecast

agent_scheduling_manage_wfm_forecast

agent_scheduling_wfm_reports

update_work_queue_config

update_work_queue_tasks

read_work_queue_tasks

work_queue_performance_report

read_work_queue_config

manage_work_queue_tasks_assigned_to_self

manage_wfo_alerts

manage_campaigns

read_campaigns

read_campaign_templates

read_segmentations

manage_call_center

read_call_center

manage_client

read_client

read_services

manage_service_groups

read_service_groups

read_agents

manage_agent_skills

read_agent_skills

manage_agent_teams

read_agent_teams

manage_term_categories

read_term_categories

manage_phone_books

read_phone_books

manage_quick_response_books

read_quick_response_books

manage_schedule_callbacks

read_schedule_callbacks

manage_agent_desktops

read_agent_desktops

read_contacts

manage_block_inbound_numbers

read_dnc

manage_phone_numbers

read_phone_numbers

manage_contact_timings

read_contact_timings

manage_cid_packages

read_cid_packages

manage_voice_profiles

read_voice_profiles

read_strategies

manage_email_channels

read_email_channels

manage_sms_channels

read_sms_channels

manage_web_widget

read_web_widget

manage_contact_flow

read_contact_flow

manage_messages

read_messages

manage_phrases

read_phrases

manage_field_mappings

read_field_mappings

manage_sftp_browser

read_sftp_browser

manage_input_filters

read_input_filters

manage_jobs

read_jobs

manage_output_formats

read_output_formats

manage_reporting_outcomes

read_reporting_outcomes

manage_subnet_ips

read_subnet_ips

manage_users
read_users

manage_user_tasks

read_user_tasks

read_audit_logs

manage_client_rates

read_client_rates

manage_rulesets

read_rulesets

manage_custom_roles

read_custom_roles

monitor_campaigns

manage_business_units

read_business_units

speechiq_read_qm_agents

speechiq_manage_qm_user_assignment

speechiq_view_qm_user_assignment

speechiq_view_logger_dashboard

speechiq_manage_sharing_clients

contacts_manage_contact_screen

contacts_read_contact_config

contacts_manage_contacts

designer_manage_message_board

designer_read_message_board

contacts_read_contacts

designer_read_desktops

designer_read_scripts

designer_read_function_library

designer_read_image_library

work_queue_manage_announcements

work_queue_view_announcements

ticketing_manage_ticket_status_workflow

ticketing_manage_ticket_type_permissions

speechiq_read_scorecards_categories

speechiq_qm_bi_dashboard

speechiq_qm_arbitrator_report

speechiq_manage_qm_library

speechiq_read_qm_library

agent_scheduling_manage_wfm_compliance_dashboard_settings

agent_scheduling_read_wfm_compliance_dashboard_settings

speechiq_qm_read_file_processing_log_report

speechiq_qm_manage_file_processing_log_report

speechiq_qm_manage_intents

speechiq_qm_read_intents

speechiq_qm_manage_agent_assist_rules

speechiq_qm_read_agent_assist_rules

speechiq_qm_rules_statistic_report

none

When sending the request including both the properties (optionalExcludedPowers and optionalManagerPowers), ensure that these values do not conflict with each other. If the values do conflict, the optionalExcludedPowers takes precedence.

For example, if you add the value of optionalManagerPowers as editDoNotCallLists and the value of optionalExcludedPowers as manage_dnc, then the system excludes the power to manage Do Not Call (DNC) List and the value specified in optionalManagerPowers is ignored.

The following table shows the mapping of the optionalExcludedPowers values for all available optionalManagerPowers values.

optionalExcludedPowers ValueoptionalManagerPowers Value
manage_dnceditDoNotCallLists
celldialCellPhones

acd

administerAgents 

manage_dialing_strategies

dialingStrategies

manage_segmentations

campaignTemplates

upload_campaigns

uploadCampaigns

manage_services

modifyServices
call_recording_reportcallRecordingReport
downloading_call_recordingdownloadCallRecording
manage_campaign_templatesaccessCampaignTemplates
manage_contactsreadContactEditor
listen_to_call_recordinglistenCallRecording
downloading_screen_recordingdownloadScreenRecording

accounts

accessAccounts
downloading_voicemail_recordingdownloadVoicemailRecording
listen_voicemail_recordingstreamVoicemailRecording
ticketingaccessTicketing
voicemail_recording_reportvoicemailRecordingReport
downloading_email_attachamentdownloadEmailAttachment

Create LiveVox User

Description: Creates a new LiveVox user.

User Roles: Sysadmin or Superuser

Method: POST /configuration/lvusers/

Parameters:

None

Body:

KeyTypeMandatory?Description
clientIdNumberNoThe client ID under which the LiveVox user is created.
userNameStringYesThe name that the LiveVox user uses when logging onto the LiveVox Portal (LVP).
firstNameStringYesFirst name of the LiveVox user.
lastNameStringYesLast name of the LiveVox user.
passwordStringYes

Password of the LiveVox user.  

  • The password value depends on the password related configuration at the client level. 
  • When single sign on (SSO) is enabled, this field is not available.
emailStringNoEmail address of the LiveVox user.
roleStringYes

The security role for the new LiveVox user. The standard values are as follows:

  • SUPERUSER
  • SYSADMIN
  • IT_USER
  • MANAGER
  • REPORT_ADMIN
  • AUDITOR
  • CLIENT_AUDITOR
  • ALERTS_ONLY

For custom roles, specify the value of this property as desired.

customFields

ArrayNo

List of custom fields to be saved for the user. Currently, the platform saves only 20 fields.    

You cannot use these fields when you include optional powers. 

 

serviceArrayNo

An array of service IDs to assign to the LiveVox user.

KeyTypeMandatory?Description
idNumberNoThe service ID.

The user making the request to create the LiveVox user can assign only services for which they have permission.

 optionalManagerPowersObjectNo

Allows the user to define the optional powers for a LiveVox user, when that user is assigned any non-agent role.

KeyTypeMandatory?Description
editDoNotCallListsBooleanYesEdits Do Not Call (DNC) Lists.
dialCellPhonesBooleanYesSpecifies whether the campaign can dial cell phones.
administerAgentsBooleanYesCreates, updates, and deletes agents.
dialingStrategiesBooleanYesConfigures dialing strategies used by campaigns.
campaignTemplatesBooleanYesAccesses campaign segmentations.
uploadCampaignsBooleanYesUploads calling lists into the LiveVox system.
modifyServicesBooleanYesChanges the attributes of a service.
callRecordingReportBooleanYesAccesses the Call Recording Report.
downloadCallRecordingBooleanYesDownloads a call recording.
accessCampaignTemplatesBooleanYesAccesses the campaign templates.
readContactEditorBooleanYesAccesses Contact Manager.
listenCallRecordingBooleanYesStreams (playback) call recordings.
downloadScreenRecordingBooleanYesDownloads the screen recording.
accessAccountsBooleanYesAccesses accounts.
downloadVoicemailRecordingBooleanYesDownloads voicemail recordings.
streamVoicemailRecordingBooleanYesStreams (plays back) voicemail recordings.
accessTicketingBooleanYesAccesses tickets.
voicemailRecordingReportBooleanYesAccesses the Voicemail Recording Report.
downloadEmailAttachmentBooleanYesDownloads an email attachment.

If a value for an optional power is not provided when creating a new LiveVox user, the default value is false

optionalExcludedPowers
ArrayNo

List of powers to be excluded for the user.  For values, see the Accepted values by optionalExcludedPowers table at the beginning of this page.

  • You cannot use the optionalExcludedPowers property if you are including custom fields.
  • The optionalExcludedPowers and optionalManagerPowers are mutually exclusive. For mapping these properties, see the Mapping Table at the beginning of this page.

Response Code: 201 Created

Body:

KeyTypeMandatory?Description
idNumberYesThe ID of the newly created LiveVox user.

Create a new LiveVox User

#Request (JSON)
POST /configuration/lvusers/
Host: localhost.com
Content-Type: application/json
Accept: application/json
 
{
  "firstName": "Manager_User",
  "lastName": "Documentation",
  "userName": "manager_user",
  "service": [
    {
      "id": 87332
    },
    {
      "id": 87515
    }
  ],
  "optionalManagerPowers": {
    "editDoNotCallLists": true,
    "dialCellPhones": true,
    "administerAgents": true,
    "dialingStrategies": true,
    "campaignTemplates": true,
    "uploadCampaigns": false,
    "modifyServices": true,
    "callRecordingReport": true,
    "downloadCallRecording": false,
    "readContactEditor": true,
    "listenCallRecording": true,
    "accessCampaignTemplates": false,
    "downloadScreenRecording": false,
    "accessAccounts": true,
    "downloadVoicemailRecording": true,
    "streamVoicemailRecording": true,
    "accessTicketing": true,
    "voicemailRecordingReport": true,
    "downloadEmailAttachment": true
  },
  "password": "pasword123",
  "email": "abc@gmail.com",
  "clientId": "87070",
  "role": "MANAGER"
}
 
#Response (JSON)
201 Created
Content-Type: application/json
 
{
  "id": 161419
}
CODE

Create a new LiveVox User using Custom Fields

#Request (JSON)
POST /configuration/lvusers/
Host: localhost.com
Content-Type: application/json
Accept: application/json   {
  "firstName": "fqa-011923010952",
  "lastName": "lqa-011923010952",
  "userName": "uqa-011923010952",
  "password": "pass@1234",
  "role": "MANAGER",
  "customFields": {
    "COL1": "121",
    "COL2": "111",
    "COL3": "112",
    "COL4": "121",
    "COL5": "111",
    "COL6": "112",
    "COL7": "121",
    "COL8": "111",
    "COL9": "112",
    "COL10": "121",
    "COL11": "111",
    "COL12": "112",
    "COL13": "121",
    "COL14": "111",
    "COL15": "112",
    "COL16": "121",
    "COL17": "111",
    "COL18": "112",
    "COL19": "121",
    "COL20": "111",
    "COL21": "112",
    "COL22": "111",
    "COL23": "112",
    "COL24": "121",
    "COL25": "111",
    "COL26": "112",
    "COL27": "121",
    "COL28": "111",
    "COL29": "112",
    "COL30": "121"
  }
}

#Response (JSON)
201 Created
Content-Type: application/json   

{
  "id": "336975"
} 
CODE

Create a new LiveVox User using Optional Excluded Powers

#Request (JSON)
POST /configuration/lvusers/
Host: localhost.com
Content-Type: application/json
Accept: application/json   

{
  "firstName": "fqa-010923020134",
  "lastName": "lqa-010923020134",
  "userName": "uqa-010923020134",
  "password": "pass@1234",
  "role": "SUPERUSER",
  "optionalExcludedPowers": [
    "speechiq_filter_by_scorecard_grade",
    "speechiq_view_only_agent_ackowleded_interactions",
    "speechiq_filter_by_agent"
  ]
}  

#Response (JSON)
201 Created
Content-Type: application/json     

{
  "id": "336713"
}
CODE

Example of request to create a LiveVox User, with an invalid password

#Request (JSON)
POST /configuration/lvusers/
Host: localhost.com
Content-Type: application/json
Accept: application/json   

{
  "firstName": "d3",
  "lastName": "doc",
  "userName": "d3",
  "password": "",
  "role": "MANAGER"
}   

#Response
400 Bad Request
Content-Type: application/json   

{
  "code": 202,
  "message": "Empty or incomplete request not allowed"
}
CODE

Delete LiveVox User

Description: Deletes a LiveVox user.

User Roles: Sysadmin or Superuser

Parameters:

Path/Query Parameter NameVariable NameTypeMandatory?Description
iduserIdNumberTrueThe LiveVox user ID you want to delete.

Body:

None

Response Code: 204 No Content

Body:

None

Delete an existing LiveVox User

#Request
DELETE /configuration/lvusers/123662
Host: localhost.com

#Response
204 No Content
CODE

Attempt to delete a LiveVox User that does not exist

#Request
DELETE /configuration/lvusers/12345
Host: localhost.com

#Response
404 Not Found
CODE

Find Matching LiveVox Users

Description:  Retrieves list of LiveVox users who match either a supplied Username, Last Name, email, and so on. Partial matches are supported in the search operation.

User Roles: Sysadmin or Superuser

Method: POST /configuration/lvusers/search?client={}&search={}

Parameters:

Path/Query Parameter NameTypeMandatory?Description
clientNumberNoSpecifies the client ID for which you want to retrieve the list of matching users.
searchStringNo

The value is searched against first name, last name and email.

Partial matches are supported.

Body:

None

Response Code: 200 OK

Body:  

KeyTypeMandatory?Description
userListYes

A container for a list of matching LiveVox user entries.

KeyTypeMandatory?Description
idNumberYesThe user ID for LVP.
lastLoginDateNoDate and Time of the last successful login by the user.

lastLoginIp

StringNoThe IP address from which the agent logged in the last time.
clientIdNumberYesThe client ID under which the user is registered. 
userNameStringYesThe username that the user uses to log into LVP.
firstNameStringYesFirst name of the LiveVox user.
lastNameStringYesLast name of the LiveVox user.
emailStringNoEmail address of the LiveVox user.
lockedBooleanNoIndicates whether the user's account is locked, which can occur when the user exceeds the maximum number of allowable invalid login attempts.
roleStringYes

The role of the user. The standard values are as below:

  • SUPERUSER
  • SYSADMIN
  • IT_USER
  • MANAGER
  • REPORT_ADMIN
  • AUDITOR
  • CLIENT_AUDITOR
  • ALERTS_ONLY

For custom roles, specify the value of this property as needed.

customFields

ArrayNo

List of custom fields saved for the user. Currently, the platform saves only 20 fields. 

You cannot use these fields when you include optional powers. 

 

optionalManagerPowersObjectNo

Allows the user to define the optional powers for a LiveVox user, when that user is assigned any non-agent role.

KeyTypeMandatory?Description
editDoNotCallListsBooleanYesEdits Do Not Call (DNC) Lists.
dialCellPhonesBooleanYesSpecifies whether the campaign can dial cell phones.
administerAgentsBooleanYesCreates, updates, and deletes agents.
dialingStrategiesBooleanYesConfigures dialing strategies used by campaigns.
campaignTemplatesBooleanYesAccesses campaign segmentations.
uploadCampaignsBooleanYesUploads calling lists into the LiveVox system.
modifyServicesBooleanYesChanges the attributes of a service.
callRecordingReportBooleanYesAccesses the Call Recording Report.
downloadCallRecordingBooleanYesDownloads a call recording.
accessCampaignTemplatesBooleanYesAccesses campaign templates.
readContactEditorBooleanYesAccesses Contact Manager.
listenCallRecordingBooleanYesStreams (plays back) call recordings.
downloadScreenRecordingBooleanYesDownloads screen recordings.
accessAccountsBooleanYesAccesses accounts.
downloadVoicemailRecordingBooleanYesDownloads voicemail recordings.
streamVoicemailRecordingBooleanYesStreams (plays back) voicemail recordings.
accessTicketingBooleanYesAccesses tickets.
voicemailRecordingReportBooleanYesAccesses the Voicemail Recording Report.
downloadEmailAttachmentBooleanYesDownloads an email attachment.

If a value for an optional power is not provided when creating a new LiveVox user, the default value is false.

optionalExcludedPowersArrayNo

List of the powers excluded for the user. For values, see the Accepted values by optionalExcludedPowers table at the beginning of this page.

  • You cannot use optionalExcludedPowers property if you include custom fields. 
  • The optionalExcludedPowers and optionalManagerPowers are mutually exclusive. For mapping of these properties, see the Mapping Table at the beginning of this page.

 

Retrieve the LiveVox User(s) Match with the Provided Search String

#Request (JSON)
POST /configuration/lvusers/search?client=94572&&search=apiSysAdmin 
Host: localhost.com
Content-Type: application/json
Accept: application/json

#Response (JSON)
200 OK
Content-Type: application/json    

{
  "user": [
    {
      "id": 165486,
      "role": "SYSADMIN",
      "optionalManagerPowers": {
        "editDoNotCallLists": true,
        "dialCellPhones": true,
        "administerAgents": true,
        "dialingStrategies": true,
        "campaignTemplates": true,
        "uploadCampaigns": true,
        "modifyServices": true,
        "callRecordingReport": true,
        "downloadCallRecording": true,
        "readContactEditor": true,
        "listenCallRecording": true,
        "accessCampaignTemplates": true,
        "downloadScreenRecording": true,
        "accessAccounts": true,
        "downloadVoicemailRecording": true,
        "streamVoicemailRecording": true,
        "accessTicketing": true,
        "voicemailRecordingReport": true,
        "downloadEmailAttachment": true
      },
      "optionalExcludedPowers": [
        "speechiq_view_only_agent_ackowleded_interactions",
        "speechiq_score_new_interactions_only",
        "speechiq_hide_assesor",
        "speechiq_read_interaction_transcript",
        "speechiq_read_approved_agents",
        "speechiq_hide_completed_scorecards",
        "speechiq_qm_agent_dashboard",
        "manage_work_queue_tasks_assigned_to_self"
      ],
      "userName": "apiSysAdmin",
      "firstName": "pass@1234",
      "lastName": "pass@1234",
      "email": "apisysadmin@livevox.com",
      "clientId": 94572,
      "locked": false,
      "customFields": {}
    }
  ]
}
CODE

Get LiveVox User List Info

Description: Retrieves metadata for a list of users.

User Roles: Sysadmin or Superuser

Method: GET /configuration/lvusers/info[?client={clientId}]

Parameters:

Path/Query Parameter NameVariable NameTypeMandatory?Description
clientclientIdInteger (ID)NoRestricts the list to entries that are specifically associated with this particular client.

Body:

None

Response Code:  200 OK

Body:

Key or AttributeTypeMandatory?Description
sizeIntegerYesTotal number of entries in the list.
lastModifiedDateTimeNoThe last date and time that the list was updated. This information might not be available. This is formatted according to the definition of dateTime in the XML Schema specification. For JSON responses, it is represented as the number of milliseconds since midnight on January 1, 1970 (GMT).

If a user with a Superuser role makes this request, the size of the list returned in the response does not take into account any users belonging to the Sysadmin role.

Get the metadata for a list of Users, filtered by a Client

#Request (JSON)
GET /configuration/lvusers/info?client=4199
Host: localhost.com
Content-Type: application/json
Accept: application/json

#Response (JSON)
200 OK
Content-Type: application/json

{
   "size": 117,
   "lastModified": 1245152417000
}
CODE

List LiveVox Users

Description: Lists users configured for a client.

User Roles: Sysadmin or Superuser

Method: GET /configuration/lvusers?client={}

Parameters:

Path/Query Parameter NameTypeMandatory?Description
clientNumberNoThe client ID for which you want to retrieve the list of users.

Body:

None

Response Code: 200 OK

Body:

KeyTypeMandatory?Description
userListYes

A container for a list of LiveVox user entries. 

KeyTypeMandatory?Description
idNumberYesThe user ID.
lastLoginDateNoDate and Time of the last successful login by the user.

lastLoginIp

StringNoThe IP address from which the agent logged in the last time.
clientIdNumberYesThe client ID under which the user is registered. 
userNameStringYesThe name the LiveVox user uses when logging onto LVP.
firstNameStringYesFirst name of the user.
lastNameStringYesLast name of the user.
emailStringNoEmail address of the LiveVox user.
lockedBooleanNoIndicates whether the user's account is locked, which can occur when the user exceeds the maximum number of allowable invalid login attempts.
roleStringYes

The role of the user. The standard values are as follows:

  • SUPERUSER
  • SYSADMIN
  • IT_USER
  • MANAGER
  • REPORT_ADMIN
  • AUDITOR
  • CLIENT_AUDITOR
  • ALERTS_ONLY

For custom roles, specify the value of this property as required.

customFields

ArrayNo

List of custom fields saved for the user. Currently, the platform saves only 20 fields. 

You cannot use these fields when you include optional powers.

 

 optionalManagerPowers

ObjectNo

Allows the user to define the optional powers for a LiveVox user, when that user is assigned any non-agent role.

KeyTypeMandatory?Description
editDoNotCallListsBooleanYesEdits Do Not Call (DNC) Lists.
dialCellPhonesBooleanYesSpecifies whether the campaign can dial cell phones.
administerAgentsBooleanYesCreates, updates, and deletes agents.
dialingStrategiesBooleanYesConfigures dialing strategies used by campaigns.
campaignTemplatesBooleanYesAccesses campaign segmentations.
uploadCampaignsBooleanYesUploads calling lists into the LiveVox system.
modifyServicesBooleanYesChanges the attributes of a service.
callRecordingReportBooleanYesAccesses the Call Recording Report.
downloadCallRecordingBooleanYesDownloads a call recording.
accessCampaignTemplatesBooleanYesAccesses campaign templates.
readContactEditorBooleanYesAccesses Contact Manager.
listenCallRecordingBooleanYesStreams (plays back) call recordings.
downloadScreenRecordingBooleanYesDownloads screen recordings.
accessAccountsBooleanYesAccesses accounts.
downloadVoicemailRecordingBooleanYesDownloads voicemail recordings.
streamVoicemailRecordingBooleanYesStreams (plays back) voicemail recordings.
accessTicketingBooleanYesAccesses tickets.
voicemailRecordingReportBooleanYesAccesses the Voicemail Recording Report.
downloadEmailAttachmentBooleanYesDownloads an email attachment.

If a value for an optional power is not provided when creating a new LiveVox User, the default value is false.

 

optionalExcludedPowersArrayNo

List of the powers excluded for the user. For values, see the Accepted values by optionalExcludedPowers table at the beginning of this page.

  • You cannot use the optionalExcludedPowers property if you include custom fields.
  • The optionalExcludedPowers and optionalManagerPowers are mutually exclusive. For mapping of these properties, see the Mapping Table at the beginning of this page.

If a user with a Superuser role makes this request, the response does not include any users belonging to the Sysadmin role.

Get a list of Users for a Client

#Request (JSON)
GET /configuration/lvusers/?client=84723 
Host: localhost.com
Content-Type: application/json
Accept: application/json

#Response (JSON)
200 OK
Content-Type: application/json    

{
  "user": [
    {
      "id": 153891,
      "role": "MANAGER",
      "optionalManagerPowers": {
        "editDoNotCallLists": true,
        "dialCellPhones": true,
        "administerAgents": true,
        "dialingStrategies": true,
        "campaignTemplates": true,
        "uploadCampaigns": true,
        "modifyServices": true,
        "callRecordingReport": true,
        "downloadCallRecording": true,
        "readContactEditor": true,
        "listenCallRecording": true,
        "accessCampaignTemplates": true,
        "downloadScreenRecording": true,
        "accessAccounts": true,
        "downloadVoicemailRecording": true,
        "streamVoicemailRecording": true,
        "accessTicketing": true,
        "voicemailRecordingReport": true,
        "downloadEmailAttachment": true
      },
      "optionalExcludedPowers": [],
      "userName": "apiAuditor",
      "firstName": "qae123",
      "lastName": "qae123",
      "email": "qads@livevox.com",
      "clientId": 84723,
      "locked": false,
      "customFields": {}
    },
    {
      "id": 153892,
      "role": "CLIENT_AUDITOR",
      "optionalManagerPowers": {
        "editDoNotCallLists": true,
        "dialCellPhones": true,
        "administerAgents": true,
        "dialingStrategies": true,
        "campaignTemplates": true,
        "uploadCampaigns": true,
        "modifyServices": true,
        "callRecordingReport": true,
        "downloadCallRecording": true,
        "readContactEditor": true,
        "listenCallRecording": true,
        "accessCampaignTemplates": true,
        "downloadScreenRecording": true,
        "accessAccounts": true,
        "downloadVoicemailRecording": true,
        "streamVoicemailRecording": true,
        "accessTicketing": true,
        "voicemailRecordingReport": true,
        "downloadEmailAttachment": true
      },
      "optionalExcludedPowers": [],
      "userName": "apiClientAuditor",
      "firstName": "pass@1234",
      "lastName": "pass@1234",
      "clientId": 84723,
      "locked": false,
      "customFields": {}
    },
    .
    .
    .
    .
    {
      "id": 153623,
      "role": "SUPERUSER",
      "optionalManagerPowers": {
        "editDoNotCallLists": true,
        "dialCellPhones": true,
        "administerAgents": true,
        "dialingStrategies": true,
        "campaignTemplates": true,
        "uploadCampaigns": true,
        "modifyServices": true,
        "callRecordingReport": true,
        "downloadCallRecording": true,
        "readContactEditor": true,
        "listenCallRecording": true,
        "accessCampaignTemplates": true,
        "downloadScreenRecording": true,
        "accessAccounts": true,
        "downloadVoicemailRecording": true,
        "streamVoicemailRecording": true,
        "accessTicketing": true,
        "voicemailRecordingReport": true,
        "downloadEmailAttachment": true
      },
      "optionalExcludedPowers": [
        "speechiq_hide_assesor",
        "speechiq_manage_interaction_intent_types",
        "speechiq_read_approved_agents",
        "speechiq_score_new_interactions_only",
        "speechiq_manage_interaction_intents",
        "speechiq_setup_word_replacement_list",
        "manage_work_queue_tasks_assigned_to_self",
        "speechiq_qm_agent_dashboard",
        "speechiq_hide_completed_scorecards",
        "speechiq_requeue_transcriptions",
        "speechiq_assign_clients_to_shared_config_phonics",
        "speechiq_qm_admin_client_integration",
        "speechiq_view_only_agent_ackowleded_interactions",
        "speechiq_manage_qm_admin_client",
        "speechiq_read_interaction_transcript"
      ],
      "userName": "wdurman",
      "firstName": "Will",
      "lastName": "Durman",
      "email": "wdurman@livevox.com",
      "clientId": 84723,
      "locked": false,
      "customFields": {}
    }
  ]
}
CODE

Read LiveVox User

Description: Retrieves information about a user.

User Roles: All users; however, users other than sysadmin or superuser can read only their own information.

Method: GET /configuration/lvusers/{id}

Parameters:

Path/Query Parameter NameTypeMandatory?Description
idNumberYesThe user ID you want to query.

Body:

None

Response Code: 200 OK

Body:

KeyTypeMandatory?Description
idNumberYesThe user ID.
serviceArrayNo

Array of Service IDs the User has permission to access.

KeyTypeMandatory?Description
idNumberNoThe service ID.
lastLoginDateNoDate and Time of the last successful login by the user.

lastLoginIp

StringNoThe IP address from which the agent logged in the last time.
clientIdNumberYesThe client ID under which the user is registered. 
userNameStringYesThe name the LiveVox user uses when logging onto LVP.
firstNameStringYesFirst name of the user.
lastNameStringYesLast name of the user.
emailStringNoEmail address of the LiveVox user.
roleEnumYes

The security role of the LiveVox user. The standard values are as follows:

  • SUPERUSER
  • SYSADMIN
  • IT_USER
  • MANAGER
  • REPORT_ADMIN
  • AUDITOR
  • CLIENT_AUDITOR
  • ALERTS_ONLY

For custom roles, specify the value of this property as required.

customFields

ArrayNo

List of custom fields saved for the user. Currently, the platform saves only 20 fields.    

You cannot use these fields when you include optional powers.

 

lockedBooleanNoIndicates whether the user's account is locked, which can occur when the user exceeds the maximum number of allowable invalid login attempts.
optionalManagerPowersObjectNo

Allows the user to define the optional powers for a LiveVox User, when that user is assigned any non-agent role. 

KeyTypeMandatory?Description
editDoNotCallListsBooleanYesEdits Do Not Call (DNC) Lists.
dialCellPhonesBooleanYesSpecifies whether the campaign can dial cell phones.
administerAgentsBooleanYesCreates, updates, and deletes agents.
dialingStrategiesBooleanYesConfigures dialing strategies used by campaigns.
campaignTemplatesBooleanYesAccesses campaign segmentations.
uploadCampaignsBooleanYesUploads calling lists into the LiveVox system.
modifyServicesBooleanYesChanges the attributes of a service.
callRecordingReportBooleanYesAccesses the Call Recording Report.
downloadCallRecordingBooleanYesDownloads a call recording.
accessCampaignTemplatesBooleanYesAccesses the campaign templates.
readContactEditorBooleanYesAccesses Contact Manager.
listenCallRecordingBooleanYesStreams (plays back) call recordings.
downloadScreenRecordingBooleanYesDownloads screen recordings.
accessAccountsBooleanYesAccesses accounts.
downloadVoicemailRecordingBooleanYesDownloads voicemail recordings.
streamVoicemailRecordingBooleanYesStreams (plays back) voicemail recordings.
accessTicketingBooleanYesAccesses tickets.
voicemailRecordingReportBooleanYesAccesses the Voicemail Recording Report.
downloadEmailAttachmentBooleanYesDownloads an email attachment.
optionalExcludedPowersArrayNo

List of the powers excluded for the user. For values, see the Accepted values by optionalExcludedPowers table at the beginning of this page.

  • You cannot use the optionalExcludedPowers property if you include custom fields.
  • The optionalExcludedPowers and optionalManagerPowers are mutually exclusive. For mapping of these properties, see the Mapping Table at the beginning of this page.

A user with a Superuser role cannot use this request to retrieve information about a user belonging to the Sysadmin role. If this is attempted, the response is a 403 error.

Read configuration properties of an existing LiveVox User

#Request (JSON)
GET /configuration/lvusers/165486 
Host: localhost.com
Content-Type: application/json
Accept: application/json

#Response (JSON)
200 OK
Content-Type: application/json      

{
  "id": 165486,
  "role": "SYSADMIN",
  "service": [
    {
      "id": 94572
    },
    {
      "id": 94573
    },
    {
      "id": 94574
    },
    {
      "id": 94576
    },
    {
      "id": 94577
    },
    {
      "id": 94579
    },
    {
      "id": 94580
    },
    {
      "id": 94582
    },
    {
      "id": 94583
    },
    {
      "id": 94585
    },
    {
      "id": 94586
    },
    {
      "id": 94588
    },
    {
      "id": 94590
    },
    {
      "id": 94591
    },
    {
      "id": 94592
    },
    {
      "id": 94593
    },
    {
      "id": 94594
    },
    {
      "id": 94595
    },
    {
      "id": 94596
    },
    {
      "id": 94597
    },
    {
      "id": 95271
    },
    {
      "id": 96414
    },
    {
      "id": 97387
    },
    {
      "id": 97388
    },
    {
      "id": 98539
    },
    {
      "id": 99172
    },
    {
      "id": 99173
    },
    {
      "id": 99174
    },
    {
      "id": 99176
    },
    {
      "id": 99177
    },
    {
      "id": 99224
    },
    {
      "id": 99613
    },
    {
      "id": 99795
    },
    {
      "id": 100298
    },
    {
      "id": 106669
    },
    {
      "id": 106672
    },
    {
      "id": 106788
    },
    {
      "id": 106789
    },
    {
      "id": 106790
    },
    {
      "id": 106791
    },
    {
      "id": 106792
    },
    {
      "id": 94589
    }
  ],
  "optionalManagerPowers": {
    "editDoNotCallLists": true,
    "dialCellPhones": true,
    "administerAgents": true,
    "dialingStrategies": true,
    "campaignTemplates": true,
    "uploadCampaigns": true,
    "modifyServices": true,
    "callRecordingReport": true,
    "downloadCallRecording": true,
    "readContactEditor": true,
    "listenCallRecording": true,
    "accessCampaignTemplates": true,
    "downloadScreenRecording": true,
    "accessAccounts": true,
    "downloadVoicemailRecording": true,
    "streamVoicemailRecording": true,
    "accessTicketing": true,
    "voicemailRecordingReport": true,
    "downloadEmailAttachment": true
  },
  "optionalExcludedPowers": [
    "speechiq_hide_completed_scorecards",
    "speechiq_read_approved_agents",
    "speechiq_view_only_agent_ackowleded_interactions",
    "manage_work_queue_tasks_assigned_to_self",
    "speechiq_qm_agent_dashboard",
    "speechiq_score_new_interactions_only",
    "speechiq_hide_assesor",
    "speechiq_read_interaction_transcript"
  ],
  "userName": "apiSysAdmin",
  "lastLogin": 1680717943000,
  "lastLoginIp": "10.201.63.158",
  "firstName": "pass@1234",
  "lastName": "pass@1234",
  "email": "apisysadmin@livevox.com",
  "clientId": 94572,
  "locked": false,
  "customFields": {}
}
CODE

Update LiveVox User

Description: Updates the properties of a LiveVox user.

You cannot assign or remove services with this method. To perform those updates, use the discrete methods Update LiveVox User Add Service and Update LiveVox User Remove Service.

User Roles: Sysadmin or Superuser

Method: PUT /configuration/lvusers/{id}

Parameters:

Path/Query Parameter NameTypeMandatory?Description
idNumberYesID of the LiveVox user you want to update.

Body:

KeyTypeMandatory?Description
firstNameStringNoUpdated first name of the LiveVox user.
lastNameStringNoUpdated last name of the LiveVox user.
passwordStringNo

New password for the LiveVox user.

  • The password value depends on the password related configuration at the client level.
  • When single sign on (SSO) is enabled, this field is not available.
emailStringNoUpdated email address of the LiveVox user.
roleStringYes

Updated security role of the LiveVox user. The standard values are as below:

  • SUPERUSER
  • SYSADMIN
  • IT_USER
  • MANAGER
  • REPORT_ADMIN
  • AUDITOR
  • CLIENT_AUDITOR
  • ALERTS_ONLY

For custom roles, specify the value of this property as required.

unlockBooleanNoWhen set to true, you can unlock a LiveVox User whose account has been locked out by the system–for example when the User has exceeded the maximum number of allowable invalid login attempts.

customFields

ArrayNo

List of custom fields to be saved for the user. Currently, the platform saves only 20 fields.    

You cannot use these fields when you include optional powers.

 

optionalManagerPowersObjectNo

Allows the user to define the optional powers for a LiveVox user, when that user is assigned any non-agent role.

KeyTypeMandatory?Description
editDoNotCallListsBooleanYesEdits Do Not Call (DNC) Lists.
dialCellPhonesBooleanYesSpecifies whether the campaign can dial cell phones.
administerAgentsBooleanYesCreates, updates, and deletes agents.
dialingStrategiesBooleanYesConfigures dialing strategies used by campaigns.
campaignTemplatesBooleanYesAccesses campaign segmentations.
uploadCampaignsBooleanYesUploads calling lists into the LiveVox system.
modifyServicesBooleanYesChanges the attributes of a service.
callRecordingReportBooleanYesAccesses the Call Recording Report.
downloadCallRecordingBooleanYesDownloads a call recording.
accessCampaignTemplatesBooleanYesAccesses campaign templates.
readContactEditorBooleanYesAccesses Contact Manager.
listenCallRecordingBooleanYesStreams (plays back) call recordings.
downloadScreenRecordingBooleanYesDownloads screen recordings.
accessAccountsBooleanYesAccesses accounts.
downloadVoicemailRecordingBooleanYesDownloads voicemail recordings.
streamVoicemailRecordingBooleanYesStreams (plays back) voicemail recordings.
accessTicketingBooleanYesAccesses tickets.
voicemailRecordingReportBooleanYesAccesses the Voicemail Recording Report.
downloadEmailAttachmentBooleanYesDownloads an email attachment.

If a value for a particular optional power is omitted when updating a LiveVox User, the value is assumed to be false.

optionalExcludedPowersArrayNo

List of the powers to be excluded for the user. For values, see the Accepted values by optionalExcludedPowers table at the beginning of this page.

  • You cannot use the optionalExcludedPowers property if you include custom fields.
  • The optionalExcludedPowers and optionalManagerPowers are mutually exclusive. For mapping of these properties, see the Mapping Table at the beginning of this page.

The body of your request must contain at least one key (or attribute) that you want to update. You can omit keys (or attributes) that you do not want to update.

Response Code: 204 No Content

Body:

None

Update properties of a LiveVox User

#Request (JSON)
PUT /configuration/lvusers/1074928 
Host: localhost.com
Content-Type: application/json
Accept: application/json   

{
  "optionalManagerPowers": {
    "editDoNotCallLists": false
  },
  "firstName": "Manager1",
  "lastName": "Doc123",
  "role": "SYSADMIN",
  "email": "manager1@livevox.com"
}   

#Response (JSON)
204 No Content
CODE

Unlock a LiveVox User whose account has been locked

#Request (JSON)
PUT /configuration/lvusers/1074928 
Host: localhost.com
Content-Type: application/json
Accept: application/json   

{
  "firstName": "Manager1",
  "lastName": "Doc123",
  "role": "SYSADMIN",
  "unlock": "true"
}   

#Response (JSON)
204 No Content
CODE

Example of request to update a LiveVox User, with an invalid password

#Request (JSON)
PUT /configuration/lvusers/161419
Host: localhost.com
Content-Type: application/json
Accept: application/json   

{
  "firstName": "Manager1",
  "lastName": "Doc123",
  "role": "SYSADMIN",
  "password": "1"
}   

#Response (JSON)
400 Bad Request
Content-Type: application/json
 
{
    "code": 202,
    "message": "Invalid password [Password must be at least 8 characters long]"
}
CODE

Update LiveVox User Add Service

DescriptionAssigns a service to an existing LiveVox User.

After using this method to give a user access to a service, you can either create a new session ID using the login method or wait 5 min for the permissions of the current session ID to update.

User Roles: Sysadmin or Superuser

Method: PUT /configuration/lvusers/{user}/services/{id}

Parameters:

Path/Query Parameter NameVariable NameTypeMandatory?Description
useruserIdNumberYesID of the LiveVox user to whom you want to assign the service.
idserviceIdNumberYes

ID of the service to which you want to assign to the LiveVox user.

Body:

None

Response Code: 204 No Content

Body:

None

Assign a Service to an existing LiveVox User

#Request (JSON)
PUT /configuration/lvusers/122935/Services/17885
Host: localhost.com
Content-Type: application/json
Accept: application/json
 
#Response
204 No Content
CODE

Update LiveVox User Remove Service

DescriptionRemoves a service from an existing LiveVox user.

User Roles: Sysadmin or Superuser

Method: DELETE /configuration/lvusers/{user}/services/{id}

Parameters:

Path/Query Parameter NameVariable NameTypeMandatory?Description
useruserIdNumberYesID of the LiveVox user from whom you want to remove the service.
idserviceIdNumberYesID of the service from which you want to unassign the LiveVox user.

Body:

None

Response Code: 204 No Content

Body:

None

Remove a Service assignment from an existing LiveVox User

#Request (JSON)
DELETE /configuration/lvusers/122935/services/17885
Host: localhost.com
Content-Type: application/json
Accept: application/json
 
#Response
204 No Content
CODE

Top of Page