A Python library to ease the integration with the Beem Africa (SMS, AIRTIME, OTP, 2WAY-SMS, BPAY, USSD)

Last update: Oct 29, 2022

Overview

python-client

A Python library to easy the integration with the Beem Africa SMS Gateway

Features to be Implemented

Getting started

To get started with exploring beem-africa you can either clone the repository or install directly from pip (pre-release is already deployed)

Installing from pip

pip install beem-africa

Installing directly from github

git clone https://github.com/beem-africa/python-client
cd python-client
python setup.py install

Authentication

The first thing you need to do before calling module in the beem-africa app is authorize our app with access key and secret key which can be obtained as you signup for beem-official website.

Do this to Authenticate !!

>>> from BeemAfrica import Authorize, AirTime, OTP, SMS
>>> Authorize('access-key', 'secret-key')

Sending SMS with BeemAfrica

To send SMS with beem africa now made easy, you can use single method to send single and multiple messages at once.

Here how you would send a single SMS with beem-africa, Note that I'm assuming you have already entered the correct access-key and secret-key

>>> SMS.send_sms('hello pythonista', '255xxxxxxxxxx')
{'successful': True, 'request_id': 35918915, 'code': 100, 'message': 'Message Submitted Successfully', 'valid': 1, 'invalid': 0, 'duplicates': 0}

The above example is that I'm assuming you're using default BeemAfrica sender ID to use yours just do this instead;

>>> SMS.send_sms(
        'You\'re now verified',
        '255xxxxxxxxx', 
        sender_id='new-sender-id'
        )

{'successful': True, 'request_id': 35918915, 'code': 100, 'message': 'Message Submitted Successfully', 'valid': 1, 'invalid': 0, 'duplicates': 0}

You can also schedule message to be sent after a certain time or at a specific time to do that together with new sender_id, do this instead !!

>>> SMS.send_sms(
        'You have won a 10 Million', 
        '2557xxxxxxxxx', 
        sender_id='new-sender-d', 
        schedule_time='scheduled time'
    )
{'successful': True, 'request_id': 35918915, 'code': 100, 'message': 'Message Submitted Successfully', 'valid': 1, 'invalid': 0, 'duplicates': 0}

Also instead of sending to one recipient per time you can send an SMS to Multiple clients at Once you just have to twist the send_sms() to look like this;

>>> SMS.send_sms('my-message', ['2557xxxxxx', '2557xxxxxx'])

Verifying One Time password with BeemAfrica

Apart from just sending SMS, Beem also provides OTP Services for One Time password verification system that is expected to be expired after a certain time that has been specified.

You can also use OTP to do 2-factor-authentication system to your app/website, Beem will generate a random OTP for you and provide you an endpoint to verify it.

Here how to send OTP with Beem !!

>>> OTP.send_otp('2557xxxxxx')
{'data': {'pinId': '4a5c2141-c965-4a9d-aca4-54f58063e831', 'message': {'code': 100, 'message': 'SMS sent successfully'}}}

To verify the OTP send to user do this !!

Note: Use pin_id from response you just recieve while sending an OTP and the PIN sent to user phone to verify the OTP, its going to look like this !!

>>> OTP.verify(pin_id='4a5c2141-c965-4a9d-aca4-54f58063e831', pin='122496')
{'data': {'message': {'code': 117, 'message': 'Valid Pin'}}}

AirTime

BeemAfrica also provide interface to interact with AirTime allowing you to easily transfer AirTime from BeemAfrica Credit to customer mobile !!

Here how to Transfer AirTime to customer mobile with Beem Africa !!

>>> AirTime.transfer_airtime('255757294146', 100)
{'code': 200, 'transaction_id': 1619484193194, 'message': 'Disbursement is in progress'}

By doing that now after few seconds check AirTime balance on mobile and it going to increase by +100 .

You can also check balance of remaining credit balance by doing this

>>> AirTime.get_credit_balance()
{'data': {'credit_bal': '708.0357'}}

Well these are the only implemented features by now !

Issues

Are you facing any issue with the integration of beem-africa libray, please raise an Issue so as we can fix as soon as we can !!

Contribution ?

Would you like to contribute to beem-africa python-client, Contributions of any kind is really welcomed, just fork it .. you can also reach me direct if you face any issue with contributing at isaaackeinstein(at)gmail(dot)com.

Give it star ?

Was this repository useful to you in any means, well then give it a star so as more people can get to know it.

Credits

All the credits to kalebu and all the future contributors

Comments

[Update]: accept App ID in OTP function, removing fixed app ID

In the latest version OTP function sets app id to a fixed app id which is 126, this returns an error because every client have a unique app id, so clients need to pass their app id in OTP function

opened by ProsperChihimba 0

Releases(0.1)

0.1(Apr 27, 2021)

it has got three main features ready implemented and Working, AirTime, Topup, SMS
Source code(tar.gz)
Source code(zip)

A Python library to ease the integration with the Beem Africa (SMS, AIRTIME, OTP, 2WAY-SMS, BPAY, USSD)

Related tags

Overview

python-client

Features to be Implemented

Getting started

Installing from pip

Installing directly from github

Authentication

Do this to Authenticate !!

Sending SMS with BeemAfrica

Verifying One Time password with BeemAfrica

AirTime

Issues

Contribution ?

Give it star ?

Credits

You might also like...

Netwalk is a Python library to discover, parse, analyze and change Cisco switched networks

An opensource library to use SNMP get/bulk/set/walk in Python

No-dependency, single file NNTP server library for developing modern, rfc3977-compliant (bridge) NNTP servers.

Script and library to wait for a DNS authority server to get its configuration.

A library of functions that can be used to manage the download of claims from the LBRY network.

Client library for relay - a service for relaying server side messages to the client side browsers via websockets.

Easy-to-use sync library for handy proxy parse

Network Engineer's Unified Realtime Automation Library

DataShare - Simple library for data sharing between scripts and public functions calling

Comments

[Update]: accept App ID in OTP function, removing fixed app ID

Releases(0.1)

0.1(Apr 27, 2021)

Owner

Beem Africa

High capacity, high availability, well connected, fast lightning node.

Event-driven networking engine written in Python.

Asyncer, async and await, focused on developer experience

Tool written on Python that locate all up host on your subnet

Arp-spoofing, this script was written for people who want to spoof any vulnerable machine such as Wİndows, of course it could have been more sophisticatedly created but these repos will be updated constantly

Asynchronous For Python(asyncio)

Multiple-requests-poster - A tool to send multiple requests to a particular website written in Python

A simple electrical network analyzer, BASED ON computer-aided design.

Secure connection between tenhou Window client and server.

An automatic web reconnaissance tool written in python3.

a decompilation of NAP36 the widevine removal software for amz and nf used by p2p groups until it stoped working due to it using expired cdm keys

No-dependency, single file NNTP server library for developing modern, rfc3977-compliant (bridge) NNTP servers.

Using AWS's API Gateway + Lambda + Python to run a simple websocket application. For learning/testing

NetworkX is a Python package for the creation, manipulation, and study of the structure, dynamics, and functions of complex networks.

Transfer files to and from a Windows host via ICMP in restricted network environments.

WARP+ uses Cloudflare’s virtual private backbone, known as Argo, to achieve higher speeds and ensure your connection is encrypted across the long haul of the Internet

The AKS cluster provisioner provisions AKS clusters :-)

This script aims to make the dynamic public ip of your local server, public.

User-friendly packet captures

Scan any IP address except IPv6 using Python.