# **MoonheimSMS**
An asynchronous Python module for interacting with the Moonheim SMS API. The MoonheimSMS package allows for easy
integration of SMS functionalities into your Python applications, including sending SMS messages, checking message
status, and querying account balance.
## **Features**
- Asynchronous API calls
- Send SMS messages
- Check the status of sent messages
- Retrieve account balance
## **Installation**
```bash
pip install moonheimsms
```
## **Quick Start**
First, ensure you have \`**aiohttp**` installed:
```bash
pip install aiohttp
```
Then, you can start using \`**MoonheimSMS**` by importing it in your project:
```python
from moonheimsms import MoonheimSMS
```
## Usage
### Initialize the Client
```python
moonheim = MoonheimSMS(token="YOUR_API_TOKEN", proxy="YOUR_PROXY")
```
### Sending an SMS
```python
await moonheim.sendSms(
phone="RECIPIENT_PHONE_NUMBER",
sender_name="YOUR_SENDER_NAME",
text="Hello, World!",
type_=0,
gateway=0,
short_link=1
)
```
### Checking SMS Status
```python
status = await moonheim.checkSmsStatus(message_id="YOUR_MESSAGE_ID")
print(status)
```
### Retrieving Account Balance
```python
balance = await moonheim.getBalance()
print(balance)
```
## Handling Exceptions
\`**MoonheimSMS**\` raises \`**InvalidPhoneNumber**\` if an invalid phone number is provided. Ensure to handle this
exception in your code to manage such errors gracefully.
## Contributing
We welcome contributions! Please open an issue or submit a pull request for any improvements.
## License
This project is licensed under the Apache License 2.0. See the [LICENSE](./LICENSE) file for details.
> [!IMPORTANT]
> This package is not officially affiliated with Meow SMS. All trademarks belong to their respective owners.
Raw data
{
"_id": null,
"home_page": "",
"name": "moonheim-sms",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "moonheim,moonheim api,asyncmoonheim,moonheim sms,moonheimsms",
"author": "fafatypoty",
"author_email": "fafatypoty@proton.me",
"download_url": "https://files.pythonhosted.org/packages/e9/61/4649afdd414a07c04d21d1e63adbcf63fa98a75eec19d243569ce0f08d2a/moonheim-sms-0.1.2.2.tar.gz",
"platform": null,
"description": "# **MoonheimSMS**\r\n\r\n\r\n\r\nAn asynchronous Python module for interacting with the Moonheim SMS API. The MoonheimSMS package allows for easy\r\nintegration of SMS functionalities into your Python applications, including sending SMS messages, checking message\r\nstatus, and querying account balance.\r\n\r\n## **Features**\r\n\r\n- Asynchronous API calls\r\n- Send SMS messages\r\n- Check the status of sent messages\r\n- Retrieve account balance\r\n\r\n## **Installation**\r\n\r\n```bash\r\npip install moonheimsms\r\n```\r\n\r\n## **Quick Start**\r\n\r\nFirst, ensure you have \\`**aiohttp**` installed:\r\n\r\n```bash\r\npip install aiohttp\r\n```\r\n\r\nThen, you can start using \\`**MoonheimSMS**` by importing it in your project:\r\n\r\n```python\r\nfrom moonheimsms import MoonheimSMS\r\n```\r\n\r\n## Usage\r\n\r\n### Initialize the Client\r\n\r\n```python\r\nmoonheim = MoonheimSMS(token=\"YOUR_API_TOKEN\", proxy=\"YOUR_PROXY\")\r\n```\r\n\r\n### Sending an SMS\r\n\r\n```python\r\nawait moonheim.sendSms(\r\n phone=\"RECIPIENT_PHONE_NUMBER\",\r\n sender_name=\"YOUR_SENDER_NAME\",\r\n text=\"Hello, World!\",\r\n type_=0,\r\n gateway=0,\r\n short_link=1\r\n)\r\n```\r\n\r\n### Checking SMS Status\r\n\r\n```python\r\nstatus = await moonheim.checkSmsStatus(message_id=\"YOUR_MESSAGE_ID\")\r\nprint(status)\r\n```\r\n\r\n### Retrieving Account Balance\r\n\r\n```python\r\nbalance = await moonheim.getBalance()\r\nprint(balance)\r\n```\r\n\r\n## Handling Exceptions\r\n\r\n\\`**MoonheimSMS**\\` raises \\`**InvalidPhoneNumber**\\` if an invalid phone number is provided. Ensure to handle this\r\nexception in your code to manage such errors gracefully.\r\n\r\n## Contributing\r\n\r\nWe welcome contributions! Please open an issue or submit a pull request for any improvements.\r\n\r\n## License\r\n\r\nThis project is licensed under the Apache License 2.0. See the [LICENSE](./LICENSE) file for details.\r\n\r\n\r\n> [!IMPORTANT]\r\n> This package is not officially affiliated with Meow SMS. All trademarks belong to their respective owners.\r\n",
"bugtrack_url": null,
"license": "Apache License, Version 2.0, see LICENSE file",
"summary": "\u0410\u0441\u0438\u043d\u0445\u0440\u043e\u043d\u043d\u044b\u0439 \u043c\u043e\u0434\u0443\u043b\u044c \u0434\u043b\u044f \u0440\u0430\u0431\u043e\u0442\u044b \u0441 Moonheim SMS API",
"version": "0.1.2.2",
"project_urls": {
"Github": "https://github.com/fafatypoty/moonheim-sms",
"Telegram": "https://t.me/fafatypoty_cloaca"
},
"split_keywords": [
"moonheim",
"moonheim api",
"asyncmoonheim",
"moonheim sms",
"moonheimsms"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e9614649afdd414a07c04d21d1e63adbcf63fa98a75eec19d243569ce0f08d2a",
"md5": "603b53896f431a4dbf2e8255e6578bf2",
"sha256": "369ac5f6d9dbacb807f8b64fb3709f935a08d8ea075496b09c50c83bd0639035"
},
"downloads": -1,
"filename": "moonheim-sms-0.1.2.2.tar.gz",
"has_sig": false,
"md5_digest": "603b53896f431a4dbf2e8255e6578bf2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 7832,
"upload_time": "2024-03-02T03:18:26",
"upload_time_iso_8601": "2024-03-02T03:18:26.690916Z",
"url": "https://files.pythonhosted.org/packages/e9/61/4649afdd414a07c04d21d1e63adbcf63fa98a75eec19d243569ce0f08d2a/moonheim-sms-0.1.2.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-02 03:18:26",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "fafatypoty",
"github_project": "moonheim-sms",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "moonheim-sms"
}
JSON
