Jump to: navigation, search
(Update with the copy of version: draft)
(Update with the copy of version: draft)
 
(7 intermediate revisions by 5 users not shown)
Line 1: Line 1:
 
= Interaction namespace=
 
= Interaction namespace=
 +
 +
{{Template:PEC_Migrated|Target=[https://all.docs.genesys.com/PEC-Developer/Current/SCAPI/InteractionNamespace Interaction namespace]}}
 +
 +
 
__TOC__
 
__TOC__
 
==Methods==
 
==Methods==
Line 11: Line 15:
 
* [[InteractionNamespace#blockMarkdone|blockMarkdone]]  
 
* [[InteractionNamespace#blockMarkdone|blockMarkdone]]  
 
* [[InteractionNamespace#unblockMarkdone|unblockMarkdone]]  
 
* [[InteractionNamespace#unblockMarkdone|unblockMarkdone]]  
 +
* [[InteractionNamespace#accept|accept]]
 +
* [[InteractionNamespace#reject|reject]]
  
 
===deleteUserData===
 
===deleteUserData===
Line 18: Line 24:
 
|-
 
|-
 
! Description
 
! 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—contact your Genesys representative for details about this configuration.
+
| Deletes the user data attached to the interaction. The [[ASServiceClient|List of User Data Write Allowed]] option in Agent Setup might restrict the allowed key/value pairs.
 
|-
 
|-
 
! Parameters
 
! Parameters
Line 129: Line 135:
 
|-
 
|-
 
! Description
 
! Description
−
| Sets the user data on the live interaction (for voice, this means the [[InteractionNamespace#Interaction|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—contact your Genesys representative for details about this configuration.
+
| Sets the user data on the live interaction (for voice, this means the [[InteractionNamespace#Interaction|interaction is not in the IDLE state]]). This request overwrites any existing keys on the user data. The [[ASServiceClient|List of User Data Write Allowed]] option in Agent Setup might restrict the allowed key/value pairs.
 
|-
 
|-
 
! Parameters
 
! Parameters
Line 216: Line 222:
 
|}
 
|}
  
−
==Type Definitions==
+
===accept===
 +
{|
 +
! Signature
 +
| <static> accept(''interactionId'', ''succeeded'', ''failed'')
 +
|-
 +
! Description
 +
| Accept an interaction when it is ringing in Agent Desktop.
 +
|-
 +
! Parameters
 +
|
 +
{|
 +
! Name
 +
! Type
 +
! Description
 +
|-
 +
| interactionId
 +
| string
 +
| The unique interaction identifier of the interaction to be accepted.
 +
|-
 +
| succeeded
 +
| string
 +
| The callback function to use if the operation succeeded.
 +
|-
 +
| failed
 +
| string
 +
| The callback function to use if the operation failed.
 +
|}
 +
|}
 +
 
 +
 
 +
===reject===
 +
{|
 +
! Signature
 +
| <static> reject(''interactionId'', ''succeeded'', ''failed'')
 +
|-
 +
! Description
 +
| Reject an interaction when it is Ringing in Agent Desktop.
 +
|-
 +
! Parameters
 +
|
 +
{|
 +
! Name
 +
! Type
 +
! Description
 +
|-
 +
| interactionId
 +
| string
 +
| The unique interaction identifier of the interaction to be rejected.
 +
|-
 +
| succeeded
 +
| string
 +
| The callback function to use if the operation succeeded.
 +
|-
 +
| failed
 +
| string
 +
| The callback function to use if the operation failed.
 +
|}
 +
|}
 +
 
 +
==Type definitions==
 
The Interaction namespace includes the following object types:
 
The Interaction namespace includes the following object types:
 
* [[InteractionNamespace#Interaction|Interaction]]
 
* [[InteractionNamespace#Interaction|Interaction]]
Line 261: Line 326:
 
*TALKING &mdash; The call is established.
 
*TALKING &mdash; The call is established.
 
*HELD &mdash; The call is on hold.
 
*HELD &mdash; The call is on hold.
 +
*PREVIEW &mdash; The interaction is a call preview.
 +
*INVITED &mdash; The open media interaction is inviting.
 +
*ACCEPTED &mdash; The open media interaction is accepted.
 +
*CREATED &mdash; The open media interaction has been created.
 +
*PULLED &mdash; The open media interaction has been pulled from a workbin.
 +
*REVOKED &mdash; The open media interaction has been revoked.
 +
*COMPLETED &mdash; The open media interaction has been completed (Mark as done).
 +
*ERROR &mdash; The open media interaction has an error.
 +
*SAVED &mdash; The open media interaction has been saved.
 +
*TRANSFERRING &mdash; The open media interaction is being transferred.
 +
*TRANSFER_COMPLETED &mdash; The open media interaction has been transferred and the transfer has been completed.
 +
*INVITED_CONFERENCE &mdash; The open media interaction receives a conference invitation.
 +
*LEFT_CONFERENCE &mdash; The open media interaction has left the conference.
 
*USER_DATA_ATTACHED &mdash; Data has been attached to the interaction.
 
*USER_DATA_ATTACHED &mdash; Data has been attached to the interaction.
 
*USER_DATA_UPDATED &mdash; The attached data has changed in the interaction.
 
*USER_DATA_UPDATED &mdash; The attached data has changed in the interaction.
 +
*JOIN_PENDING &mdash; Trying to join the chat session.
 +
*JOIN_FAILED &mdash; The connection with the chat server failed.
 +
*HISTORY_IN_PROGRESS &mdash; Loading the content of the chat interaction.
 +
*HISTORY_DONE &mdash; The content of the chat interaction has been loaded.
 +
*CANCELLED &mdash; The outbound email is cancelled.
 +
*SENT &mdash; The outbound email is sent.
 +
*READY &mdash; The call preview is ready.
 +
*CANCELED &mdash; The call preview is cancelled.
 +
*REJECTED &mdash; The call preview is rejected.
 
|-
 
|-
 
| previousState
 
| previousState
Line 311: Line 398:
 
| boolean
 
| boolean
 
| Is true if the case containing this interaction is expanded, otherwise is false.
 
| Is true if the case containing this interaction is expanded, otherwise is false.
 +
|-
 +
| interactionUUID
 +
| string
 +
| The <tt>attr_itx_id</tt> for a multimedia interaction or the <tt>callUuid</tt> for a voice interaction.
 
|}
 
|}
 
|}
 
|}

Latest revision as of 20:23, December 8, 2020

Interaction namespace

Important
This content may not be the latest Genesys Engage cloud content. To find the latest content, go to 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 List of User Data Write Allowed option in Agent Setup 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>

selectCaseByCaseId

Signature <static> genesys.wwe.service.interaction.selectCaseByCaseId(caseId, succeeded, failed)
Description Select the case in the UI by case identifier. If you subscribe to the "interaction" events (genesys.wwe.service.subscribe([ "interaction" ], eventHandler, this);), you will receive the following event: 
Received interaction event: {
	"event": "interaction",
	"data": {
		"eventType": "CASE_COLLAPSED",
		"selectedCaseId": "4401820b-c4e6-4994-69c2-6ae7fdbc4905"
	},
	"userAgent": "WWE Server",
	"protocolVersion": 2
}
Received interaction event: {
	"event": "interaction",
	"data": {
		"eventType": "CASE_EXPANDED",
		"selectedCaseId": "4401820b-c4e6-4994-69c2-6ae7fdbc4905"
	},
	"userAgent": "WWE Server",
	"protocolVersion": 2
}
Received interaction event: {
	"event": "interaction",
	"data": {
		"eventType": "CASE_SELECTED",
		"selectedCaseId": "d4187b87-9fe1-4db8-0515-6a91e666e22d"
	},
	"userAgent": "WWE Server",
	"protocolVersion": 2
}
Parameters
Name Type Description
caseId string The unique identifier for the case.

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 List of User Data Write Allowed option in Agent Setup 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.

markdone

Signature <static> markdone(interactionId)
Description Mark done the selected interaction.
Parameters
Name Type Description
interactionId string The unique identifier for the interaction.


blockMarkdone

Signature <static> blockMarkdone(interactionId, warningMessage)
Description Block the mark done operation on the selected interaction. The "markdone" event must be subscribed to receive the event which informs that there is a delay in blocking the markdone operation with this method.
Parameters
Name Type Description
interactionId string The unique interaction identifier of the interaction to prevent the mark done operation.
warningMessage string The warning message.

unblockMarkdone

Signature <static> unblockMarkdone(interactionId)
Description Unblock the mark done operation on the selected interaction that was previously blocked.
Parameters
Name Type Description
interactionId string The unique interaction identifier of the interaction to prevent the mark done operation.

accept

Signature <static> accept(interactionId, succeeded, failed)
Description Accept an interaction when it is ringing in Agent Desktop.
Parameters
Name Type Description
interactionId string The unique interaction identifier of the interaction to be accepted.
succeeded string The callback function to use if the operation succeeded.
failed string The callback function to use if the operation failed.


reject

Signature <static> reject(interactionId, succeeded, failed)
Description Reject an interaction when it is Ringing in Agent Desktop.
Parameters
Name Type Description
interactionId string The unique interaction identifier of the interaction to be rejected.
succeeded string The callback function to use if the operation succeeded.
failed string The callback function to use if the operation failed.

Type definitions

The Interaction namespace includes the following object types:

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. This attribute is only on voice interactions.
direction string The call direction. Possible values are: IN, OUT or UNKNOWN. This attribute is only on voice interactions.
callType string The call type. Possible values are: INTERNAL, INBOUND, OUTBOUND, CONSULT or UNKNOWN. This attribute is only on voice interactions.
ani string The Automatic Number Identification service. This attribute is only on voice interactions.
dnis string The Dialed Number Identification Service. This attribute is only on voice interactions.
recordingState string The call recording state. Possible values are: STOPPED, RECORDING or PAUSED. This attribute is only on voice interactions.
isCaseSelected boolean Is true if the case containing this interaction is selected, otherwise is false.
isCaseExpanded boolean Is true if the case containing this interaction is expanded, otherwise is false.
interactionUUID string The attr_itx_id for a multimedia interaction or the callUuid for a voice interaction.

Party

Description Represents the JSON structure of a party.
Type Object
Properties
Name Type Description
name string The name of the party.
This page was last edited on December 8, 2020, at 20:23.
Comments or questions about this documentation? Contact us for support!