Jump to: navigation, search

GetCategorizedInteractions

URL

  • GET /OMInteractions/GetCategorizedInteractions/

Request

Parameters

Key ValueType Value Description Mandatory Unique Default
TenantId Integer The TenantId true true
SubscriberId String The subscriber (line of business) within the tenant to which the interactions belong false true
StartPeriod String The start period date in ISO8601 Date Format true true
EndPeriod String The start period date in ISO8601 Date Format true true
PageMaxSize Integer Maximum scroll page size false true 2147483647
OwnerIds KVList KVList of Strings (must be long or int) representing DBIds of the optional owners false true
MediaType String Media type as defined in configuration (like email, sms, chat and so on). Passing the special value $all$ will return all interaction types. Note that due to legacy compatibility, not passing the MediaType has the same effect as passing $all$. false true

Success

Parameters

Key ValueType Value Description Mandatory Unique Default
HasNext String true or false If true it means a cursor has been opened to allow call to InteractionListGetNextPage and InteractionListRelease. true true
ScrollId String If HasNext=true, the Id of the scrollable cursor. To be used with InteractionListGetNextPage and InteractionListRelease. false true
InteractionData KVList The keys are integers starting from 0, values are KVList like below where Id is interaction Id. Subject and OwnerId are not returned if corresponding interaction fields are null.

InteractionData={ 0={ Attributes={ Text=My text 0 CategoryId = 00001a8VG06Q003T StartDate = 2013 - 06 - 12T08:54:29.000Z Subject = My email inbound OwnerId=2301 } Id = 0002Ha8UNN5G0013 } 1={ Attributes={ Text=My text 1 CategoryId = 00001a8VG06Q003S StartDate = 2013 - 04 - 14T08:51:29.000Z OwnerId = 2301 } Id = 0002Ha8UNN5G0015 } }

false true
PageSize Integer Number of element returned in the page true true


Error

FaultCode FaultString Description
204 Incorrect value for parameter {0}, expected {1} but was {2} Incorrect value for parameter
510 {0} not found in database Record is not found in database

Feedback

Comment on this article:

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