Jump to: navigation, search

FindOrCreatePhoneCall

Purpose

Finds an existing PhoneCall object or, if no matching record is found, creates a new one.

URL

  • POST /OMInteractions/FindOrCreatePhoneCall/

Request

Parameters

Key ValueType Value Description Mandatory Unique Default
Id String Phone Call identifier,

Max length: 16 characters

false true UCS generated Id
Duration Integer false true
OutCome String Max. length: 100 characters false true
PhoneNumber String Max. length: 30 characters false true
TConnectionId String Max. length: 16 characters true true
OwnerId Integer true true
TenantId Integer Tenant value true true
SubscriberId String The subscriber (line of business) within the tenant to which the interaction should belong false true
CanBeParent String This attribute is mandatory in MCR DB but UCS provides a default value if no value is provided false true true
CreatorAppId Integer This attribute is mandatory in MCR DB but UCS provides a default value if no value is provided false true UCS DBID
TypeId String Interaction Type value (must be declared in ConfigServer)

Max length: 32 characters

true true
StartDate String Formatted String using Date pattern (in format "yyyy-MM-ddTHH:mm:ss.SSSZ")

This attribute is mandatory in MCR DB but UCS provides a default value if no value is provided

false true Current UCS date
Status Integer Must be one of 0 (NEW), 1 (PENDING), 2 (IN_PROCESS), 3 (STOPPED) true true
Timeshift Integer false true
CategoryId String Max. length: 16 characters false true
SubtypeId String Interaction Sub Type value (must be declared in ConfigServer)

Max length: 32 characters

false true
ExternalId String Max length: 256 characters false true
ThreadId String Max length: 16 characters false true
Subject String Max length: 512 characters false true
IsCategoryApproved String Value can be true or false false true
StoppedReason String Max. length: 64 characters false true
ContactId String Max. length: 16 characters false true
ParentId String Max. length: 16 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
TheComment String false true
EndDate String Formatted String using Date pattern (in format "yyyy-MM-ddTHH:mm:ss.SSSZ") false true
AllAttributes KVList User data key/value pairs false true

Success

Parameters

Key ValueType Value Description Mandatory Unique Default
Id String PhoneCall Id false true
IsCreated String true or false true if a Phone Call record has been created as a result of this call, false otherwise false true


Error

FaultCode FaultString Description
201 Missing parameter 'SubscriberId' SubscriberId was not provided but is a required parameter.
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.