Configuration API

Introduction

The LiveVox Configuration API provides methods that allow you to retrieve configuration data from the LiveVox platform, such as lists and properties of Call Centers, Services, Term Codes, etc. See the  LiveVox API Overview for a general description of how to interact with the API.

Prerequisites

• The user must have successfully logged into the LiveVox platform to obtain a valid Session ID. See Session Management for more information.
• The user must have an active subscription to the Configuration API, in order to obtain an Access Token for use in all API requests. See Access Tokens for details.
• All messages in this API may be subject to rate limits and other restrictions.

Configuration API WADL/Swagger

The Session API WADL/Swagger is publicly available; to obtain the WADL/Swagger for any other API category a user will need to include the LV-Session header with a valid session ID in the WADL/Swagger request.

The Configuration API v17.0 WADL/Swagger is available at the following URL:

The URLs listed below are for the LiveVox NA3 environment and will change slightly if your portal is in a different environment. To see how the URL changes per environment, see the LiveVox Environments and APIs section.

User Roles

Unless otherwise specified in this documentation, for a user to be able to access any data through the Configuration API, the user must belong to either the Sysadmin, IT User, Superuser, or Manager role. These roles are defined in the LiveVox Configuration Manager and correspond to users who can access LiveVox configuration data through the LiveVox user interfaces.

Within a session generated by an Agent, the following methods of the Configuration API may be accessed. Attempts to access any other API method of the Configuration API will return a 403 Forbidden response.

• Read Agent
• List Agents
• FindMatchingAgents
• Get Agent Related Objects
• Get Call Center Related Objects
• List Call Centers
• Get Call Center List Info
• Read Call Center
• Read Screen Pop
• List Screen Pop
• Get Screen Pop List Info
• Read Term Code
• List Term Code
• Get Term Code List Info
• Read Term Code Category
• List Term Code Categories
• Get Term Code Category List Info
• Read LiveVox Result
• List LiveVox Results
• Read Custom Outcomes

API Methods

Agents

The Configuration API supports Create, Read, Update, Delete, List, and Get List Info methods for Agent objects. There are separate methods to Add and Remove Services and Agent Skills to and from Agents. Read, List, and Get List Info methods for Agent Skill objects, as well as a method to Get Agent Related Objects, are also supported.  For more information, see the Agents API Methods section.

Call Centers

The Configuration API supports Create, Delete, Read, Update, List, and Get List Info methods for Call Center objects.  For more information, see the Call Centers API Methods section.

Clients

The Configuration API supports Read General Settings, Read Voice Pool Settings, and Read Messaging Settings methods for Client resources. Create, Update, and Delete are not supported.  For more information, see the Clients API Methods section.

Contact Timing

Contact Timing resources define how the dialing of accounts within campaigns is prioritized. Contact Timing resources are used by the LiveVox platform to identify accounts that fall into "prime time" windows by Time Zone. Higher dialing priorities are assigned to accounts while they are within one of these “prime time” windows. Contact Timing resources are assigned to Services, and a default Contact Timing may also be assigned at the Client level.

The Configuration API supports Read, List, and Get List Info methods for Contact Timing resources. Create, Update, and Delete are not yet supported.  For more information, see the Contact Timing API Methods section.

Dialing Strategies

Dialing Strategies are the rules that define the inclusion of numbers for an account, sequence of dialing, whether to move to the next number in the sequence and requeue inclusion.

The Configuration API supports List, Get List Info, Read, Create, Update, and Delete methods for Dialing Strategies objects.  For more information, see the Dialing Strategies API Methods section.

LCID Packages

LCID Packages allow a Service to display different LCIDs to a call recipient depending on their location. They are assigned to Outbound Services and Inbound traffic to these numbers are routed to a single Inbound Service. 

The Configuration API supports Read, List, and Get List Info methods for LCID Packages objects. Create, Update, and Delete are not yet supported.  For more information, see the LCID Packages API Methods section.

Message Templates

For Message Template objects, the configuration API supports List, and Get List Info methods, as well as retrieves a list of objects related to a Message.  For more information, see the Message Templates API Methods section.

Report Formats

Report Formats are used to define the settings of a CDR such as what information is included, what type of file it is, the delimiter, etc. Currently, the Configuration API supports List and Get List Info methods. Create, Update, Read and Delete are not yet supported.  For more information, see the Report Formats API Methods section.

Resource Groups

Resource Group defines which Outbound Services an Agent can be signed into to receive traffic from the contributing Inbound and Outbound Services.

The Configuration API supports Create, Update, Delete Read, List, and Get List Info methods for Resource Groups objects.  For more information, see the Resource Groups API Methods section.

Screen Pops

The Configuration API supports Read, List, and Get List Info methods for Screen Pop objects. Create, Update, and Delete are not yet supported.  For more information, see the Screen Pops API Methods section.

Services

The Configuration API supports Read, List, and Get List Info methods for Service objects, as well as the ability to find Services that match selected criteria and retrieve a list of objects related to a Service. Limited Update methods are also available, such as updating a Services assigned messaging template and changing an inbound Services open hours. Create and Delete are not yet supported. For more information, see the Services API Methods section.

Term Codes

For Term Code objects, the Configuration API supports Create, Read, Update, Delete, List, and Get List Info methods.  For more information, see the Term Codes API Methods section.

Users

"Users" refers to all non-agent users of the LiveVox platform. The Configuration API supports Create, Read, Update, Delete, List, and Get List Info methods for LiveVox user objects.  For more information, see the Users API Method section.

Utilities

The Configuration API supports List and Read Voices methods for the Utilities objects. These methods allow a user to get information about all voice talents available on the LiveVox system, this includes ones they have access to and ones they don't. The Utilities object also supports an audit log search which returns all the audit log entries and can be filtered by the user who made the change and the type of change.  For more information, see the Utilities API Methods section.

Errors

For more information, see the Errors topic on the REST APIs page. 

Top of Page