cxengage-javascript-sdk.modules.interaction
accept
(accept & args__9078__auto__)The accept function is used to accept a work offer/interaction and initiate communication with the customer.
CxEngage.interactions.accept({
interactionId: '{{uuid}}'
});
Possible Errors:
assign
(assign & args__9078__auto__)The assignContact function is used to assign a Skylight CRM contact to the interaction.
CxEngage.interactions.assignContact({
interactionId: '{{uuid}}',
contactId: '{{uuid}}'
});
Possible Errors:
cancel-extension-transfer
(cancel-extension-transfer & args__9078__auto__)Cancel a transfer to a PSTN, SIP, or WebRTC extension. Note: only warm transfers can be cancelled.
CxEngage.interactions.cancelExtensionTransfer({
interactionId: '{{uuid}}',
transferExtension: {type: '{pstn or sip or webrtc}', value: '+15055555555'}
});
Possible Errors:
cancel-queue-transfer
(cancel-queue-transfer & args__9078__auto__)Cancel a queue transfer. Note: only warm transfers can be cancelled.
CxEngage.interactions.cancelQueueTransfer({
interactionId: '{{uuid}}',
transferQueueId: '{{uuid}}'
});
Possible Errors:
cancel-resource-transfer
(cancel-resource-transfer & args__9078__auto__)Cancel a resource (user) transfer. Note: only warm transfers can be cancelled.
CxEngage.interactions.cancelResourceTransfer({
interactionId: '{{uuid}}',
transferResourceId: '{{uuid}}'
});
Possible Errors:
create-note
(create-note & args__9078__auto__)custom-interrupt
(custom-interrupt & args__9078__auto__)deselect-disposition
(deselect-disposition & args__9078__auto__)The deselectDispositionCode is used to remove all selected dispositions from the interaction.
CxEngage.interactions.deselectDispositionCode({
interactionId: '{{uuid}}'
});
Possible Errors:
disable-wrapup
(disable-wrapup & args__9078__auto__)The disableWrapup function is used during an interaction to turn wrap up off on following the end of the interaction. This should only be called when the interaction has ‘Allow Wrap Up Update’ configured on the interaction.
CxEngage.interactions.disableWrapup({
interactionId: '{{uuid}}'
});
Possible Errors:
enable-wrapup
(enable-wrapup & args__9078__auto__)The enableWrapup function is used during an interaction to turn wrap up on following the end of the interaction. This should only be called when the interaction has ‘Allow Wrap Up Update’ configured on the interaction.
CxEngage.interactions.enableWrapup({
interactionId: '{{uuid}}'
});
Possible Errors:
end
(end & args__9078__auto__)The reject/end function is used to reject a work offer or end an interaction from the agent perspective and disconnect from the customer.
CxEngage.interactions.end({
interactionId: '{{uuid}}'
});
// Same as
CxEngage.interactions.reject({
interactionId: '{{uuid}}'
});
Possible Errors:
end-wrapup
(end-wrapup & args__9078__auto__)The endWrapup function can be used during wrap up to end the wrap up phase of the interaction, freeing the resource for new work.
CxEngage.interactions.endWrapup({
interactionId: '{{uuid}}'
});
Possible Errors:
focus
(focus & args__9078__auto__)The focus function is used to signal reporting that the agent is actively viewing the interaction.
CxEngage.interactions.focus({
interactionId: '{{uuid}}'
});
Possible Errors:
get-all-notes
(get-all-notes & args__9078__auto__)get-note
(get-note & args__9078__auto__)select-disposition
(select-disposition & args__9078__auto__)The selectDispositionCode is used to assign a disposition to the interaction.
CxEngage.interactions.selectDispositionCode({
interactionId: '{{uuid}}',
dispositionId: '{{uuid}}'
});
Possible Errors:
send-script
(send-script & args__9078__auto__)The sendSript function is used to send a script either submited by the user, auto-submit itself after a configurable amount of time or automatically when configured on the end of the interaction.
CxEngage.interactions.sendScript({
interactionId: '{{uuid}}',
scriptId: '{{uuid}}',
answers: '{{object}}',
dismissed: '{{bool}}',
scriptReporting: '{{bool}}',
exitReason: '{{'user-submitted'||'script-timeout'||'script-auto-dismissed'}}'
});
Possible Errors:
transfer-to-extension
(transfer-to-extension & args__9078__auto__)Transfer an interaction to a PSTN, SIP, or WebRTC extension. Warm transfer type will keep the current agent on the conference and put the customer on hold. Cold transfer type will immediately remove the current agent from the conference.
CxEngage.interactions.transferToExtension({
interactionId: '{{uuid}}',
transferExtension: {type: '{pstn or sip or webrtc}', value: '+15055555555'},
transferType: '{{warm or cold}}'
});
Possible Errors:
transfer-to-queue
(transfer-to-queue & args__9078__auto__)Transfer an interaction to a queue. Warm transfer type will keep the current agent on the conference and put the customer on hold. Cold transfer type will immediately remove the current agent from the conference.
CxEngage.interactions.transferToQueue({
interactionId: '{{uuid}}',
queueId: '{{uuid}}',
transferType: '{{warm or cold}}'
});
Possible Errors:
transfer-to-resource
(transfer-to-resource & args__9078__auto__)Transfer an interaction to another resource (user). Warm transfer type will keep the current agent on the conference and put the customer on hold. Cold transfer type will immediately remove the current agent from the conference.
CxEngage.interactions.transferToResource({
interactionId: '{{uuid}}',
resourceId: '{{uuid}}',
transferType: '{{warm or cold}}'
});
Possible Errors:
unassign
(unassign & args__9078__auto__)The unassignContact function is used to unassign a Skylight CRM contact from the interaction.
CxEngage.interactions.unassignContact({
interactionId: '{{uuid}}',
contactId: '{{uuid}}'
});
Possible Errors:
unfocus
(unfocus & args__9078__auto__)The unfocus function is used to signal reporting that the agent is no longer viewing the interaction.
CxEngage.interactions.unfocus({
interactionId: '{{uuid}}'
});
Possible Errors:
update-note
(update-note & args__9078__auto__)