# BulkSMSNigeria API Wrapper Documentation
The BulkSMSNigeria API Wrapper is a Python library that provides a convenient interface for sending SMS messages using the BulkSMSNigeria SMS gateway. This library simplifies the process of sending messages to single or multiple recipients, retrieving account balance, and obtaining delivery reports.
Installation
To use the BulkSMSNigeria API Wrapper, you need to
1. Create an account on BulkSMSNigeria.com (www.bulksmsnigeria.com/register)
2. Verify at least one of your contacts (i.e., email or phone number).
3. Fund your account with at least 500NGN.
4. Generate an API Token on the API Settings Page (www.bulksmsnigeria.com/app/api-settings)
5. Maintain a minimum balance of 100NGN in the account.
6. Have Python installed. You can install the library using pip:
```
pip install bulksmsnigeria
```
## Getting Started
To begin using the BulkSMSNigeria API Wrapper, you need to import the necessary module and initialize an instance of the BulkSMSNigeria class:
```
from bulksmsnigeria import BulkSMSNigeria
# Initialize the BulkSMSNigeria object with your API token
api_token = 'YOUR_API_TOKEN'
bulksms = BulkSMSNigeria(api_token)
```
Replace YOUR_API_TOKEN with your actual API token obtained from BulkSMSNigeria
## Sending SMS
### Sending SMS to a Single Recipient
You can use the sendToOne method to send an SMS to a single recipient:
```
sender = 'SENDER_NAME'
recipient = 'RECIPIENT_PHONE_NUMBER'
body = 'MESSAGE_CONTENT'
response = bulksms.sendToOne(sender, recipient, body)
```
`sender` (str): The name that will be displayed as the sender of the message.
`recipient` (str): The phone number of the recipient.
`body` (str): The content of the message.
The method returns a dictionary with the following keys:
`status` (int): The HTTP status code of the request.
`response` (dict): The JSON response received from the BulkSMSNigeria API.
### Sending SMS to Multiple Recipients
You can use the sendToMany method to send an SMS to multiple recipients:
```
sender = 'SENDER_NAME'
recipients = ['RECIPIENT_PHONE_NUMBER_1', 'RECIPIENT_PHONE_NUMBER_2', ...]
body = 'MESSAGE_CONTENT'
response = bulksms.sendToMany(sender, recipients, body)
```
`sender` (str): The name or phone number that will be displayed as the sender of the message.
`recipients` (list): A list of phone numbers of the recipients.
`body` (str): The content of the message.
The method returns a dictionary with the following keys:
`status` (int): The HTTP status code of the request.
`response` (dict): The JSON response received from the BulkSMSNigeria API.
## Retrieving Account Balance
To retrieve your account balance, you can use the getWalletBalance method:
```
response = bulksms.getWalletBalance()
```
The method returns a dictionary with the following keys:
`status` (int): The HTTP status code of the request.
`response` (dict): The JSON response received from the BulkSMSNigeria API.
## Retrieving Delivery Report
You can retrieve the delivery report of a sent message using the getDeliveryReport method:
```
message_id = 'MESSAGE_ID'
response = bulksms.getDeliveryReport(message_id)
```
`message_id` (str): The unique ID of the message for which you want to obtain the delivery report.
The method returns a dictionary with the following keys:
`status` (int): The HTTP status code of the request.
`response` (dict): The JSON response received from the BulkSMSNigeria API.
## Contributing
We welcome contributions from the community! If you would like to contribute to the BulkSMSNigeria Python library, please follow these guidelines:
1. Fork the repository and create your branch from the `main` branch.
2. Make your changes and ensure that the code passes all tests.
3. Write clear and concise commit messages.
4. Submit a pull request to the `main` branch.
### Code Style
Please adhere to the following code style guidelines:
- Use PEP 8 style guide for Python code.
- Write clear and meaningful variable and function names.
- Include comments to explain complex logic or important details.
- Follow the existing code formatting and structure.
### Bug Reports and Feature Requests
If you encounter any bugs or have suggestions for new features, please open an issue on the GitHub repository. Provide a clear description of the problem or feature request and any relevant details.
### Contact
If you have any questions or need assistance, you can reach out to us.
We appreciate your contributions and thank you for helping improve the BulkSMSNigeria Python library!
Raw data
{
"_id": null,
"home_page": "https://github.com/emmyvera/bulksmsng",
"name": "bulksmsng",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "SMS,Nigeria,BulkSMS,Bulk SMS Nigeria,bulk sms",
"author": "Oluwaloni Emmanuel",
"author_email": "emmyvera01@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/50/95/21a32ffc2cab053dfbc8d4929c27785346833c73c0e8959d54a321ffea4c/bulksmsng-1.0.0.tar.gz",
"platform": null,
"description": "# BulkSMSNigeria API Wrapper Documentation\n\nThe BulkSMSNigeria API Wrapper is a Python library that provides a convenient interface for sending SMS messages using the BulkSMSNigeria SMS gateway. This library simplifies the process of sending messages to single or multiple recipients, retrieving account balance, and obtaining delivery reports.\n\nInstallation\nTo use the BulkSMSNigeria API Wrapper, you need to \n\n1. Create an account on BulkSMSNigeria.com (www.bulksmsnigeria.com/register)\n2. Verify at least one of your contacts (i.e., email or phone number).\n3. Fund your account with at least 500NGN.\n4. Generate an API Token on the API Settings Page (www.bulksmsnigeria.com/app/api-settings)\n5. Maintain a minimum balance of 100NGN in the account.\n\n6. Have Python installed. You can install the library using pip:\n```\npip install bulksmsnigeria\n```\n\n## Getting Started\n\nTo begin using the BulkSMSNigeria API Wrapper, you need to import the necessary module and initialize an instance of the BulkSMSNigeria class:\n\n```\nfrom bulksmsnigeria import BulkSMSNigeria\n\n# Initialize the BulkSMSNigeria object with your API token\napi_token = 'YOUR_API_TOKEN'\nbulksms = BulkSMSNigeria(api_token)\n\n```\nReplace YOUR_API_TOKEN with your actual API token obtained from BulkSMSNigeria\n\n## Sending SMS\n### Sending SMS to a Single Recipient\nYou can use the sendToOne method to send an SMS to a single recipient:\n```\nsender = 'SENDER_NAME'\nrecipient = 'RECIPIENT_PHONE_NUMBER'\nbody = 'MESSAGE_CONTENT'\n\nresponse = bulksms.sendToOne(sender, recipient, body)\n\n```\n\n`sender` (str): The name that will be displayed as the sender of the message.\n`recipient` (str): The phone number of the recipient.\n`body` (str): The content of the message.\n\nThe method returns a dictionary with the following keys:\n`status` (int): The HTTP status code of the request.\n`response` (dict): The JSON response received from the BulkSMSNigeria API.\n\n### Sending SMS to Multiple Recipients\nYou can use the sendToMany method to send an SMS to multiple recipients:\n```\nsender = 'SENDER_NAME'\nrecipients = ['RECIPIENT_PHONE_NUMBER_1', 'RECIPIENT_PHONE_NUMBER_2', ...]\nbody = 'MESSAGE_CONTENT'\n\nresponse = bulksms.sendToMany(sender, recipients, body)\n```\n\n`sender` (str): The name or phone number that will be displayed as the sender of the message.\n`recipients` (list): A list of phone numbers of the recipients.\n`body` (str): The content of the message.\n\nThe method returns a dictionary with the following keys:\n`status` (int): The HTTP status code of the request.\n`response` (dict): The JSON response received from the BulkSMSNigeria API.\n\n## Retrieving Account Balance\nTo retrieve your account balance, you can use the getWalletBalance method:\n```\nresponse = bulksms.getWalletBalance()\n```\n\nThe method returns a dictionary with the following keys:\n`status` (int): The HTTP status code of the request.\n`response` (dict): The JSON response received from the BulkSMSNigeria API.\n\n## Retrieving Delivery Report\nYou can retrieve the delivery report of a sent message using the getDeliveryReport method:\n```\nmessage_id = 'MESSAGE_ID'\nresponse = bulksms.getDeliveryReport(message_id)\n```\n\n`message_id` (str): The unique ID of the message for which you want to obtain the delivery report.\n\nThe method returns a dictionary with the following keys:\n`status` (int): The HTTP status code of the request.\n`response` (dict): The JSON response received from the BulkSMSNigeria API.\n\n## Contributing\nWe welcome contributions from the community! If you would like to contribute to the BulkSMSNigeria Python library, please follow these guidelines:\n\n1. Fork the repository and create your branch from the `main` branch.\n2. Make your changes and ensure that the code passes all tests.\n3. Write clear and concise commit messages.\n4. Submit a pull request to the `main` branch.\n\n### Code Style\nPlease adhere to the following code style guidelines:\n- Use PEP 8 style guide for Python code.\n- Write clear and meaningful variable and function names.\n- Include comments to explain complex logic or important details.\n- Follow the existing code formatting and structure.\n\n### Bug Reports and Feature Requests\nIf you encounter any bugs or have suggestions for new features, please open an issue on the GitHub repository. Provide a clear description of the problem or feature request and any relevant details.\n\n### Contact\nIf you have any questions or need assistance, you can reach out to us.\n\nWe appreciate your contributions and thank you for helping improve the BulkSMSNigeria Python library!\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "The BulkSMSNigeria API Wrapper is a Python library that provides a convenient interface for sending SMS messages",
"version": "1.0.0",
"project_urls": {
"Homepage": "https://github.com/emmyvera/bulksmsng"
},
"split_keywords": [
"sms",
"nigeria",
"bulksms",
"bulk sms nigeria",
"bulk sms"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "509521a32ffc2cab053dfbc8d4929c27785346833c73c0e8959d54a321ffea4c",
"md5": "8211a515ec40b0c6dad46c458ca57736",
"sha256": "2d57adb15000951bab27efc85a36adfde94adc99fe215dae872fa589e5a50352"
},
"downloads": -1,
"filename": "bulksmsng-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "8211a515ec40b0c6dad46c458ca57736",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 4389,
"upload_time": "2023-06-16T18:13:09",
"upload_time_iso_8601": "2023-06-16T18:13:09.575117Z",
"url": "https://files.pythonhosted.org/packages/50/95/21a32ffc2cab053dfbc8d4929c27785346833c73c0e8959d54a321ffea4c/bulksmsng-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-16 18:13:09",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "emmyvera",
"github_project": "bulksmsng",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "bulksmsng"
}
JSON
