Jump to: navigation, search

InteractionListGet

Purpose

This method provides a ScrollableList of interactions, filtered by constraints and sorted using criteria.

URL

  • GET /OMInteractions/InteractionListGet/

Request

Parameters

Key ValueType Value Description Mandatory Unique Default
TenantId Integer true true
SubscriberId String The subscriber (i.e. line of business) within the tenant to which the interactions belong false true
PageMaxSize Integer If no value is provided, UCS configured value (schema/select-limit) is used. false true (schema/select-limit)
DataSource String Ignored in 9.0 false false
EntityTypeId Integer Possible values are: 0: EmailIn, 1: EmailOut, 2: Chat, 3: PhoneCall, 5: Callback, 6: CoBrowse (deprecated), 7: Interaction (default) false true 7: Open Media Interaction

If no set, entity specific information cannot be searched, but it is returned.

ESQuery String Raw Lucene Query. If present, overrides both SearchCriteria and SortCriteria. false true
SearchCriteria KVList No filtering if not present false true
SortCriteria KVList No ordering if not present false true
AttributeList KVList The list of attributes, which have to be delivered with each interaction false true

Please refer to www.elastic.co/guide/en/elasticsearch/reference/1.7/query-dsl.html for a description of the ESQuery possible values

SearchCriteria KVList. SimpleConstraint KVList

Key ValueType Value Description Mandatory Unique Default
(Operator) KVList true true

(Operator) = EQUAL, NOT_EQUAL, GREATER, GREATER_OR_EQUAL, LESSER, LESSER_OR_EQUAL or LIKE

KVList

Key ValueType Value Description Mandatory Unique Default
AttrName String The name of a searchable Interaction Attribute. true true
AttrValue String The value type of the "AttrName" parameter depends on the searchable attribute. false true


SearchCriteria KVList. ComplexConstraint KVList

Key ValueType Value Description Mandatory Unique Default
(Operator) KVList One instance for NOT operator, more than one instances for AND or OR operators true false

(Operator) = NOT, AND or OR KVList value detail is conform to SimpleConstraint or ComplexConstraint KVList definition

SortCriteria KVList

Key ValueType Value Description Mandatory Unique Default
(Sort Index) KVList false true


KVList

Key ValueType Value Description Mandatory Unique Default
Operator String Can have value of "ASC" or "DSC". true true
AttrName String The name of a searchable Interaction Attribute. true true


AttributeList KVList

Key ValueType Value Description Mandatory Unique Default
AttrName String String value represents `the name of an Interaction Attribute.

If no AttrName parameter is specified, only default "AttributeList" is returned.

false false


Sample

TenantId 102
SearchCriteria AND EQUAL AttrName Status
AttrValue 2
AND NOT_EQUAL AttrName ThreadId
AttrValue WX345SBGA34TFGGS
SortCriteria 0 Operator ASC
AttrName StartDate
AttributeList AttrName Id
AttrName TypeId
AttrName SubtypeId

Sample

TenantId 102
Segment Airbnb
SearchCriteria EQUAL AttrName ESQuery
AttrValue +ThreadId:WX345SBGA34TFGGS +Status:2
AttributeList AttrName Id
AttrName TypeId
AttrName SubtypeId

Sample

TenantId 102
Segment Airbnb
ESQuery +ThreadId:WX345SBGA34TFGGS +Status:2
AttributeList AttrName Id
AttrName TypeId
AttrName SubtypeId

Sample

TenantId 102
Segment Airbnb
ESQuery { "query" : { "bool" : {"must" : { "term" : { "ThreadId" : "WX345SBGA34TFGGS" } },"must_not" : { "range" : { "Status" : { "from" : 1, "to" : 3 } }} } }
AttributeList AttrName Id
AttrName TypeId
AttrName SubtypeId

Success

Parameters

Key ValueType Value Description Mandatory Unique Default
ScrollId String ScrollableList Id This id is used to call LookupNextPage.

not available if HasNext is false

false true
PageSize Integer The number of Contacts available in this page true true
HasNext String true or false Indicates more records are available (using method LookupNextPage).

If true: CloseLookup method is to be called after iteration If false: UCS automatically closes the list and there is no need to call CloseLookup method

true true
InteractionData KVList false true


InteractionData KVList

Key ValueType Value Description Mandatory Unique Default
(Interaction Index) KVList (Interaction Index) is a String representation of an integer index used to maintain Interactions ordering false true


KVList

Key ValueType Value Description Mandatory Unique Default
Id String Interaction Id false true
Attributes KVList The list of interaction attributes. Attribute "Id" is never delivered with this list even if requested directly in AttributeList. false true


KVList

Key ValueType Value Description Mandatory Unique Default
(AttributeName) StringInteger (Attribute Name) is the name of the attribute as specified in the request. true true


Error

FaultCode FaultString Description
201 Missing parameter 'SubscriberId' SubscriberId was not provided but is a required parameter.
533 Invalid ES Query Provided ESQuery is malformed
732 Invalid Tenant {0} Provided tenant is not configured in UCS
921 SubscriberId '{0}' is invalid or not active. The provided SubscriberId is not valid.

Feedback

Comment on this article:

blog comments powered by Disqus
This page was last modified on May 18, 2018, at 07:05.