/pySMSPilot

Python SMS Pilot API implementation

Primary LanguagePythonBSD 2-Clause "Simplified" LicenseBSD-2-Clause

pySMSPilot

English

Description

Python class with Implementation for SMS sending gateway API http://www.smspilot.ru/ You need regisration and API-Key to start using it. We use some features from API 2.3.2. API provider gives some free sms for testing purposes, henceforward you need to pay some fee for them. Prices provided on their site. Now available at PyPI. You can install it by running: pip install pySMSPilot

Installation ang quick start

After registering at http://www.smspilot.ru/:

  • Include it with:

import pySMSPilot.sender

  • Initialize class with your API-key:

Pilot = pySMSPilot.sender.Sender(api)

  • Add some sms messages with command:

    Pilot.add_sms([your_local_sms_id_int], "Phone number", u"SMS message", u"Sender name")

Note: phone number must be in format 7xxxxxxxxxx

Note: sender name must contain only latin letters dots and dashes, min length 3 letters, max - 11

Note: Ability to change sender name may be limited by service rules, refer to http://www.smspilot.ru/ to find out more

  • Run sending command with:

Result = Pilot.send()

Object with sending results will be returned. More info look at http://www.smspilot.ru/apikey.php

Russian

Описание

Класс имлементации использования API (версии 2.x) сайта http://www.smspilot.ru/ для отправки SMS рассылок. Для отправки смс необходима регистрация на сайте. Провайдер предоставляет несколько бесплатных смс для тестирования. Но в дальнейшем нужно оплачивать отправку каждого смс. Прайсы на сайте. По России недорого. Ок. 30 копеек за смс на сегодня. Теперь библиотека доступна через PyPI. Для установки просто выполните: pip install pySMSPilot

Инструкции

  • Подключить модуль:

import pySMSPilot.sender

  • Инициализировать класс API-ключом:

Pilot = pySMSPilot.sender.Sender(api)

  • Добавим одно или несколько sms вот так:

Pilot.add_sms([локальный_id_сообщения_int],"Номер телефона", u"SMS сообщение", u"Imya Otpravitelya")

Note: номер телефона должен быть в формате 7xxxxxxxxxx

Note: Imya Otpravitelya - имя отправителя может содежать только латинские буквы, точки и тире, длина мин 3 символа, макс - 11

Note: возможность изменять имя отправителя может быть ограничена сервисом, подробнее см. условия на сайте http://www.smspilot.ru/

  • Запускаем комманду отправки:

Result = Pilot.send()

Будет возвращен объект с результатами отправки. Больше информации см. http://www.smspilot.ru/apikey.php

  • Запрос баланса: {u'balance': 260.53} В попугаях (в штуках?) оставлено для совместимости, возможность не документирована

Pilot.checkBalance()

В рублях:

Result = Pilot.checkBalance('rur')

Возвращает объект с результатами запроса:

{u'balance': 260.53}

Copyright (c) 2013 by Stanislav Sokolov aka Ratso