Python sdk for Infobip's API
Project description
Infobip API Python SDK
Python client for Infobip's API channels.
📡 Supported channels
More channels to be added in the near future.
ℹ️ General Info
For infobip-api-python-sdk
versioning we use
Semantic Versioning scheme.
Python 3.6 is minimum supported version by this library.
🔐 Authentication
Currently, infobip-api-python-sdk only supports API Key authentication, and the key needs to be passed during client creation. This will most likely change with future versions, once more authentication methods are included.
📦 Installation
To install infobip SDK you will need to run:
pip install infobip-api-python-sdk
Details of the package can be found here
🚀 Usage
Code Example
To use the package you'll need an Infobip account. If you don't already have one, you can create a free trial account here.
In this example we will show how to send WhatsApp text message. Similar can be done for other channels. First step is to import necessary channel, in this case WhatsApp channel.
from infobip_channels.whatsapp.channel import WhatsAppChannel
Now you can create instance of WhatsAppChannel
with your base_url
and api_key
.
c = WhatsAppChannel.from_auth_params({
"base_url": "<your_base_url>",
"api_key": "<your_api_key>"
})
After that you can access all the methods from WhatsAppChannel
.
To send text message you can use send_text_message
method and add correct payload:
response = c.send_text_message(
{
"from": "<WhatsApp sender number from your Infobib account>",
"to": "<Number that will receive WhatsApp message>",
"messageId": "a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"content": {
"text": "Some text"
},
"callbackData": "Callback data",
"notifyUrl": "https://www.example.com/whatsapp"
}
)
🧪 Testing
To run tests position yourself in the project's root while your virtual environment is active and run:
python -m pytest
✅ Enable pre-commit hooks
To enable pre-commit hooks run:
pip install -r requirements/dev.txt
You will need to install pre-commit hooks Using homebrew:
brew install pre-commit
Using conda (via conda-forge):
conda install -c conda-forge pre-commit
To check installation run:
pre-commit --version
If installation was successful you will see version number.
You can find the Pre-commit configuration in .pre-commit-config.yaml
.
Install the git hook scripts:
pre-commit install
Run against all files:
pre-commit run --all-files
If setup was successful pre-commit will run on every commit.
Every time you clone a project that uses pre-commit, running pre-commit install
should be the first thing you do.
⚖️ License
This library is distributed under the MIT license found in the License.
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
Built Distribution
Hashes for infobip-api-python-sdk-2.3.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e0aaed772a62f1e5360c7ea6835b907647267196204cdb887de925522cbc2857 |
|
MD5 | 44519d09e946337cf72e29a6153b18f0 |
|
BLAKE2b-256 | 2913ec07b94985081be92fb9bac9f241965dfd5fccbda09eb379bed346cb320a |
Hashes for infobip_api_python_sdk-2.3.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 24c7ddfb46170953be30148dcab0ed56a77b8275dbb5c58db6993c279398b02e |
|
MD5 | 517edc1a3e833382b99907ea27010e05 |
|
BLAKE2b-256 | 8a55cac59490fcd26d8acc290251d6d26ab031d620bfce907f9f3c71ee982e6c |