A call summary is a compact record of a completed call. Use it for support and reporting when you need the important participants, issues, and outcomes without reading every raw sample. Enable it before calls start so it observes their full lifecycle.

Call summaries capture selected call-level results when a call closes. Persist full samples through a sink when you need detailed history.

Configure before the call begins#

Summaries are disabled when callSummary is absent or null. Supplying an object enables collection; its default inclusion list is empty. Choose the sections you need instead of assuming every detail will be captured.

Default caps are 500 issue entries and 10,000 client IDs. Samples and summaries serve different purposes: use a sink for full sample history and a summary for call-level reporting.

Save a completed-call record#

const observer = new Observer({
  callSummary: {
    include: ['clients', 'issues', 'scores'],
  },
});
observer.on('call-summary', ({ summary }) => {
  archive(summary);
});

archive is your application’s persistence function. The summary is emitted when the call closes, including closure after its empty-call grace period. Decide how to store it and how to handle persistence failures in your service.

Sections and collection#

Choose from clients, issues, turnServers and scores, with optional event enrichers. Truncation is recorded when configured caps are reached.

Collector subscriptions span the Observer. The final summary emits during call close.

Sources: CallSummary, CallSummaryCollector.