Get Preferences
Use the get preferences request to get a list of your private and shared preferences and their details.
As mentioned previously a preference works as a saved view for the U-Capture application, this can include what metadata columns to display and in what order, as well as set a filter for that view such as a specific date/time range. Preferences can be shared (available to everyone in your organization) or private (just for one user).
Endpoint
Method: GET
URL: /preference
Response and Error Code
Response Code | Condition |
|---|---|
200 | OK |
Response Parameter
Parameter Name | Data Type | Description |
|---|---|---|
| Array | A list of the preferences available to you. Each preference usually consisting of the following parameters. |
| String | The category of the preference, this will show as |
| String | Determines if the preference is shared ( |
| Integer | The automatically generated unique ID for the preference. |
| String | A useful name for the preference (view). |
| Array | The details that determine how the preference works, what the view will show, consisting of the following parameters, |
| Array | A comma separated list of metadata fields to display as columns in the U-Capture application when using the preference. |
| Array | A filter to apply automatically apply when using the preference, for more information on filters, see Filters. |
| Number | Placeholder for future enhancements. |
| Boolean | If the user responsible for the get preferences request is the owner of the preference. Either |
Sample Response
{
"preferences": [
{
"category": "PREFERENCE_CATEGORY_VIEW_STATE",
"scope": "ACCESS_SCOPE_PRIVATE_AUTOSAVED",
"id": "14441",
"viewState": {
"fields": [
"agentFullName",
"agent.extension",
"callProperties.startDate",
"agent.location",
"agent.manager",
"agent.number"
],
"filter": {
"groupFilter": {
"leftGroupFilter": {
"leftGroupFilter": {
"leftFilter": {
"fieldName": "agent.extension",
"operator": "CONVERSATION_FILTER_OPERATOR_CONTAINS",
"stringValue": "502"
}
}
},
"operator": "CONVERSATION_LOGICAL_OPERATOR_AND",
"rightGroupFilter": {
"leftFilter": {
"fieldName": "callProperties.startDate",
"operator": "CONVERSATION_FILTER_OPERATOR_GREATER_THAN_OR_EQUAL",
"timestampValue": "2024-06-17T23:00:00Z"
},
"operator": "CONVERSATION_LOGICAL_OPERATOR_AND",
"rightFilter": {
"fieldName": "callProperties.endDate",
"operator": "CONVERSATION_FILTER_OPERATOR_LESS_THAN_OR_EQUAL",
"timestampValue": "2024-09-16T22:59:59.999Z"
}
}
},
"pageSize": "0"
}
},
"isOwner": true
},
{
"category": "PREFERENCE_CATEGORY_VIEW_STATE",
"scope": "ACCESS_SCOPE_PUBLIC",
"id": "12191",
"title": "new shared view",
"viewState": {
"fields": [
"agentFullName",
"callProperties.otherPartyName",
"conversationId",
"callProperties.startDate",
"agent.number",
"agent.manager",
"agent.location",
"agent.lastName",
"agent.id",
"agent.extension"
],
"filter": {
"groupFilter": {
"leftFilter": {
"fieldName": "callProperties.startDate",
"operator": "CONVERSATION_FILTER_OPERATOR_GREATER_THAN_OR_EQUAL",
"timestampValue": "2024-06-01T18:30:00Z"
},
"operator": "CONVERSATION_LOGICAL_OPERATOR_AND",
"rightFilter": {
"fieldName": "callProperties.endDate",
"operator": "CONVERSATION_FILTER_OPERATOR_LESS_THAN_OR_EQUAL",
"timestampValue": "2024-06-05T18:29:59.999Z"
}
},
"pageSize": "0"
}
}
}
]
}