# smsir-python
sms.ir python package
## Installation
```
pip install smsir-python
```
## Requirements
You only need the requests package to send apis.
## Usage
### Create Instance
```python
from sms_ir import SmsIr
sms_ir = SmsIr(
api_key,
linenumber,
)
```
### Send Sms
Send message to specific mobile number
```python
sms_ir.send_sms(
number,
message,
linenumber,
)
```
### Send Bulk Sms
Send message to multiple mobile numbers
```python
sms_ir.send_bulk_sms(
numbers,
message,
linenumber,
)
```
### Send Like To Like Sms
Send multiple messages to multiple mobile numbers pair to pair
```python
sms_ir.send_like_to_like(
numbers,
messages,
linenumber,
send_date_time,
)
```
### Delete Scheduled
Delete scheduled message pack
```python
sms_ir.delete_scheduled(
pack_id,
)
```
### Send Verification Code
Send verification code with predefined template
```python
sms_ir.send_verify_code(
number,
template_id,
parameters,
)
```
another sample code:
```python
sms_ir.send_verify_code(
number="+989111111111",
template_id=10000,
parameters=[
{
"name" : "code",
"value": 12345,
},
],
)
```
### Message Report
get report of sent message
```python
sms_ir.report_message(
message_id,
)
```
### Pack Report
get report of sent message pack
```python
sms_ir.report_pack(
pack_id,
)
```
### Today Report
get report of Today sent Messages
```python
sms_ir.report_today(
page_size,
page_number,
)
```
### Archived Report
get report of Archived Messages
```python
sms_ir.report_archived(
from_date,
to_date,
page_size,
page_number,
)
```
### Latest Received Report
get report of latest received messages
```python
sms_ir.report_latest_received(
count,
)
```
### Today Received Report
get report of today received messages
```python
sms_ir.report_today_received(
page_size,
page_number,
)
```
### Archived Received Report
get report of today received messages
```python
sms_ir.report_archived_received(
from_date,
to_date,
page_size,
page_number,
)
```
### Get Credit
get account credit
```python
sms_ir.get_credit()
```
### Get Line Numbers
get account line numbers
```python
sms_ir.get_line_numbers()
```
## Link
If you find a bug or have a question, you can contact me via the link below mojtaba.akbari.221B@gmail.com.
Raw data
{
"_id": null,
"home_page": "https://github.com/IPeCompany/SmsPanelV2.Python",
"name": "smsir-python",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": null,
"author": "Mojtaba Akbari",
"author_email": "mojtaba.akbari.221b@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/2c/55/1f735ec386ef5792697c7ea371839733ec6472d0ddd0781fedb6fc017234/smsir-python-1.0.8.tar.gz",
"platform": null,
"description": "# smsir-python\nsms.ir python package\n\n## Installation\n```\npip install smsir-python\n```\n\n## Requirements\nYou only need the requests package to send apis.\n\n## Usage\n### Create Instance\n```python\nfrom sms_ir import SmsIr\nsms_ir = SmsIr(\n api_key,\n linenumber,\n)\n```\n\n### Send Sms\nSend message to specific mobile number\n```python\nsms_ir.send_sms(\n number,\n message,\n linenumber,\n)\n```\n\n### Send Bulk Sms\nSend message to multiple mobile numbers\n```python\nsms_ir.send_bulk_sms(\n numbers,\n message,\n linenumber,\n)\n```\n\n### Send Like To Like Sms\nSend multiple messages to multiple mobile numbers pair to pair\n```python\nsms_ir.send_like_to_like(\n numbers,\n messages,\n linenumber,\n send_date_time,\n)\n```\n\n### Delete Scheduled\nDelete scheduled message pack\n```python\nsms_ir.delete_scheduled(\n pack_id,\n)\n```\n\n### Send Verification Code\nSend verification code with predefined template\n```python\nsms_ir.send_verify_code(\n number,\n template_id,\n parameters,\n)\n```\nanother sample code:\n```python\nsms_ir.send_verify_code(\n number=\"+989111111111\",\n template_id=10000,\n parameters=[\n {\n \"name\" : \"code\",\n \"value\": 12345,\n },\n ],\n)\n```\n\n### Message Report\nget report of sent message\n```python\nsms_ir.report_message(\n message_id,\n)\n```\n\n### Pack Report\nget report of sent message pack\n```python\nsms_ir.report_pack(\n pack_id,\n)\n```\n\n### Today Report\nget report of Today sent Messages\n```python\nsms_ir.report_today(\n page_size,\n page_number,\n)\n```\n\n### Archived Report\nget report of Archived Messages\n```python\nsms_ir.report_archived(\n from_date,\n to_date,\n page_size,\n page_number,\n)\n```\n\n### Latest Received Report\nget report of latest received messages\n```python\nsms_ir.report_latest_received(\n count,\n)\n```\n\n### Today Received Report\nget report of today received messages\n```python\nsms_ir.report_today_received(\n page_size,\n page_number,\n)\n```\n\n### Archived Received Report\nget report of today received messages\n```python\nsms_ir.report_archived_received(\n from_date,\n to_date,\n page_size,\n page_number,\n)\n```\n\n### Get Credit\nget account credit\n```python\nsms_ir.get_credit()\n```\n\n### Get Line Numbers\nget account line numbers\n```python\nsms_ir.get_line_numbers()\n```\n\n## Link\nIf you find a bug or have a question, you can contact me via the link below mojtaba.akbari.221B@gmail.com.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python Package of SMS.ir Panel",
"version": "1.0.8",
"project_urls": {
"Homepage": "https://github.com/IPeCompany/SmsPanelV2.Python"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4978cfed1728dd1e6bf0b6af7a5706446cb91778bb096128e084419ebd6ef989",
"md5": "e0054b53b833a3da2df37c640d6ee8a1",
"sha256": "0197ccd4014c8704d934ae18329d10939ffbca83eb97d72da17ab6d61ef849a8"
},
"downloads": -1,
"filename": "smsir_python-1.0.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e0054b53b833a3da2df37c640d6ee8a1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 4908,
"upload_time": "2024-08-05T06:13:08",
"upload_time_iso_8601": "2024-08-05T06:13:08.984202Z",
"url": "https://files.pythonhosted.org/packages/49/78/cfed1728dd1e6bf0b6af7a5706446cb91778bb096128e084419ebd6ef989/smsir_python-1.0.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2c551f735ec386ef5792697c7ea371839733ec6472d0ddd0781fedb6fc017234",
"md5": "6404cdcfbf85babb1be984014050bdf1",
"sha256": "06460aca14fdb37fb45a23ad5ed8df7f80b7327edd490b1fd6950acef73183b9"
},
"downloads": -1,
"filename": "smsir-python-1.0.8.tar.gz",
"has_sig": false,
"md5_digest": "6404cdcfbf85babb1be984014050bdf1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 4167,
"upload_time": "2024-08-05T06:13:14",
"upload_time_iso_8601": "2024-08-05T06:13:14.338838Z",
"url": "https://files.pythonhosted.org/packages/2c/55/1f735ec386ef5792697c7ea371839733ec6472d0ddd0781fedb6fc017234/smsir-python-1.0.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-05 06:13:14",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "IPeCompany",
"github_project": "SmsPanelV2.Python",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "smsir-python"
}
JSON
