Jump to: navigation, search
(Auto-creation of topic Documentation:HTCC:Dev:InteractionNamespace:8.5.2DRAFT via TOC Documentation:HTCC:DevTOC8.5.2DRAFT)
 
Line 1: Line 1:
−
= InteractionNamespace=
+
= Interaction Namespace=
 +
__TOC__
 +
==Methods==
 +
===attachUserData===
 +
{|
 +
! Signature
 +
| <static> attachUserData(''interactionId'', ''keyValues'')
 +
|-
 +
! Description
 +
| Attaches key/value pairs of user data to the live interaction.
 +
|-
 +
! Parameters
 +
|
 +
{|
 +
! Name
 +
! Type
 +
! Description
 +
|-
 +
| interactionId
 +
| string
 +
| The unique identifier for the interaction.
 +
|-
 +
| keyValues
 +
| object
 +
| The key value pairs to set on the user data.
 +
|}
 +
|}
 +
 
 +
===deleteUserData===
 +
{|
 +
! Signature
 +
| <static> deleteUserData(''interactionId'', ''key'')
 +
|-
 +
! Description
 +
| Deletes the user data attached to the interaction.
 +
|-
 +
! Parameters
 +
|
 +
{|
 +
! Name
 +
! Type
 +
! Description
 +
|-
 +
| interactionId
 +
| string
 +
| The unique identifier for the interaction.
 +
|-
 +
| key
 +
| string
 +
| The key to delete from the attached data.
 +
|}
 +
|}
 +
 
 +
===getByInteractionId===
 +
{|
 +
! Signature
 +
| <static> getByInteractionId(''interactionId'') → {[[InteractionNamespace#Interaction|interaction.Interaction]]}
 +
|-
 +
! Description
 +
| Gets an interaction by its unique identifier.
 +
|-
 +
! Parameters
 +
|
 +
{|
 +
! Name
 +
! Type
 +
! Description
 +
|-
 +
| interactionId
 +
| string
 +
| The unique identifier for the interaction.
 +
|}
 +
|-
 +
! Return Type
 +
| [[InteractionNamespace#Interaction|interaction.Interaction]] or null if the interaction doesn't exist.
 +
|}
 +
 
 +
===getInteractions===
 +
{|
 +
! Signature
 +
| <static> getInteractions() → {Array.<[[InteractionNamespace#Interaction|interaction.Interaction]]>}
 +
|-
 +
! Description
 +
| Gets all the interactions.
 +
|-
 +
! Return Type
 +
| Array.<[[InteractionNamespace#Interaction|interaction.Interaction]]>
 +
|}
 +
 
 +
===updateUserData===
 +
{|
 +
! Signature
 +
| <static> updateUserData(''interactionId'', ''keyValues'')
 +
|-
 +
! Description
 +
| Updates the user data on the live interaction.
 +
|-
 +
! Parameters
 +
|
 +
{|
 +
! Name
 +
! Type
 +
! Description
 +
|-
 +
| interactionId
 +
| string
 +
| The unique identifier for the interaction.
 +
|-
 +
| keyValues
 +
| object
 +
| The key value pairs to set on the user data.
 +
|}
 +
|}
 +
 
 +
==Type Definitions==
 +
===Interaction===
 +
{|
 +
! Description
 +
| Represents the JSON structure of an interaction. Specific attributes to voice interaction are: callUuid, direction, callType, ani, dnis and recordingState.
 +
|-
 +
! Type
 +
| Object
 +
|-
 +
! Properties
 +
|
 +
{|
 +
! Name
 +
! Type
 +
! Description
 +
|-
 +
| interactionId
 +
| string
 +
| The unique identifier for the interaction.
 +
|-
 +
| parentInteractionId
 +
| string
 +
| The unique identifier for the parent interaction.
 +
|-
 +
| caseId
 +
| string
 +
| This identifier targets the case that this interaction is part of.
 +
|-
 +
| userData
 +
| object
 +
| The attached user data key/value object that is updated with each interaction event.
 +
|-
 +
| state
 +
| string
 +
| The current state of the interaction.
 +
|-
 +
| previousState
 +
| string
 +
| The previous state of the interaction.
 +
|-
 +
| parties
 +
| Array.<[[InteractionNamespace#Party|interaction.Party]]>
 +
| A collection of all the parties involved in the interaction.
 +
|-
 +
| isConsultation
 +
| boolean
 +
| This property is true if the interaction is a consultation; otherwise, it's false.
 +
|-
 +
| isMainCaseInteraction
 +
| boolean
 +
| This property is true if the interaction is the main interaction in the customer case; otherwise, it's false. In Workspace Web Edition, the main interaction is related to Case Information, Disposition, Note, Contact Profile, and so on.
 +
|-
 +
| startDate
 +
| integer
 +
| The number of milliseconds between midnight of January 1, 1970, and when the interaction was created.
 +
|-
 +
| callUuid
 +
| string
 +
| The UUID of the call.
 +
|-
 +
| direction
 +
| string
 +
| The call direction. Possible values are: IN, OUT or UNKNOWN.
 +
|-
 +
| callType
 +
| string
 +
| The call type. Possible values are: INTERNAL, INBOUND, OUTBOUND, CONSULT or UNKNOWN.
 +
|-
 +
| ani
 +
| string
 +
| The Automatic Number Identification service.
 +
|-
 +
| dnis
 +
| string
 +
| The Dialed Number Identification Service.
 +
|-
 +
| recordingState
 +
| string
 +
| The call recording state. Possible values are: STOPPED, RECORDING or PAUSED.
 +
|}
 +
|}
 +
 
 +
===Party===
 +
{|
 +
! Description
 +
| Represents the JSON structure of a party.
 +
|-
 +
! Type
 +
| Object
 +
|-
 +
! Properties
 +
|
 +
{|
 +
! Name
 +
! Type
 +
! Description
 +
|-
 +
| name
 +
| string
 +
| The name of the party.
 +
|}
 +
|}
 +
 
 +
 
 +
 
  
 
[[Category:V:HTCC:8.5.2DRAFT]]
 
[[Category:V:HTCC:8.5.2DRAFT]]

Revision as of 18:00, July 14, 2015

Interaction Namespace

Methods

attachUserData

Signature <static> attachUserData(interactionId, keyValues)
Description Attaches key/value pairs of user data to the live interaction.
Parameters
Name Type Description
interactionId string The unique identifier for the interaction.
keyValues object The key value pairs to set on the user data.

deleteUserData

Signature <static> deleteUserData(interactionId, key)
Description Deletes the user data attached to the interaction.
Parameters
Name Type Description
interactionId string The unique identifier for the interaction.
key string The key to delete from the attached data.

getByInteractionId

Signature <static> getByInteractionId(interactionId) → {interaction.Interaction}
Description Gets an interaction by its unique identifier.
Parameters
Name Type Description
interactionId string The unique identifier for the interaction.
Return Type interaction.Interaction or null if the interaction doesn't exist.

getInteractions

Signature <static> getInteractions() → {Array.<interaction.Interaction>}
Description Gets all the interactions.
Return Type Array.<interaction.Interaction>

updateUserData

Signature <static> updateUserData(interactionId, keyValues)
Description Updates the user data on the live interaction.
Parameters
Name Type Description
interactionId string The unique identifier for the interaction.
keyValues object The key value pairs to set on the user data.

Type Definitions

Interaction

Description Represents the JSON structure of an interaction. Specific attributes to voice interaction are: callUuid, direction, callType, ani, dnis and recordingState.
Type Object
Properties
Name Type Description
interactionId string The unique identifier for the interaction.
parentInteractionId string The unique identifier for the parent interaction.
caseId string This identifier targets the case that this interaction is part of.
userData object The attached user data key/value object that is updated with each interaction event.
state string The current state of the interaction.
previousState string The previous state of the interaction.
parties Array.<interaction.Party> A collection of all the parties involved in the interaction.
isConsultation boolean This property is true if the interaction is a consultation; otherwise, it's false.
isMainCaseInteraction boolean This property is true if the interaction is the main interaction in the customer case; otherwise, it's false. In Workspace Web Edition, the main interaction is related to Case Information, Disposition, Note, Contact Profile, and so on.
startDate integer The number of milliseconds between midnight of January 1, 1970, and when the interaction was created.
callUuid string The UUID of the call.
direction string The call direction. Possible values are: IN, OUT or UNKNOWN.
callType string The call type. Possible values are: INTERNAL, INBOUND, OUTBOUND, CONSULT or UNKNOWN.
ani string The Automatic Number Identification service.
dnis string The Dialed Number Identification Service.
recordingState string The call recording state. Possible values are: STOPPED, RECORDING or PAUSED.

Party

Description Represents the JSON structure of a party.
Type Object
Properties
Name Type Description
name string The name of the party.
Comments or questions about this documentation? Contact us for support!