InteractionApiEvents

InteractionApiEvents

Methods

(abstract) callAccepted(params)

Implement this callback to execute your code when a call moves to TALKING, ON_HOLD or RINGING_ON_OTHER_SIDE states. This event is executed only once for a call. It is also executed after every page refresh right after callStarted event if a call is in a one of the mentioned states.

Parameters:
Name Type Description
params object
Name Type Description
callData CallData

Call information

(abstract) callEnded(params)

Implement this callback to execute your code when call was ended either by agent or customer but before it has been dispositioned

Parameters:
Name Type Description
params object
Name Type Description
callData CallData

Call information

(abstract) callFinished(params) → {void}

Implement this callback to execute your code when ADT finished handling a call It's called after a disposition was set and a call log is saved in a CRM system (applicable when used with an adapter integrated with a CRM system). When this event is triggered the interaction is already completed and the most of interaction data (CAVs, dispositions, search results etc.) is unavailable, so related API methods will fail.

Parameters:
Name Type Description
params object
Name Type Description
callData CallData

Call information

callLogData CallLogData

Call log data

Returns:
Type:
void

(abstract) callRejected(params)

Implement this callback to execute your code when call was rejected by agent

Parameters:
Name Type Description
params object
Name Type Description
callData CallData

Call information

(abstract) callStarted(params) → {void}

Implement this callback to execute your code when ADT starts handling new call This event is also executed after every page refresh if ADT is handling call.

Parameters:
Name Type Description
params object
Name Type Description
callData CallData

Call information

Returns:
Type:
void

(abstract) chatAccepted(params) → {void}

Implement this callback to execute your code when a chat is locked by an agent or the agent is added to a conference. This event is also executed after each page refresh.

Parameters:
Name Type Description
params object
Name Type Description
chatData ChatData

Chat interaction information

Returns:
Type:
void

(abstract) chatEnded(params) → {void}

Implement this callback to execute your code when call was ended either by agent or customer and before it has been dispositioned

Parameters:
Name Type Description
params object
Name Type Description
chatData ChatData

Chat interaction information

Returns:
Type:
void

(abstract) chatFinished(params) → {void}

Implement this callback to execute your code when a disposition (either open or close) was set. It's called after a disposition was successfully set and a chat log is saved in a CRM system (applicable when used with an adapter integrated with a CRM system). When this event is triggered the interaction is already completed and the most of interaction data (dispositions, search results etc.) is unavailable, so related API methods will fail.

Parameters:
Name Type Description
params object
Name Type Description
chatData ChatData

Chat interaction information

chatLogData ChatLogData

Chat log data

Returns:
Type:
void

(abstract) chatOffered(params) → {void}

Implement this callback to execute your code when ADT starts handling new call

Parameters:
Name Type Description
params object
Name Type Description
chatData ChatData

Chat interaction information

Returns:
Type:
void

(abstract) chatRejected(params) → {void}

Implement this callback to execute your code when chat was rejected by agent

Parameters:
Name Type Description
params object
Name Type Description
chatData ChatData

Chat interaction information

Returns:
Type:
void

(abstract) chatTransferred(params) → {void}

Implement this callback to execute your code when chat was transferred to another agent or skill

Parameters:
Name Type Description
params object
Name Type Description
chatData ChatData

Chat interaction information

Returns:
Type:
void

(abstract) emailAccepted(params) → {void}

Implement this callback to execute your code when an email is locked by agent. This event is executed after each page refresh right after emailOffered event.

Parameters:
Name Type Description
params object
Name Type Description
emailData EmailData

Email interaction information

Returns:
Type:
void

(abstract) emailFinished(params) → {void}

Implement this callback to execute your code when a disposition (either open or close) was set. It's called after a disposition was successfully set and an email log is saved in a CRM system (applicable when used with an adapter integrated with a CRM system). When this event is triggered the interaction is already completed and the most of interaction data (dispositions, search results etc.) is unavailable, so related API methods will fail.

Parameters:
Name Type Description
params object
Name Type Description
emailData EmailData

Email interaction information

emailLogData EmailLogData

Email log data

Returns:
Type:
void

(abstract) emailOffered(params) → {void}

Implement this callback to execute your code when ADT starts handling new call

Parameters:
Name Type Description
params object
Name Type Description
emailData EmailData

Email interaction information

Returns:
Type:
void

(abstract) emailRejected(params) → {void}

Implement this callback to execute your code when email was rejected by agent

Parameters:
Name Type Description
params object
Name Type Description
emailData EmailData

Email interaction information

Returns:
Type:
void

(abstract) emailTransferred(params) → {void}

Implement this callback to execute your code when email was transferred to another agent or skill. It's also called when your unlock an email.

Parameters:
Name Type Description
params object
Name Type Description
emailData EmailData

Email interaction information

Returns:
Type:
void

(abstract) interactionOpened(params) → {void}

Implement this callback to execute your code when interaction opened

Parameters:
Name Type Description
params object
Name Type Description
interactionType InteractionType

Type of interaction

interactionId string

Interaction id

Returns:
Type:
void

(abstract) objectSelected(params) → {void}

Implement this callback to execute your code when CRM object was selected by agent in Name/RelatedTo list

Parameters:
Name Type Description
params object
Name Type Description
crmObject CrmObject | undefined

Selected CRM object or 'undefined' if 'None' is selected

interactionType InteractionType

Type of interaction

interactionData CallData | ChatData | EmailData

Five9 Interaction data

Returns:
Type:
void