Difference between revisions of "PEC-Developer/Current/SCAPI/InteractionNamespace"
From Genesys Documentation
m (Text replacement - "\|Platform=([^\|]*)GenesysEngage-onpremises([\|]*)" to "|Platform=$1GenesysEngage-cloud$2") |
(Published) |
||
Line 6: | Line 6: | ||
|ComingSoon=No | |ComingSoon=No | ||
|Platform=GenesysEngage-cloud | |Platform=GenesysEngage-cloud | ||
− | |||
|Section={{Section | |Section={{Section | ||
|sectionHeading=Methods | |sectionHeading=Methods | ||
|anchor=Methods | |anchor=Methods | ||
|alignment=Vertical | |alignment=Vertical | ||
− | |||
− | |||
|structuredtext=The Interaction namespace includes the following methods: | |structuredtext=The Interaction namespace includes the following methods: | ||
Line 182: | Line 179: | ||
{{!}}} | {{!}}} | ||
{{!}}} | {{!}}} | ||
+ | {{AnchorDiv|outbound}} | ||
+ | ====Outbound interactions==== | ||
+ | The <tt>markdone</tt> operation can be used for outbound interactions such as pull preview, push preview, and direct push preview, but there are some details you need to know: | ||
+ | |||
+ | *Pull preview - Mark done is similar to doing a 'Done and Stop' action, where the next preview record is not fetched. | ||
+ | *Push preview - No special behaviour. | ||
+ | *Direct push preview - Mark done is similar to doing a 'Done and Stop' action, where it triggers a notification to [https://docs.genesys.com/Documentation/OU Outbound Contact Server] to stop sending direct push preview records. | ||
===blockMarkdone=== | ===blockMarkdone=== | ||
Line 231: | Line 235: | ||
===accept=== | ===accept=== | ||
{{{!}} | {{{!}} | ||
− | ! Signature | + | !Signature |
− | {{!}} <static> accept(''interactionId'', ''succeeded'', ''failed'') | + | {{!}}<static> accept(''interactionId'', ''succeeded'', ''failed'') |
{{!}}- | {{!}}- | ||
− | ! Description | + | !Description |
− | {{!}} Accept an interaction when it is ringing in Agent Desktop. | + | {{!}}Accept an interaction when it is ringing in Agent Desktop. |
{{!}}- | {{!}}- | ||
− | ! Parameters | + | !Parameters |
{{!}} | {{!}} | ||
{{{!}} | {{{!}} | ||
− | ! Name | + | !Name |
− | ! Type | + | !Type |
− | ! Description | + | !Description |
{{!}}- | {{!}}- | ||
− | {{!}} interactionId | + | {{!}}interactionId |
− | {{!}} string | + | {{!}}string |
− | {{!}} The unique interaction identifier of the interaction to be accepted. | + | {{!}}The unique interaction identifier of the interaction to be accepted. |
{{!}}- | {{!}}- | ||
− | {{!}} succeeded | + | {{!}}succeeded |
− | {{!}} string | + | {{!}}string |
− | {{!}} The callback function to use if the operation succeeded. | + | {{!}}The callback function to use if the operation succeeded. |
{{!}}- | {{!}}- | ||
− | {{!}} failed | + | {{!}}failed |
− | {{!}} string | + | {{!}}string |
− | {{!}} The callback function to use if the operation failed. | + | {{!}}The callback function to use if the operation failed. |
{{!}}} | {{!}}} | ||
{{!}}} | {{!}}} | ||
Line 260: | Line 264: | ||
===reject=== | ===reject=== | ||
{{{!}} | {{{!}} | ||
− | ! Signature | + | !Signature |
− | {{!}} <static> reject(''interactionId'', ''succeeded'', ''failed'') | + | {{!}}<static> reject(''interactionId'', ''succeeded'', ''failed'') |
{{!}}- | {{!}}- | ||
− | ! Description | + | !Description |
− | {{!}} Reject an interaction when it is | + | {{!}}Reject an interaction when it is ringing in Agent Desktop. |
{{!}}- | {{!}}- | ||
− | ! Parameters | + | !Parameters |
{{!}} | {{!}} | ||
{{{!}} | {{{!}} | ||
− | ! Name | + | !Name |
− | ! Type | + | !Type |
− | ! Description | + | !Description |
{{!}}- | {{!}}- | ||
− | {{!}} interactionId | + | {{!}}interactionId |
− | {{!}} string | + | {{!}}string |
− | {{!}} The unique interaction identifier of the interaction to be rejected. | + | {{!}}The unique interaction identifier of the interaction to be rejected. |
{{!}}- | {{!}}- | ||
− | {{!}} succeeded | + | {{!}}succeeded |
− | {{!}} string | + | {{!}}string |
− | {{!}} The callback function to use if the operation succeeded. | + | {{!}}The callback function to use if the operation succeeded. |
{{!}}- | {{!}}- | ||
− | {{!}} failed | + | {{!}}failed |
− | {{!}} string | + | {{!}}string |
− | {{!}} The callback function to use if the operation failed. | + | {{!}}The callback function to use if the operation failed. |
{{!}}} | {{!}}} | ||
{{!}}} | {{!}}} | ||
− | |||
− | |||
− | |||
|Status=No | |Status=No | ||
}}{{Section | }}{{Section | ||
Line 294: | Line 295: | ||
|anchor=Typedefinitions | |anchor=Typedefinitions | ||
|alignment=Vertical | |alignment=Vertical | ||
− | |||
− | |||
|structuredtext=The Interaction namespace includes the following object types: | |structuredtext=The Interaction namespace includes the following object types: | ||
Line 410: | Line 409: | ||
{{!}}boolean | {{!}}boolean | ||
{{!}}Is true if the case containing this interaction is selected, otherwise is false. | {{!}}Is true if the case containing this interaction is selected, otherwise is false. | ||
+ | {{!}}- | ||
+ | {{!}}ronaCallState | ||
+ | {{!}}string | ||
+ | {{!}}This value is populated on event RELEASED when an agent receives an inbound call and does not answer. Possible values are: REDIRECTED or NO_ANSWER. | ||
{{!}}- | {{!}}- | ||
{{!}}isCaseExpanded | {{!}}isCaseExpanded | ||
Line 418: | Line 421: | ||
{{!}}string | {{!}}string | ||
{{!}}The <tt>attr_itx_id</tt> for a multimedia interaction or the <tt>callUuid</tt> for a voice interaction. | {{!}}The <tt>attr_itx_id</tt> for a multimedia interaction or the <tt>callUuid</tt> for a voice interaction. | ||
+ | {{!}}- | ||
+ | {{!}}connId | ||
+ | {{!}}string | ||
+ | {{!}}The unique connection ID from the T-Server. | ||
{{!}}} | {{!}}} | ||
{{!}}} | {{!}}} | ||
Line 441: | Line 448: | ||
{{!}}} | {{!}}} | ||
{{!}}} | {{!}}} | ||
− | |||
− | |||
|Status=No | |Status=No | ||
}} | }} | ||
}} | }} |
Revision as of 19:56, October 14, 2021
Contents
Learn about the Interaction namespace methods and type definitions in the Service Client API.
Methods
The Interaction namespace includes the following methods:
- deleteUserData
- getByInteractionId
- getInteractions
- selectCaseByCaseId
- setUserData
- markdone
- blockMarkdone
- unblockMarkdone
- accept
- reject
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 |
|
getByInteractionId
Signature | <static> getByInteractionId(interactionId) → topic=InteractionNamespace | ||||||
---|---|---|---|---|---|---|---|
Description | Gets an interaction by its unique identifier. | ||||||
Parameters |
| ||||||
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 |
|
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 |
|
markdone
Signature | <static> markdone(interactionId) | ||||||
---|---|---|---|---|---|---|---|
Description | Mark done the selected interaction. | ||||||
Parameters |
|
Outbound interactions
The markdone operation can be used for outbound interactions such as pull preview, push preview, and direct push preview, but there are some details you need to know:
- Pull preview - Mark done is similar to doing a 'Done and Stop' action, where the next preview record is not fetched.
- Push preview - No special behaviour.
- Direct push preview - Mark done is similar to doing a 'Done and Stop' action, where it triggers a notification to Outbound Contact Server to stop sending direct push preview records.
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 |
|
unblockMarkdone
Signature | <static> unblockMarkdone(interactionId) | ||||||
---|---|---|---|---|---|---|---|
Description | Unblock the mark done operation on the selected interaction that was previously blocked. | ||||||
Parameters |
|
accept
Signature | <static> accept(interactionId, succeeded, failed) | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Description | Accept an interaction when it is ringing in Agent Desktop. | ||||||||||||
Parameters |
|
reject
Signature | <static> reject(interactionId, succeeded, failed) | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Description | Reject an interaction when it is ringing in Agent Desktop. | ||||||||||||
Parameters |
|
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 |
|
Party
Description | Represents the JSON structure of a party. | ||||||
---|---|---|---|---|---|---|---|
Type | Object | ||||||
Properties |
|
Comments or questions about this documentation? Contact us for support!