android-sms-gateway

SMS Gateway for Android™ Python API Client

This is a Python client library for interfacing with the SMS Gateway for Android API.

Requirements

• Python >= 3.7
• One of the following packages:
  • requests
  • aiohttp
  • httpx

Optional:

• pycryptodome - end-to-end encryption support

Installation

pip install android_sms_gateway

You can also install it with the preferred HTTP client:

pip install android_sms_gateway[requests]
pip install android_sms_gateway[aiohttp]
pip install android_sms_gateway[httpx]

With encrypted messages support:

pip install android_sms_gateway[encryption]

Quickstart

Here's an example of using the client:

import asyncio
import os

from android_sms_gateway import client, domain, Encryptor

login = os.getenv("ANDROID_SMS_GATEWAY_LOGIN")
password = os.getenv("ANDROID_SMS_GATEWAY_PASSWORD")
# encryptor = Encryptor('passphrase') # for end-to-end encryption, see https://sms-gate.app/privacy/encryption/

message = domain.Message(
    "Your message text here.",
    ["[phone]"],
)

def sync_client():
    with client.APIClient(
        login, 
        password,
        # encryptor=encryptor,
    ) as c:
        state = c.send(message)
        print(state)

        state = c.get_state(state.id)
        print(state)


async def async_client():
    async with client.AsyncAPIClient(
        login, 
        password,
        # encryptor=encryptor,
    ) as c:
        state = await c.send(message)
        print(state)

        state = await c.get_state(state.id)
        print(state)

print("Sync client")
sync_client()

print("\nAsync client")
asyncio.run(async_client())

Client

There are two client classes: APIClient and AsyncAPIClient. The APIClient is synchronous and the AsyncAPIClient is asynchronous. Both implement the same interface and can be used as context managers.

Methods

There are two groups of methods:

Messages

• send(message: domain.Message) -> domain.MessageState: Send a new SMS message.
• get_state(_id: str) -> domain.MessageState: Retrieve the state of a previously sent message by its ID.

Webhooks

• get_webhooks() -> list[domain.Webhook]: Retrieve a list of all webhooks registered for the account.
• create_webhook(webhook: domain.Webhook) -> domain.Webhook: Create a new webhook.
• delete_webhook(_id: str): Delete a webhook by its ID.

HTTP Client

The API clients abstract away the HTTP client used to make requests. The library includes support for some popular HTTP clients and tries to discover them automatically:

• requests - APIClient only
• aiohttp - AsyncAPIClient only
• httpx - APIClient and AsyncAPIClient

You can also implement your own HTTP client that conforms to the http.HttpClient or ahttp.HttpClient protocol.

Contributing

Contributions are welcome! Please submit a pull request or create an issue for anything you'd like to add or change.

License

This library is open-sourced software licensed under the Apache-2.0 license.