Skip to main content

A package extending developable features of the Intelli-Africa Solutions SMS Gateway

Project description

Overview

  1. Installation

  2. Authenticate

  3. Assign CSV file path to variable CSV for a bulk sms

  4. Call either method for sending bulk or single SMSs

1. Installation

pip install intelli-sms-gateway # For Windows

pip3 install intelli-sms-gateway # For Linux

Should dependencies fail to automatically install

pip install requests && pip install pandas

#OR

pip3 install requests && pip3 install pandas

2. Authentication

Instantiate Client class byt passing the parameters email and password in that order

from intelli_sms_gateway.client import Client

# Import the client class from the client module

client = Client('foo@foo.com', 'password')

# This line of code with Authenticate you. Should you not be authenticated, it will raise an exception

Should the client be authenticated, this instantiation will return a property of value True. The reverse is true.

3. Getting Details On a Bulk SMS from a CSV

Define a variable, assign to it the path of the csv file you want to use Make sure the first column in the CSV is named 'numbers' or the program will return errors. Phone numbers must be in the format 263777534224

4. Sending the messages

Bulk SMSes

Call the single SMS method of the client instance and pass the required parameters namely: message, csv, title The CSV that is being passed is the variable that contains the path to the CSV. Should the path be incorrect, errors will be raised

# We send a bulk SMS after authentication

client.send_bulk_sms('Please attend the meeting at 1pm', csv_variable, 'Meeting announcament')

Single SMSes

Call the single SMS method of the client instance and pass the required parameters namely: message, receiver, title Phone numbers must be in the format 263777534224

# We send a single SMS after authentication

client.send_single_sms('Please attend the meeting at 1pm', '263777534224', 'Meeting announcament')

If your credentials are correct, your messages will not be sent

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

intelli-sms-gateway-0.1.6.tar.gz (3.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

intelli_sms_gateway-0.1.6-py3-none-any.whl (4.2 kB view details)

Uploaded Python 3

File details

Details for the file intelli-sms-gateway-0.1.6.tar.gz.

File metadata

  • Download URL: intelli-sms-gateway-0.1.6.tar.gz
  • Upload date:
  • Size: 3.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.3 pkginfo/1.7.1 requests/2.24.0 requests-toolbelt/0.9.1 tqdm/4.54.0 CPython/3.9.2

File hashes

Hashes for intelli-sms-gateway-0.1.6.tar.gz
Algorithm Hash digest
SHA256 a21eb8944fb3195d112f89e00fe2f4e5eb46193350edad701fb7e7a8cd365ca3
MD5 67bdc30d3b595a69f2c0764ac0656c05
BLAKE2b-256 be5a00c4ccfb15c5a896d80dfa65f817deadcf51e71523059b7fb6d54176fa9f

See more details on using hashes here.

File details

Details for the file intelli_sms_gateway-0.1.6-py3-none-any.whl.

File metadata

  • Download URL: intelli_sms_gateway-0.1.6-py3-none-any.whl
  • Upload date:
  • Size: 4.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.3 pkginfo/1.7.1 requests/2.24.0 requests-toolbelt/0.9.1 tqdm/4.54.0 CPython/3.9.2

File hashes

Hashes for intelli_sms_gateway-0.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 90c4301e14c9aebdd17b60b477ed55df14ad746020f1ef90535e036fd926e8b4
MD5 2314b4c2420e0d3246cdea5f565a5f37
BLAKE2b-256 e69d1ca16916804e5692f5469f8fcb5b7ee2436d2eec9fcdacd626d94d0a7963

See more details on using hashes here.

Supported by

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