infobip-api-python-sdk 5.0.1

Python sdk for Infobip's API

Infobip API Python SDK

Client SDK to use the Infobip API with Python.

This package enables you to use multiple Infobip communication channels, like SMS, MMS, WhatsApp, Email, etc.

---

📡 Supported APIs

The following communication channels are supported:

• SMS + 2FA
• Whatsapp
• Email
• WebRTC
• MMS
• RCS

The following platform management APIs are supported:

• Entities

More APIs to be added in the near future.

🔐 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 in the PyPI page.

🚀 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 a WhatsApp text message. Other channels can be used in a similar way. The first step is to import the 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>"
})

Alternatively, you can create the instance from the environment, having the IB_BASE_URL and IB_API_KEY variables set, like this:

c = WhatsAppChannel.from_env()

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"
    }
)

Samples

We are adding samples in the samples folder, which you can use as a reference on how to use the SDK with real payloads.

🗒️ Notes

For infobip-api-python-sdk versioning we use Semantic Versioning scheme.

Python 3.6 is the minimum supported version by this library.

🧡 Want to help and improve this open-source SDK?

Check out our contributing guide and code of conduct.

⚖️ License

This library is distributed under the MIT license found in the License.