Search packages, repositories and app categories

Package detailsv6.0.1

call_log

A Flutter plugin to access and query call history log. Support for Android only as iOS does not provide API for accessing call history.

Android
30-day downloads
6.3K
Likes
117
Pub points
160

Install package

flutter pub add call_log

Package Overview

Package selection guidance compiled from public package information, community data, and project usage.

The call_log package is a Flutter plugin that enables Android apps to access and query the device's call history. It provides a simple API to retrieve details such as caller number, call type (incoming, outgoing, missed), and call duration. As iOS does not expose call history APIs, this plugin is limited to Android only. It is useful for applications requiring call log integration, such as contact managers or communication tools. The package is maintained by 4q.eu and available via pub.dev.

Use cases

  • Accessing call history in Android apps
  • Building contact or call management tools
  • Integrating call logs into communication apps
  • Creating call analytics dashboards
  • Developing dialer or voicemail applications

Key features

  • Android-only support
  • Simple API for querying call logs
  • Retrieval of call details like number and type
  • Support for call duration and timestamps
  • Open-source code on GitHub

Suitable for

  • Android app developers
  • Call log management features
  • Communication and productivity apps
  • Apps needing user call history data

Considerations

  • Not compatible with iOS
  • Requires runtime permissions on Android
  • Limited to system call log data
  • May vary by device manufacturer
  • Privacy-sensitive data access

Original README

Original README snapshot from the linked source repository. Visit the repository for the latest content.

call_log

pub package

A Flutter plugin to access and query call history log.
Support for Android only as iOS does not provide API for accessing call history

Usage

To use this plugin, add call_log as a dependency in your pubspec.yaml file.

You may add the following permission to your Android Manifest:

<uses-permission android:name="android.permission.READ_CALL_LOG" />
<uses-permission android:name="android.permission.WRITE_CALL_LOG" />
<uses-permission android:name="android.permission.READ_PHONE_NUMBERS" />

Ensure that following options are present in your build.gradle:

compileOptions {
......//
coreLibraryDesugaringEnabled true
}

dependencies {
coreLibraryDesugaring 'com.android.tools:desugar_jdk_libs:1.2.2'
}

This plugin is able to handle checking and requesting permission automatically.
Currently implemented query params are dateFrom, dateTo, durationFrom, durationTo, name and number.
String params are queried using LIKE and '%' wildcard on both sides.

Migration to 6.0.0+

Since 6.0.0, we also check permission android.permission.READ_PHONE_NUMBERS, which is required for the simDisplayName to work in case of multiSim setups.

Add new permission to your manifest:

<uses-permission android:name="android.permission.READ_PHONE_NUMBERS" />

Delete Call Logs

You can delete specific call log entries or all call logs:

// Delete a specific call log entry
int deletedCount = await CallLog.deleteCallLog(entry.id);

// Delete all call logs
int deletedCount = await CallLog.deleteAllCallLogs();

The methods return the number of entries deleted (1 for single deletion, total count for bulk deletion).

Export Call Logs

You can export all call logs to a JSON file:

// Export call logs to Downloads directory with timestamp
Map<String, dynamic> result = await CallLog.exportCallLog();

The export method saves the file to the Downloads directory with a filename in the format call_log_YYYYMMDD_HHMMSS.json. The method returns a map containing the number of entries exported and the absolute path to the exported file.

Background execution

This plugin may be used in flutter background engine, via plugins like WorkManager. But please note that it is impossible for plugin to request permission while it is executed in background. You have to manually request permissions READ_CALL_LOG and READ_PHONE_STATE

Note on iOS support

Unfortuynately iOS doesn't support queries of call log. More information here: https://stackoverflow.com/questions/33753644/is-there-an-ios-api-for-accessing-call-logs

Example

// IMPORT PACKAGE
import 'package:call_log/call_log.dart';

// GET WHOLE CALL LOG
Iterable<CallLogEntry> entries = await CallLog.get();

// QUERY CALL LOG (ALL PARAMS ARE OPTIONAL)
var now = DateTime.now();
int from = now.subtract(Duration(days: 60)).millisecondsSinceEpoch;
int to = now.subtract(Duration(days: 30)).millisecondsSinceEpoch;
Iterable<CallLogEntry> entries = await CallLog.query(
      dateFrom: from,
      dateTo: to,
      durationFrom: 0,
      durationTo: 60,
      name: 'John Doe',
      number: '901700000',
      type: CallType.incoming,
    );

Todo

  • [x] query call log using most common fields, using AND as a logical gate
  • [ ] query call log with full power of native API

Contribution and Support

  • Contributions are welcome!
  • If you want to contribute code please create a PR
  • If you find a bug or want a feature, please fill an issue

Categories

Source repository

Projects using this package