Optional wellnessContextProvider: WellnessBreakContextProviderPrivate metricsPrivate pendingPrivate webexPrivate Optional Readonly wellnessFetches historic transcripts for an interaction. This API is allowed only when real-time transcription feature is enabled.
interaction/conversation identifier
Requests an Agent Wellness Break. The promise resolves when the HTTP request is accepted with status 202; the later approval or denial is delivered independently through a wellness notification.
A promise that resolves with no value after HTTP acceptance
Structured Contact Center error when disabled, stale, invalid, or delivery fails
await webex.cc.apiAIAssistant.requestWellnessBreak();
@public
Responds to a backend-provided Agent Wellness Break offer. The promise resolves when the HTTP request is accepted with status 202 and does not wait for a WebSocket completion event.
ACCEPTED, REJECTED, or NO_RESPONSE
A promise that resolves with no value after HTTP acceptance
Structured Contact Center error when disabled, stale, invalid, or delivery fails
await webex.cc.apiAIAssistant.respondToWellnessBreak({
action: WELLNESS_BREAK_USER_ACTIONS.ACCEPTED,
});
@public
Sends an event to the AI Assistant service.
agent identifier
interaction/conversation identifier
the type of event (e.g. 'CUSTOM_EVENT')
the name of the event (e.g. 'GET_TRANSCRIPTS')
Optional eventMetaData: Record<string, unknown>event-specific fields to include in eventDetails.data
Optional languageCode: stringlanguage code within eventDetails.data
Optional trackingId: stringtracking identifier within eventDetails.data
Optional publishTimestamp: numberOptional timeout: numberSends user action feedback for a real-time assistance adaptive card.
Real-time assistance user action parameters
HTTP response body from the AI Assistant event API
Private createPrivate getStatic Private getPrivate removePrivate send
ApiAIAssistant provides AI Assistant APIs for transcript controls.