Skip to main content

Call Center Ingest Events

Kenkai SDK Call Center Module consists of events for such platforms which involves communication from a central station to/from patient. The goal is to track the usage of such platforms and the operators too.

List of Events

Event NameTypeDescription
BreakbreakTrack actions regarding break events of the platform user.
ContactcontactTrack events regarding contact with the patient/representative, can be a phone call, email, SMS, etc.
OpsScorecardops_scorecardTrack stats of the platform user.


Break Event

To log user break timings and duration. This event is used to track the time when the user is on break or returns.

Format

ParamUsabilityFormatEnum ValuesDescription
typeREQUIREDSTRINGbio_break, feedback, meeting, meal, tea, otherType of the break.
sub_typeOPTIONALSTRING---Sub-type of the break.
actionREQUIREDSTRINGview, start, end, pause, resume, otherAction applied for the break.
total_timeREQUIREDFLOAT---Total time allocated for the break in seconds.
consumed_timeREQUIREDFLOAT---Consumed time for the break in seconds.
metaOPTIONALANY---Any additional value that is sent with the log.

Usage

    let callEvent = {
type: BreakType.BioBreak,
sub_type: "Some Sub Type",
action: CallCenterAction.Add,
total_time: 10,
consumed_time: 5
}
CallCenter.logIngestEvent(CallCenterEventType.Break, callEvent)


Contact Event

To log actions related to Contact event. Which includes events related to attending, declining, transferring a call, etc.

Format

ParamUsabilityFormatEnum ValuesDescription
contact_idREQUIREDSTRING---Id of the contact
actionREQUIREDSTRINGview, add, update, remove, start, end, pause, resume, attend, decline, terminate, transfer, skip, otherAction applied on the contact/call/sms/email.
contact_typeREQUIREDSTRINGemergency, grievance, non_emergency, transfer, follow_up, service_offering, customer_support, otherType of the contact item in the event
contact_sub_typeOPTIONALSTRING---Sub-type of the contact item in the event
contact_start_timeOPTIONALSTRING---Start time of the contact in the event, should be in ISO 8601 format
contact_channelREQUIREDSTRINGcall, whatsapp, sms, email, otherChannel of the contact item in the event
contact_is_validOPTIONALBOOLEAN---Is the contact valid or spam
contact_is_transferOPTIONALBOOLEAN---Is item a transfer contact
contact_incident_idOPTIONALSTRING---Id of the incident attached with the contact
contact_customer_idOPTIONALSTRING---Id of the customer/patient attached with the contact
contact_customer_typeOPTIONALSTRING---Type of the customer/patient attached with the contact
contact_phone_idOPTIONALSTRING---Phone id of the customer/patient attached with the contact
contact_extensionOPTIONALSTRING---Phone id extension of the customer/patient attached with the contact
contact_durationOPTIONALFLOAT---Duration for the contact in seconds
contact_resolutionOPTIONALSTRING---Resolution of the contact event
contact_summaryOPTIONALSTRING---Summary of the contact event
contact_remarksOPTIONALSTRING---Remarks of the contact event
contact_is_priorityOPTIONALBOOLEAN---Is the contact a priority
transfer_idREQUIREDSTRING---Id of the transfer in the event
transfer_destinationOPTIONALSTRING---Transfer of the transfer in the event
transfer_summaryOPTIONALSTRING---Summary of the transfer in the event
transfer_remarksOPTIONALSTRING---Remarks of the transfer in the event
metaOPTIONALANY---Any additional value that is sent with the log.

Usage

    let contactEvent = {
action: CallCenterAction.Attend,
contact_id: "contactId",
contact_channel: ContactChannel.Call,
contact_start_time: "2025-01-01T12:00:27.87+02:00",
contact_type: ContactType.FollowUp,
contact_sub_type: "Some Sub Type",
contact_is_transfer: false,
contact_customer_type: "Some Customer Type",
contact_duration: 100,
contact_is_priority: false,
transfer_id: "transferId",
transfer_destination: "Some Destination"
}

CallCenter.logIngestEvent(CallCenterEventType.Contact, contactEvent)


OpsScorecard Event

To log actions related to the platform user's performance.

Format

ParamUsabilityFormatEnum ValuesDescription
audit_countREQUIREDINTEGER---Audit count for the performance traits
quality_scoreOPTIONALFLOAT---Quality score for the performance traits
fatal_callsOPTIONALINTEGER---Fatal Calls for the performance traits
fatal_scoreOPTIONALFLOAT---Fatal score for the performance traits
performance_groupREQUIREDSTRING---Performance group for the performance traits
remarksOPTIONALSTRING---Remarks for the performance traits
metaOPTIONALANY---Any additional value that is sent with the log.

Usage

     let opsScoreCardEvent = {
audit_count: 10,
fatal_calls: 11,
performance_group: "moderate"
}

CallCenter.logIngestEvent(CallCenterEventType.OpsScorecard, opsScoreCardEvent)