Currently, 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.Read Client Internal Settings

Description: Retrieves the "Internal Settings" properties of a Client (i.e. the properties configured on the Internal Settings tab of the Client Editor in the LiveVox Configuration Manager. Some settings are also available on the Versions tab).

User Roles: Sysadmin or IT User

Method: GET /configuration/clients/[{id}/]internal

Parameters:

Path/Query Parameter NameVariable NameTypeMandatory?Description
idclientIdInteger (ID)NoThe ID of the Client you want to query

Body:

None

Response Code: 200 OK

Body:

Key or AttributeTypeMandatory?Description
maxDailyAttemptsIntegerNoThe maximum number of attempts that can be made to an account per day.
callRecordingDaysIntegerNoThe number of days call recordings are available through the LiveVox VoicePortal.
encryptCcsPasswordBooleanNoIf set to true, LiveVox VoicePortal passwords will be encrypted.
maxFailedCcsLoginAttemptsIntegerNoThe maximum number of attempts before the LiveVox User is locked.
encryptAcdPasswordBoobleanNoIf set to true , LiveVox ACD passwords will be encrypted.
maxFailedAcdLoginAttemptsIntegerNoThe maximum number of attempts before the LiveVox Agent is locked.
passwordExpirationDaysIntegerNoThe number of days before the VoicePortal and Agent passwords expire.

Get General & Settings configuration properties of a Client

#Request (JSON)
GET /configuration/clients/4199/internal
Host: localhost.com
Content-Type: application/json
Accept: application/json

#Response
200 OK
Content-Type: application/json

{"maxDailyAttempts":0,
"callRecordingDays":30,
"encryptCcsPassword":true,
"maxFailedCcsLoginAttempts":5,
"encryptAcdPassword":true,
"maxFailedAcdLoginAttempts":0,
"passwordExpirationDays":0}
CODE

Read Client General Settings

Description: Retrieves the "General" and "Settings" properties of a Client (i.e. the properties configured on the General and Settings tabs of the Client Editor in the LiveVox Configuration Manager).

User Roles: Sysadmin or IT User

Method: GET /configuration/clients/[{id}/]settings

Parameters:

Path/Query Parameter NameVariable NameTypeMandatory?Description
idclientIdInteger (ID)NoThe ID of the Client you want to query

Body:

None

Response Code: 200 OK

Body:

Key or AttributeTypeMandatory?Description
displayNameStringYesClient name as displayed at the top of the LiveVox Voice Portal
clientCodeStringYesLiveVox assigned company name identifier
defaultScreenPopIdInteger (ID)No

The ID of the default Screen Pop used for calls handled by Agents under this Client.

There may also be a default setting for this property configured at the Service level.


defaultDialingProfileIdInteger (ID)No

The ID of the default Dialing Profile used for calls made under this Client. The Dialing Profile establishes the rules for when (days and times) a call can be dialed in different countries, states, and area codes. 

There may also be a default setting for this property configured at the Service level.


serviceLevelSecondsIntegerYes

The number of seconds in which calls must be dialed to be in compliance. Used in some reports. 

There may also be a default setting for this property configured at the Service level.


restrictStrategiesScopeBooleanYesWhen set to true, Dialing Strategies can be restricted to only certain Services/Call Centers. Default value is false when a new Client is created.
defaultStrategyIdInteger (ID)NoThe ID of the Dialing Strategy applied to Campaigns. This is the default value for all Campaigns created under the Client, and can be adjusted for each Campaign on the Campaigns screen in LVP.
requeueStrategyIdInteger (ID)NoThe ID of the Dialing Strategy applied to Requeue Campaigns. This is the default value for all Campaigns created under the Client, and can be adjusted for each Campaign on the Campaigns screen in LVP.
defaultContactTimingIdInteger (ID)No

The ID of the dialing system that is used to determine the best time of day to dial numbers in a Campaign. This is the default value for all Campaigns created under the Client, and can be adjusted for each Campaign on the Campaigns screen in LVP. 

There may also be a default setting for this property configured at the Service level.


defaultVoiceIdInteger (ID)No

The ID of the voice talent used for messaging/IVR. This is the default value for all Campaigns created under the Client, and can be adjusted for each Campaign on the Campaigns screen in LVP. 

There may also be a default setting for this property configured at the Service level.


answeringMachineOptionEnumNo

This is the default value for all Campaigns created under the Client, and can be adjusted for each Campaign on the Campaigns screen in LVP. Valid values are NO_MESSAGES, LEAVE_MESSAGES, and TRANSFER

There may also be a default setting for this property configured at the Service level.


scrubWirelessBooleanYes

When set to true, wireless numbers will be scrubbed from a Campaign. This is the default value for all Campaigns created under the Client, and can be adjusted for each Campaign on the Campaigns screen in LVP. Default value is false when a new Client is created. 

There may also be a default setting for this property configured at the Service level.


acdResourceGroupEnabledBooleanYesWhen set to true, allows Resource Groups, which route traffic from Inbound or Outbound Service(s) to Agents in other Outbound Service(s) to be created and maintained. Default value is false when a new Client is created.
acdAgentSkillEnabledBooleanYesWhen set to true, allows a more granular control than the Resource Group, actually defining the Agents to receive calls. Default value is false when a new Client is created.
acctRealtimeDncBooleanYesIf set to true, the LiveVox platform will do a real-time check to see if an Account is marked as "do not call", before allowing a phone number associated with that account to be dialed.
lcidPackageIdInteger (ID)NoThe default LCID package for a client.
reportOnlyAfterAllRetriesBooleanNoWhen set to true, campaigns will wait to report until after all retries have been completed. If set to false campaigns will report after only retry attempts remain. The default setting is false and is the current functionality for Clients unless requested otherwise.

Get General & Settings configuration properties of a Client

#Request (JSON)
GET /configuration/clients/4199/settings
Host: localhost.com
Content-Type: application/json
Accept: application/json

#Response
200 OK
Content-Type: application/json

{
   "displayName": "Demo",
   "clientCode": "CAVALRY",
   "defaultScreenPopId": 3063,
   "defaultDialingProfileId": 0,
   "serviceLevelSeconds": 20,
   "restrictStrategiesScope": true,
   "defaultStrategyId": 468,
   "requeueStrategyId": 469,
   "defaultContactTimingId": 1,
   "defaultVoiceId": 1,
   "answeringMachineOption": null,
   "scrubWireless": false,
   "acdResourceGroupEnabled": true,
   "acdAgentSkillEnabled": true,
   "acctRealtimeDnc": true,
   "lcidPackageId": 1256,
   "reportOnlyAfterAllRetries": false
}
CODE

Read Client Messaging Settings

Description: Retrieves the "Messaging" properties of a Client (i.e. the properties configured on the Messaging tab of the Client Editor in the LiveVox Configuration Manager). 

Messaging properties do not all relate to actual messaging functionality, but are grouped on the Messaging tab, and are therefore grouped in this API request.

User Roles: Sysadmin or IT User

Method: GET /configuration/clients/[{id}/]messaging

Parameters:

Path/Query Parameter NameVariable NameTypeMandatory?Description
idclientIdInteger (ID)NoThe ID of the Client you want to query

Body:

None

Response Code: 200 OK

Body:

KeyTypeMandatory?Description

defaultInputFilterId

Integer (ID)YesID of the default Input Filter configured for the Client.
propertyArrayYes

An array of zero or more key-value pairs configured for the Client, representing configuration properties. These configuration properties relate to Input Filter functionality, some relate to Messaging functionality, and some may be unrelated to either of those categories of functionality.

KeyTypeMandatory?Description
keyStringYes

Key of the configuration property

valueStringNoValue of the configuration property


Get Messaging configuration properties of a Client

#Request (JSON)
GET /configuration/clients/4199/messaging
Host: localhost.com
Content-Type: application/json
Accept: application/json

#Response
200 OK
Content-Type: application/json

{
   "property":    [
            {
         "key": "exclusion_fields",
         "value": "ACCOUNT"
      },
            {
         "key": "exclusion_range",
         "value": "1"
      },
            {
         "key": "requeue_limit",
         "value": "15"
      },
            {
         "key": "sequential_loading",
         "value": "0"
      },
            {
         "key": "store_wireless",
         "value": "DAYS_DUE_6"
      },
            {
         "key": "template_id",
         "value": "11601"
      }
   ],
   "defaultInputFilterId": 21572
}
CODE

Read Client Voice Pool Settings

Description: Retrieves the "Voice Pool" properties of a Client (i.e. the properties configured on the Voice Pool tab of the Client Editor in the LiveVox Configuration Manager).

User Roles: Sysadmin or IT User

Method: GET /configuration/clients/[{id}/]voicePool

Parameters:

Path/Query Parameter NameVariable NameTypeMandatory?Description
idclientIdInteger (ID)No

The ID of the Client to be read.

Body:

None

Response Code: 200 OK

Body:

KeyTypeMandatory?Description
voiceArrayYes

An array of zero or more Voice IDs configured for the Client. If a Voice ID is configured for a Client it means that the Voice is available to be configured for a Campaign.

KeyTypeMandatory?Description
idInteger (ID)Yes

ID of the Voice resource assigned to the Client. Possible values are:

Voice IDNameLanguageDialectGender
1JulieEnglishAmericanF
2JuanitaSpanishAmericanF
3KateEnglishBritishF
4GiselePortuguesePortugueseF
5BobEnglishAmericanM
6Gruff-MEnglishAmericanM
8Gruff-FEnglishAmericanF
9LeeEnglishAmericanM
10ScarletEnglishAmericanF
11ClaudineFrenchCanadianF


Get Voice Pool configuration properties of a Client

#Request (JSON)
GET /configuration/clients/4199/voicePool
Host: localhost.com
Content-Type: application/json
Accept: application/json

#Response
200 OK
Content-Type: application/json

{"voice": [
   {"id": 1},
   {"id": 5},
   {"id": 2},
   {"id": 3}
]}
CODE

Update Client Add Voice

Description: Adds a voice talent to the list of talents available for use by the Client.

User Roles: Sysadmin or IT User.

Method: POST /configuration/clients/[{client}/]voicePool/{id}

Parameters:

Path/Query Parameter NameVariable NameTypeMandatory?Description
clientclientIdInteger (ID)No

The ID of the Client to add the voice talent to.

idvoiceIdInteger (ID)Yes

The voice ID of the voice talent to be added, possible values include:

Voice IDNameLanguageDialectGender
1JulieEnglishAmericanF
2JuanitaSpanishAmericanF
3KateEnglishBritishF
4GiselePortuguesePortugueseF
5BobEnglishAmericanM
6Gruff-MEnglishAmericanM
8Gruff-FEnglishAmericanF
9LeeEnglishAmericanM
10ScarletEnglishAmericanF
11ClaudineFrenchCanadianF

Body:

None

Response Code: 204 No Content

Body:

None

Add a voice talent to a Client

#Request
POST /configuration/clients/4199/voicePool/11
Host: localhost.com
Content-Type: application/json
Accept: application/json

#Response
204 No Content
CODE

Update Client Remove Voice

Description: Removes a voice talent from the list of talents available for use by the Client.

User Roles: Sysadmin or IT User

Method: DELETE /configuration/clients/[{client}/]voicePool/{id}

Parameters:

Path/Query Parameter NameVariable NameTypeMandatory?Description
clientclientIdInteger (ID)No

The ID of the Client to remove the voice talent from.

idvoiceIdInteger (ID)Yes

The voice ID of the voice talent to be removed, possible values include:

Voice IDNameLanguageDialectGender
1JulieEnglishAmericanF
2JuanitaSpanishAmericanF
3KateEnglishBritishF
4GiselePortuguesePortugueseF
5BobEnglishAmericanM
6Gruff-MEnglishAmericanM
8Gruff-FEnglishAmericanF
9LeeEnglishAmericanM
10ScarletEnglishAmericanF
11ClaudineFrenchCanadianF

Body:

None

Response Code: 204 No Content

Body:

None

Remove a voice talent from a Client

#Request
POST /configuration/clients/4199/voicePool/11
Host: localhost.com
Content-Type: application/json
Accept: application/json

#Response
204 No Content
CODE

List Countries

Description: Lists the allowed countries for the client.

User Roles: Sysadmin or IT User

Method: GET  /configuration/clients/countries

Parameters:

None

Body:

None

Response Code: 200 OK

Body:

AttributeTypeMandatory?Description

ArrayYes

abbreviation

AttributeTypeMandatory?Details
nameStringYesThe full name of the country. 
countryCode
LongNo

International Organization for Standardization (ISO) Country code . 

idNumberYesThe value of the Country ID.

Get the Allowed Countries List

#Request
GET /configuration/clients/countries 
Host: localhost.com
Content-Type: application/json
Accept: application/json   

#Response
200 OK
Content-Type: application/json
 

[
  {
    "countryCode": "54",
    "name": "ARGENTINA",
    "id": 7
  },
  {
    "countryCode": "61",
    "name": "AUSTRALIA",
    "id": 11
  },
  {
    "countryCode": "43",
    "name": "AUSTRIA",
    "id": 12
  },
  {
    "countryCode": "32",
    "name": "BELGIUM",
    "id": 13
  },
  {
    "countryCode": "591",
    "name": "BOLIVIA",
    "id": 14
  },
  {
    "countryCode": "55",
    "name": "BRAZIL",
    "id": 3
  },
  {
    "countryCode": "359",
    "name": "BULGARIA",
    "id": 15
  },
  {
    "countryCode": "1",
    "name": "CANADA",
    "id": 2
  },
  {
    "countryCode": "56",
    "name": "CHILE",
    "id": 16
  },
  {
    "countryCode": "86",
    "name": "CHINA",
    "id": 17
  },
  {
    "countryCode": "57",
    "name": "COLOMBIA",
    "id": 9
  },
  {
    "countryCode": "506",
    "name": "COSTA RICA",
    "id": 18
  },
  {
    "countryCode": "385",
    "name": "CROATIA",
    "id": 19
  },
  {
    "countryCode": "357",
    "name": "CYPRUS",
    "id": 20
  },
  {
    "countryCode": "420",
    "name": "CZECH REPUBLIC",
    "id": 21
  },
  {
    "countryCode": "45",
    "name": "DENMARK",
    "id": 22
  },
  {
    "countryCode": "593",
    "name": "ECUADOR",
    "id": 23
  },
  {
    "countryCode": "20",
    "name": "Egypt",
    "id": 33
  },
  {
    "countryCode": "372",
    "name": "ESTONIA",
    "id": 24
  },
  {
    "countryCode": "358",
    "name": "FINLAND",
    "id": 25
  },
  {
    "countryCode": "33",
    "name": "FRANCE",
    "id": 26
  },
  {
    "countryCode": "49",
    "name": "GERMANY",
    "id": 27
  },
  {
    "countryCode": "30",
    "name": "GREECE",
    "id": 28
  },
  {
    "countryCode": "502",
    "name": "GUATEMALA",
    "id": 29
  },
  {
    "countryCode": "31",
    "name": "HOLLAND",
    "id": 30
  },
  {
    "countryCode": "36",
    "name": "HUNGARY",
    "id": 31
  },
  {
    "countryCode": "354",
    "name": "ICELAND",
    "id": 32
  },
  {
    "countryCode": "91",
    "name": "INDIA",
    "id": 10
  },
  {
    "countryCode": "964",
    "name": "IRAQ",
    "id": 68
  },
  {
    "countryCode": "353",
    "name": "Ireland",
    "id": 128
  },
  {
    "countryCode": "39",
    "name": "ITALY",
    "id": 34
  },
  {
    "countryCode": "81",
    "name": "JAPAN",
    "id": 35
  },
  {
    "countryCode": "371",
    "name": "LATVIA",
    "id": 36
  },
  {
    "countryCode": "370",
    "name": "LITHUANIA",
    "id": 37
  },
  {
    "countryCode": "352",
    "name": "LUXEMBOURG",
    "id": 38
  },
  {
    "countryCode": "60",
    "name": "MALAYSIA",
    "id": 39
  },
  {
    "countryCode": "356",
    "name": "MALTA",
    "id": 40
  },
  {
    "countryCode": "52",
    "name": "MEXICO",
    "id": 4
  },
  {
    "countryCode": "31",
    "name": "NETHERLANDS",
    "id": 41
  },
  {
    "countryCode": "64",
    "name": "NEW ZEALAND",
    "id": 42
  },
  {
    "countryCode": "234",
    "name": "NIGERIA",
    "id": 43
  },
  {
    "countryCode": "47",
    "name": "NORWAY",
    "id": 44
  },
  {
    "countryCode": "92",
    "name": "PAKISTAN",
    "id": 45
  },
  {
    "countryCode": "507",
    "name": "PANAMA",
    "id": 46
  },
  {
    "countryCode": "595",
    "name": "PARAGUAY",
    "id": 47
  },
  {
    "countryCode": "51",
    "name": "PERU",
    "id": 48
  },
  {
    "countryCode": "48",
    "name": "POLAND",
    "id": 49
  },
  {
    "countryCode": "351",
    "name": "PORTUGAL",
    "id": 50
  },
  {
    "countryCode": "1",
    "name": "PUERTO RICO",
    "id": 51
  },
  {
    "countryCode": "40",
    "name": "ROMANIA",
    "id": 52
  },
  {
    "countryCode": "7",
    "name": "RUSSIA",
    "id": 53
  },
  {
    "countryCode": "44",
    "name": "SCOTLAND",
    "id": 54
  },
  {
    "countryCode": "65",
    "name": "SINGAPORE",
    "id": 5
  },
  {
    "countryCode": "421",
    "name": "SLOVAKIA",
    "id": 55
  },
  {
    "countryCode": "386",
    "name": "SLOVENIA",
    "id": 56
  },
  {
    "countryCode": "34",
    "name": "SPAIN",
    "id": 57
  },
  {
    "countryCode": "46",
    "name": "SWEDEN",
    "id": 58
  },
  {
    "countryCode": "41",
    "name": "SWITZERLAND",
    "id": 59
  },
  {
    "countryCode": "886",
    "name": "TAIWAN",
    "id": 60
  },
  {
    "countryCode": "1",
    "name": "TRINIDAD TOBAGO",
    "id": 61
  },
  {
    "countryCode": "90",
    "name": "TURKEY",
    "id": 62
  },
  {
    "countryCode": "44",
    "name": "UK",
    "id": 8
  },
  {
    "countryCode": "971",
    "name": "UNITED ARAB EMIRATES",
    "id": 63
  },
  {
    "countryCode": "1",
    "name": "UNITED STATES OF AMERICA",
    "id": 1
  },
  {
    "countryCode": "598",
    "name": "URUGUAY",
    "id": 64
  },
  {
    "countryCode": "58",
    "name": "VENEZUELA",
    "id": 65
  },
  {
    "countryCode": "44",
    "name": "WALES",
    "id": 66
  },
  {
    "countryCode": "260",
    "name": "ZAMBIA",
    "id": 67
  }
]
CODE

Top of Page