flutter_tele #

A Flutter plugin for telephony operations based on Android's InCallService and telecom APIs.

Features #

• Make outgoing calls
• Answer incoming calls
• Hangup/decline calls
• Hold/unhold calls
• Mute/unmute calls
• Switch between speaker and earpiece
• Real-time call state monitoring
• Event-driven architecture for call events
• Support for multiple SIM cards
• Dialer replacement functionality - Set your app as the default dialer

Getting Started #

Installation #

Add this to your package's pubspec.yaml file:

dependencies:
  flutter_tele: ^2.0.5+105

Android Permissions #

Add the following permissions to your android/app/src/main/AndroidManifest.xml:

<uses-permission android:name="android.permission.READ_PHONE_STATE" />
<uses-permission android:name="android.permission.CALL_PHONE" />
<uses-permission android:name="android.permission.READ_CALL_LOG" />
<uses-permission android:name="android.permission.MODIFY_PHONE_STATE" />
<uses-permission android:name="android.permission.READ_PRECISE_PHONE_STATE" />
<uses-permission android:name="android.permission.ANSWER_PHONE_CALLS" />
<uses-permission android:name="android.permission.MANAGE_OWN_CALLS" />
<uses-permission android:name="android.permission.USE_FULL_SCREEN_INTENT" />
<uses-permission android:name="android.permission.WAKE_LOCK" />
<uses-permission android:name="android.permission.FOREGROUND_SERVICE" />
<uses-permission android:name="android.permission.FOREGROUND_SERVICE_PHONE_CALL" />

Usage #

Initialize the Telephony Service

import 'package:flutter_tele/flutter_tele.dart';

final TeleEndpoint endpoint = TeleEndpoint();

// Start the telephony service
final result = await endpoint.start({
  'ReplaceDialer': false,
  'Permissions': false,
});

print('Initial calls: ${result['calls']}');

Dialer Replacement

// Check if this app is the default dialer
final isDefault = await TeleDialer.isDefaultDialer();
print('Is default dialer: $isDefault');

// Check if this app can be set as default dialer
final canSet = await TeleDialer.canSetDefaultDialer();
print('Can set as default dialer: $canSet');

// Set this app as the default dialer
if (canSet && !isDefault) {
  final success = await TeleDialer.setDefaultDialer();
  if (success) {
    print('Successfully set as default dialer');
  } else {
    print('Failed to set as default dialer');
  }
}

Make a Call

// Make an outgoing call
final call = await endpoint.makeCall(
  1, // SIM slot (1 or 2)
  '+1234567890', // Phone number
  null, // Call settings (optional)
  null, // Message data (optional)
);

print('Call initiated: ${call.id}');

Handle Call Events

// Listen for incoming calls
endpoint.on('call_received').listen((event) {
  print('Incoming call: $event');
  final call = TeleCall.fromMap(event);
  // Handle incoming call
});

// Listen for call state changes
endpoint.on('call_changed').listen((event) {
  print('Call state changed: $event');
  final call = TeleCall.fromMap(event);
  // Handle call state change
});

// Listen for call termination
endpoint.on('call_terminated').listen((event) {
  print('Call terminated: $event');
  final call = TeleCall.fromMap(event);
  // Handle call termination
});

Call Control Operations

// Answer an incoming call
await endpoint.answerCall(call);

// Hangup a call
await endpoint.hangupCall(call);

// Decline an incoming call
await endpoint.declineCall(call);

// Hold a call
await endpoint.holdCall(call);

// Unhold a call
await endpoint.unholdCall(call);

// Mute a call
await endpoint.muteCall(call);

// Unmute a call
await endpoint.unMuteCall(call);

// Use speaker
await endpoint.useSpeaker(call);

// Use earpiece
await endpoint.useEarpiece(call);

Call Information

// Get call duration
final duration = call.getTotalDuration();
final formattedDuration = call.getFormattedTotalDuration();

// Get call state
final state = call.getState();
final isTerminated = call.isTerminated();

// Get remote party information
final remoteNumber = call.getRemoteNumber();
final remoteName = call.getRemoteName();

Cleanup

// Dispose the endpoint when done
endpoint.dispose();

API Reference #

TeleEndpoint #

The main class for telephony operations.

Methods

• start(Map<String, dynamic> configuration) - Initialize the telephony service
• makeCall(int sim, String destination, Map<String, dynamic>? callSettings, Map<String, dynamic>? msgData) - Make an outgoing call
• answerCall(TeleCall call) - Answer an incoming call
• hangupCall(TeleCall call) - Hangup a call
• declineCall(TeleCall call) - Decline an incoming call
• holdCall(TeleCall call) - Hold a call
• unholdCall(TeleCall call) - Unhold a call
• muteCall(TeleCall call) - Mute a call
• unMuteCall(TeleCall call) - Unmute a call
• useSpeaker(TeleCall call) - Use speaker
• useEarpiece(TeleCall call) - Use earpiece
• sendEnvelope(TeleCall call) - Send envelope command
• dispose() - Clean up resources

Events

• call_received - Fired when a new call is received
• call_changed - Fired when call state changes
• call_terminated - Fired when a call is terminated
• connectivity_changed - Fired when connectivity changes

TeleDialer #

The dialer replacement functionality class.

Methods

• isDefaultDialer() - Check if this app is the default dialer
• setDefaultDialer() - Set this app as the default dialer
• canSetDefaultDialer() - Check if this app can be set as default dialer
• requestDefaultDialer() - Request to become the default dialer (opens system dialog)

TeleCall #

Represents a telephony call.

Properties

• id - Call identifier
• state - Current call state
• remoteNumber - Remote party number
• remoteName - Remote party name
• direction - Call direction (incoming/outgoing)
• held - Whether call is on hold
• muted - Whether call is muted
• speaker - Whether speaker is enabled

Methods

• getTotalDuration() - Get total call duration in seconds
• getFormattedTotalDuration() - Get formatted duration (MM:SS)
• getConnectDuration() - Get connected duration in seconds
• getFormattedConnectDuration() - Get formatted connected duration
• isTerminated() - Check if call is terminated
• toMap() - Convert to map for serialization
• fromMap(Map<String, dynamic> map) - Create from map

Dialer Replacement #

The plugin includes dialer replacement functionality that allows your app to become the default dialer on Android. This enables your app to:

• Receive incoming call notifications
• Handle dialer intents from other apps
• Provide a custom dialer interface
• Manage call history and contacts

Setting as Default Dialer #

// Check current status
final isDefault = await TeleDialer.isDefaultDialer();
final canSet = await TeleDialer.canSetDefaultDialer();

if (canSet && !isDefault) {
  // This will open the system settings dialog
  final success = await TeleDialer.setDefaultDialer();
  if (success) {
    print('App is now the default dialer');
  }
}

Handling Dialer Intents #

When your app is set as the default dialer, it will receive intents for:

• ACTION_DIAL - User wants to dial a number
• ACTION_CALL - User wants to make a call
• ACTION_VIEW - User wants to view call history

Your app should handle these intents appropriately.

Example #

See the example directory for a complete example application demonstrating all features including dialer replacement functionality.

Requirements #

• Android API level 21 or higher
• Flutter 3.3.0 or higher
• Dart 3.8.1 or higher

License #

This project is licensed under the ISC License.