Skip to main content

Send SMS messages to mobile devices through GABIA SMS api.

Project description

Python 2 & 3 compatible

https://travis-ci.org/hwshim0810/gabia-sms-Django.svg?branch=master https://coveralls.io/repos/github/hwshim0810/gabia-sms-Django/badge.svg?branch=master

Quickstart

Send sms message to use shortcut function

import gabia_sms

try:
    # Send single SMS
    gabia_sms.send(message='message', receiver='will receive phone number')

except SMSModuleException:
    print('SMS send failure')
  • SMS Types: [‘sms’, ‘lms’, ‘multi_sms’, ‘multi_lms’]

  • Send function returning Tuple(Unique key, Result code)

More usage

import gabia_sms

try:
    # Reserve single SMS
    gabia_sms.send(
        message='message',
        receiver='will receive phone number',
        scheduled_time='2018-02-02 22:22:22'
    )

    # Send multiple SMS
    gabia_sms.send(message='message', receiver=['phone number', '...'])
    gabia_sms.send(message='message', receiver=('phone number', '...'))

    # Reserve multiple SMS
    gabia_sms.send(
        message='message',
        receiver=['phone number', '...'],
        scheduled_time='2018-02-02 22:22:22'
    )

    # Cancel reservation
    gabia_sms.cancel_reservation('Unique key', 'SMS type')

    # Request result code
    gabia_sms.get_send_result('Unique key')

except SMSModuleException:
    print('SMS send failure')

Advanced usage

Inherit SMS class, override post_sent_sms / before_send_sms

import gabia_sms

class AdvancedSMSModule(GabiaSMS):

  def post_sms_sent(self, param, *args, **kwargs):
     # ... Do what you need

  def before_send_sms(self, param, *args, **kwargs):
     # ... Do what you need

AdvancedSMSModule.send(message='message', receiver='will receive phone number')

Dependencies

  • Python 2.7 or 3.4+

  • Django 1.11+

Installation

You can install the library directly from pypi using pip:

$ pip install gabia-sms-Django

Edit your settings.py file:

GABIA_SMS_SETTINGS = {
    'SENDER': 'YOUR NUMBER',
    'API_ID': 'YOUR API ID,
    'API_KEY': 'YOUR API KEY'
}

Contributors

See https://github.com/hwshim0810/gabia-sms-Django/graphs/contributors

Project details


Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

gabia_sms_Django-1.1.1-py3-none-any.whl (8.8 kB view details)

Uploaded Python 3

File details

Details for the file gabia_sms_Django-1.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for gabia_sms_Django-1.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 90ca3033bb959057d195f7decc60562e6457bbce57d54b7474f22b2cf8c4eb29
MD5 859dbe94d3f93f51b59705df7f4193bf
BLAKE2b-256 c9507c39d8dadaf43b3ed54dac7c5dbcd2fb527d6509cf7d6a6e45150da39038

See more details on using hashes here.

Supported by

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