send text messages with bulksmszw api
Project description
BulkSmsZW-Api
- bulksmszw api for sending affordable text messages in Python
- for Embedded device supported library in C++ for ESP8266-Arduino boards for IoT check out the ported library bulksms ESP8266
Installation
- make sure git is installed on your system or download repo as zip
- In cmd or terminal do
$ git clone https://github.com/DonnC/BulkSmsZW-Api.git
$ cd BulkSmsZW-Api
$ python setup.py install
- or directly with pip,
python3.x
$ pip install bulksmszw
Authentication details
- register an account on bulksms website
- if already have an account, login on bulksms web portal
- Got to "My Account", then Click on "User Configuration", to obtain "Webservices token".
Sending default message
- test file test_api.py
- recipients is passed as a list of bulksms valid format
2637xxxxxxxx
, list can also contain groups#devteam
and can be mixed
api = Client(<username>, <token>)
respond = api.send("hello guys", ['2637xxxxxxxx', '#devteam', '#students'])
- Example script
from BulkSmsApi.Client import Client
bulksms = Client(<username>, <web-token>)
response = bulksms.send(body="bulk sms ZW api testing", recipients=['2637xxxxxxxx', '2637yyyyyyyy'])
print(response)
- On successful run, the response
Send message and get credits(text messages) left
credits
flag by default is set toFalse
- to receive the number of credits on your web portal, set the
credit
flag toTrue
api = Client(<username>, <token>)
credits_response = api.send(body="hello world", recipients=['2637xxxxxxxx'], credits=True)
print(credits_response)
Catch BulkSmsZw status errors as python exceptions
- You can wrap your code in a
try - except
to catch unsuccessful and bulksms error messages as normal python exceptions
# this wil throw an exception because of the wrong / not valid username
bulksms = Client(username=<wrong-username>, token=<web-token>)
try:
response = bulksms.send(body="bulk sms ZW api testing", recipients=['2637xxxxxxxx', '2637yyyyyyyy'])
print(response)
except Exception as exc:
print("Encountered an Error: %s" %exc)
Responses
- responses are in default JSON format used by BulkSMSZW service
acknowledgements
- Big shoutout to the BulkSMS ZW team
- Original bulksms python api script
- All credits to the Bulk SMS ZW Team
HTTP API
- api docs HTTP API INTEGRATION DOC
TODO
- Schedule messages
- Validate phone numbers
get in contact
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Bulksmsapi-zw-1.2.0.tar.gz
(4.4 kB
view hashes)
Built Distribution
Close
Hashes for Bulksmsapi_zw-1.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 02cc7c354ba3b912877534a32a4f3a7485c427784b7870312b260675928c2ecc |
|
MD5 | a2e5493053cb8f352701168c13ce2cb0 |
|
BLAKE2b-256 | 6c996121ed6d9f029e408a7c6fda3b17ee78f5691127b5ed2c0434dff1c5553b |