Documentation:HTCC:Dev:InteractionNamespace:8.5.2DRAFT

Interaction Namespace

Methods

The Interaction namespace includes the following methods:

• deleteUserData
• getByInteractionId
• getInteractions
• setUserData

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

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

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. 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. keyValues object The key value pairs to set on the user data.

Type Definitions

The Interaction namespace includes the following object types:

• Interaction
• Party

Interaction

Description	Represents the JSON structure of an interaction. Attributes specific to voice interactions are: callUuid, direction, callType, ani, dnis and recordingState.
Type	Object
Properties	Name Type Description interactionId string The unique identifier for the interaction. Note: This is a client-side ID that is lost on the next session or refresh. parentInteractionId string The unique identifier for the parent interaction. Note: This is a client-side ID that is lost on the next session or refresh. 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. Possible values are: UNKNOWN — An unknown state. IDLE — Specifies a non-active interaction which could be closed. RINGING — The inbound call is ringing. DIALING — The outbound call is ringing. TALKING — The call is established. HELD — The call is on hold. PREVIEW — The interaction is a call preview. INVITED — The open media interaction is inviting. ACCEPTED — The open media interaction is accepted. CREATED — The open media interaction has been created. PULLED — The open media interaction has been pulled from a workbin. REVOKED — The open media interaction has been revoked. COMPLETED — The open media interaction has been completed (Mark as done). ERROR — The open media interaction has an error. SAVED — The open media interaction has been saved. TRANSFERRING — The open media interaction is being transferred. TRANSFER_COMPLETED — The open media interaction has been transferred and the transfer has been completed. INVITED_CONFERENCE — The open media interaction receives a conference invitation. LEFT_CONFERENCE — The open media interaction has left the conference. USER_DATA_ATTACHED — Data has been attached to the interaction. USER_DATA_UPDATED — The attached data has changed in the interaction. JOIN_PENDING — Trying to join the chat session. JOIN_FAILED — The connection with the chat server failed. HISTORY_IN_PROGRESS — Loading the content of the chat interaction. HISTORY_DONE — The content of the chat interaction has been loaded. CANCELLED — The outbound email is cancelled. SENT — The outbound email is sent. READY — The call preview is ready. CANCELED — The call preview is cancelled. REJECTED — The call preview is rejected. 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. 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.