PDF
Download PDF
Download page Screen Pops API Methods.
Screen Pops API Methods
The Configuration API supports Read, List, and Get List Info methods for Screen Pop objects. Create, Update, and Delete are not yet supported.
List Screen Pops
Description: Lists Screen Pops configured for a client.
User Roles: Sysadmin or IT User
Method: GET /configuration/screenPops
Parameters:
None
Body:
None
Response Code: 200 OK
Body:
| Key | Type | Mandatory? | Description | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| screenPop | Array | No | A container for a page of Screen Pop entries. The page size is controlled via count and offset in the request.
|
Get a list of Screen Pops for a Client
#Request (JSON)
GET /configuration/screenPops
Host: localhost.com
Content-Type: application/json
Accept: application/json
#Response
200 OK
Content-Type: application/json
{
"screenPop":
{
"id": 3063,
"name": "Default ScreenPop for 4199"
},
{
"id": 7346,
"name": "Cable Service Scriptor"
},
{
"id": 8046,
"name": "Political Survey Scriptor"
},
{
"screenPopId": 9128,
"screenPopName": "URL screen pop"
},
{
"id": 8887,
"name": "Radio Survey"
}
}
CODE
Read Screen Pop
Description: Retrieves information about a Screen Pop.
User Roles: Sysadmin or IT User
Method: GET /configuration/screenPops/{id}
Parameters:
| Path/Query Parameter Name | Variable Name | Type | Mandatory? | Description |
|---|---|---|---|---|
| id | screenPopId | Integer (ID) | Yes | The ID of the Screen Pop you want to query. |
Body:
None
Response Code: 200 OK
Body:
| Key | Type | Mandatory? | Description | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| description | String | No | The description of the Screen Pop. | ||||||||||||||||||||
| screenPopData | Array | No |
| ||||||||||||||||||||
| name | String | Yes | The name of the Screen Pop. | ||||||||||||||||||||
| clientId | Integer (ID) | No | The internal LiveVox ID of the Client to which the Screen Pop is associated. | ||||||||||||||||||||
| notesEnabled | Boolean | Yes | If set to true, the agent can enter notes on the agent desktop when in "In Call" or "Wrap Up" status. | ||||||||||||||||||||
| callRecordControlEnabled | Boolean | Yes | If set to true, the agent can control call recordings (i.e. pause, resume, stop) through the agent desktop. | ||||||||||||||||||||
| displayNotReadySubCodes | Boolean | Yes | If set to true, the agent can select a sub-code, or "break code" when changing her status to Not Ready. | ||||||||||||||||||||
acctNumberRequired | Boolean | Yes | If set to true, the agent is required to enter an Account Number when she is making a manual call or handling a callback call. | ||||||||||||||||||||
screenRecordingEnabled | Boolean | No | If set to true, the agent activity will be recorded performed on the screen when in 'In Call' or 'Wrap Up' status. | ||||||||||||||||||||
screenRecordingFrameRate | Number | No | The Internal screen recording frame rate set for the agent desktop or screen pop. | ||||||||||||||||||||
screenRecordingDaysHeld | Number | No | The Internal number of days set to retain the screen recording in the system. | ||||||||||||||||||||
designerEnabled | Boolean | No | If set to true, the agent can access designer desktop. | ||||||||||||||||||||
dotNetEnabled | Boolean | No | If set to true, the agent can access dot net enabled screen pop. | ||||||||||||||||||||
holdEnabled | Boolean | No | If set to true, the agent can control hold and unhold. | ||||||||||||||||||||
agentReadyAfterSignIn | Boolean | No | If set to true, the agent can login with 'Ready' state. | ||||||||||||||||||||
createdBy | String | No | Specifies the user created. | ||||||||||||||||||||
createdDate | Date | No | Specifies the date created. | ||||||||||||||||||||
modifiedBy | String | No | Specifies the user modified. | ||||||||||||||||||||
modifiedDate | Date | No | Specifies the user modified. |
Read the configuration properties of an existing Screen Pop
#Request (JSON)
GET /configuration/screenPops/7436
Host: localhost.com
Content-Type: application/json
Accept: application/json
#Response
200 OK
Content-Type: application/json
{
"description": "Cable Service Screen Pop",
"associatedService": [
{
"serviceId": 33114,
"name": "test_ATL_1stParty_Preview All_QC _Cable Script (8)"
},
{
"serviceId": 43185,
"name": "ATL_1st Party_Agent VM_IB (11)"
},
{
"serviceId": 20576,
"name": "ATL_1stParty_Cable_IB_8773402033 (7)"
},
{
"serviceId": 26911,
"name": "Testservice(8)"
},
{
"serviceId": 26881,
"name": "ATL_1stParty_PVAll_QC_Cable Script_VOIP (8)"
}
],
"infoField": [
{
"key": "lvtransaction_type",
"displayName": "Call Type",
"position": 1,
"delimiter": "BAR"
},
{
"key": "account",
"displayName": "Account Number",
"position": null,
"delimiter": null
},
{
"key": "patient_firstname",
"displayName": "First Name",
"position": null,
"delimiter": null
},
{
"key": "patient_lastname",
"displayName": "Last Name",
"position": null,
"delimiter": null
},
{
"key": "phone_dialed",
"displayName": "Phone Dialed",
"position": null,
"delimiter": null
}
],
"dotNetData": [ {
"key": "Account Information",
"command": "Enter",
"data": "account",
"position": 1,
"delimiter": "BAR"
}],
"name": "Cable Service Scriptor",
"clientId": 4199,
"associatedToClient": false,
"notesEnabled": false,
"callRecordControlEnabled": true,
"displayNotReadySubCodes": true,
"acctNumberRequired": true
}
CODE
Attempt to read a Screen Pop that does not exist
#Request
GET /configuration/screenPops/1234
Host: localhost.com
Content-Type: application/json
Accept: application/json
#Response
404 Not Found
CODE