README.md

BulkSmsZW-Api

• Unofficial bulksmszw api for sending affordable text messages in Python using zim bulksms getaway providers
• Flutter dart package available here on pub.dev/bulksmszw
• for Embedded device supported library in C++ for ESP8266-Arduino boards for IoT check out the ported library bulksms ESP8266

Installation

$ pip install bulksmsapi-zw

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 to False
• to receive the number of credits on your web portal, set the credit flag to True

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

• the BulkSMS ZW team
• Original bulksms python api script

HTTP API

• api docs for bulksmsweb HTTP API INTEGRATION DOC

TODO

• Schedule messages
• Validate phone numbers

get in contact

• twitter
• whatsapp
• donychinhuru@gmail.com