ConversationsApi
Utilities for interacting with Genesys Cloud conversations
since 1.1.0
Hierarchy
↳ ConversationsApi
Index
Methods
Methods
proposeInteractionMessage
▸ proposeInteractionMessage(mode: "insert", message: string): void
Send a message to be filled into the interaction message box for the agent to review and send. This function works specifically with a bound interaction when both the interaction and calling app are visible, it is not intended (and will not work) for situations where the interaction is not active. Furthermore, this function should only be called in response to user interaction to ensure the agent is aware of the impending text insertion and so their existing draft state is not unexpectedly altered.
Parameters:
Name | Type | Description |
| "insert" | The insertion mode to use when injecting the text into the agent's text box. 'insert' -> injects text at agent's cursor position, leaving other text intact. |
| string | The message to inject into the agent's text box. |
Returns: void
showInteractionDetails
▸ showInteractionDetails(conversationId: string): void
Show an interaction by ID.
Required Permissions:
- ALL Of
- analytics:conversationDetail:view
- analytics:conversationAggregate:view
- ANY Of
- conversation:communication:view
- quality:evaluation:add
- quality:calibration:view
- quality:evaluation:editScore
myClientApp.conversations.showInteractionDetails('af2ef59d-9bc5-4436-8738-97c04869c81c');since 1.1.0
Parameters:
Name | Type |
| string |
Returns: void
