Difference between revisions of "ATC/Current/SDK/Use Events methods with web chats"
From Genesys Documentation
m (Text replacement - "\|Platform=([^\|]*)GenesysEngage-onpremises([\|]*)" to "|Platform=$1GenesysEngage-cloud$2") |
(Published) |
||
| Line 6: | Line 6: | ||
|Dimension=WebActions | |Dimension=WebActions | ||
|ComingSoon=No | |ComingSoon=No | ||
| − | |Platform=GenesysEngage-cloud | + | |Platform=PureConnect, GenesysCloud, GenesysEngage-cloud |
| − | |||
|Section={{Section | |Section={{Section | ||
| + | |sectionHeading=About web messaging | ||
| + | |anchor=WebMessaging | ||
| + | |alignment=Vertical | ||
| + | |structuredtext={{BarbFeatureTemp|Feature=Web messaging}}This article only applies to customers using web chat. If you are a Genesys Cloud customer, we encourage you to use the new {{Link-AnywhereElse|product=ATC|version=Current|manual=AdminGuide|topic=About_web_messaging|display text=web messaging}} feature to replace web chat. | ||
| + | |Status=No | ||
| + | }}{{Section | ||
|sectionHeading=Subscribe to offered events | |sectionHeading=Subscribe to offered events | ||
|anchor=WCOffered | |anchor=WCOffered | ||
|alignment=Vertical | |alignment=Vertical | ||
| − | |||
| − | |||
|structuredtext=<syntaxhighlight lang="javascript"> | |structuredtext=<syntaxhighlight lang="javascript"> | ||
ac('on', 'webchat:offered', (event) => { | ac('on', 'webchat:offered', (event) => { | ||
| Line 19: | Line 22: | ||
}); | }); | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| − | |||
| − | |||
|Status=No | |Status=No | ||
}}{{Section | }}{{Section | ||
| Line 26: | Line 27: | ||
|anchor=WCAccepted | |anchor=WCAccepted | ||
|alignment=Vertical | |alignment=Vertical | ||
| − | |||
| − | |||
|structuredtext=<syntaxhighlight lang="javascript"> | |structuredtext=<syntaxhighlight lang="javascript"> | ||
ac('on', 'webchat:accepted', (event) => { | ac('on', 'webchat:accepted', (event) => { | ||
| Line 33: | Line 32: | ||
}); | }); | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| − | |||
| − | |||
|Status=No | |Status=No | ||
}}{{Section | }}{{Section | ||
| Line 40: | Line 37: | ||
|anchor=WCStarted | |anchor=WCStarted | ||
|alignment=Vertical | |alignment=Vertical | ||
| − | |||
| − | |||
|structuredtext=<syntaxhighlight lang="javascript"> | |structuredtext=<syntaxhighlight lang="javascript"> | ||
ac('on', 'webchat:started', (event) => { | ac('on', 'webchat:started', (event) => { | ||
| Line 48: | Line 43: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| − | |||
| − | |||
|Status=No | |Status=No | ||
}}{{Section | }}{{Section | ||
| Line 55: | Line 48: | ||
|anchor=WCEngaged | |anchor=WCEngaged | ||
|alignment=Vertical | |alignment=Vertical | ||
| − | |||
| − | |||
|structuredtext=<syntaxhighlight lang="javascript"> | |structuredtext=<syntaxhighlight lang="javascript"> | ||
ac('on', 'webchat:engaged', (event) => { | ac('on', 'webchat:engaged', (event) => { | ||
| Line 62: | Line 53: | ||
}); | }); | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| − | |||
| − | |||
|Status=No | |Status=No | ||
}}{{Section | }}{{Section | ||
| Line 69: | Line 58: | ||
|anchor=WCRejected | |anchor=WCRejected | ||
|alignment=Vertical | |alignment=Vertical | ||
| − | |||
| − | |||
|structuredtext=<syntaxhighlight lang="javascript"> | |structuredtext=<syntaxhighlight lang="javascript"> | ||
ac('on', 'webchat:rejected', (event) => { | ac('on', 'webchat:rejected', (event) => { | ||
| Line 76: | Line 63: | ||
}); | }); | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| − | |||
| − | |||
|Status=No | |Status=No | ||
}}{{Section | }}{{Section | ||
| Line 83: | Line 68: | ||
|anchor=WCIgnored | |anchor=WCIgnored | ||
|alignment=Vertical | |alignment=Vertical | ||
| − | |||
| − | |||
|structuredtext=<syntaxhighlight lang="javascript"> | |structuredtext=<syntaxhighlight lang="javascript"> | ||
ac('on', 'webchat:ignored', (event) => { | ac('on', 'webchat:ignored', (event) => { | ||
| Line 90: | Line 73: | ||
}); | }); | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| − | |||
| − | |||
|Status=No | |Status=No | ||
}}{{Section | }}{{Section | ||
| Line 97: | Line 78: | ||
|anchor=WCErrored | |anchor=WCErrored | ||
|alignment=Vertical | |alignment=Vertical | ||
| − | |||
| − | |||
|structuredtext=<syntaxhighlight lang="javascript"> | |structuredtext=<syntaxhighlight lang="javascript"> | ||
ac('on', 'webchat:errored', (event) => { | ac('on', 'webchat:errored', (event) => { | ||
| Line 104: | Line 83: | ||
}); | }); | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| − | |||
| − | |||
|Status=No | |Status=No | ||
}}{{Section | }}{{Section | ||
| Line 111: | Line 88: | ||
|anchor=WCTimedOut | |anchor=WCTimedOut | ||
|alignment=Vertical | |alignment=Vertical | ||
| − | |||
| − | |||
|structuredtext=<syntaxhighlight lang="javascript"> | |structuredtext=<syntaxhighlight lang="javascript"> | ||
ac('on', 'webchat:timedout', (event) => { | ac('on', 'webchat:timedout', (event) => { | ||
| Line 118: | Line 93: | ||
}); | }); | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| − | |||
| − | |||
|Status=No | |Status=No | ||
}}{{Section | }}{{Section | ||
| Line 125: | Line 98: | ||
|anchor=WCAll | |anchor=WCAll | ||
|alignment=Vertical | |alignment=Vertical | ||
| − | |||
| − | |||
|structuredtext=<syntaxhighlight lang="javascript"> | |structuredtext=<syntaxhighlight lang="javascript"> | ||
ac('on', 'webchat:all', (event) => { | ac('on', 'webchat:all', (event) => { | ||
| Line 133: | Line 104: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| − | |||
| − | |||
|Status=No | |Status=No | ||
}}{{Section | }}{{Section | ||
| Line 140: | Line 109: | ||
|anchor=Unsubscribe | |anchor=Unsubscribe | ||
|alignment=Vertical | |alignment=Vertical | ||
| − | |||
| − | |||
|structuredtext=<syntaxhighlight lang="javascript"> | |structuredtext=<syntaxhighlight lang="javascript"> | ||
ac('off', 'webchat:offered', eventHandler); // unsubscribes `eventHandler` from 'webchat:offered' events | ac('off', 'webchat:offered', eventHandler); // unsubscribes `eventHandler` from 'webchat:offered' events | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| − | |||
| − | |||
|Status=No | |Status=No | ||
}} | }} | ||
}} | }} | ||
Revision as of 13:21, December 15, 2020
This topic is part of the manual Journey JavaScript SDK for version Current of Genesys Predictive Engagement.
Contents
- 1 About web messaging
- 2 Subscribe to offered events
- 3 Subscribe to accepted events
- 4 Subscribe to started events
- 5 Subscribe to engaged events
- 6 Subscribe to rejected events
- 7 Subscribe to ignored events
- 8 Subscribe to errored events
- 9 Subscribe to timedout events
- 10 Subscribe to all web chat events
- 11 Unsubscribe from web chats in the offered state
See examples of how to use Events methods with web chats.
About web messaging
Feature coming soon: Web messaging
This article only applies to customers using web chat. If you are a Genesys Cloud customer, we encourage you to use the new web messaging feature to replace web chat.
Subscribe to offered events
ac('on', 'webchat:offered', (event) => {
console.log('received %s:%s event', event.actionMediaType, event.actionState, event);
});Subscribe to accepted events
ac('on', 'webchat:accepted', (event) => {
console.log('received %s:%s event', event.actionMediaType, event.actionState, event);
});Subscribe to started events
ac('on', 'webchat:started', (event) => {
console.log('received %s:%s event', event.actionMediaType, event.actionState, event);
});Subscribe to engaged events
ac('on', 'webchat:engaged', (event) => {
console.log('received %s:%s event', event.actionMediaType, event.actionState, event);
});Subscribe to rejected events
ac('on', 'webchat:rejected', (event) => {
console.log('received %s:%s event', event.actionMediaType, event.actionState, event);
});Subscribe to ignored events
ac('on', 'webchat:ignored', (event) => {
console.log('received %s:%s event', event.actionMediaType, event.actionState, event);
});Subscribe to errored events
ac('on', 'webchat:errored', (event) => {
console.log('received %s:%s event', event.actionMediaType, event.actionState, event);
});Subscribe to timedout events
ac('on', 'webchat:timedout', (event) => {
console.log('received %s:%s event', event.actionMediaType, event.actionState, event);
});Subscribe to all web chat events
ac('on', 'webchat:all', (event) => {
console.log('received %s:%s event', event.actionMediaType, event.actionState, event);
});Unsubscribe from web chats in the offered state
ac('off', 'webchat:offered', eventHandler); // unsubscribes `eventHandler` from 'webchat:offered' eventsComments or questions about this documentation? Contact us for support!