<div align="center">
# `bulksmsmd` - Python wrapper for Unifun BulkSMSAPI (bulksms.md)
Condsider the official documentation before using this package or to understand the more advanced options __dlrurl__, __dlrmask__, __charset__ and __coding__.
[2021 Official documentation .DOCX](https://github.com/markmelnic/bulksmsmd/blob/main/res/docs_2021.docx)
[2021 Official documentation .PDF](https://github.com/markmelnic/bulksmsmd/blob/main/res/docs_2021.pdf)
</div>
## Installation
Installation is done using the following command:
pip install bulksmsmd
## Usage
The `username` and `password` are the credentials for the API. The `sender` is the name of the sender.
client = SMSClient(
username = 'username',
password = 'password',
sender = 'sender',
proxy = {
'http': 'http://PROXY_URL,
'https': 'https://PROXY_URL',
}
)
The `client` object is used to send messages and contains two methods: `send_sms_simple` & `send_sms_nde`.
client.send_sms_simple(
msisdn = '69123456',
body = 'Test message.',
prefix = '373',
)
client.send_sms_nde(
msisdn = '69123456',
body = 'Test message.',
prefix = '373',
dlr_url = 'https://example.com/dlr',
dlr_mask = '31',
charset = 'utf8',
coding = '2',
)
# History
## 0.1.0 (2021-10-03)
* First release on Github.
## 0.1.1 (2021-10-03)
* Uploaded wheel.
## 0.1.2 (2022-03-03)
* Multiple changes & documentation improved.
## 0.1.3 (2023-02-07)
* Proxy support added.
Raw data
{
"_id": null,
"home_page": "https://github.com/markmelnic/bulksmsmd",
"name": "bulksmsmd",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "python api wrapper unifun bulksms bulksmsmd bulksmsapi",
"author": "Mark Melnic",
"author_email": "me@markmelnic.com",
"download_url": "",
"platform": null,
"description": "<div align=\"center\">\r\n\r\n# `bulksmsmd` - Python wrapper for Unifun BulkSMSAPI (bulksms.md)\r\n\r\n\r\n\r\n\r\n\r\nCondsider the official documentation before using this package or to understand the more advanced options __dlrurl__, __dlrmask__, __charset__ and __coding__.\r\n\r\n[2021 Official documentation .DOCX](https://github.com/markmelnic/bulksmsmd/blob/main/res/docs_2021.docx)\r\n\r\n[2021 Official documentation .PDF](https://github.com/markmelnic/bulksmsmd/blob/main/res/docs_2021.pdf)\r\n\r\n</div>\r\n\r\n## Installation\r\n\r\nInstallation is done using the following command:\r\n\r\n pip install bulksmsmd\r\n\r\n## Usage\r\n\r\nThe `username` and `password` are the credentials for the API. The `sender` is the name of the sender.\r\n\r\n client = SMSClient(\r\n username = 'username',\r\n password = 'password',\r\n sender = 'sender',\r\n proxy = {\r\n 'http': 'http://PROXY_URL,\r\n 'https': 'https://PROXY_URL',\r\n }\r\n )\r\n\r\nThe `client` object is used to send messages and contains two methods: `send_sms_simple` & `send_sms_nde`.\r\n\r\n client.send_sms_simple(\r\n msisdn = '69123456',\r\n body = 'Test message.',\r\n prefix = '373',\r\n )\r\n\r\n client.send_sms_nde(\r\n msisdn = '69123456',\r\n body = 'Test message.',\r\n prefix = '373',\r\n dlr_url = 'https://example.com/dlr',\r\n dlr_mask = '31',\r\n charset = 'utf8',\r\n coding = '2',\r\n )\r\n\r\n\r\n# History\r\n\r\n## 0.1.0 (2021-10-03)\r\n\r\n* First release on Github.\r\n\r\n## 0.1.1 (2021-10-03)\r\n\r\n* Uploaded wheel.\r\n\r\n## 0.1.2 (2022-03-03)\r\n\r\n* Multiple changes & documentation improved.\r\n\r\n## 0.1.3 (2023-02-07)\r\n\r\n* Proxy support added.\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python wrapper for Unifun BulkSMSAPI (bulksms.md)",
"version": "0.1.3",
"project_urls": {
"Homepage": "https://github.com/markmelnic/bulksmsmd"
},
"split_keywords": [
"python",
"api",
"wrapper",
"unifun",
"bulksms",
"bulksmsmd",
"bulksmsapi"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1ea4f35d0c6c1eea98cc7158a4a3e812fa370db998b89b294bd850f82c2e26bb",
"md5": "2c1512d94ca789b4dacdeb6f3ef2a930",
"sha256": "e71b0204617777ee3ad8e8402cb6a5a901cd25b39128c9df5163e37e727ec6f7"
},
"downloads": -1,
"filename": "bulksmsmd-0.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2c1512d94ca789b4dacdeb6f3ef2a930",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 4859,
"upload_time": "2024-02-07T17:50:47",
"upload_time_iso_8601": "2024-02-07T17:50:47.667609Z",
"url": "https://files.pythonhosted.org/packages/1e/a4/f35d0c6c1eea98cc7158a4a3e812fa370db998b89b294bd850f82c2e26bb/bulksmsmd-0.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-07 17:50:47",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "markmelnic",
"github_project": "bulksmsmd",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "bulksmsmd"
}
JSON
