Call Logs

Display CometChat Calls SDK v5 call logs on Flutter with call history, participants, call type, duration, and status details.

Retrieve call history for your application. Call logs provide detailed information about past calls including duration, participants, recordings, and status.

Fetch Call Logs

Use CallLogRequest to fetch call logs with pagination support. The builder pattern allows you to filter results by various criteria.

CallLogRequest callLogRequest = (CallLogRequestBuilder()..limit = 30).build();

callLogRequest.fetchNext(
  onSuccess: (List<CallLog> callLogs) {
    for (CallLog callLog in callLogs) {
      debugPrint("Session: ${callLog.sessionId}");
      debugPrint("Duration: ${callLog.totalDuration}");
      debugPrint("Status: ${callLog.status}");
    }
  },
  onError: (CometChatCallsException e) {
    debugPrint("Error: ${e.message}");
  },
);

CallLogRequestBuilder

CallLogRequestBuilder is a top-level class and exposes public fields, not setX() methods — configure it with Dart cascades, then .build().

Field	Type	Description
limit	int	Number of call logs to fetch per request (default: 30)
callType	String?	Filter by call type: video or audio
callStatus	String?	Filter by call status
hasRecording	bool	Filter calls that have recordings (default: false)
hasTranscriptions	bool	Filter calls that were transcribed, and attach each call’s transcripts to its log (default: false)
callCategory	String?	Filter by category: call or meet
callDirection	String?	Filter by direction: incoming or outgoing
uid	String?	Filter calls with a specific user
guid	String?	Filter calls with a specific group

Unlike SessionSettingsBuilder, which takes cascaded setter calls (..setType(...)), this builder takes cascaded field assignments (..callType = "video"). The two look alike and are not the same shape.

hasTranscriptions is the one exception: it has a setHasTranscriptions(bool) method as well as the field, added for parity with the other CometChat SDKs. Either works; the field assignment is consistent with the rest of this builder.

Filter Examples

// Fetch only video calls
CallLogRequest videoCallsRequest = (CallLogRequestBuilder()
      ..callType = "video"
      ..limit = 20)
    .build();

// Fetch calls with recordings
CallLogRequest recordedCallsRequest =
    (CallLogRequestBuilder()..hasRecording = true).build();

// Fetch missed incoming calls
CallLogRequest missedCallsRequest = (CallLogRequestBuilder()
      ..callStatus = "missed"
      ..callDirection = "incoming")
    .build();

// Fetch calls with a specific user
CallLogRequest userCallsRequest =
    (CallLogRequestBuilder()..uid = "user_id").build();

Pagination

Use fetchNext() and fetchPrevious() for pagination:

// Fetch next page
callLogRequest.fetchNext(
  onSuccess: (List<CallLog> callLogs) {
    // Handle next page
  },
  onError: (CometChatCallsException e) {
    debugPrint("Error: ${e.message}");
  },
);

// Fetch previous page
callLogRequest.fetchPrevious(
  onSuccess: (List<CallLog> callLogs) {
    // Handle previous page
  },
  onError: (CometChatCallsException e) {
    debugPrint("Error: ${e.message}");
  },
);

CallLog Object

Each CallLog object contains detailed information about a call:

Property	Type	Description
sessionID	String	Unique identifier for the call session
initiator	CallEntity	User who initiated the call
receiver	CallEntity	User or group that received the call
receiverType	String	user or group
type	String	Call type: video or audio
status	String	Final status of the call
callCategory	String	Category: call or meet
initiatedAt	int	Timestamp when call was initiated
endedAt	int	Timestamp when call ended
totalDuration	String	Human-readable duration (e.g., “5:30”)
totalDurationInMinutes	double	Duration in minutes
totalAudioMinutes	double	Audio duration in minutes
totalVideoMinutes	double	Video duration in minutes
totalParticipants	int	Number of participants
hasRecording	bool	Whether the call was recorded
recordings	List<Recording>	List of recording objects
transcriptions	List<Transcript>?	List of transcript objects; null unless the request opted in
participantInfoList	List<ParticipantInfo>	List of participant details

Access Recordings

If a call has recordings, access them through the recordings property:

callLogRequest.fetchNext(
  onSuccess: (List<CallLog> callLogs) {
    for (CallLog callLog in callLogs) {
      if (callLog.hasRecording == true) {
        callLog.recordings?.forEach((recording) {
          debugPrint("Recording ID: ${recording.rid}");
          debugPrint("Recording URL: ${recording.recordingUrl}");
          debugPrint("Duration: ${recording.duration} seconds");
        });
      }
    }
  },
  onError: (CometChatCallsException e) {
    debugPrint("Error: ${e.message}");
  },
);

Access Transcripts

Available since v5.0.7

Set hasTranscriptions to fetch only calls that were transcribed. Opting in also makes the server attach each call’s transcripts to the log:

CallLogRequest transcribedCallsRequest = (CallLogRequestBuilder()
      ..limit = 30
      ..hasTranscriptions = true)
    .build();

transcribedCallsRequest.fetchNext(
  onSuccess: (List<CallLog> callLogs) {
    for (CallLog callLog in callLogs) {
      for (final transcript in callLog.getTranscriptions()) {
        debugPrint("Transcript ID: ${transcript.tid}");
        debugPrint("Transcript URL: ${transcript.transcriptUrl}");
      }
    }
  },
  onError: (CometChatCallsException e) {
    debugPrint("Error: ${e.message}");
  },
);

getTranscriptions() returns an empty list when the server omitted transcripts, so it never needs a null check. Leaving the filter off sends no filter at all, so the list comes back unfiltered. To page through a single session’s transcripts directly, use TranscriptRequestBuilder.

Call Status Values

Status	Description
ongoing	Call is currently in progress
busy	Receiver was busy
rejected	Call was rejected
cancelled	Call was cancelled by initiator
ended	Call ended normally
missed	Call was missed
initiated	Call was initiated but not answered
unanswered	Call was not answered

Call Category Values

Category	Description
call	Direct call between users
meet	Meeting/conference call

Call Direction Values

Direction	Description
incoming	Call received by the user
outgoing	Call initiated by the user