Call Logs

Call logs provide a history of calls made through your application. You can retrieve call logs using the CometChat Chat SDK’s call log APIs.

Call logs are managed by the CometChat Chat SDK, not the Calls SDK. Ensure you have the Chat SDK integrated to access call history.

Prerequisites

To use call logs, you need:

CometChat Chat SDK integrated (@cometchat/chat-sdk-react-native)
User authenticated with the Chat SDK

Retrieve Call Logs

Use the Calls SDK’s CallLogRequestBuilder to fetch call logs. It needs the logged-in user’s auth token:

import { CometChatCalls } from '@cometchat/calls-sdk-react-native';

async function fetchCallLogs() {
  const callLogRequest = new CometChatCalls.CallLogRequestBuilder()
    .setAuthToken(CometChatCalls.getUserAuthToken() ?? '')
    .setLimit(30)
    .setCallStatus('ended') // 'ongoing', 'busy', 'rejected', 'cancelled', 'ended', 'missed'
    .build();

  try {
    const callLogs = await callLogRequest.fetchNext();
    console.log('Call logs:', callLogs);
    return callLogs;
  } catch (error) {
    console.error('Error fetching call logs:', error);
    throw error;
  }
}

CallLogRequestBuilder Options

Method	Type	Description
`setLimit(limit)`	number	Maximum number of logs to fetch (default: 30, max: 100)
`setCallStatus(status)`	string	Filter by call status
`setCallType(type)`	string	Filter by call type (`audio` or `video`)
`setCallCategory(category)`	string	Filter by category: `call` or `meet`
`setCallDirection(direction)`	string	Filter by direction: `incoming` or `outgoing`
`setUid(uid)`	string	Calls with this user
`setGuid(guid)`	string	Calls with this group
`setHasRecording(hasRecording)`	boolean	Only calls with a recording
`setHasTranscriptions(hasTranscriptions)`	boolean	Only calls with transcripts
`setAuthToken(token)`	string	Auth token for the request

Call Status Values

Status	Description
`ongoing`	Currently active calls
`ended`	Completed calls
`cancelled`	Calls cancelled by the initiator
`rejected`	Calls rejected by the receiver
`busy`	Calls where the receiver was busy
`missed`	Calls that weren’t answered

Call Log Object

Each call log is a CallLog object. Read it through its getters:

Getter	Returns	Description
`getSessionID()`	string	Unique session identifier
`getInitiator()`	`CallUser`	User who initiated the call
`getReceiver()`	`CallUser` or `CallGroup`	Call recipient
`getReceiverType()`	string	`user` or `group`
`getStatus()`	string	Final status of the call
`getType()`	string	`audio` or `video`
`getInitiatedAt()`	number	Timestamp when the call was initiated
`getStartedAt()`	number	Timestamp when the call started
`getEndedAt()`	number	Timestamp when the call ended
`getTotalDuration()`	string	Call duration
`getParticipants()`	`Participant[]`	List of participants
`getRecordings()`	`Recording[]`	List of recordings (if any)
`getTranscriptions()`	`Transcription[]`	List of transcripts. Only attached when the request opts in with `setHasTranscriptions(true)`

Filter by User

Get call logs for a specific user:

const callLogRequest = new CometChatCalls.CallLogRequestBuilder()
  .setAuthToken(CometChatCalls.getUserAuthToken() ?? '')
  .setLimit(30)
  .setUid('user_uid')
  .build();

Filter by Group

Get call logs for a specific group:

const callLogRequest = new CometChatCalls.CallLogRequestBuilder()
  .setAuthToken(CometChatCalls.getUserAuthToken() ?? '')
  .setLimit(30)
  .setGuid('group_guid')
  .build();

Pagination

Fetch call logs in pages:

import { CometChatCalls } from '@cometchat/calls-sdk-react-native';

type CallLogRequest = ReturnType<InstanceType<typeof CometChatCalls.CallLogRequestBuilder>['build']>;

class CallLogManager {
  private callLogRequest: CallLogRequest;

  constructor() {
    this.callLogRequest = new CometChatCalls.CallLogRequestBuilder()
      .setAuthToken(CometChatCalls.getUserAuthToken() ?? '')
      .setLimit(30)
      .build();
  }

  async fetchNextPage() {
    try {
      const callLogs = await this.callLogRequest.fetchNext();
      return callLogs;
    } catch (error) {
      console.error('Error fetching call logs:', error);
      throw error;
    }
  }
}

// Usage
const manager = new CallLogManager();

// First page
const page1 = await manager.fetchNextPage();

// Next page
const page2 = await manager.fetchNextPage();

Transcripts

Available since v5.0.5 Use the Calls SDK’s CallLogRequestBuilder to fetch only calls that were transcribed. Opting in also makes the server attach each call’s transcripts to the log:

import { CometChatCalls } from '@cometchat/calls-sdk-react-native';

const callLogRequest = new CometChatCalls.CallLogRequestBuilder()
  .setLimit(30)
  .setHasTranscriptions(true)
  .build();

const callLogs = await callLogRequest.fetchNext();

callLogs.forEach((callLog) => {
  callLog.getTranscriptions().forEach((transcription) => {
    console.log(transcription.getTid(), transcription.getTranscriptURL());
  });
});

getTranscriptions() returns an empty array when the server omitted transcripts, so it never needs a null check. To page through a session’s transcripts directly, use TranscriptRequestBuilder.

Complete Example

import React, { useState, useEffect, useCallback } from 'react';
import { View, FlatList, Text, StyleSheet, ActivityIndicator } from 'react-native';
import { CometChatCalls } from '@cometchat/calls-sdk-react-native';

type CallLogRequest = ReturnType<InstanceType<typeof CometChatCalls.CallLogRequestBuilder>['build']>;
type CallLog = InstanceType<typeof CometChatCalls.CallLog>;

function CallLogsScreen() {
  const [callLogs, setCallLogs] = useState<CallLog[]>([]);
  const [loading, setLoading] = useState(true);
  const [loadingMore, setLoadingMore] = useState(false);
  const [callLogRequest, setCallLogRequest] = useState<CallLogRequest | null>(null);

  useEffect(() => {
    const request = new CometChatCalls.CallLogRequestBuilder()
      .setAuthToken(CometChatCalls.getUserAuthToken() ?? '')
      .setLimit(30)
      .build();
    setCallLogRequest(request);
    fetchCallLogs(request);
  }, []);

  const fetchCallLogs = async (request: CallLogRequest) => {
    try {
      const logs = await request.fetchNext();
      setCallLogs(logs);
    } catch (error) {
      console.error('Error fetching call logs:', error);
    } finally {
      setLoading(false);
    }
  };

  const loadMore = useCallback(async () => {
    if (!callLogRequest || loadingMore) return;

    setLoadingMore(true);
    try {
      const moreLogs = await callLogRequest.fetchNext();
      setCallLogs((prev) => [...prev, ...moreLogs]);
    } catch (error) {
      console.error('Error loading more:', error);
    } finally {
      setLoadingMore(false);
    }
  }, [callLogRequest, loadingMore]);

  const formatDate = (timestamp: number) => {
    return new Date(timestamp * 1000).toLocaleString();
  };

  const renderCallLog = ({ item }: { item: CallLog }) => (
    <View style={styles.callLogItem}>
      <View style={styles.callInfo}>
        <Text style={styles.participantName}>
          {item.getInitiator().getName()} → {item.getReceiver().getName()}
        </Text>
        <Text style={styles.callDetails}>
          {item.getType()} • {item.getStatus()}
        </Text>
        <Text style={styles.callTime}>{formatDate(item.getInitiatedAt())}</Text>
      </View>
      <Text style={styles.duration}>
        {item.getTotalDuration() || '-'}
      </Text>
    </View>
  );

  if (loading) {
    return (
      <View style={styles.centered}>
        <ActivityIndicator size="large" />
      </View>
    );
  }

  return (
    <FlatList
      data={callLogs}
      keyExtractor={(item) => item.getSessionID()}
      renderItem={renderCallLog}
      onEndReached={loadMore}
      onEndReachedThreshold={0.5}
      ListFooterComponent={
        loadingMore ? <ActivityIndicator style={styles.footer} /> : null
      }
      ListEmptyComponent={
        <View style={styles.centered}>
          <Text style={styles.emptyText}>No call logs</Text>
        </View>
      }
    />
  );
}

const styles = StyleSheet.create({
  centered: {
    flex: 1,
    justifyContent: 'center',
    alignItems: 'center',
  },
  callLogItem: {
    flexDirection: 'row',
    justifyContent: 'space-between',
    alignItems: 'center',
    padding: 16,
    borderBottomWidth: 1,
    borderBottomColor: '#eee',
  },
  callInfo: {
    flex: 1,
  },
  participantName: {
    fontSize: 16,
    fontWeight: '600',
  },
  callDetails: {
    fontSize: 14,
    color: '#666',
    marginTop: 4,
  },
  callTime: {
    fontSize: 12,
    color: '#999',
    marginTop: 4,
  },
  duration: {
    fontSize: 14,
    color: '#333',
  },
  footer: {
    padding: 16,
  },
  emptyText: {
    fontSize: 16,
    color: '#999',
  },
});

export default CallLogsScreen;

Recording - Access call recordings
Transcription - Retrieve call transcripts
Ringing - Implement call notifications

Overview

Getting Started

Call Session

Features

Advanced

Migration Guide

Resources

Prerequisites

Retrieve Call Logs

CallLogRequestBuilder Options

Call Status Values

Call Log Object

Filter by User

Filter by Group

Transcripts

Complete Example

​Prerequisites

​Retrieve Call Logs

​CallLogRequestBuilder Options

​Call Status Values

​Call Log Object

​Filter by User

​Filter by Group

​Pagination

​Transcripts

​Complete Example

​Related Documentation

Prerequisites

Retrieve Call Logs

CallLogRequestBuilder Options

Call Status Values

Call Log Object

Filter by User

Filter by Group

Pagination

Transcripts

Complete Example

Related Documentation