mirror of
https://github.com/makayabou/asg-server.git
synced 2026-05-02 17:43:36 +02:00
[docs] use of for Android™
This commit is contained in:
parent
7ce1e88040
commit
f7b63ed3f3
21
README.md
21
README.md
@ -4,13 +4,13 @@
|
||||
[![Issues][issues-shield]][issues-url]
|
||||
[![Apache 2.0 License][license-shield]][license-url]
|
||||
|
||||
# Android SMS Gateway Server
|
||||
# SMS Gateway for Android™ Server
|
||||
|
||||
This server acts as the backend component of the [Android SMS Gateway](https://github.com/capcom6/android-sms-gateway), facilitating the sending of SMS messages through connected Android devices. It includes a RESTful API for message management, integration with Firebase Cloud Messaging (FCM), and a database for persistent storage.
|
||||
This server acts as the backend component of the [SMS Gateway for Android](https://github.com/capcom6/android-sms-gateway), facilitating the sending of SMS messages through connected Android devices. It includes a RESTful API for message management, integration with Firebase Cloud Messaging (FCM), and a database for persistent storage.
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- [Android SMS Gateway Server](#android-sms-gateway-server)
|
||||
- [SMS Gateway for Android™ Server](#sms-gateway-for-android-server)
|
||||
- [Table of Contents](#table-of-contents)
|
||||
- [Features](#features)
|
||||
- [Prerequisites](#prerequisites)
|
||||
@ -18,13 +18,16 @@ This server acts as the backend component of the [Android SMS Gateway](https://g
|
||||
- [Work modes](#work-modes)
|
||||
- [Contributing](#contributing)
|
||||
- [License](#license)
|
||||
- [Legal Notice](#legal-notice)
|
||||
|
||||
## Features
|
||||
|
||||
- Send SMS messages via a RESTful API.
|
||||
- Get message status.
|
||||
- Get the list of connected devices.
|
||||
- Public and private modes.
|
||||
- **SMS Messaging**: Dispatch SMS messages through a RESTful API.
|
||||
- **Message Status**: Retrieve status for sent messages.
|
||||
- **Device Management**: View information about connected Android devices.
|
||||
- **Webhooks**: Configure webhooks for event-driven notifications.
|
||||
- **Health Monitoring**: Access health check endpoints to ensure system integrity.
|
||||
- **Access Control**: Operate in either public mode for open access or private mode for restricted access.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
@ -74,6 +77,10 @@ Don't forget to give the project a star! Thanks again!
|
||||
|
||||
Distributed under the Apache-2.0 license. See [LICENSE](LICENSE) for more information.
|
||||
|
||||
## Legal Notice
|
||||
|
||||
Android is a trademark of Google LLC.
|
||||
|
||||
[contributors-shield]: https://img.shields.io/github/contributors/capcom6/sms-gateway.svg?style=for-the-badge
|
||||
[contributors-url]: https://github.com/capcom6/sms-gateway/graphs/contributors
|
||||
[forks-shield]: https://img.shields.io/github/forks/capcom6/sms-gateway.svg?style=for-the-badge
|
||||
|
||||
@ -4,8 +4,8 @@
|
||||
],
|
||||
"swagger": "2.0",
|
||||
"info": {
|
||||
"description": "Provides an API for (Android) SMS Gateway",
|
||||
"title": "SMS Gateway - API",
|
||||
"description": "This API provides programmatic access to sending SMS messages on Android devices. Features include sending SMS, checking message status, device management, webhook configuration, and system health checks.",
|
||||
"title": "SMS Gateway for Android™ API",
|
||||
"contact": {
|
||||
"name": "Aleksandr Soloshenko",
|
||||
"email": "i@capcom.me"
|
||||
|
||||
@ -321,8 +321,10 @@ info:
|
||||
contact:
|
||||
email: i@capcom.me
|
||||
name: Aleksandr Soloshenko
|
||||
description: Provides an API for (Android) SMS Gateway
|
||||
title: SMS Gateway - API
|
||||
description: This API provides programmatic access to sending SMS messages on Android
|
||||
devices. Features include sending SMS, checking message status, device management,
|
||||
webhook configuration, and system health checks.
|
||||
title: SMS Gateway for Android™ API
|
||||
version: '{APP_VERSION}'
|
||||
paths:
|
||||
/3rdparty/v1/device:
|
||||
|
||||
@ -11,9 +11,9 @@ import (
|
||||
// @name Authorization
|
||||
// @description Mobile device token
|
||||
|
||||
// @title SMS Gateway - API
|
||||
// @title SMS Gateway for Android™ API
|
||||
// @version {APP_VERSION}
|
||||
// @description Provides an API for (Android) SMS Gateway
|
||||
// @description This API provides programmatic access to sending SMS messages on Android devices. Features include sending SMS, checking message status, device management, webhook configuration, and system health checks.
|
||||
|
||||
// @contact.name Aleksandr Soloshenko
|
||||
// @contact.email i@capcom.me
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user