You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
isra el 923da3bd7e fix(android): fix multisim issues on old phones 2 years ago
android fix(android): fix multisim issues on old phones 2 years ago
api feat(api): throttle all endpoints to 30 requests per minute 2 years ago
web chore(web): fix typo 2 years ago
README.md Update README.md 2 years ago

README.md

TextBee - Android SMS Gateway

A simple SMS gateway that allows users to send SMS messages from a web interface or from their application via a REST API. It utilizes android phones as SMS gateways.

  • Technology stack: React, Next.js, Node.js, NestJs, MongoDB, Android, Java
  • Link: https://textbee.dev

Usage

  1. Go to textbee.dev and register or login with your account
  2. Install the app on your android phone from textbee.dev/android
  3. Open the app and grant the permissions for SMS
  4. Go to textbee.dev/dashboard and click register device/ generate API Key
  5. Scan the QR code with the app or enter the API key manually
  6. You are ready to send SMS messages from the dashboard or from your application via the REST API

Code Snippet: Few lines of code showing how to send an SMS message via the REST API

const API_KEY = 'YOUR_API_KEY';
const DEVICE_ID = 'YOUR_DEVICE_ID';

await axios.post(`https://api.textbee.dev/api/v1/gateway/devices/${DEVICE_ID}/sendSMS?apiKey=${API_KEY}`, {
  receivers: [ '+251912345678' ],
  smsBody: 'Hello World!',
})

Contributing

Contributions are welcome!

  1. Fork the project.
  2. Create a feature or bugfix branch from main branch.
  3. Make sure your commit messages and PR comment summaries are descriptive.
  4. Create a pull request to the main branch.