infobip-community/infobip-api-python-sdk

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.

infobip-api-python-sdk's Issues

[BUG] Allow multiple attachments to request

Describe the bug
The OAS is for an array of binary objects but we only send a single object

Expected behaviour
Allow multiple items to be attached as a file

[FEATURE] Expose the pedantic types to be visible outside the function signature

Describe the solution you'd like
Expose the pedantic types to be visible outside the function signature

`entityId` and `applicationId` should live in a base class and used as a mixin where appropriate

This also allows for a centralised places for flags an options which are universal across message types.

`TransliterationEnum` for SMS should be updated with new options to match API

infobip-api-python-sdk/infobip_channels/core/models.py

Line 243 in 70439e2

class TransliterationEnum(str, Enum):

needs updating with new options from https://www.infobip.com/docs/api/channels/sms/sms-messaging/outbound-sms/send-sms-message

WhatsApp should use `CoreMixin` for `entityId` and `applicationId` in message types

`SMSMessageBody` should use `CoreMixin` instead of defining its own `applicationId` and `entityId` fields

`SMSMessageBody` should include `includeSmsCountInResponse`

infobip-api-python-sdk/infobip_channels/sms/models/body/send_message.py

Line 34 in 70439e2

class SMSMessageBody(MessageBodyBase):

should include includeSmsCountInResponse per https://www.infobip.com/docs/api/channels/sms/sms-messaging/outbound-sms/send-sms-message

`Regional` parameters for outbound SMS should contain information options for South Korea

infobip-api-python-sdk/infobip_channels/sms/models/body/core.py

Line 56 in 70439e2

class Regional(CamelCaseModel):

Needs updating with South Korea information per https://www.infobip.com/docs/api/channels/sms/sms-messaging/outbound-sms/send-sms-message

Consider relaxing dependency requirements

Hi, could you consider relaxing the fixed dependency requirements?

I'm trying to build an airbyte source connector for infobip, but I run into the following problem:

ERROR: Cannot install -r requirements.txt (line 1), connector-acceptance-test and source-infobip because these package versions have conflicting dependencies.

The conflict is caused by:
    connector-acceptance-test 0.0.0 depends on pydantic~=1.6
    airbyte-cdk 0.2.0 depends on pydantic~=1.9.2
    infobip-api-python-sdk 5.0.0 depends on pydantic==1.9.0

Query parameters should use the `TransliterationEnum` from `core/models.py`

infobip-api-python-sdk/infobip_channels/sms/models/query_parameters/send_message.py

Line 10 in 70439e2

class TransliterationEnum(str, Enum):

should instead be an import from

infobip-api-python-sdk/infobip_channels/core/models.py

Line 243 in 70439e2

class TransliterationEnum(str, Enum):