Skip to main content

Very simple and easy to use library for integrating SSLWireless SMS API.

Project description

ismslib

Very simple and easy to use Python 3 library for integrating SSLWireless SMS API.

Installation

using virtual environment (pipenv)

pipenv install ismslib

using pip globally

python3 -m pip install ismslib

Example

from ismslib import ISMS

# Contact with SSLWireless Key Account Manager for these credentials
config = {
    "username": '<user>',
    "password": '<pass>',
    "sid": '<SID>',
}

response = ISMS.set_config(config)\
                .set_body("আসসালামু আলাইকুম").make_unicode()\
                .set_recipient(['88018XXXXXXXX', '88019XXXXXXXX'])\
                .send()

print(response) if response['error'] else print('success')

Usage

1. First we import the library

 from ismslib import ISMS

2. Set Credentials

Create a dictionary with user credentials obtained from SSLWireless.

config = {
    "username": '',  # Please add your username provided by SSLWireless
    "password": '',  # Please add your password provided by SSLWireless
    "sid": '',  # Please add your SID provided by SSLWireless
}

3. Set data

Call needed methods with valid data
ISMS.set_config(config) # Set config values
ISMS.set_body("আসসালামু আলাইকুম") #Set SMS body text, Can be English or Unicode Bangla
ISMS.make_unicode() # Use for Bangla SMS, otherwise is not needed
ISMS.set_recipient(['88018XXXXXXXX', '88019XXXXXXXX']) # list of mobile numbers to send to
ISMS.set_debug(True) # __DO NOT USE IN PRODUCTION__. Prints useful information on console.
response = ISMS.send() # Finally send SMS.
optionally, methods can be chained together
response = ISMS.set_config(config)\
                .set_body("আসসালামু আলাইকুম").make_unicode()\
                .set_recipient(['88018XXXXXXXX', '88019XXXXXXXX'])\
                .set_debug()\
                .send()

4. Check the returned response

We can print out the response in console

print(response) if response['error'] else print('success')

Return values

"send()" returns a dictionary containing 3 values
{'error': True, 'msg': 'Login FAILED. Please check your username and password.', 'json': '{"REPLY": {"PARAMETER": "OK", "LOGIN": "FAIL"}}'}
1. error [boolean] : False if SMS sent successfully, True on error
2. msg [string] : Error message. Explains the reason of failure.
3. json [json string] : Raw API response, it's there if needed.

Contribution

Star ⭐ this repo if you find it useful. Any feedback is much appreciated. For official support / user credentials, contact your Key Account Manager (KAM).

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

ismslib-2.1.tar.gz (3.7 kB view hashes)

Uploaded Source

Built Distribution

ismslib-2.1-py3-none-any.whl (16.4 kB view hashes)

Uploaded 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