https://github.com/maniac-tech/react-native-expo-read-sms
Library to read incoming SMS in Android for Expo (React Native)
https://github.com/maniac-tech/react-native-expo-read-sms
android android-sms expo react-native read-sms sms sms-notification
Last synced: about 1 year ago
JSON representation
Library to read incoming SMS in Android for Expo (React Native)
- Host: GitHub
- URL: https://github.com/maniac-tech/react-native-expo-read-sms
- Owner: maniac-tech
- License: mit
- Created: 2022-07-02T15:54:12.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2025-04-22T17:23:47.000Z (about 1 year ago)
- Last Synced: 2025-04-23T19:25:30.239Z (about 1 year ago)
- Topics: android, android-sms, expo, react-native, read-sms, sms, sms-notification
- Language: Java
- Homepage: https://react-native-expo-read-sms.vercel.app/
- Size: 1.12 MB
- Stars: 67
- Watchers: 1
- Forks: 26
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
react-native-expo-read-sms
Reading SMS made simple in React Native on Android
Documentation •
Installation •
Usage •
Example •
Methods •
License
## Installation
Install this in your managed Expo project by running this command:
`$ npm install @maniac-tech/react-native-expo-read-sms --save`
## Usage
1. Import the startReadSMS function after installation
`import { startReadSMS } from "@maniac-tech/react-native-expo-read-sms";`
2. Pass Success and Error callbacks
`startReadSMS(successCallbackFn, errorCallbackFn)`
3. Everytime an SMS has been received `successCallbackFn` will be called with the sms
## Example
You may refer to this sample application for how to use the library: [GitHub Repo](https://github.com/maniac-tech/ExpoReadSMS-TestApp)
## Methods
| Method name | Description | Params | Returns |
|-------------|-------------|--------|---------|
| `checkIfHasSMSPermission` | Function which checks if the application has `READ_SMS` and `RECEIVE_SMS` permissions | - | ```{ hasReceiveSmsPermission: true/false, hasReadSmsPermission: true/false }``` |
| `requestReadSMSPermission` | Requests `READ_SMS` and `RECEIVE_SMS` permission, if missing | - | Returns `true` if granted, and `false` otherwise |
| `startReadSMS` | Starts listening for incoming messages. Note: SMS Permissions should be present. | callback fn | Return a string with message orginating address, and message body. Example: `[+919999999999, this is a sample message body]` |
### Important Note:
Ensure your app has `READ_SMS`, and `RECEIVE_SMS`, failing which you'll receive error on calling the function
## Support
Tested on Expo SDK v44, v45 & v47, v48, v49, v50 and Node JS v18
## License
MIT
## Maintainers
[maniac-tech](https://github.com/maniac-tech/) Active maintainer
## Credits
- [Docusaurus](https://docusaurus.io/): For helping spin up and manitain the documentation with ease.