android-sms-gateway

<a name="readme-top"></a>

<!-- PROJECT SHIELDS -->
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![Apache 2.0 License][license-shield]][license-url]



<!-- PROJECT LOGO -->
<br />
<div align="center">
  <a href="https://github.com/capcom6/android-sms-gateway">
    <img src="assets/logo.png" alt="Logo" width="80" height="80">
  </a>

<h3 align="center">SMS Gateway for Android™</h3>

  <p align="center">
    Turns your smartphone into an SMS gateway for sending and receiving messages via API.
    <br />
    <a href="https://sms-gate.app"><strong>Explore the docs »</strong></a>
    <br />
    <br />
    <a href="https://github.com/capcom6/android-sms-gateway/issues">Report Bug</a>
    ·
    <a href="https://github.com/capcom6/android-sms-gateway/issues">Request Feature</a>
  </p>
</div>



<!-- TABLE OF CONTENTS -->
- [About The Project](#about-the-project)
  - [Features](#features)
  - [Ideal For](#ideal-for)
  - [Built With](#built-with)
- [Installation](#installation)
  - [Build Variants](#build-variants)
  - [Prerequisites](#prerequisites)
    - [Permissions](#permissions)
  - [Installation from APK](#installation-from-apk)
  - [Build from Source](#build-from-source)
- [Getting Started](#getting-started)
  - [Local Server](#local-server)
  - [Cloud Server](#cloud-server)
    - [Device Registration](#device-registration)
    - [Unregister Device](#unregister-device)
  - [Webhooks](#webhooks)
    - [Supported Events](#supported-events)
    - [Setting Up Webhooks](#setting-up-webhooks)
- [Roadmap](#roadmap)
- [Contributing](#contributing)
- [License](#license)
- [Contact](#contact)
  - [Links](#links)

<!-- ABOUT THE PROJECT -->
## About The Project

<p align="center"><img src="assets/screenshot.png" width="360"></p>


SMS Gateway turns your Android smartphone into an SMS gateway. It's a lightweight application that allows you to send SMS messages programmatically via an API or CLI tool and receive webhooks on incoming SMS. This makes it ideal for integrating SMS functionality into your own applications or services.

### Features

📱 Core Functionality:

- 📝 **No personal information required:** Creating an account needs no email or personal details. In cloud mode the device is registered only after you sign up or sign in; in local mode you don't need an account at all!
- 📨 **Send and Receive SMS via API:** Use [our API](https://docs.sms-gate.app/integration/api/) to send messages directly from your applications or services.
- 🤖 **Support for Android 5.0 and above:** Compatible with Android 5.0 and later versions. [See Android 15 Note](https://docs.sms-gate.app/faq/general/#does-the-app-support-android-15)
- 👤 **Explicit device registration:** The device never registers itself in the background — in cloud mode you always sign up or sign in first.
- 🗑️ **Unregister device:** Remove the cloud registration from the device at