|
|
| Line 1: |
Line 1: |
| | = API Commands = | | = API Commands = |
| | | | |
| − | Once you've registered your own plugin on the bus, you can call commands on other registered plugins. Below we'll quickly register a new plugin on the bus using the global bus object.
| + | {{NoteFormat|Documentation for this software has moved to a new home. Please update links and bookmarks to content hosted at https://all.docs.genesys.com/WID/Current/SDK/WebChatService-combined#API_Commands.}} |
| − | | |
| − | {{NoteFormat|The global bus object is a debug tool. When implementing Widgets on your own site, do not use the global bus object to register your custom plugins. Instead, see [[GWCBusExtensions|Widgets Extensions]] for more information about extending Genesys Widgets.|1}} | |
| − | | |
| − | | |
| − | <source lang='javascript'>var oMyPlugin = window._genesys.widgets.bus.registerPlugin('MyPlugin');
| |
| − | | |
| − | oMyPlugin.command('WebChatService.getAgents');</source>
| |
| − | | |
| − | {{NoteFormat|Starting 9.0.008.04 version, WebChatService allows you to choose between the types of chat API services available in Genesys via the transport section configuration options. For more information, see the “Options” table in [[WebChatServiceConfiguration#Options|WebChatService Configuration.]]|1}}
| |
| − | | |
| − | == configure ==
| |
| − | Internal use only. The main App plugin shares configuration settings to widgets using each widget’s configure command. The configure command can only be called once at startup. Calling configure again after startup may result in unpredictable behavior.
| |
| − | <br /><br />
| |
| − | == startChat ==
| |
| − | Initiates a new chat session with the chat server via GMS or with the service configured under transport section. Intended to be used by WebChat widgets only. Should not be invoked manually.
| |
| − | <br /><br />
| |
| − | === Example ===
| |
| − | <source lang='javascript'>
| |
| − | oMyPlugin.command('WebChatService.startChat', {
| |
| − | | |
| − | nickname: 'Jonny',
| |
| − | firstname: 'Johnathan',
| |
| − | lastname: 'Smith',
| |
| − | email: 'jon.smith@mail.com',
| |
| − | subject: 'product questions',
| |
| − | userData: {}
| |
| − | | |
| − | }).done(function(e){
| |
| − | | |
| − | // WebChatService started a chat successfully
| |
| − | | |
| − | }).fail(function(e){
| |
| − | | |
| − | // WebChatService failed to start chat
| |
| − | });
| |
| − | </source>
| |
| − | | |
| − | <br />
| |
| − | === Options ===
| |
| − | {|
| |
| − | |-
| |
| − | ! Option
| |
| − | ! Type
| |
| − | ! Description
| |
| − | |-
| |
| − | | nickname
| |
| − | | string
| |
| − | | Chat Entry Form Data: 'nickname'.
| |
| − | |-
| |
| − | | firstname
| |
| − | | string
| |
| − | | Chat Entry Form Data: 'firstname'.
| |
| − | |-
| |
| − | | lastname
| |
| − | | string
| |
| − | | Chat Entry Form Data: 'lastname'.
| |
| − | |-
| |
| − | | email
| |
| − | | string
| |
| − | | Chat Entry Form Data: 'email'.
| |
| − | |-
| |
| − | | subject
| |
| − | | string
| |
| − | | Chat Entry Form Data: 'subject'.
| |
| − | |-
| |
| − | | userData
| |
| − | | object
| |
| − | | Arbitrary data to attach to the chat session (AKA attachedData). Properties defined here will be merged with default userData set in the configuration object.
| |
| − | |-
| |
| − | |}
| |
| − | <br />
| |
| − | === Resolutions ===
| |
| − | {|
| |
| − | |-
| |
| − | ! Status
| |
| − | ! When
| |
| − | ! Returns
| |
| − | |-
| |
| − | | resolved
| |
| − | | When server confirms session started
| |
| − | | (AJAX Response Object)
| |
| − | |-
| |
| − | | rejected
| |
| − | | When a chat session is already active
| |
| − | | 'There is already an active chat session'
| |
| − | |-
| |
| − | | rejected
| |
| − | | When AJAX exception occurs
| |
| − | | (AJAX Response Object)
| |
| − | |-
| |
| − | | rejected
| |
| − | | When server exception occurs
| |
| − | | (AJAX Response Object)
| |
| − | |-
| |
| − | | rejected
| |
| − | | When userData is invalid
| |
| − | | 'malformed data object provided in userData property'
| |
| − | |-
| |
| − | |}
| |
| − | == endChat ==
| |
| − | Ends the chat session with the chat server via GMS or with the service configured under transport section. Intended to be used by WebChat widgets only. Should not be invoked manually.
| |
| − | <br /><br />
| |
| − | === Example ===
| |
| − | <source lang='javascript'>
| |
| − | oMyPlugin.command('WebChatService.endChat').done(function(e){
| |
| − | | |
| − | // WebChatService ended a chat successfully
| |
| − | | |
| − | }).fail(function(e){
| |
| − | | |
| − | // WebChatService failed to end chat
| |
| − | });
| |
| − | </source>
| |
| − | | |
| − | <br />
| |
| − | === Resolutions ===
| |
| − | {|
| |
| − | |-
| |
| − | ! Status
| |
| − | ! When
| |
| − | ! Returns
| |
| − | |-
| |
| − | | resolved
| |
| − | | When active session is ended successfully
| |
| − | | (AJAX Response Object)
| |
| − | |-
| |
| − | | rejected
| |
| − | | If no chat session is currently active
| |
| − | | 'There is no active chat session'
| |
| − | |-
| |
| − | |}
| |
| − | == sendMessage ==
| |
| − | Send a message from the client to the chat session. Intended to be used by WebChat widgets only. Should not be invoked manually.
| |
| − | <br /><br />
| |
| − | === Example ===
| |
| − | <source lang='javascript'>
| |
| − | oMyPlugin.command('WebChatService.sendMessage', {message: 'hi'}).done(function(e){
| |
| − | | |
| − | // WebChatService sent a message successfully
| |
| − | | |
| − | }).fail(function(e){
| |
| − | | |
| − | // WebChatService failed to send a message
| |
| − | });
| |
| − | </source>
| |
| − | | |
| − | <br />
| |
| − | === Options ===
| |
| − | {|
| |
| − | |-
| |
| − | ! Option
| |
| − | ! Type
| |
| − | ! Description
| |
| − | |-
| |
| − | | message
| |
| − | | string
| |
| − | | The message you want to send
| |
| − | |-
| |
| − | |}
| |
| − | <br />
| |
| − | === Resolutions ===
| |
| − | {|
| |
| − | |-
| |
| − | ! Status
| |
| − | ! When
| |
| − | ! Returns
| |
| − | |-
| |
| − | | resolved
| |
| − | | When message is successfully sent
| |
| − | | (AJAX Response Object)
| |
| − | |-
| |
| − | | rejected
| |
| − | | If no message text provided
| |
| − | | 'No message text provided'
| |
| − | |-
| |
| − | | rejected
| |
| − | | If no chat session is currently active
| |
| − | | 'There is no active chat session'
| |
| − | |-
| |
| − | | rejected
| |
| − | | When AJAX exception occurs
| |
| − | | (AJAX Response Object)
| |
| − | |-
| |
| − | |}
| |
| − | == sendCustomNotice ==
| |
| − | Send a custom notice from the client to the chat server. This request is used to deliver any custom notification between a custom client application and a custom agent desktop. Neither Genesys Widgets, nor Workspace use this out of the box.
| |
| − | <br /><br />
| |
| − | === Example ===
| |
| − | <source lang='javascript'>
| |
| − | oMyPlugin.command('WebChatService.sendCustomNotice', {message: 'bye'}).done(function(e){
| |
| − | | |
| − | // WebChatService sent a custom message successfully
| |
| − | | |
| − | }).fail(function(e){
| |
| − | | |
| − | // WebChatService failed to send a custom message
| |
| − | });
| |
| − | </source>
| |
| − | | |
| − | <br />
| |
| − | === Options ===
| |
| − | {|
| |
| − | |-
| |
| − | ! Option
| |
| − | ! Type
| |
| − | ! Description
| |
| − | |-
| |
| − | | message
| |
| − | | string
| |
| − | | A message you want to send along with the custom notice
| |
| − | |-
| |
| − | |}
| |
| − | <br />
| |
| − | === Resolutions ===
| |
| − | {|
| |
| − | |-
| |
| − | ! Status
| |
| − | ! When
| |
| − | ! Returns
| |
| − | ! Introduced / Updated
| |
| − | |-
| |
| − | | resolved
| |
| − | | When message is successfully sent
| |
| − | | (AJAX Response Object)
| |
| − | |
| |
| − | |-
| |
| − | | rejected
| |
| − | | When AJAX exception occurs
| |
| − | | (AJAX Response Object)
| |
| − | |
| |
| − | |-
| |
| − | | rejected
| |
| − | | When the server doesn't support receiving custom notices
| |
| − | | This transport doesn't support sendCustomNotice command.
| |
| − | | 9.0.008.04
| |
| − | |-
| |
| − | |}
| |
| − | | |
| − | == sendTyping ==
| |
| − | Send 'customer typing' notification to chat session. A visual indication will be shown to agent. Intended to be used by WebChat widgets only. Should not be invoked manually.
| |
| − | <br /><br />
| |
| − | === Example ===
| |
| − | <source lang='javascript'>
| |
| − | oMyPlugin.command('WebChatService.sendTyping').done(function(e){
| |
| − | | |
| − | // WebChatService sent typing successfully
| |
| − | | |
| − | }).fail(function(e){
| |
| − | | |
| − | // WebChatService failed to send typing
| |
| − | });
| |
| − | </source>
| |
| − | | |
| − | <br />
| |
| − | === Resolutions ===
| |
| − | {|
| |
| − | |-
| |
| − | ! Status
| |
| − | ! When
| |
| − | ! Returns
| |
| − | |-
| |
| − | | resolved
| |
| − | | When AJAX request is successful
| |
| − | | (AJAX Response Object)
| |
| − | |-
| |
| − | | rejected
| |
| − | | When AJAX exception occurs
| |
| − | | (AJAX Response Object)
| |
| − | |-
| |
| − | | rejected
| |
| − | | If no chat session is currently active
| |
| − | | 'There is no active chat session'
| |
| − | |-
| |
| − | |}
| |
| − | == sendFilteredMessage ==
| |
| − | Send a message along with a regular expression to match the message and hide it from the client. Useful for sending codes and tokens through the WebChat interface to the Agent Desktop.
| |
| − | | |
| − | {{NoteFormat|Filters are now automatically stored and recalled on chat restore for the duration of the session.}}
| |
| − | <br /><br />
| |
| − | === Example ===
| |
| − | <source lang='javascript'>
| |
| − | oMyPlugin.command('WebChatService.sendFilteredMessage', {
| |
| − | | |
| − | message: 'filtered message',
| |
| − | regex: /[a-zA-Z]/
| |
| − | | |
| − | }).done(function(e){
| |
| − | | |
| − | // WebChatService sent filtered message successfully
| |
| − | | |
| − | }).fail(function(e){
| |
| − | | |
| − | // WebChatService failed to send filtered message
| |
| − | });
| |
| − | </source>
| |
| − | | |
| − | <br />
| |
| − | === Options ===
| |
| − | {|
| |
| − | |-
| |
| − | ! Option
| |
| − | ! Type
| |
| − | ! Description
| |
| − | |-
| |
| − | | message
| |
| − | | string
| |
| − | | Message you want to send but don't want to appear in the transcript
| |
| − | |-
| |
| − | | regex
| |
| − | | RegExp
| |
| − | | Regular expression to match the message
| |
| − | |-
| |
| − | |}
| |
| − | <br />
| |
| − | === Resolutions ===
| |
| − | {|
| |
| − | |-
| |
| − | ! Status
| |
| − | ! When
| |
| − | ! Returns
| |
| − | |-
| |
| − | | resolved
| |
| − | | When there is an active session
| |
| − | | n/a
| |
| − | |-
| |
| − | | rejected
| |
| − | | If no chat session is currently active
| |
| − | | 'No active chat session'
| |
| − | |-
| |
| − | |}
| |
| − | == addPrefilter ==
| |
| − | Add a new regular expression prefilter to the prefilter list. Any messages matched using the prefilters will not be shown in the transcript
| |
| − | | |
| − | {{NoteFormat|Filters are now automatically stored and recalled on chat restore for the duration of the session.}}
| |
| − | <br /><br />
| |
| − | === Example ===
| |
| − | <source lang='javascript'>
| |
| − | oMyPlugin.command('WebChatService.addPrefilter', {filters: /[a-zA-Z]/}).done(function(e){
| |
| − | | |
| − | // WebChatService added filter successfully
| |
| − | // e == Object of registered prefilters
| |
| − | | |
| − | }).fail(function(e){
| |
| − | | |
| − | // WebChatService failed to add filter
| |
| − | });
| |
| − | </source>
| |
| − | | |
| − | <br />
| |
| − | === Options ===
| |
| − | {|
| |
| − | |-
| |
| − | ! Option
| |
| − | ! Type
| |
| − | ! Description
| |
| − | |-
| |
| − | | filters
| |
| − | | RegExp or Array of RegExp
| |
| − | | Regular Expression(s) to add to the prefilter list
| |
| − | |-
| |
| − | |}
| |
| − | <br />
| |
| − | === Resolutions ===
| |
| − | {|
| |
| − | |-
| |
| − | ! Status
| |
| − | ! When
| |
| − | ! Returns
| |
| − | |-
| |
| − | | resolved
| |
| − | | When valid filters are provided
| |
| − | | Array of all registered prefilters.
| |
| − | |-
| |
| − | | rejected
| |
| − | | When invalid or missing filters provided
| |
| − | | 'Missing or invalid filters provided. Please provide a regular expression or an array of regular expressions.'
| |
| − | |-
| |
| − | |}
| |
| − | == updateUserData ==
| |
| − | Updates the userData properties associated with the chat session. If this command is called before a chat session starts, it will update the internal userData object and will be sent when a chat session starts. If this command is called after a chat session starts, a request to the server will be made to update the userData on the server associated with the chat session.
| |
| − | <br /><br />
| |
| − | === Example ===
| |
| − | <source lang='javascript'>
| |
| − | oMyPlugin.command('WebChatService.updateUserData', {firstname: 'Joe'}).done(function(e){
| |
| − | | |
| − | // WebChatService updated user data successfully
| |
| − | | |
| − | }).fail(function(e){
| |
| − | | |
| − | // WebChatService failed to update user data
| |
| − | });
| |
| − | </source>
| |
| − | | |
| − | <br />
| |
| − | === Options ===
| |
| − | {|
| |
| − | |-
| |
| − | ! Option
| |
| − | ! Type
| |
| − | ! Description
| |
| − | |-
| |
| − | | n/a
| |
| − | | object
| |
| − | | userData object you want to send to the server for this active session
| |
| − | |-
| |
| − | |}
| |
| − | <br />
| |
| − | === Resolutions ===
| |
| − | {|
| |
| − | |-
| |
| − | ! Status
| |
| − | ! When
| |
| − | ! Returns
| |
| − | ! Introduced / Updated
| |
| − | |-
| |
| − | | resolved
| |
| − | | Session is active and userData is successfully sent
| |
| − | | (AJAX Response Object)
| |
| − | |
| |
| − | |-
| |
| − | | rejected
| |
| − | | Session is active and AJAX exception occurs
| |
| − | | (AJAX Response Object)
| |
| − | |
| |
| − | |-
| |
| − | | resolved
| |
| − | | Session is not active and internal userData object is merged with new userData properties provided
| |
| − | | The internal userData object that will be sent to the server
| |
| − | |
| |
| − | |-
| |
| − | | rejected
| |
| − | | Session is active and the server doesn't support updating userData
| |
| − | | This transport doesn't support updating userData during an active chat session.
| |
| − | | 9.0.008.04
| |
| − | |-
| |
| − | |}
| |
| − | == poll ==
| |
| − | Internal use only. Start polling for new messages. Intended to be used by WebChat widgets only. Should not be invoked manually.
| |
| − | <br /><br />
| |
| − | === Example ===
| |
| − | <source lang='javascript'>
| |
| − | oMyPlugin.command('WebChatService.poll').done(function(e){
| |
| − | | |
| − | // WebChatService started polling successfully
| |
| − | | |
| − | }).fail(function(e){
| |
| − | | |
| − | // WebChatService failed to start polling
| |
| − | });
| |
| − | </source>
| |
| − | | |
| − | <br />
| |
| − | === Resolutions ===
| |
| − | {|
| |
| − | |-
| |
| − | ! Status
| |
| − | ! When
| |
| − | ! Returns
| |
| − | ! Introduced / Updated
| |
| − | |-
| |
| − | | resolved
| |
| − | | When there is an active session
| |
| − | | n/a
| |
| − | |
| |
| − | |-
| |
| − | | rejected
| |
| − | | WebChatService isn't calling this command
| |
| − | | 'Access Denied to private command. Only WebChatService is allowed to invoke this command.'
| |
| − | |
| |
| − | |-
| |
| − | | rejected
| |
| − | | If no chat session is currently active
| |
| − | | 'previous poll has not finished.'
| |
| − | |
| |
| − | |-
| |
| − | | rejected
| |
| − | | When the server doesn't support polling
| |
| − | | 'This transport doesn't support polling.'
| |
| − | | 9.0.008.04
| |
| − | |-
| |
| − | |}
| |
| − | == startPoll ==
| |
| − | Start automatic polling for new messages. Intended to be used by WebChat widgets only. Should not be invoked manually.
| |
| − | <br /><br />
| |
| − | === Example ===
| |
| − | <source lang='javascript'>
| |
| − | oMyPlugin.command('WebChatService.startPoll').done(function(e){
| |
| − | | |
| − | // WebChatService started polling successfully
| |
| − | | |
| − | }).fail(function(e){
| |
| − | | |
| − | // WebChatService failed to start polling
| |
| − | });
| |
| − | </source>
| |
| − | | |
| − | <br />
| |
| − | === Resolutions ===
| |
| − | {|
| |
| − | |-
| |
| − | ! Status
| |
| − | ! When
| |
| − | ! Returns
| |
| − | ! Introduced / Updated
| |
| − | |-
| |
| − | | resolved
| |
| − | | When there is an active session
| |
| − | | n/a
| |
| − | |
| |
| − | |-
| |
| − | | rejected
| |
| − | | When no chat session is currently active
| |
| − | | No active chat session
| |
| − | |
| |
| − | |-
| |
| − | | rejected
| |
| − | | When the server doesn't support polling
| |
| − | | This transport doesn't support polling
| |
| − | | 9.0.008.04
| |
| − | |-
| |
| − | |}
| |
| − | == stopPoll ==
| |
| − | Stop automatic polling for new messages. Intended to be used by WebChat widgets only. Should not be invoked manually.
| |
| − | <br /><br />
| |
| − | === Example ===
| |
| − | <source lang='javascript'>
| |
| − | oMyPlugin.command('WebChatService.stopPoll').done(function(e){
| |
| − | | |
| − | // WebChatService stopped polling successfully
| |
| − | | |
| − | }).fail(function(e){
| |
| − | | |
| − | // WebChatService failed to stop polling
| |
| − | });
| |
| − | </source>
| |
| − | | |
| − | <br />
| |
| − | === Resolutions ===
| |
| − | {|
| |
| − | |-
| |
| − | ! Status
| |
| − | ! When
| |
| − | ! Returns
| |
| − | ! Introduced / Updated
| |
| − | |-
| |
| − | | resolved
| |
| − | | When there is an active session
| |
| − | | n/a
| |
| − | |
| |
| − | |-
| |
| − | | rejected
| |
| − | | If no chat session is currently active
| |
| − | | No active chat session
| |
| − | |
| |
| − | |-
| |
| − | | rejected
| |
| − | | When the server doesn't support polling
| |
| − | | This transport doesn't support polling
| |
| − | | 9.0.008.04
| |
| − | |-
| |
| − | |}
| |
| − | == resetPollExceptions ==
| |
| − | Reset the poll exception count to 0. pollExceptionLimit is set in the configuration.
| |
| − | <br /><br />
| |
| − | === Example ===
| |
| − | <source lang='javascript'>
| |
| − | oMyPlugin.command('WebChatService.resetPollExceptions').done(function(e){
| |
| − | | |
| − | // WebChatService reset polling successfully
| |
| − | | |
| − | }).fail(function(e){
| |
| − | | |
| − | // WebChatService failed to reset polling
| |
| − | });
| |
| − | </source>
| |
| − | | |
| − | <br />
| |
| − | === Resolutions ===
| |
| − | {|
| |
| − | |-
| |
| − | ! Status
| |
| − | ! When
| |
| − | ! Returns
| |
| − | ! Introduced / Updated
| |
| − | |-
| |
| − | | resolved
| |
| − | | Always
| |
| − | | n/a
| |
| − | |
| |
| − | |-
| |
| − | | rejected
| |
| − | | When the server doesn't support polling
| |
| − | | This transport doesn't support resetPollExceptions command.
| |
| − | | 9.0.008.04
| |
| − | |-
| |
| − | |}
| |
| − | == restore ==
| |
| − | Internal use only. Intended to be used by WebChatService only. Should not be invoked manually, except when using Async mode.
| |
| − | <br /><br />
| |
| − | === Example ===
| |
| − | <source lang='javascript'>
| |
| − | oMyPlugin.command('WebChatService.restore').done(function(e){
| |
| − | | |
| − | // WebChatService restored successfully
| |
| − | | |
| − | }).fail(function(e){
| |
| − | | |
| − | // WebChatService failed to restore
| |
| − | });
| |
| − | </source>
| |
| − | | |
| − | <br />
| |
| − | === Options ===
| |
| − | {|
| |
| − | |-
| |
| − | ! Option
| |
| − | ! Type
| |
| − | ! Description
| |
| − | ! Accepted Values
| |
| − | ! Introduced / Updated
| |
| − | |-
| |
| − | | sessionData
| |
| − | | string
| |
| − | | The session data that is needed to restore the WebChat in Async mode. It is a JWT token string value. Applicable only when using WebChat with PureEngage v3 API. For more information, see the “PureEngage v3” tab in the “Options” table in [[WebChatServiceConfiguration#Options| WebChatService Configuration]].
| |
| − | | (JWT string token)
| |
| − | | 9.0.008.04
| |
| − | |-
| |
| − | |}
| |
| − | <br />
| |
| − | === Resolutions ===
| |
| − | {|
| |
| − | |-
| |
| − | ! Status
| |
| − | ! When
| |
| − | ! Returns
| |
| − | ! Introduced / Updated
| |
| − | |-
| |
| − | | resolved
| |
| − | | Session has been found.
| |
| − | | n/a
| |
| − | |
| |
| − | |-
| |
| − | | rejected
| |
| − | | Session cannot be found.
| |
| − | | n/a
| |
| − | |
| |
| − | |-
| |
| − | | rejected
| |
| − | | Restoring chat session is in progress.
| |
| − | | Already restoring. Ignoring request.
| |
| − | | 9.0.002.06
| |
| − | |-
| |
| − | | rejected
| |
| − | | Chat session is already active.
| |
| − | | Chat session is already active, ignoring restore command.
| |
| − | | 9.0.002.06
| |
| − | |-
| |
| − | | rejected
| |
| − | | Trying restore chat session manually.
| |
| − | | Access Denied to private command. Only WebChatService is allowed to invoke this command in Non-Async mode.
| |
| − | | 9.0.002.06
| |
| − | |-
| |
| − | |}
| |
| − | == getTranscript ==
| |
| − | Fetch an array of all messages in the chat session.
| |
| − | {{NoteFormat|For more information on the fields included in JSON response, see [[Documentation:GMS:API:APIResponses#Digital_Channels_Chat_V2_Response_Format|Digital Channels Chat V2 Response Format]].}}
| |
| − | <br /><br />
| |
| − | === Example ===
| |
| − | <source lang='javascript'>
| |
| − | oMyPlugin.command('WebChatService.getTranscript').done(function(e){
| |
| − | | |
| − | // WebChatService got transcript successfully
| |
| − | // e == Object with an array of messages
| |
| − | | |
| − | }).fail(function(e){
| |
| − | | |
| − | // WebChatService failed to get transcript
| |
| − | });
| |
| − | </source>
| |
| − | | |
| − | <br />
| |
| − | === Resolutions ===
| |
| − | {|
| |
| − | |-
| |
| − | ! Status
| |
| − | ! When
| |
| − | ! Returns
| |
| − | |-
| |
| − | | resolved
| |
| − | | Always
| |
| − | | Object with an array of messages
| |
| − | |-
| |
| − | |}
| |
| − | == getAgents ==
| |
| − | Return a list of agents that have participated in the chat. Includes agent metadata.
| |
| − | <br /><br />
| |
| − | === Example ===
| |
| − | <source lang='javascript'>
| |
| − | oMyPlugin.command('WebChatService.getAgents').done(function(e){
| |
| − | | |
| − | // WebChatService got agents successfully
| |
| − | // e == Object with agents information in chat
| |
| − | | |
| − | }).fail(function(e){
| |
| − | | |
| − | // WebChatService failed to get agents
| |
| − | });
| |
| − | </source>
| |
| − | | |
| − | <br />
| |
| − | === Resolutions ===
| |
| − | {|
| |
| − | |-
| |
| − | ! Status
| |
| − | ! When
| |
| − | ! Returns
| |
| − | |-
| |
| − | | resolved
| |
| − | | Always
| |
| − | | (Object List) {name: (String), connected: (Boolean), supervisor: (Boolean), connectedTime: (int time),disconnectedTime: (int time)}
| |
| − | |-
| |
| − | |}
| |
| − | == getStats ==
| |
| − | Return stats on chat session including start time, end time, duration, and list of agents.
| |
| − | <br /><br />
| |
| − | === Example ===
| |
| − | <source lang='javascript'>
| |
| − | oMyPlugin.command('WebChatService.getStats').done(function(e){
| |
| − | | |
| − | // WebChatService got stats successfully
| |
| − | // e == Object with chat session stats
| |
| − | | |
| − | }).fail(function(e){
| |
| − | | |
| − | // WebChatService failed to get stats
| |
| − | });
| |
| − | </source>
| |
| − | | |
| − | <br />
| |
| − | === Resolutions ===
| |
| − | {|
| |
| − | |-
| |
| − | ! Status
| |
| − | ! When
| |
| − | ! Returns
| |
| − | |-
| |
| − | | resolved
| |
| − | | Always
| |
| − | | {agents: (Object), startTime: (int time), endTime: (int time), duration: (int time)}
| |
| − | |-
| |
| − | |}
| |
| − | == sendFile ==
| |
| − | '''[Introduced: 9.0.008.04]'''
| |
| − | | |
| − | Sends the file from the client machine to the agent.
| |
| − | | |
| − | {{NoteFormat|This command is not applicable when using Chat via GMS.}}
| |
| − | <br /><br />
| |
| − | === Example ===
| |
| − | <source lang='javascript'>
| |
| − | oMyPlugin.command('WebChatService.sendFile', {files: $('<input/>').attr('type', 'file') /* Only works on UI, can not dynamically change */ }).done(function(e){
| |
| − | | |
| − | // WebChatService sent file successfully
| |
| − | | |
| − | }).fail(function(e){
| |
| − | | |
| − | // WebChatService failed to send file
| |
| − | });
| |
| − | </source>
| |
| − | | |
| − | <br />
| |
| − | === Options ===
| |
| − | {|
| |
| − | |-
| |
| − | ! Option
| |
| − | ! Type
| |
| − | ! Description
| |
| − | |-
| |
| − | | files
| |
| − | | File
| |
| − | | A reference to a file input element (for example <input type=“file”/>)
| |
| − | |-
| |
| − | |}
| |
| − | <br />
| |
| − | === Resolutions ===
| |
| − | {|
| |
| − | |-
| |
| − | ! Status
| |
| − | ! When
| |
| − | ! Returns
| |
| − | |-
| |
| − | | resolved
| |
| − | | When the file sent is a valid type and size
| |
| − | | (AJAX Response Object)
| |
| − | |-
| |
| − | | rejected
| |
| − | | When the file sent is an invalid type
| |
| − | | (AJAX Response Object)
| |
| − | |-
| |
| − | | rejected
| |
| − | | When the number of uploads is exceeded
| |
| − | | (AJAX Response Object)
| |
| − | |-
| |
| − | | rejected
| |
| − | | When the file size exceeds the limit
| |
| − | | (AJAX Response Object)
| |
| − | |-
| |
| − | | rejected
| |
| − | | When the file size is too large or an unknown error occurs
| |
| − | | (AJAX Response Object)
| |
| − | |-
| |
| − | | rejected
| |
| − | | When the server doesn't support file uploads
| |
| − | | This transport doesn't support file uploads
| |
| − | |-
| |
| − | |}
| |
| − | == getSessionData ==
| |
| − | '''[Introduced: 9.0.002.06]'''
| |
| − | | |
| − | To retrieve the active session data at any time.
| |
| − | <br /><br />
| |
| − | === Example ===
| |
| − | <source lang='javascript'>
| |
| − | oMyPlugin.command('WebChatService.getSessionData')
| |
| − | </source>
| |
| − | | |
| − | <br />
| |
| − | === Resolutions ===
| |
| − | {|
| |
| − | |-
| |
| − | ! Status
| |
| − | ! When
| |
| − | ! Returns
| |
| − | ! Introduced / Updated
| |
| − | |-
| |
| − | | resolved
| |
| − | | Always, when using Chat via GMS API. For more information, see the 'GMS' tab in the 'Options' table in [[WebChatServiceConfiguration#Options| WebChatService Configuration.]]
| |
| − | | {secureKey: (string), sessionID: (number/string), alias: (number/string), userId: (number/string)}
| |
| − | |
| |
| − | |-
| |
| − | | resolved
| |
| − | | Always, when using Chat via PureEngage v3 API. For more information, see the 'PureEngage v3' tab in the 'Options' table in [[WebChatServiceConfiguration#Options| WebChatService Configuration.]]
| |
| − | | {participantId: (string), sessionId: {string), token: (string), transportId: (string)}
| |
| − | | 9.0.008.04
| |
| − | |-
| |
| − | | rejected
| |
| − | | Never
| |
| − | | undefined
| |
| − | |
| |
| − | |-
| |
| − | |}
| |
| − | == fetchHistory ==
| |
| − | '''[Introduced: 9.0.008.04]'''
| |
| − | | |
| − | For use with WebChat Widget only. This applies only in Asynchronous mode to fetch older chat messages. It does not fetch all at a time, rather a certain number of messages are fetched every time this command is called. Response data will be available in the [[WebChatServiceEvents|messageReceived]] event.
| |
| − | <br /><br />
| |
| − | === Example ===
| |
| − | <source lang='javascript'>
| |
| − | oMyPlugin.command('WebChatService.fetchHistory')
| |
| − | </source>
| |
| − | | |
| − | <br />
| |
| − | === Resolutions ===
| |
| − | {|
| |
| − | |-
| |
| − | ! Status
| |
| − | ! When
| |
| − | ! Returns
| |
| − | |-
| |
| − | | resolved
| |
| − | | When old messages are retrieved.
| |
| − | | (AJAX Response Object)
| |
| − | |-
| |
| − | | rejected
| |
| − | | When request fails.
| |
| − | | (AJAX Response Object)
| |
| − | |-
| |
| − | | rejected
| |
| − | | When Asynchronous mode is not enabled.
| |
| − | | Fetching history messages applies only to Asynchronous chat
| |
| − | |-
| |
| − | | rejected
| |
| − | | When all messages are received
| |
| − | | No more messages to fetch
| |
| − | |-
| |
| − | |}
| |
| − | == registerTypingPreviewInput ==
| |
| − | Select an HTML input to watch for key events. Used to trigger startTyping and stopTyping automatically. Intended to be used by WebChat widgets only. Should not be invoked manually.
| |
| − | <br /><br />
| |
| − | === Example ===
| |
| − | <source lang='javascript'>
| |
| − | oMyPlugin.command('WebChatService.registerTypingPreviewInput', {input: $('input') }).done(function(e){
| |
| − | | |
| − | // WebChatService registered input area successfully
| |
| − | | |
| − | }).fail(function(e){
| |
| − | | |
| − | // WebChatService failed to register typing preview
| |
| − | });
| |
| − | </source>
| |
| − | | |
| − | <br />
| |
| − | === Options ===
| |
| − | {|
| |
| − | |-
| |
| − | ! Option
| |
| − | ! Type
| |
| − | ! Description
| |
| − | |-
| |
| − | | input
| |
| − | | HTML Reference
| |
| − | | An HTML reference to a text or textarea input
| |
| − | |-
| |
| − | |}
| |
| − | <br />
| |
| − | === Resolutions ===
| |
| − | {|
| |
| − | |-
| |
| − | ! Status
| |
| − | ! When
| |
| − | ! Returns
| |
| − | |-
| |
| − | | resolved
| |
| − | | When valid HTML input reference is provided
| |
| − | | n/a
| |
| − | |-
| |
| − | | rejected
| |
| − | | When invalid or missing HTML input reference
| |
| − | | 'Invalid value provided for the 'input' property. An HTML element reference to a textarea or text input is required.'
| |
| − | |-
| |
| − | |}
| |
| − | == registerPreProcessor ==
| |
| − | Allows you to register a function that receives the message object, allowing you to manipulate the values before it is rendered in the transcript.
| |
| − | <br /><br />
| |
| − | === Example ===
| |
| − | <source lang='javascript'>
| |
| − | oMyPlugin.command('WebChatService.registerPreProcessor', {preprocessor: function(message){
| |
| − | | |
| − | message.text = message.text + ' some preprocessing text';
| |
| − | | |
| − | return message;
| |
| − | | |
| − | }}).done(function(e){
| |
| − | | |
| − | // WebChatService registered preprocessor function
| |
| − | // e == function that was registered
| |
| − | | |
| − | }).fail(function(e){
| |
| − | | |
| − | // WebChatService failed to register function
| |
| − | | |
| − | });
| |
| − | </source>
| |
| − | | |
| − | <br />
| |
| − | === Options ===
| |
| − | {|
| |
| − | |-
| |
| − | ! Option
| |
| − | ! Type
| |
| − | ! Description
| |
| − | |-
| |
| − | | preprocessor
| |
| − | | function
| |
| − | | The preprocessor function you want to register.
| |
| − | |-
| |
| − | |}
| |
| − | <br />
| |
| − | === Resolutions ===
| |
| − | {|
| |
| − | |-
| |
| − | ! Status
| |
| − | ! When
| |
| − | ! Returns
| |
| − | |-
| |
| − | | resolved
| |
| − | | When a valid preprocessor function is provided and is registered.
| |
| − | | The registered preprocessor function.
| |
| − | |-
| |
| − | | rejected
| |
| − | | When an invalid preprocessor function is provided.
| |
| − | | No preprocessor function provided. Type provided was '<DATATYPE>'.
| |
| − | |-
| |
| − | |}
| |
| | | | |
| | | | |
| | [[Category:V:PSAAS:Public]] | | [[Category:V:PSAAS:Public]] |
