Jump to: navigation, search

GetInteractionsForContact

Purpose

This method is intended for delivering of all of or some (depending on the filtering) of the interactions for the contact in question.The aim of this method is to provide the Interaction history.

It returns only attributes from the Interaction table. This is because it is not possible to get MediaServer specific attributes (which are scattered in multiple tables) in one request. Specific MediaServer attributes can be retrieved individually by calling the GetInteractionContent method.

URL

  • GET /OMInteractions/GetInteractionsForContact/


Request

Parameters

Key ValueType Value Description Mandatory Unique Default
ContactId String Unique contact Id, whose interactions requested

Max length: 16 characters

true true
DataSource String Ignored in 9.0 false false
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
TenantId Integer The Tenant of the Contact and its Interactions false true Contact Tenant if not specified
SubscriberId String Importantβ€”The subscriber (line of business) within the tenant to which the contact belongs false true


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 StringInteger The value type of the "AttrName" parameter depends on the searchable attribute. false true


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 attribute name. The name of an Interaction Attribute. If no AttrName parameter is specified, only default AttributeList is returned. false false


Sample

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

Success

Parameters

Key ValueType Value Description Mandatory Unique Default
ContactInteractions KVList List of interactions, related to contact in question false true


ContactInteractions 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, starts with 0 false true


KVList

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


Attributes KVList

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

The value type depends on attribute as described in OMInteractions / InsertInteraction.

false true


Sample

ContactInteractions 0 Id (InteractionId-1)
Attributes (AttributeName-1) AttributeValue1
(AttributeName-2) AttributeValue2
1 Id (InteractionId-2)
Attributes (AttributeName-1) AttributeValue
(AttributeName-2); AttributeValue2

Feedback

Comment on this article:

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