For Term Code objects, the Configuration API supports Create, Read, Update, Delete, List, and Get List Info methods. For Term Code Categories, the API supports Create, Read, Update, Delete, List, and Get List Info methods. There is also a List method for listing the LiveVox Results, and a Read method for retrieving Custom Outcomes mapped to a LiveVox Result.

Create Term Code

Description: Creates a new Term Code.

User Roles: Sysadmin or IT User

Method: POST /configuration/termCodes

Body:

Key or AttributeTypeMandatory?Description
nameStringYesThe name of the Term Code.
serviceIdInteger (ID)YesThe Service to which the Term Code is associated.
termCategoryIdInteger (ID)YesThe internal LiveVox ID of the category associated with the Term Code. Categories are used to group together similar Term Codes.
lvResultIdInteger (ID)YesThe internal LiveVox ID of the result associated with the Term Code (sometimes referred to as the "TFH Result").
actionEnumYesIndicates whether the call should be disconnected, or a message should be left, after the Term Code   is selected by an agent. Must be either DISCONNECT_CALL or LEAVE_MESSAGE .
reportOrderIntegerYesThe order in which the Term Code will appear on the Call Detail Record.
previewDialEnabledBooleanNoIf set to true, the agent is presented with a text box after they select the Term Code. The agent enters a follow up phone # which is immediately dialed.

Response Code: 201 Created

Body:

Key or AttributeTypeMandatory?Description
idInteger (ID)YesThe ID of the newly created Term Code.

Create a New Term Code

#Request (JSON)
POST /configuration/termCodes/
Host: localhost.com
Content-Type: application/json
Accept: application/json
 
{"name": "Deceased", "serviceId": 20575,"termCategoryId": 17296,"lvResultId": 725,"action": "DISCONNECT_CALL","reportOrder": 20,"previewDialEnabled": false}
 
#Response
201 Created
Content-Type: application/json
 
{"id": 1275944}
 
CODE

Create Term Code Category

Description: Creates a new Term Code Category for a Client.

User Roles: Sysadmin or IT User

Method: POST /configuration/termCodes/categories

Parameters:

None

Body:

Key or AttributeTypeMandatory?Description
clientIdInteger (ID)NoThe ID of the LiveVox Client for which this Term Code Category will be created.
nameStringYesThe display name of the Term Code Category. There may not be more than one Term Code Category within the same Client, with the same name.

Response Code: 201 Created

Body:

Key or AttributeTypeMandatory?Description
idInteger (ID)YesID of the Term Code Category

Create a new Term Code Category for a Client

#Request (JSON)
POST /configuration/termCodes/categories
Host: localhost.com
Content-Type: application/json
Accept: application/json
  
{
"name":"Successful Outcome",
"clientId":4199
}
  
#Response (JSON)
201 Created
Content-Type: application/json
  
{"id": 21636}
CODE

Delete Term Code

Description: Deletes a Term Code.

User Roles: Sysadmin or IT User

Parameters:

Path/Query Parameter NameVariable NameTypeMandatory?Description
idtermCodeIdInteger (ID)TrueID of the Term Code you want to delete

Body:

None

Response Code: 204 No Content

Body:

None

Delete an existing Term Code

#Request
DELETE /configuration/termCodes/1197098
Host: localhost.com
Content-Type: application/json
Accept: application/json  

#Response
204 No Content
CODE

Attempt to delete a Term Code that does not exist

#Request
DELETE /configuration/termCodes/6777231
Host: localhost.com
Content-Type: application/json
Accept: application/json  

#Response
404 Not Found
CODE

Delete Term Code Category

Description: Deletes a Term Code Category.

User Roles: Sysadmin or IT User

Method: DELETE /configuration/termCodes/categories/{id}

Parameters:

Path/Query Parameter NameVariable NameTypeMandatory?Description
idcategoryIdInteger (ID)YesID of the Term Code Category you wish to delete. You cannot delete a Term Code Category if it is in use (that is, if it is associated with a Term Code)

Body:

None

Response Code: 204 No Content

Body:

None

Delete a Term Code Category

#Request
DELETE /configuration/termCodes/categories/26368
Host: localhost.com
Content-Type: application/json
Accept: application/json
 
#Response
204 No Content
Content-Type: application/json
CODE

Get Term Code Category List Info

Description: Gets metadata for a list of Term Code Categories.

User Roles: Sysadmin, IT User, Manager or Agent

Method: GET /configuration/termCodes/categories/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. If clientId is omitted, the list size will be based on the global Term Code Categories that are available for use by all Clients.

Body:

None

Response Code: 200 OK

Body:

Key or AttributeTypeMandatory?Description
sizeIntegerYesTotal number of entries in the list.
lastModifiedDateTimeNoThe last date & 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).

Get the metadata for a term code category list filtered by a Client

#Request (JSON)
GET /configuration/termCodes/categories/info?client=4199
Host: localhost.com
Content-Type: application/json
Accept: application/json
 
#Response (JSON)
200 OK
Content-Type: application/json
 
{
   "size": 5,
   "lastModified": null
}
CODE

Get the metadata for the list of term code categories available to all clients

#Request (JSON)
GET /configuration/termCodes/categories/info
Host: localhost.com
Content-Type: application/json
Accept: application/json
 
#Response (JSON)
200 OK
Content-Type: application/json
 
{
   "size": 38,
   "lastModified": null
}
CODE

Get Term Code List Info

Description: Gets metadata for a list of Term Codes.

User Roles: Sysadmin, IT User, Manager or Agent

Method: GET /configuration/termCodes/info?service={serviceId}

Parameters:

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

Body:

None

Response Code:  200 OK

Body:

Key or AttributeTypeMandatory?Description
sizeIntegerYesTotal number of entries in the list.

Get the metadata for a term code list, filtered by a Service

#Request (JSON)
GET /configuration/termCodes/info?service=38012
Host: localhost.com
Content-Type: application/json
Accept: application/json

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

{
   "size": 18,
   "lastModified": null
}
CODE

List LiveVox Results

Description: Returns list of LiveVox Results that are used in Term Code configuration.

User Roles: Sysadmin, IT User, Manager or Agent

Method: GET /configuration/termCodes/results?type={lvResultType}[&client={clientId}]

Parameters:

Path/Query Parameter NameVariable NameTypeMandatory?Description
typelvResultTypeStringYesRestricts the list to a specific type of LiveVox Result. Valid values are SYSTEM, AGENT and ALL. Using the lvResultType of ALL will return both SYSTEM and AGENT Result Types. LiveVox Results of type AGENT are ones that can be associated with Term Codes that are presented to agents on their desktop during calls.
clientclientIdInteger (ID)NoThe Client ID for which you want to retrieve details.

Body:

None

KeyTypeMandatory?Description
lvResultArrayNo

A container for the LiveVox Result entries.

KeyTypeMandatory?Description
idInteger (ID)Yes

Internal ID of the LiveVox Result

nameStringYesName of the LiveVox Result
priorityIntegerYesPriority of the LiveVox Result
resultTypeStringYesType of result. Either SYSTEM or AGENT. Results of type AGENT are ones that can be associated with Term Codes that are presented to agents on their desktop during calls.

Get the list of LiveVox Results of type 'AGENT' available for Term Code configuration

#Request (JSON)
GET /configuration/termCodes/results?type=AGENT&client=4199
Host: localhost.com
Content-Type: application/json
Accept: application/json
 
#Response (JSON)
200 OK
Content-Type: application/json
 
{"lvResult": [
      {
      "id": 743,
      "name": "AGENT - Agent Hung Up",
	  "priority": 137,
      "resultType": "AGENT"
   },
      {
      "id": 723,
      "name": "AGENT - Attorney Handling",
	  "priority": 112,
      "resultType": "AGENT"
   },
      {
      "id": 724,
      "name": "AGENT - Bankrupt",
	  "priority": 113,      
	  "resultType": "AGENT"
   },
...
      {
      "id": 735,
      "name": "AGENT - Wrong Number",
	  "priority": 151,
      "resultType": "AGENT"
   },
      {
      "id": 736,
      "name": "AGENT - Wrong Party",
	  "priority": 152,
      "resultType": "AGENT"
   }
]}
CODE

Get the full list of LiveVox Results available for Term Code configuration

#Request (JSON)
GET /configuration/termCodes/results?type=ALL
Host: localhost.com
Content-Type: application/json
Accept: application/json
 
#Response (JSON)
200 OK
Content-Type: application/json
 
{"lvResult": [
      {
      "id": 743,
      "name": "AGENT - Agent Hung Up",
	  "priority": 137,
      "resultType": "AGENT"
   },
      {
      "id": 723,
      "name": "AGENT - Attorney Handling",
	  "priority": 112,
      "resultType": "AGENT"
   },
...
      {
      "id": 307,
      "name": "Will Provide Insurance Info",
	  "priority": 408,
      "resultType": "SYSTEM"
   },
      {
      "id": 764,
      "name": "Wireless Call Suppressed (Not Made)",
	  "priority": 9016,
      "resultType": "SYSTEM"
   }
]}
CODE

List Term Code Categories

Description: Lists Term Code Categories configured for a Client. Also provides the ability to list the "global" Term Code Categories that are available for use by all Clients.

User Roles: Sysadmin, IT User, Manager or Agent

Method: GET /configuration/termCodes/categories?count={n}&offset={n}[&client={clientId}]

Parameters:

Path/Query Parameter NameVariable NameTypeMandatory?Description
countnIntegerYesSpecifies the number of items to return in the list. There is a hard cap of 1000 items.
offsetnIntegerYesSpecifies the offset from 0, based on count, to start listing from.
clientclientIdInteger (ID)NoRestricts the list to entries that are specifically associated with this particular Client. If this key is omitted, the request will return the list of "global" Term Code Categories that are available for use by all LiveVox Clients.

Response Code: 200 OK

Body:

KeyTypeMandatory?Description
nextURINoA URI for the next page of entries. If next is not present, or blank, then there are no pages after this one.
categoryArrayNo

A container for a page of Term Code Category entries. The page size is controlled via count and offset in the request.

KeyTypeMandatory?Description
idInteger (ID)YesID of the Term Code Category.
nameStringYesName of the Term Code Category.
clientIdInteger (ID)NoClient to which the Term Code Category is associated. If this Term Code Category is a global category available for use by all LiveVox Clients, the value of clientId will be null.

Get the list of Term Code Categories filtered by a Client

#Request (JSON)
GET /configuration/termCodes/categories?client=4199&offset=0&count=10
Host: localhost.com
Content-Type: application/json
Accept: application/json
 
#Response (JSON)
200 OK
Content-Type: application/json
 
{
   "category":    [
            {
         "id": 17230,
         "name": "WPC",
         "clientId": 4199
      },
            {
         "id": 17296,
         "name": "OTHER",
         "clientId": 4199
      },
            {
         "id": 19108,
         "name": "Patient Contact",
         "clientId": 4199
      },
            {
         "id": 19110,
         "name": "Patient Services",
         "clientId": 4199
      },
            {
         "id": 19112,
         "name": "Patient Billing",
         "clientId": 4199
      }
   ],
   "next": null
}
CODE

Get the list of Term Code Categories available to all Clients

#Request (JSON)
GET /configuration/termCodes/categories?offset=0&count=38
Host: localhost.com
Content-Type: application/json
Accept: application/json
 
#Response (JSON)
200 OK
Content-Type: application/json

{
   "category":    [
            {
         "id": 16046,
         "name": "Customer Contact",
         "clientId": null
      },
            {
         "id": 16048,
         "name": "Message",
         "clientId": null
      },
...
      {
         "id": 15232,
         "name": "Third Party",
         "clientId": null
      }
   ],
   "next": null
}
CODE

List Term Codes

Description: Lists Term Codes.

Please be aware that there are no user level restrictions on this method; this means that any user level may list the term codes for any Service. The change was implemented because within LiveVox Agents are not assigned to inbound Services and therefore were not able to list the term codes of inbound Services.

Method: GET /configuration/termCodes?count={n}&offset={n}[&service={serviceId}]

Parameters:

Path/Query Parameter NameVariable NameTypeMandatory?Description
countnIntegerYesSpecifies the number of items to return in the list. There is a hard cap of 1000 items.
offsetnIntegerYesSpecifies the offset from 0, based on count, to start listing from.
serviceserviceIdInteger (ID)NoRestricts the list to entries that are specifically associated with this particular Service.

Body:

None

Response Code: 200 OK

Body:

KeyTypeMandatory?Description
nextURINoA URI for the next page of entries. If next is not present, or blank, then there are no pages after this one.
termCodeArrayNo

A container for a page of Term Code entries. The page size is controlled via count and offset in the request.

KeyTypeMandatory?Description
termCodeNameStringYesThe name of the Term Code.
serviceIdInteger (ID)YesThe Service to which the Term Code is associated.
termCategoryIdInteger (ID)YesThe internal LiveVox ID of the category associated with the Term Code. Categories are used to group together similar Term Codes.
lvResultIdInteger (ID)YesThe internal LiveVox ID of the result associated with the Term Code (sometimes referred to as the "TFH Result").
actionEnumYesIndicates whether the call should be disconnected, or a message should be left, after the Term Code is selected by an agent. Must be either DISCONNECT_CALL or LEAVE_MESSAGE.
reportOrderIntegerYesThe order in which the Term Code will appear on the Call Detail Record.
previewDialEnabledBooleanNoIf set to true, the agent is presented with a text box after they select the Term Code. The agent enters a follow up phone # which is immediately dialed.
idInteger (ID)YesThe internal LiveVox ID of the Term Code.
termCategoryNameStringYesName of the Term Code category.
resultNameStringYesA user-friendly name for the result associated with the Term Code.

Get a list of Term Codes filtered by a Service

#Request (JSON)
GET /configuration/termCodes?service=20575&offset=0&count=10
Host: localhost.com
Content-Type: application/json
Accept: application/json
 
#Response (JSON)
200 OK
Content-Type: application/json
 
{
   "termCode":    [
            {
         "termCodeName": "PTP Payment in Full",
         "serviceId": 17797,
         "termCategoryId": 15724,
         "lvResultId": 721,
         "action": "DISCONNECT_CALL",
         "reportOrder": 10,
         "previewDialEnabled": false,
         "id": 132751,
         "termCategoryName": "RPC",
         "resultName": "AGENT - PTP Payment in Full"
      },
            {
         "termCodeName": "Debtor Dispute",
         "serviceId": 17797,
         "termCategoryId": 13150,
         "lvResultId": 722,
         "action": "DISCONNECT_CALL",
         "reportOrder": 3,
         "previewDialEnabled": false,
         "id": 132753,
         "termCategoryName": "Other",
         "resultName": "AGENT - Debtor Dispute"
      },
...
      {
         "termCodeName": "Transfer",
         "serviceId": 17797,
         "termCategoryId": 17296,
         "lvResultId": 758,
         "action": "DISCONNECT_CALL",
         "reportOrder": 21,
         "previewDialEnabled": false,
         "id": 1197907,
         "termCategoryName": "OTHER",
         "resultName": "AGENT - CUST RPC 2"
      }
   ],
   "next": "configuration/termCodes?count=5&service=20575&offset=5"
}
CODE

Read Custom Outcomes

Description: Returns the custom outcomes mapped to a LiveVox Result. For each LiveVox Result, there may be up to three custom outcomes mapped at the Client level, and for each Service as well. Custom outcomes allow the LiveVox Results that are associated with Agent Term Codes and call attempts, to be mapped to client and Service-specific strings that can be used for integration with a client's system of record.

Please be aware that there are no user level restrictions on this method; this means that any user level may read the custom outcomes for any Service. The change was implemented because within LiveVox Agents are not assigned to inbound Services and therefore were not able to read the custom outcomes of inbound Services.

Method: GET /configuration/termCodes/results/customOutcomes/{id}?[client={clientId}][&service={serviceId}]

Parameters:

Path/Query Parameter NameVariable NameTypeMandatory?Description
idlvResultIdInteger (ID)YesID of the LiveVox result for which you want to retrieve custom outcome mappings.
clientclientIdInteger (ID)NoLiveVox ID of the Client for whom you are retrieving custom outcomes.
serviceserviceIdInteger (ID)NoIf serviceId is specified in the request, the custom outcomes mapped to the LiveVox Result for that Service will be returned. If serviceId is omitted, the custom outcomes mapped to the LiveVox Result at the Client level will be returned.

Body:

None

KeyTypeMandatory?Description
resultNameStringYesName of the LiveVox Result
outcomesArrayNo

An array of 1-3 custom outcomes that are mapped to the LiveVox Result. The ordinal key indicates whether the custom outcome is considered to be "Custom Outcome 1", "Custom Outcome 2", or "Custom Outcome 3", if you were to refer to the screen in the LiveVox Portal where these custom outcomes are configured.

KeyTypeMandatory?Description
outcomeStringYes

One of the custom outcomes mapped to the LiveVox Result

ordinalIntegerYesDescribes whether the custom outcome is in position 1, 2, or 3 (as displayed in the LiveVox Portal GUI).

Retrieve the custom outcome for a LiveVox Result, mapped to a specific Service

#Request (JSON)
GET /configuration/termCodes/results/customOutcomes/723?client=4199&service=38184
Host: localhost.com
Content-Type: application/json
Accept: application/json
 
#Response (JSON)
200 OK
Content-Type: application/json
 
{
   "outcomes":    [
            {
         "outcome": "CA_10",
         "ordinal": 1
      },
            {
         "outcome": "XNA",
         "ordinal": 2
      },
            {
         "outcome": "XTDR",
         "ordinal": 3
      }
   ],
   "resultName": "AGENT - Attorney Handling"
}
CODE

Retrieve the custom outcome for a LiveVox Result, mapped at the Client-level

#Request
GET /configuration/termCodes/results/customOutcomes/723?client=4199
Host: localhost.com
Content-Type: application/json
Accept: application/json
 
#Response
200 OK
Content-Type: application/json
 
{
   "outcomes": [   {
      "outcome": "XCDN",
      "ordinal": 1
   }],
   "resultName": "AGENT - Attorney Handling"
}
CODE

Read LiveVox Result

Description: Retrieve details about a specific LiveVox Result. Agent-type LiveVox Results are used in Term Code configuration, and system-type LiveVox Results are used to disposition call attempts.

User Roles: Sysadmin, IT User, Manager or Agent

Method: GET /configuration/termCodes/results/{id}[?client={clientId}]

Parameters:

Path/Query Parameter NameVariable NameTypeMandatory?Description
idlvResultIdInteger (ID)YesThe LiveVox Result for which you want to retrieve details.
clientclientIdInteger (ID)NoThe Client ID for which you want to retrieve details.

Body:

None

Key or AttributeTypeMandatory?Description
resultIdInteger (ID)YesID of the LiveVox Result you want to read
resultNameStringYesDisplay name of the LiveVox Result
priorityIntegerYesPriority of the LiveVox Result. All LiveVox Results have a unique priority, so that if multiple call attempts are made for an account, it is possible to determine the "best result" based on this priority.
resultTypeEnumYesThe type of LiveVox Result. The possible values are AGENT and SYSTEM.
notConnectedBooleanYesIf true, this LiveVox Result reflects that the call was not connected to a consumer.
operatorTransferBooleanYesIf true, this LiveVox Result reflects that the system attempted to transferr the call to an agent.
notMadeBooleanYesIf true, this LiveVox Result reflects a call that was not made.
operatorTransferSuccessfulBooleanYesIf true, this LiveVox Result reflects that the call was successfully transferred to an agent.
attendedServicesOnlyBooleanYesIf true, this LiveVox Result is relevant for attended Services only.
requeueableBooleanYesIf true, this LiveVox Result reflects that a call attempt is requeueable.
liveAnswerBooleanYesIf true, this LiveVox Result reflects that a call was answered by a consumer.
agentActionTypeEnumNoFor LiveVox Results where resultType = AGENT, this key indicates the type of agent action reflected by the result. Possible values are: RPC_SUCCESS, R PC_NO_SUCCESS, WRONG_PARTY_CONTACT, and NON_CONTACT. Here, RPC means "Right-Party Connect", which means that the call was connected to the intended consumer.

Read the details of a LiveVox Result

#Request (JSON)
GET /configuration/termCodes/results/723?client=4199
Host: localhost.com
Content-Type: application/json
Accept: application/json
 
#Response (JSON)
200 OK
Content-Type: application/json
 
{
   "resultId": 723,
   "resultName": "AGENT - Attorney Handling",
   "priority": 112,
   "resultType": "AGENT",
   "notConnected": false,
   "operatorTransfer": true,
   "notMade": false,
   "operatorTransferSuccessful": true,
   "attendedServicesOnly": true,
   "requeueable": true,
   "liveAnswer": true,
   "agentActionType": "RPC_NO_SUCCESS"
}
CODE

Read Term Code

Description: Gets information about a Term Code.

User Roles: Sysadmin, IT User, Manager or Agent

Method: GET /configuration/termCodes/{id}

Parameters:  

Path/Query Parameter NameVariable NameTypeMandatory?Description
idtermCodeIdInteger (ID)YesThe ID of the Term Code you want to query.

Body:

None

Response Code: 200 OK

Body:

Key or AttributeTypeMandatory?Description
termCodeNameStringYesThe name of the Term Code.
serviceIdInteger (ID)YesThe Service to which the Term Code is associated.
termCategoryIdInteger (ID)YesThe internal LiveVox ID of the category associated with the Term Code. Categories are used to group together similar Term Codes.
termCategoryNameStringYesName of the Term Code category.
lvResultIdInteger (ID)YesThe internal LiveVox ID of the result associated with the Term Code (sometimes referred to as the "TFH Result").
resultNameStringYesA user-friendly name for the result associated with the Term Code.
actionEnumYesIndicates whether the call should be disconnected, or a message should be left, after the Term Code  is selected by an agent. Must be either DISCONNECT_CALL or LEAVE_MESSAGE.
reportOrderIntegerYesThe order in which the Term Code will appear in the Call Detail Record
previewDialEnabledBooleanNoIf set to true, the agent is presented with a text box after they select the Term Code. The agent enters a follow up phone # which is immediately dialed.

Read an existing Term Code

#Request (JSON)
GET /configuration/termCodes/1197098
Host: localhost.com
Content-Type: application/json
Accept: application/json
 
#Response (JSON)
200 OK
Content-Type: application/json
 
{
   "termCodeName": "Debtor Dispute",
   "serviceId": 20575,
   "termCategoryId": 13150,
   "termCategoryName": "Sale",
   "lvResultId": 722,
   "resultName": "AGENT - Debtor Dispute",
   "action": "DISCONNECT_CALL",
   "reportOrder": 3,
   "previewDialEnabled": false
}
CODE

Attempt to read a Term Code that doesn't exist

#Request
GET /configuration/termCodes/654366
Host: localhost.com
Content-Type: application/json
Accept: application/json
 
#Response
404 Not Found
CODE

Read Term Code Category

Description: Retrieve details about a specific Term Code Category. This may either be a LiveVox-wide Term Code Category or one specific to the Client for whom the user has permission.

User Roles: Sysadmin, IT User, Manager or Agent

Method: GET /configuration/termCodes/categories/{id}

Parameters:

Path/Query Parameter NameVariable NameTypeMandatory?Description
idcategoryIdInteger (ID)YesThe Term Code Category for which you want to retrieve details.

Body:

None

Key or AttributeTypeMandatory?Description
idInteger (ID)YesID of the Term Code Category you want to read
nameStringYes

Display name of the Term Code Category

clientIdInteger (ID)NoID of the LiveVox Client under which the Term Code Category is configured. If this key is omitted from the response, it means that the Term Code Category is a system-wide category available to all Clients.

Read the details of a Term Code Category

#Request (JSON)
GET /configuration/termCodes/categories/21638
Host: localhost.com
Content-Type: application/json
Accept: application/json
 
#Response (JSON)
200 OK
Content-Type: application/json
 
{
   "id": 21638,
   "name": "Successful Outcome",
   "clientId": 4199
}
CODE

Update Term Code

Description: Updates information for a Term Code.

User Roles: Sysadmin or IT User

Method: PUT /configuration/termCodes/{id}

Parameters:

Path/Query Parameter NameVariable NameTypeMandatory?Description
idtermCodeIdInteger (ID)YesThe ID of the Term Code you want to update.

Body :

Key or Attribute

Type

Mandatory?

Description

name

String

No

The name of the Term Code.

serviceId

Integer (ID)

No

The Service to which the Term Code is associated.

You can assign an existing Term Code to a new Service by providing an updated value for this key, but bear in mind that the there can only be one Term Code assigned to a given LV Result ID, per Service. Thus, if you try to update the Service ID of a Term Code and the LV Result ID associated with the Term Code is already associated to another Term Code under that new Service, your request will return a fault.

termCategoryId

Integer (ID)

No

The internal LiveVox ID of the category associated with the Term Code. Categories are used to group together similar Term Codes.

lvResultId

Integer (ID)

No

The internal LiveVox ID of the result associated with the Term Code (sometimes referred to as the "TFH Result").

action

Enum

No

Indicates whether the call should be disconnected, or a message should be left, after the Term Code   is selected by an agent. Must be either DISCONNECT_CALL or LEAVE_MESSAGE .

reportOrder

Integer

No

The order in which the Term Code will appear in the Call Detail Record

previewDialEnabled

Boolean

No

If set to true, the agent is presented with a text box after they select the Term Code. The agent enters a follow up phone # which is immediately dialed.

The body of this request must include at least one key that you want to update.

Response Code: 204 No Content

Body:

None

Update an existing Term Code

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

{
"termCategoryId": 13150,
"reportOrder": 4
}

#Response (JSON)
204 No Content
CODE

Invalid request to update an existing Term Code

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

{
"termCategoryId": 13150,
"reportOrder": 4
}

#Response (JSON)
400 Bad Request
CODE

Update Term Code Category

Description: Updates the name of a Term Code Category.

User Roles: Sysadmin or IT User

Method: PUT /configuration/termCodes/categories/{id}

Parameters:

Path/Query Parameter NameVariable NameTypeMandatory?Description
idcategoryIdInteger (ID)YesThe ID of the Term Code Category you wish to update

Body:

Key or AttributeTypeMandatory?Description
nameStringYes

The updated display name of the Term Code Category. There may not be more than one Term Code Category within the same Client, with the same name.

Response Code: 204 No Content

Body:

None

Update a Term Code Category

#Request (JSON)
PUT /configuration/termCodes/categories/2636
Host: localhost.com
Content-Type: application/json
Accept: application/json
 
{
"name":"Successful Outcome 2"
}
 
#Response (JSON)
204 No Content
Content-Type: application/json
 
CODE

Top of Page