> For the complete documentation index, see [llms.txt](https://telephony.shounakmulay.dev/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://telephony.shounakmulay.dev/master.md).

# Telephony

{% hint style="danger" %}

### Thank you for checking out the Telephony plugin. Unfortunately, this plugin is no longer actively maintained.

{% endhint %}

{% hint style="success" %}
[Check out on GitHub](https://github.com/shounakmulay/Telephony)  
{% endhint %}

**This plugin currently only works on Android Platform**

A Flutter plugin to use telephony features such as

* Send SMS Messages
* Query SMS Messages
* Listen for incoming SMS
* Retrieve various network parameters

This plugin tries to replicate some of the functionality provided by Android's [Telephony](https://developer.android.com/reference/android/provider/Telephony) class.

Check the [Features section](/master.md#features) to see the list of implemented and missing features.

{% hint style="danger" %}

#### Telephony deals with features that require high risk or sensitive permissions.

Make sure that your app complies with the requirements of Google Play.\
\--> [https://support.google.com/googleplay/android-developer/answer/9214102](https://support.google.com/googleplay/android-developer/answer/9214102?hl=en)\
\--> <https://support.google.com/googleplay/android-developer/answer/9888170>
{% endhint %}

### Usage

To use this plugin add `telephony` as a [dependency in your pubspec.yaml file](https://flutter.dev/docs/development/packages-and-plugins/using-packages).

### Get Started

#### Setup

Import the `telephony` package

```dart
import 'package:telephony/telephony.dart';
```

Retrieve the singleton instance of `telephony` by calling

```dart
final Telephony telephony = Telephony.instance;
```

### Features

* [x] [Send SMS](/sending-an-sms.md)
* [x] [Query SMS](/query-sms.md)
  * [x] [Inbox](/query-sms.md#getinboxsms)
  * [x] [Sent](/query-sms.md#getsentsms)
  * [x] [Draft](/query-sms.md#getdraftsms)
* [x] [Query Conversations](/query-conversations.md)
* [x] [Listen to incoming SMS](/listen-incoming-sms.md)
  * [x] When app is in foreground
  * [x] When app is in background
* [x] [Network data and metrics](/network-data-and-metrics.md)
  * [x] [Cellular data state](/network-data-and-metrics.md#cellulardatastate)
  * [x] [Call state](/network-data-and-metrics.md#callstate)
  * [x] [Data activity](/network-data-and-metrics.md#dataactivity)
  * [x] [Network operator](/network-data-and-metrics.md#networkoperator)
  * [x] [Network operator name](/network-data-and-metrics.md#networkoperatorname)
  * [x] [Data network type](/network-data-and-metrics.md#datanetworktype)
  * [x] [Phone type](/network-data-and-metrics.md#phonetype)
  * [x] [Sim operator](/network-data-and-metrics.md#simoperator)
  * [x] [Sim operator name](/network-data-and-metrics.md#simoperatorname)
  * [x] [Sim state](/network-data-and-metrics.md#simstate)
  * [x] [Network roaming](/network-data-and-metrics.md#isnetworkroaming)
  * [x] [Signal strength](/network-data-and-metrics.md#signalstrengths)
  * [x] [Service state](/network-data-and-metrics.md#servicestate)
* [x] Start Phone Call
* [ ] Schedule a SMS
* [ ] SMS Retriever API