flutter_callkit_incoming

The plugin provides the following capabilities:

• Displaying incoming call interfaces.
• Initiating outgoing calls.
• Custom UI for Android and standard CallKit integration for iOS.
• Support for PushKit/VoIP on iOS to wake the app from a terminated state.

When implementing incoming calls on iOS, please note the following critical requirements:

• Real Device Only: CallKit is not fully supported on the iOS simulator for incoming VoIP calls. You must use a physical device for testing.
• PushKit Setup: To ensure the app can be woken from a terminated state for incoming VoIP calls, you must set up PushKit.

To use this plugin in your Flutter project, follow these steps:

1. Install Packages: Add flutter_callkit_incoming to your pubspec.yaml dependencies.
2. Configure Project: Perform platform-specific configurations for Android and iOS (details in subsequent sections).
3. Usage: Implement the API to show incoming or outgoing calls.

dependencies:
  flutter_callkit_incoming: ^3.1.5

To change the launch screen image for the iOS version of your app, you can either replace the image files directly in the example/ios/Runner/Assets.xcassets/LaunchImage.imageset/ directory or use Xcode for a more visual approach.

Using Xcode:

1. Open your Flutter project's iOS workspace using: open ios/Runner.xcworkspace.
2. In the Xcode Project Navigator, navigate to Runner/Assets.xcassets.
3. Drag and drop your desired images into the asset catalog to replace the existing ones.

After setting up certificates, you must configure your iOS project to handle incoming VoIP pushes.

• AppDelegate Configuration: You need to implement logic in your AppDelegate.swift to handle the DeviceToken and incoming pushes.
• Reference Implementation: A complete example of the required AppDelegate.swift configuration can be found in the project's example directory: example/ios/Runner/AppDelegate.swift.

Ensure your app is configured to handle the lifecycle of a call, including starting calls from recent history if necessary.

To use the plugin on iOS, update your Info.plist to include the necessary background modes. If you need to process background tasks, you can also include processing.

Swift Package Manager (SPM) Support

For Flutter 3.24+, this plugin supports SPM. To use SPM instead of CocoaPods, run: flutter config --enable-swift-package-manager.

Note: CocoaPods is in maintenance mode and will become read-only in December 2026; SPM is highly recommended for modern projects.

<!-- Info.plist -->
<key>UIBackgroundModes</key>
<array>
    <string>voip</string>
    <string>remote-notification</string>
    <string>processing</string>
</array>

You can test your VoIP push implementation by sending a manual request to the Apple Push Notification service (APNs) using curl.

Requirements:

• A generated VOIP.pem file.
• The target device token.
• The correct apns-topic (your app's bundle ID).

Note for Terminated State Testing: To test how your app behaves when it is in a terminated state, configure your Xcode scheme: Xcode -> Edit Schema -> Wait for the executable to be launched.

curl -v \
-d '{"aps":{"alert":"Hien Nguyen Call"},"id":"44d915e1-5ff4-4bed-bf13-c423048ec97a","nameCaller":"Hien Nguyen","handle":"0123456789","isVideo":true}' \
-H "apns-topic: com.hiennv.testing.voip" \
-H "apns-push-type: voip" \
--http2 \
--cert VOIP.pem:'<passphrase>' \
https://api.development.push.apple.com/3/device/<device token>

The API provides methods to control the lifecycle of calls:

• Start Outgoing Call: startCall(params)
• Show Missed Call Notification: showMissCallNotification(params)
• Hide Call Notification (Android): hideCallkitIncoming(params)
• End Specific Call: endCall(uuid)
• End All Calls: endAllCalls()

// Start Outgoing Call
await FlutterCallkitIncoming.startCall(params);

// Show Missed Call
await FlutterCallkitIncoming.showMissCallNotification(params);

// End specific call
await FlutterCallkitIncoming.endCall(uuid);

// End all calls
await FlutterCallkitIncoming.endAllCalls();