CrmApi

CrmApi

new CrmApi()

Methods

click2dial(params) → {void}

Communicate to Five9 adapter that user pressed phone number and wants to initiate click to dial. call will be started automatically if default campaign is configured by administrator or campaign name is provided in click2DialData parameter.

crmApi.click2dial({click2DialData: {clickToDialNumber: "9250000111", crmObject: {id: "789", type: "Account", label: "Account", name: "XYZ", isWho: false, isWhat: true}}});
Parameters:
Name Type Description
params object
Name Type Description
click2DialData Click2DialData

data associated with click 2 dial operation

Returns:
Type:
void

objectVisited(params) → {void}

Communicate details of object visited by user in CRM system to Five9 Agent Desktop toolkit. Five9 adapter will display this object in the list of objects available for saving call logs.

crmApi.objectVisited({crmObject: {id: "456", type: "Case", label: "Case", name: "Broken microwave", isWho: false, isWhat: true}});
Parameters:
Name Type Description
params object
Name Type Description
crmObject CrmObject

data of visited CRM object

interactionType InteractionType

interaction type

interactionId string

interaction id

Returns:
Type:
void

registerApi(object) → {void}

Registers implementation of callbacks integrating ADT with CRM system. See example in Integrating ADT inside web page

Parameters:
Name Type Description
object CrmApiCallbacks

with properties corresponding to callbacks you would like to implement

Returns:
Type:
void

suggestedNumbers(params) → {void}

Communicate to Five9 adapter that user navigated to object with phone numbers and those numbers need to be displayed in the list of suggested numbers if agent navigates to make call screen.

crmApi.suggestedNumbers({suggestedNumbers: [
 {clickToDialNumber:"9250000111", crmObject: {id: "441", type: "Case", label: "Case", name: "Engine broken", isWho: false, isWhat: true}},
 {clickToDialNumber:"9250000112", crmObject: {id: "789", type: "Account", label: "Account", name: "XYZ", isWho: false, isWhat: true}},
 {clickToDialNumber:"9250000113", crmObject: {id: "731", type: "Contact", label: "Contact", name: "Tim", isWho: true, isWhat: false}}]});
Parameters:
Name Type Description
params object

objects and configuration that will be used to populate suggested numbers menu

Name Type Description
suggestedNumbers Array.<Click2DialData>

list of objects

Returns:
Type:
void