ozekilibsrest 1.8.0

It is a library, that makes it easier for you to comunicate with the Ozeki SMS Gateway.

How to use the ozekilibsrest library

How to install the ozekilibsrest library

In order to install the ozekilibsrest library you have to use the following command:

pip install ozekilibsrest

After you have installed the library, you can import its contents into your project by using the following lines of code:

from ozekilibsrest import Configuration, Message, MessageApi

Creating a Configuration

To send your SMS message to the built in API of the Ozeki SMS Gateway, your client application needs to know the details of your Gateway and the http_user. We can define a Configuration instance with these lines of codes in Python.

configuration = Configuration(
    username="http_user",
    password="qwe123",
    api_url="http://127.0.0.1:9509/api"
)

Creating a Message

After you have initialized your configuration object you can continue by creating a Message object. A message object holds all the needed data for message what you would like to send. In Python we create a Message instance with the following lines of codes:

msg = Message(
    to_address="[phone]",
    text="Hello world!"
)

Creating a MessageApi

You can use the MessageApi class of the ozekilibsrest library to create a MessageApi object which has the methods to send, delete, mark and receive SMS messages from the Ozeki SMS Gateway. To create a MessageApi, you will need these lines of codes and a Configuration instance.

api = MessageApi(configuration)

After everything is ready you can begin with sending the previously created Message object:

result = api.send(msg)

print(result)

After you have done all the steps, you check the Ozeki SMS Gateway and you will see the message in the Sent folder of the http_user.