Jump to: navigation, search

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.

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 Widgets Extensions for more information about extending Genesys Widgets.

var oMyPlugin = window._genesys.widgets.bus.registerPlugin('MyPlugin');



Opens the CallUs UI.



	// CallUs opened successfully


	// CallUs failed to open


Status When Returns
resolved When CallUs is successfully opened n/a
rejected When CallUs is already open 'Already opened'


Closes the CallUs UI.



	// CallUs closed successfully


	// CallUs failed to close


Status When Returns
resolved When CallUs successfully closed n/a
rejected When CallUs is already closed 'Already closed'


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.


oMyPlugin.command('CallUs.configure', {

	contacts: [
			displayName: 'Payments',
			i18n: 'Number001',
			number: '1 888 436 3797'
	hours: ['8am - 8pm Mon - Fri']


	// CallUs configred successfully


	// CallUs failed to configure


Option Type Description
contacts Array An array of objects that represent phone numbers and their labels. The first number in this list will display as the larger, main number.
hours Array Array of strings to show stacked in the business hours section. Strings here are freeform.


Status When Returns
resolved When CallUs configuration is provided n/a
rejected When no configuration provided 'Invalid Configuration'
This page was last edited on March 7, 2018, at 19:39.
Comments or questions about this documentation? Contact us for support!