CustomPresenceApi

CustomPresenceApi

new CustomPresenceApi()

Methods

channelsChanged(params) → {void}

Communicate new channels list to Five9 Agent Desktop toolkit.

customPresenceApi.channelsChanged({
  channels: [
    {id: 'CALL', name: 'Call'},
    {id: 'CHAT', name: 'Chat'}
  ]
});
Parameters:
Name Type Description
params object
Name Type Description
channels Array.<Channel>

new channels
Returns:
Type:
void

notReadyCodesChanged(params) → {void}

Communicate new Not Ready Codes to Five9 Agent Desktop toolkit.

customPresenceApi.notReadyCodesChanged({
  notReadyCodes: [
    {id: '1', name: 'Break'},
    {id: '2', name: 'Meal'}
  ]
});
Parameters:
Name Type Description
params object
Name Type Description
notReadyCodes Array.<NotReadyCode>

new Not Ready Codes
Returns:
Type:
void

presenceChanged(params) → {void}

Communicate new presence state to Five9 Agent Desktop toolkit.

customPresenceApi.presenceChanged({
  presence: {
    isReady: true,
    channelIds: ['CALL', 'CHAT'],
    notReadyCodeId: null,
    elapsedTime: null
  }
});
Parameters:
Name Type Description
params object
Name Type Description
presence Presence

current presence state
Returns:
Type:
void

registerApi(object) → {void}

Registers implementation of callbacks integrating ADT with CRM system.

Parameters:
Name Type Description
object CustomPresenceApiCallbacks

with properties corresponding to callbacks you would like to implement
Returns:
Type:
void