Skip to main content

SmsAero API client

Project description

SmsAero API client

PyPI version Python Versions Downloads License

Installation (from PyPI):

pip install -U smsaero-api

Usage example:

Get credentials from account settings page: https://smsaero.ru/cabinet/settings/apikey/

from pprint import pprint
from smsaero import SmsAero, SmsAeroException


SMSAERO_EMAIL = 'your email'
SMSAERO_API_KEY = 'your api key'


def send_sms(phone: int, message: str) -> dict:
    """
    Sends an SMS message

    Parameters:
    phone (int): The phone number to which the SMS message will be sent.
    message (str): The content of the SMS message to be sent.

    Returns:
    dict: A dictionary containing the response from the SmsAero API.
    """
    api = SmsAero(SMSAERO_EMAIL, SMSAERO_API_KEY)
    return api.send_sms(phone, message)


if __name__ == '__main__':
    try:
        result = send_sms(79038805678, 'Hello, World!')
        pprint(result)
    except SmsAeroException as e:
        print(f"An error occurred: {e}")

Exceptions:

  • SmsAeroException - base exception class for all exceptions raised by the library.
  • SmsAeroConnectionException - exception raised when there is a connection error.
  • SmsAeroNoMoneyException - exception raised when there is not enough money in the account.

Command line usage:

SMSAERO_EMAIL="your email"
SMSAERO_API_KEY="your api key"

smsaero_send --email "$SMSAERO_EMAIL" --api_key "$SMSAERO_API_KEY" --phone 79038805678 --message 'Hello, World!'

Run on Docker:

docker pull 'smsaero/smsaero_python:latest'
docker run -it --rm 'smsaero/smsaero_python:latest' smsaero_send --email "your email" --api_key "your api key" --phone 79038805678 --message 'Hello, World!'

Compatibility:

  • Currently version of library is compatible with Python 3.6+.
  • Previous versions of Python supported by versions 2.2.0 and below.

License:

MIT License

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

smsaero_api-3.0.0.tar.gz (19.9 kB view hashes)

Uploaded Source

Built Distribution

smsaero_api-3.0.0-py2.py3-none-any.whl (13.0 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page