API Server Parameters and Data Types
The NICE Uptivity API Server can be utilized by any program that can communicate over HTTP. It is important to understand parameters and their associated data type values to achieve the desired results when creating and sending commands.
For more information, see API Overview.
Parameter Definitions
- 0 — On Hook
- 1 — Off Hook
- 2 — Recording
- 3 — Playback
- 4 — Waiting
- 5 — Error
- 6 — Resetting
- 7 — Recording Prep
- 8 — Finish Recording
- 9 — Dialing For Playback
- STATIONNAME may be passed as the required item in place of DEVICEID in CALLSTART. If DEVICEID is not passed or is passed as a blank value, NICE Uptivity will look up the DEVICEID based on the value from the COMPUTERNAME field.
- You may also pass the STATIONNAME to override the station mapping that is stored in the recording database for the DEVICEID. This allows you to define your station mappings externally without having to store them in the local NICE Uptivity system database.
agent_id | ani | archive_action_id | audio_hash | audio_size |
Calldirection | callid | channel | device_alias | device_id |
dnis | duration | filename | filename_video | gate |
globalid | Ident | keepdays | locked | listenedto |
mediaLabel | overridden | priority | qa_forms | qa_group_id |
qa_poss_score | qa_score | recording_time | recording_type | screen_capture |
sgroup | user1 | user2 | user3 | user4 |
user5 | user6 | user7 | user8 | user9 |
user10 | user11 | user12 | user13 | user14 |
user15 | video_hash | video_size | wrap_duration |
(**) Updates to these fields using some special characters and symbols may not work correctly. Test all possible characters needed before using this function.
Data Type Values
Charts in this section specify how data is stored in the NICE Uptivity database. REQUEST and RESPONSE XML messages to and from the API Server pass these values as strings. The API converts the items to the appropriate data type when writing values to the database.
Call Handling Data Types
Functions: CALLSTART, CALLSTOP, CALLUPDATE,RECORDSTART, RECORDSTOP
Parameter |
Value Type |
REQUESTID |
integer (signed 32-bit) |
DEVICEID |
char(64) |
CALLINSTANCE |
TBD |
DEVICEALIAS |
char(15) |
GROUP |
char(20) |
GATE |
char(20) |
ANI |
char(20) |
DNIS |
char(20) |
USER1-USER3 |
varchar(20) |
USER4-USER8 |
varchar(255) |
USER9-USER15 |
varchar(50) |
CALLID |
char(16) |
PRIORITY |
integer (signed 32-bit) |
CALLDIRECTION |
char(1) (‘I’,’O’,’?’) |
MAXRECORDSILENCE |
integer (signed 32-bit) |
MAXRECORDTIME |
integer (signed 32-bit) |
AGENTINITIATED |
char(1) (‘Y’,’N’) |
CTIINITIATED |
char(1) (’Y’,’N’) |
STATIONNAME |
char(50) |
UPDATE_IF_NOT_RECORDING |
char(1) (‘Y’,’N’) |
ARCHIVEACTION |
bigint(8) |
SYS_USER |
char(30) |
CRM_USER |
char(30) |
KEEPDAYS |
TBD |
Status Data Types
Functions: DEVICELIST, DEVICESTATUS, DEVICERECORDINGSTATUS
Parameter |
Value Type |
REQUESTID |
integer (signed 32-bit) |
DEVICEID |
char(64) |
DEVICEALIAS |
char(15) |
SYS_USER |
char(30) |
CALLDISCRIMINATOR |
char(64) |
CRM_USER |
char(30) |
GROUP |
char(20) |
GATE |
char(20) |
ANI |
char(20) |
DNIS |
char(20) |
USER1-USER3 |
varchar(20) |
USER4-USER8 |
varchar(255) |
USER9-USER15 |
varchar(50) |
CALLDIRECTION |
char(1) (‘I’,’O’,’?’) |
ISTRUNK |
Boolean |
STATION |
char(128) |
ISRECORDING |
Boolean |
FILENAME |
char(255) |
CALLID |
char(30) |
Function: SYSTEMSTATUS
Parameter |
Value Type |
REQUESTID |
integer (signed 32-bit) |
RECORDINGPATH |
string |
RECORDINGSPACEINFO |
string |
RECORDINGTOTALDISKCAPACITY |
float |
RECORDINGTOTALDISKFREE |
float |
RECORDINGTOTALDISKFREEPCT |
float (%2f) |
SYSTEMPROCESSORSPEED |
string |
SYSTEMPROCESSORTYPE |
string |
SYSTEMRAMTOTAL |
integer (signed 64-bit) |
SYSTEMRAMFREE |
integer (signed 64-bit) |
SYSTEMRAMUSEDPCT |
integer (unsigned 32-bit) |
SYSTEMUPTIME |
String |
Function: CHANNELS
Parameter |
Value Type |
REQUESTID |
integer (signed 32-bit) |
COUNT |
Integer (signed 32-bit) |
ID |
integer (signed 32-bit) |
STATE |
String |
LASTSTATECHANGE |
String |
LASTSTATECHANGEUNIXTIME |
String |
Function: STATIONS
Parameter |
Value Type |
REQUESTID |
integer (signed 32-bit) |
COUNT |
integer (signed 32-bit) |
STATIONNAME |
char(50) |
DEVICEID |
char(64) |
Function: FETCHTERMINOLOGY
Parameter |
Value Type |
REQUESTID |
integer (signed 32-bit) |
COUNT |
integer (signed 32-bit) |
NAME |
varchar(255) |
VALUE |
varchar(255) |
Function: CALLLIST
Parameter |
Value Type |
REQUESTID |
integer (signed 32-bit) |
DEVICEID |
char(64) |
CRM_USER |
char(30) |
SYS_USER |
char(30) |
DEVICEALIAS |
char(15) |
GROUP |
char(20) |
GATE |
char(20) |
ANI |
char(20) |
DNIS |
char(20) |
CALLCOUNT |
NA |
CALLDATESTART |
bigint(8) |
CALLDATEEND |
bigint(8) |
USER1- USER3 |
varchar(20) |
USER4-USER8 |
varchar(255) |
USER9- USER15 |
varchar(50) |
Recording Control Data Types
Function: CHATSTART, CHATSTOP, CHATUPDATE
Parameter |
Value Type |
REQUESTID |
integer (signed 32-bit) |
SESSIONID |
char(255) |
AGENTID (USERID) |
integer (signed 32-bit) |
KEYNAME |
string values USERNAME, EMPLOYEEID |
KEYVALUE |
char(255) |
DEVICEALIAS |
char(15) |
GROUP |
char(20) |
GATE |
char(20) |
ANI |
char(20) |
DNIS |
char(20) |
USER1-USER3 |
varchar(20) |
USER4-USER8 |
varchar(255) |
USER9-USER15 |
varchar(50) |
CALLDIRECTION |
char(1) (‘I’,’O’,’?’) |
CALLID |
char(16) |
Function: BLACKOUTSTART, BLACKOUTSTOP
Parameter |
Value Type |
REQUESTID |
integer (signed 32-bit) |
DEVICEID |
varchar(64) |
DEVICEALIAS |
varchar(100) |
CRM_USER |
varchar(50) |
SYS_USER |
varchar(255) |
CALLINSTANCE |
TBD |
Import Data Types
Function: IMPORTUSER, IMPORTAGENTPHONE, IMPORTWORKSTATION
Parameter |
Value Type |
REQUESTID |
integer (signed 32-bit) |
ACTION |
string values ADD, DELETE, MODIFY |
AGENTID |
integer (signed 32-bit) |
FIRSTNAME |
char(20) |
LASTNAME |
char(30) |
SYS_USER |
varchar(255) |
DOMAIN |
char(30) |
|
char(255) |
EMPLOYEEID |
char(20) |
ALLOWSELFRECORD |
char(1) (‘Y’,’N’) |
ALLOWSELFDOWNLOAD |
char(1) (‘Y’,’N’) |
ALLOWDUPLICATE |
char(1) (‘Y’,’N’) |
STATUS |
char(1) (‘A’ - Active, ’I’ - Inactive) |
SYS_DOMAIN |
TBD |
SITE_ID |
TBD |
MOBILE_ID |
TBD |
PHONEID |
char(10) |
DEVICEID |
char(15) |
STATIONNAME |
char(50) |
LOCATIONID |
integer (signed 32-bit) |
User, Group and Role Data Types
Function: ADDGROUP, MODIFYGROUPPERMISSION, MODIFYUSERGROUPPERMISSION
Parameter |
Value Type |
REQUESTID |
integer (signed 32-bit) |
ACTION |
string values ADD, MODIFY |
GROUPNAME |
char(255) |
GROUPID |
integer (signed 32-bit) |
DEVICEID |
char(64) |
USERNAME |
char(16) |
PHONEID |
char(10) |
FIRSTNAME |
char(20) |
LASTNAME |
char(30) |
AGENTID |
integer (signed 32-bit) |
Function: EMAIL, COMBINEDEMAIL
Parameter |
Value Type |
REQUESTID |
integer (signed 32-bit) |
UNIQUEFIELD |
varchar(255) |
UNIQUEID |
varchar(255) |
TOADDRESS |
varchar(255) |
TONAME |
varchar(255) |
FROMADDRESS |
varchar(255) |
FROMNAME |
varchar(255) |
MEDIA_FORMAT |
varchar(3) |
IDENT |
varchar(255) |
Function: AGENTWINDOW
Parameter |
Value Type |
REQUESTID |
integer (signed 32-bit) |
COMPUTERNAME |
varchar(255) |
USERNAME |
varchar(255) |
DOMAIN |
varchar(255) |
IPADDRESS |
varchar(255) |
STATUS |
varchar(255) |
APPLICATIONTITLE |
varchar(255) |
LASTUPDATE |
varchar(255) |
See Also
- API Server Commands — for information on how to send commands to the API Server
- API Server Event Interface — for an introduction to writing XML API requests
- API Server Command Results — for an explanation of API responses, formatting, and how to interpret the output
- API Server Web API Service — for information on sending requests to the API using HTTP