Skip to main content

📱 SMSGate Python Client

Contributors Forks Stars Issues License PyPI Version

A modern Python client for the SMSGate API: send SMS messages through your Android devices with synchronous and asynchronous interfaces, Basic or JWT authentication, and optional end-to-end encryption. See the client libraries overview for the full ecosystem.

📖 About

android-sms-gateway is a typed Python library for the SMSGate 3rd-party API, with fully type-hinted domain models. It ships a synchronous APIClient and an asynchronous AsyncAPIClient, auto-detects the installed HTTP backend (requests, aiohttp, or httpx), and supports optional end-to-end message encryption via Encryptor (AES-256-CBC). Covers messages (SMS, data, and MMS), inbox (refresh, attachments), devices, webhooks, settings, logs, health probes, and the JWT token lifecycle.

📚 Table of Contents

⭐ Features

  • Synchronous APIClient and asynchronous AsyncAPIClient (context managers)
  • Basic and JWT authentication; token generate, refresh, and revoke
  • HTTP backends: requests (sync), aiohttp (async), httpx (both), auto-detected
  • Optional end-to-end encryption via Encryptor (AES-256-CBC)
  • Webhooks, devices, settings, logs, and health probes (live, ready, startup)
  • Outgoing MMS with subject, text, and base64 attachments via MmsMessage (E2E-encrypted when configured)
  • Inbox refresh with webhook delivery and MMS attachment download
  • Full type hints and typed exceptions (APIError subclasses)

📦 Installation

pip install android-sms-gateway

Requires Python 3.9+. Optional extras:

pip install android-sms-gateway[requests]    # sync requests backend
pip install android-sms-gateway[aiohttp]     # async aiohttp backend
pip install android-sms-gateway[httpx]       # httpx backend (sync + async)
pip install android-sms-gateway[encryption]  # end-to-end encryption (pycryptodome)

🚀 Getting Started

Prerequisites

  • Python 3.9 or higher
  • An SMSGate account with API credentials
  • An Android device running the SMSGate app

Quick Setup

  1. Install the library with your preferred HTTP backend:

    pip install android-sms-gateway[requests]
    
  2. Set environment variables:

    export SMSGATE_LOGIN="your-login"
    export SMSGATE_PASSWORD="your-password"
    
  3. Send your first message:

    import os
    from android_sms_gateway import client, domain
    
    message = domain.Message(
        phone_numbers=["+12025550100"],
        text_message=domain.TextMessage(text="Hello from Python"),
    )
    
    with client.APIClient(os.getenv("SMSGATE_LOGIN"), os.getenv("SMSGATE_PASSWORD")) as c:
        state = c.send(message)
        print(f"Message ID: {state.id}")
    

🔑 Authentication

Two methods are supported: Basic authentication with account credentials, and JWT bearer tokens with scoped permissions. Pass login=None with a token to switch to JWT.

Basic Authentication

import os

from android_sms_gateway import client, domain

login = os.getenv("SMSGATE_LOGIN")
password = os.getenv("SMSGATE_PASSWORD")
message = domain.Message(
    phone_numbers=["+12025550100"],
    text_message=domain.TextMessage(text="Hello from Python"),
)

with client.APIClient(login, password) as c:
    state = c.send(message)

JWT Authentication

from android_sms_gateway import client, domain

with client.APIClient(login, password) as c:
    token = c.generate_token(
        domain.TokenRequest(scopes=["messages:send", "messages:read"], ttl=3600)
    )

jwt_client = client.APIClient(None, token.access_token)

💻 Usage

Beyond sending, the client covers message listing and cancellation, inbox listing and refresh, device management, health checks, logs, settings (get, update, patch), webhooks, and the token lifecycle. See android_sms_gateway/client.py for the complete method list with signatures and android_sms_gateway/domain.py for the domain models.

📖 API Reference

🗺️ Roadmap

  • Add support for batch message sending
  • Implement message scheduling
  • Add webhook signature verification
  • Support for custom HTTP headers
  • Async context manager improvements

See the open issues for a full list of proposed features and known issues.

🤝 Contributing

Contributions are welcome. Open an issue to discuss major changes before submitting a pull request; PRs target the master branch.

📞 Contact

Aleksandr Soloshenko - admin@sms-gate.app

Project Link: https://github.com/android-sms-gateway/client-py

📄 License

Distributed under the Apache License 2.0. See LICENSE.

🙏 Acknowledgments

Metadata

Release files for android-sms-gateway 4.3.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for android-sms-gateway 4.3.3
File Size Uploaded Provenance Actions
android_sms_gateway-4.3.3.tar.gz 39.7 kB With provenance Details for android_sms_gateway-4.3.3.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for android-sms-gateway 4.3.3
File Interpreter ABI Platform Actions
android_sms_gateway-4.3.3-py3-none-any.whl Python 3 none any Details for android_sms_gateway-4.3.3-py3-none-any.whl

Total release size: 67.6 kB

Release files / android_sms_gateway-4.3.3.tar.gz

Download URL android_sms_gateway-4.3.3.tar.gz
Size 39.7 kB
Tags Source
SHA-256 checksum
How to use checksums
5258ab44831cee9689f0bd893c31adc0b4290312c52ad0777a9cfa0267c30db2
BLAKE2b-256 checksum
How to use checksums
c7f4438bb41d5d9f2c12eb98a80e04b4e068d7805e91e7eda204ba28028933a4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 26, 2026.

Transparency log

Release files / android_sms_gateway-4.3.3-py3-none-any.whl

Download URL android_sms_gateway-4.3.3-py3-none-any.whl
Size 27.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
91db4d1d2115ba319b7499bfb37a9d01ac0d7af538c55ede6fcc353f8a6e2fc1
BLAKE2b-256 checksum
How to use checksums
e2f727b9d96c411e828d23fd48f15f6b7b78cea38591f8048c8229144cd29454
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 26, 2026.

Transparency log

Security for android-sms-gateway 4.3.3

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for android_sms_gateway-4.3.3.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 26, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page