Interaction Namespace
Methods
The Interaction namespace includes the following methods:
deleteUserData
| Signature
|
<static> deleteUserData(interactionId, key)
|
| Description
|
Deletes the user data attached to the interaction. The service-client-api.user-data.write-allowed option might restrict the allowed key/value pairs.
|
| 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.
|
|
| Returns
|
interaction.Interaction or null if the interaction doesn't exist.
|
getInteractions
setUserData
| Signature
|
<static> setUserData(interactionId, keyValues)
|
| Description
|
Sets the user data on the live interaction (for voice, this means the interaction is not in the IDLE state). This request overwrites any existing keys on the user data.
|
| 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
The Interaction namespace includes the following object types:
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.
|
|
