Jump to: navigation, search

UpdateInteraction

Purpose

This method is intended for updating of interaction attributes and binary content.

URL

  • PUT /OMInteractions/UpdateInteraction/

Request

Parameters

Key ValueType Value Description Mandatory Unique Default
InteractionAttributes KVList The list of attributes and their values, which have to be updated. KVList format described in OMInteractions / InsertInteraction. If MediaServer specific parameters must be updated, then EntityTypeId is also required. Attributes which are declared as mandatory in InsertInteraction method description and attributes CanBeParent, CreatorAppId, StartDate must have a not null value if passed in UpdateInteraction. Id and TenantId are mandatory attributes.

EntityTypeId is required if MediaServer specific parameters are updated. Id, TenantId, SubscriberId, MediaTypeId and EntityTypeId are immutable attributes. They should never be set to a new value.

true true
EntityAttributes KVList The list of Entity specific attributes and their values, which have to be updated. KVList format described in OMInteractions / InsertInteraction. Attributes which are declared as mandatory in InsertInteraction method description must have a not null value if passed in UpdateInteraction. Mandatory if EntityTypeId = 0, 1, 2, 3, 5, or 6. false true
InteractionContent KVList Information to update binary content. KVList format described in OMInteractions / InsertInteraction. Attributes which are declared as mandatory in InsertInteraction method description must have a not null value if passed in UpdateInteraction. false true
InteractionContentSentReceived KVList Important—Introduced to support specifically ESJ MIME Customization. KVList format described in OMInteractions / InsertInteraction. false true
DeleteAllAttachmentsBefore String Important—(For ESJ only) Introduced to support ESJ insert interaction with attachments, delete all previous attachments before adding new ones. false true false
Attachments KVList Important—(For ESJ only) Introduced to support ESJ insert interaction with attachments. The list of attachments for this interaction. false true
Action String **Deprecated** (was applicable to CoBrowse records) false true

[RG]UCS will distinguish between:(AttributeName) key not present (meaning no update required for this attribute)and (AttributeName)= null(meaning this attribute must be updated with a null value-the attribute must be nullable!)

InteractionAttributes

Key ValueType Value Description Mandatory Unique Default
TypeId String Interaction Type value (must be declared in ConfigServer)

Max.length: 32 characters

false true
StartDate String Formatted String using Date pattern (in format "yyyy-MM-ddTHH:mm:ss.SSSZ") false true Current UCS date
EndDate String Formatted String using Date pattern (in format "yyyy-MM-ddTHH:mm:ss.SSSZ") false true
TheComment String false true
Subject String false true
CanBeParent String false true
ContactId String false true
CreatorAppId Integer false true
Status Integer Must be one of 0 (NEW), 1 (PENDING), 2 (IN_PROCESS), 3 (STOPPED) false true
Timeshift Integer false true
CategoryId String Max. length: 16 characters false true
SubtypeId String Max. length: 32 characters false true
ExternalId String Max. length: 256 characters false true
ThreadId String Max. length: 16 characters false true
IsCategoryApproved String Value can be true or false false true
StoppedReason String Max. length: 64 characters false true
Lang String Max. length: 64 characters false true
QueueName String Max. length: 64 characters false true
IsSpam String Value can be true or false false true
WebSafeEmailStatus String Max. length: 32 characters false true
OwnerId Integer false true
AllAttributes KVList User data key/value pairs false true
EntityTypeId Integer Possible values are:

0:EmailIn 1:EmailOut 2:Chat 3:PhoneCall 5:Callback 6:CoBrowse (deprecated) 7:Interaction

false true

Error

FaultCode FaultString Description
510 {0} not found in database Interaction with Id=(InteractionId) is not found in database
732 Invalid Tenant {0} Provided tenant is not configured in UCS

Feedback

Comment on this article:

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