settings

embedWebRTCByDefault

Boolean

The integration embeds agent's WebRTC phone in the embedded agent interface (true) or pops the WebRTC Phone window (false).

Default: true. <br><br>The WebRTC Phone window establishes and maintains WebRTC phone connectivity. If your environment often refreshes, then set embedWebRTCByDefault to false. Also, for the window to appear, pop-up blocker must be turned off in the browser.

hideWebRTCPopUpOption

Boolean

The integration hides (true) or shows (false) the setting for the WebRTC Phone window.

Default: false.

enableCallLogs

Boolean

The integration enables (true) or disables (false) interaction logging.

Default: true.

hideCallLogSubject

Boolean

The integration hides (true) or shows (false) the interaction log subject field in the Interaction Log view in the embedded agent interface.

Default: false.

hideCallLogContact

Boolean

The integration hides (true) or shows (false) the interaction log contact menu in the Interaction Log view in the embedded agent interface.

Default: false.

hideCallLogRelation

Boolean

The integration hides (true) or shows (false) the interaction log relation menu in the Interaction Log view in the embedded agent interface.

Default: false.

<a name="enableTransferContext">enableTransferContext</a>

Boolean

The integration enables (true) or disables (false) the sending of additional information when agents transfer interactions.

Default: false. <br><br>For more information, see addTransferContext.

<a name="dedicatedLoginWindow">dedicatedLoginWindow</a>

Boolean

The integration opens (true) or does not open (false) a separate login window.

Default: false. <br><br>If set to true, add https://apps.mypurecloud.com/crm/authWindow.html under Authorized redirect URIs in the OAuth client that you are using with the embeddable framework. For more information, see the Genesys Cloud Embeddable Framework tab in Create an OAuth client (Genesys Cloud Resource Center).<br><br>For private deployments, add the query string parameter dedicatedLoginWindow=true to the iframe URL. For more information, see iframe URLs.

<a name="embeddedInteractionWindow">embeddedInteractionWindow</a>

Boolean

The integration embeds the Interactions window (true) or opens the Interactions window as a separate pop-up window (false).

Default: false. <br><br>If set to true, add a second iframe to your web app for the Interactions window. For more information, see step 5 under Development on the private deployment or public deployment pages.

enableConfigurableCallerID

Boolean

Allows agents to update caller ID names and numbers in the client for outbound calls.

Default: false. <br><br>Telco support for callerId and callerIdName varies.<br><br>If set to true, configure Calling for your external trunk in your Genesys Cloud organization. For more information, see Configure caller ID (Genesys Cloud Resource Center).

<a name="enableServerSideLogging">enableServerSideLogging</a>

Boolean

The integration saves logs server-side (true) or does not save logs server-side (false).

Default: false.<br><br>If set to true, Customer Care can access these logs directly, eliminating the need for you to send the logs.<br><br>Warning: enableServerSideLogging must be a dynamic setting. If this value is hard-coded, your framework.js file will not pass security review. For more information about configuring a dynamic setting, see Embedded CRM Genesys Cloud Embedded Framework (GitHub).<br><br>Warning: Enabling this option allows Genesys Cloud Embeddable Framework integration to capture and send operational logs to Genesys. These logs can contain potentially sensitive information such as, unique identifiers, package settings, and other technical data. By selecting this option, you acknowledge and consent to provide Genesys with this information for diagnostic and troubleshooting purposes.<br><br>Tip: If you have a slow or unreliable Internet connection, or you risk running out of session storage, Genesys recommends that you do not set enableServerSideLogging to true.

enableCallHistory

Boolean

Allows agents to view their call history in the client.

Default: false.

<a name="defaultOutboundSMSCountryCode">defaultOutboundSMSCountryCode</a>

String

The country code that the integration prefixes to numbers for outbound SMS interactions.

Default: +1. <br><br>Use + followed by the appropriate country code. See also type on the clickToDial page.

<a name="searchTargets">searchTargets</a>

Array

The contact types that the integration returns when users search for names or phone numbers before making calls or transferring interactions.

Values: people (from a Genesys Cloud organization), queues (from a Genesys Cloud organization), frameworkContacts (from an external CRM), externalContacts (from a Genesys Cloud organization). <br><br>To use frameworkContacts, specify what contacts the integration searches for and returns from the external CRM. For more information, see contactSearch. <br><br> If searchTargets is not used, the integration returns contact types from a Genesys Cloud organization.

<a name="callControls">callControls</a>

Array

The call control elements to appear in the client and the order in which they appear.

Values: pickup, hold, mute, transfer, disconnect, record, securePause, dtmf, scheduleCallback, flag, requestAfterCallWork. <br><br>If you add items to the array but do not include "pickup" or "disconnect", the integration automatically adds "pickup" and "disconnect" to the end of the call controls.<br><br>If you use an empty array, the integration displays the default call controls. For more information, see Call controls (Genesys Cloud Resource Center).

<a name="settingsTheme">theme</a>

Object

See theme object.

sso

Object

See sso object.

display

Object

See display object.