PEC-Developer/Current/SCAPI/InteractionNamespace - Revision history

WikiSysop at 13:44, February 22, 2023

2023-02-22T13:44:23Z

Show changes

WikiSysop at 08:15, January 20, 2023

2023-01-20T08:15:46Z

Show changes

WikiSysop at 18:00, August 31, 2022

2022-08-31T18:00:59Z

WikiSysop at 19:19, July 28, 2022

2022-07-28T19:19:48Z

WikiSysop at 14:45, May 20, 2022

2022-05-20T14:45:42Z

Jumunn: Published

2022-03-02T14:02:19Z

Published

Julie.munn@genesys.com: Published

2021-10-14T19:56:11Z

Published

WikiSysop: Text replacement - "\|Platform=([^\|])GenesysEngage-onpremises([\|])" to "|Platform=$1GenesysEngage-cloud$2"

2020-07-25T02:32:28Z

Text replacement - "\|Platform=([^\|]*)GenesysEngage-onpremises([\|]*)" to "|Platform=$1GenesysEngage-cloud$2"

Jumunn: Published

2020-07-16T17:26:04Z

Published

WikiSysop: Text replacement - "\|Platforms?=([^\|])PureEngage([\|])" to "|Platform=$1GenesysEngage-onpremises$2"

2020-07-15T11:45:37Z

Text replacement - "\|Platforms?=([^\|]*)PureEngage([\|]*)" to "|Platform=$1GenesysEngage-onpremises$2"

@@ Line 311: / Line 311: @@
 *{{Link-SomewhereInThisManual|topic=InteractionNamespace|anchor=Interaction|display text=Interaction}}
 *{{Link-SomewhereInThisManual|topic=InteractionNamespace|anchor=Party|display text=Party}}
 ===Interaction===
@@ Line 437: / Line 438: @@
 {{!}}string
 {{!}}The unique connection ID from the T-Server.
 {{!}}}
 {{!}}}
@@ Line 458: / Line 463: @@
 {{!}}string
 {{!}}The name of the party.
 {{!}}}
 {{!}}}

@@ Line 251: / Line 251: @@
 {{!}}-
 !Description
-{{!}}Accept an interaction when it is ringing in Agent Desktop.
+{{!}}Accept an interaction when it is ringing in Agent Workspace.
 {{!}}-
 !Parameters
@@ Line 280: / Line 280: @@
 {{!}}-
 !Description
-{{!}}Reject an interaction when it is ringing in Agent Desktop.
+{{!}}Reject an interaction when it is ringing in Agent Workspace.
 {{!}}-
 !Parameters

@@ Line 135: / Line 135: @@
 {{!}}string
 {{!}}The unique identifier for the case.
 {{!}}}
 {{!}}}
@@ Line 258: / Line 266: @@
 {{!}}succeeded
 {{!}}string
-{{!}}The callback function to use if the operation succeeded.
+{{!}}The callback function to use if the operation is successful.
 {{!}}-
 {{!}}failed
 {{!}}string
-{{!}}The callback function to use if the operation failed.
+{{!}}The callback function to use if the operation fails.
 {{!}}}
 {{!}}}
@@ Line 287: / Line 295: @@
 {{!}}succeeded
 {{!}}string
-{{!}}The callback function to use if the operation succeeded.
+{{!}}The callback function to use if the operation is successful.
 {{!}}-
 {{!}}failed
 {{!}}string
-{{!}}The callback function to use if the operation failed.
+{{!}}The callback function to use if the operation fails.
 {{!}}}
 {{!}}}

@@ Line 7: / Line 7: @@
 |Platform=GenesysEngage-cloud
 |Section={{Section
 |sectionHeading=Methods
 |anchor=Methods
@@ Line 29: / Line 33: @@
 {{!}}-
 !Description
-{{!}}Deletes the user data attached to the interaction. The {{Link-AnywhereElse|product=PEC-AS|version=Current|manual=ManageCC|topic=Service_Client_options|display text=List of User Data Write Allowed}} option in Agent Setup might restrict the allowed key/value pairs.
+{{!}}Deletes the user data attached to the interaction. The {{Link-AnywhereElse|product=PEC-AS|version=Current|manual=ManageCC|topic=Service_Client_options|display text=List of User Data Write Allowed}} setting in Agent Setup or the [https://docs.genesys.com/Documentation/Options/Current/HTCC/GWS-interaction-workspace#service-client-api-user-data-write-allowed service-client-api.user-data.write-allowed] configuration option might restrict the allowed key/value pairs.
 {{!}}-
 !Parameters
@@ Line 140: / Line 144: @@
 {{!}}-
 !Description
-{{!}}Sets the user data on the live interaction (for voice, this means the {{Link-SomewhereInThisManual|topic=InteractionNamespace|anchor=Interaction|display text=interaction is not in the IDLE state}}). This request overwrites any existing keys on the user data. The {{Link-AnywhereElse|product=PEC-AS|version=Current|manual=ManageCC|topic=Service_Client_options|display text=List of User Data Write Allowed}} option in Agent Setup might restrict the allowed key/value pairs.
+{{!}}Sets the user data on the live interaction (for voice, this means the {{Link-SomewhereInThisManual|topic=InteractionNamespace|anchor=Interaction|display text=interaction is not in the IDLE state}}). This request overwrites any existing keys on the user data. The {{Link-AnywhereElse|product=PEC-AS|version=Current|manual=ManageCC|topic=Service_Client_options|display text=List of User Data Write Allowed}} setting in Agent Setup or the [https://docs.genesys.com/Documentation/Options/Current/HTCC/GWS-interaction-workspace#service-client-api-user-data-write-allowed service-client-api.user-data.write-allowed] configuration option might restrict the allowed key/value pairs.
 {{!}}-
 !Parameters

@@ Line 6: / Line 6: @@
 |ComingSoon=No
 |Platform=GenesysEngage-cloud
 |Section={{Section
 |sectionHeading=Methods
 |anchor=Methods
 |alignment=Vertical
 |structuredtext=The Interaction namespace includes the following methods:
@@ Line 182: / Line 179: @@
 {{!}}}
 {{!}}}
 ===blockMarkdone===
@@ Line 231: / Line 235: @@
 ===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===
 {{{!}}
-! Signature
+!Signature
-{{!}} <static> reject(''interactionId'', ''succeeded'', ''failed'')
+{{!}}<static> reject(''interactionId'', ''succeeded'', ''failed'')
 {{!}}-
-! Description
+!Description
-{{!}} Reject an interaction when it is Ringing in Agent Desktop.
+{{!}}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
 }}{{Section
@@ Line 294: / Line 295: @@
 |anchor=Typedefinitions
 |alignment=Vertical
 |structuredtext=The Interaction namespace includes the following object types:
@@ Line 410: / Line 409: @@
 {{!}}boolean
 {{!}}Is true if the case containing this interaction is selected, otherwise is false.
 {{!}}-
 {{!}}isCaseExpanded
@@ Line 418: / Line 421: @@
 {{!}}string
 {{!}}The <tt>attr_itx_id</tt> for a multimedia interaction or the <tt>callUuid</tt> for a voice interaction.
 {{!}}}
 {{!}}}
@@ Line 441: / Line 448: @@
 {{!}}}
 {{!}}}
 |Status=No
 }}
 }}

@@ Line 5: / Line 5: @@
 |Context=Learn about the Interaction namespace methods and type definitions in the Service Client API.
 |ComingSoon=No
-|Platform=GenesysEngage-onpremises
+|Platform=GenesysEngage-cloud
 |Prereq=
 |Section={{Section

@@ Line 23: / Line 23: @@
 *{{Link-SomewhereInThisManual|topic=InteractionNamespace|anchor=blockMarkdone|display text=blockMarkdone}}
 *{{Link-SomewhereInThisManual|topic=InteractionNamespace|anchor=unblockMarkdone|display text=unblockMarkdone}}
 ===deleteUserData===
@@ Line 180: / Line 182: @@
 {{!}}}
 {{!}}}
 ===blockMarkdone===
@@ Line 227: / Line 228: @@
 {{!}}}
 {{!}}}
 |structuredtextwide=
 |FAQHeading=

PEC-Developer/Current/SCAPI/InteractionNamespace - Revision history

WikiSysop at 13:44, February 22, 2023

WikiSysop at 08:15, January 20, 2023

WikiSysop at 18:00, August 31, 2022

WikiSysop at 19:19, July 28, 2022

WikiSysop at 14:45, May 20, 2022

Jumunn: Published

Julie.munn@genesys.com: Published

WikiSysop: Text replacement - "\|Platform=([^\|]*)GenesysEngage-onpremises([\|]*)" to "|Platform=$1GenesysEngage-cloud$2"

Jumunn: Published

WikiSysop: Text replacement - "\|Platforms?=([^\|]*)PureEngage([\|]*)" to "|Platform=$1GenesysEngage-onpremises$2"

WikiSysop: Text replacement - "\|Platform=([^\|])GenesysEngage-onpremises([\|])" to "|Platform=$1GenesysEngage-cloud$2"

WikiSysop: Text replacement - "\|Platforms?=([^\|])PureEngage([\|])" to "|Platform=$1GenesysEngage-onpremises$2"