CrmSdk

Five9. CrmSdk

Members

(static) ApiErrorCode

Properties:
Name Type Description
ApiErrorCode ApiErrorCode

API error codes

(static) HookStatusCode

Properties:
Name Type Description
HookStatusCode HookApiStatusCode

Hook API status codes

(static) PresenceEventReason

Properties:
Name Type Description
PresenceEventReason PresenceEventReason

Hook API status codes

Methods

applicationApi() → {ApplicationApi}

Use this method to obtain reference to Application API instance. If Five9 Plugin SDK is loaded

const applicationApi = window.Five9.CrmSdk.applicationApi();
Returns:
Type:
ApplicationApi

reference to Application API instance

crmApi() → {CrmApi}

Use this method to obtain reference to CRM API instance. Only one instance of CRM API can be used on the same page. If Five9 Plugin SDK is loaded in multiple iframes on the same page the first instance of CRM API that establishes connection to Five9 Agent Desktop Toolkit will receive events

const crmApi = window.Five9.CrmSdk.crmApi();
Returns:
Type:
CrmApi

reference to CRM API instance

customComponentsApi() → {CustomComponentsApi}

Use this method to obtain reference to Custom Components API instance. Only one instance of Custom Components API can be used on the same page. If Five9 Plugin SDK is loaded in multiple iframes on the same page the first instance of Custom Components API that establishes connection to Five9 Agent Desktop Toolkit will receive events

const customComponentsApi = window.Five9.CrmSdk.customComponentsApi();
Returns:
Type:
CustomComponentsApi

reference to Custom Components API instance

customMethodsApi() → {CustomMethodsApi}

Use this method to obtain a Custom Methods API instance. You can use this API to establish a communication channel between a customization bundle and an iframe on a page. So you can call methods implemented in an iframe from a customization bundle and vice versa.

const customMethodsApi = window.Five9.CrmSdk.customMethodsApi();
Returns:
Type:
CustomMethodsApi

reference to Custom Methods API instance

customPresenceApi() → {CustomPresenceApi}

Use this method to obtain reference to Custom Presence API instance.

const customPresenceApi = window.Five9.CrmSdk.customPresenceApi();
Returns:
Type:
CustomPresenceApi

reference to Presence API instance

hookApi() → {HookApi}

Use this method to obtain reference to Hook API instance. Only one instance of Hook API can be used on the same page. If Five9 Plugin SDK is loaded in multiple iframes on the same page the first instance of Hook API that establishes connection to Five9 Agent Desktop Toolkit will receive events

const hookApi = window.Five9.CrmSdk.hookApi();
Returns:
Type:
HookApi

reference to Hook API instance

interactionApi() → {InteractionApi}

Use this method to obtain reference to Interaction API instance. If Five9 Plugin SDK is loaded

const interactionApi = window.Five9.CrmSdk.interactionApi();

in multiple iframes on the same page all instances will receive events and can be used to execute methods.

Returns:
Type:
InteractionApi

reference to Interaction API instance

presenceApi() → {PresenceApi}

Use this method to obtain reference to Presence API instance. If Five9 Plugin SDK is loaded

const presenceApi = window.Five9.CrmSdk.presenceApi();
Returns:
Type:
PresenceApi

reference to Presence API instance

sfNativeApi() → {SfNativeApi}

Use this method to obtain a Salesforce Native API instance. You can use this API to establish a communication channel between a customization bundle and an iframe on a page. So you can call methods implemented in an iframe from a customization bundle and vice versa.

const sfNativeApi = window.Five9.CrmSdk.sfNativeApi();
Returns:
Type:
SfNativeApi

reference to Salesforce Native API instance