blacksms 1.0.0__tar.gz

blacksms-1.0.0/PKG-INFO

@@ -0,0 +1,71 @@
+Metadata-Version: 2.4
+Name: blacksms
+Version: 1.0.0
+Summary: Official Python SDK for BlackSMS API (SMS OTP, WhatsApp OTP, Quick SMS, Bulk SMS)
+Author: BlackSMS
+License: MIT
+Project-URL: Homepage, https://blacksms.in
+Project-URL: Documentation, https://docs.blacksms.in
+Keywords: blacksms,sms,otp,whatsapp,bulk-sms,django,fastapi
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: requests>=2.25.0
+
+# BlackSMS Python SDK (`blacksms`)
+
+Official Python client library for the [BlackSMS API Platform](https://docs.blacksms.in/).
+
+Easily send **SMS OTPs**, **WhatsApp OTPs**, **Quick SMS**, and manage **Bulk SMS Campaigns** in Python, Django, FastAPI, and Flask.
+
+---
+
+## Installation
+
+```bash
+pip install blacksms
+```
+
+---
+
+## Quick Start
+
+```python
+from blacksms import BlackSMS, BlackSMSAPIError
+
+# Initialize client with your API key
+client = BlackSMS(api_key="YOUR_BLACKSMS_API_KEY")
+
+# 1. Send SMS OTP
+try:
+    response = client.send_sms(
+        sender_id=1,          # Your numeric Sender ID (e.g. 1, 2, 10)
+        code="123456",        # OTP code
+        numbers="9876543210", # Recipient number
+        route=1
+    )
+    print("SMS OTP Sent:", response)
+except BlackSMSAPIError as e:
+    print("API Error:", e)
+
+# 2. Send WhatsApp OTP
+response = client.send_whatsapp(
+    sender_id=1,
+    code="123456",
+    numbers="9876543210"
+)
+
+# 3. Send Quick SMS
+response = client.send_quick_sms(
+    sender_id=1,
+    message="Welcome to BlackSMS!",
+    numbers="9876543210"
+)
+
+# 4. Create Bulk SMS Campaign
+campaign = client.create_bulk_sms_campaign(
+    title="Promo Sale",
+    message="Check out our special offers!",
+    contacts=["9876543210", "9123456789"]
+)
+print("Campaign Created:", campaign)
+```

blacksms-1.0.0/README.md

@@ -0,0 +1,58 @@
+# BlackSMS Python SDK (`blacksms`)
+
+Official Python client library for the [BlackSMS API Platform](https://docs.blacksms.in/).
+
+Easily send **SMS OTPs**, **WhatsApp OTPs**, **Quick SMS**, and manage **Bulk SMS Campaigns** in Python, Django, FastAPI, and Flask.
+
+---
+
+## Installation
+
+```bash
+pip install blacksms
+```
+
+---
+
+## Quick Start
+
+```python
+from blacksms import BlackSMS, BlackSMSAPIError
+
+# Initialize client with your API key
+client = BlackSMS(api_key="YOUR_BLACKSMS_API_KEY")
+
+# 1. Send SMS OTP
+try:
+    response = client.send_sms(
+        sender_id=1,          # Your numeric Sender ID (e.g. 1, 2, 10)
+        code="123456",        # OTP code
+        numbers="9876543210", # Recipient number
+        route=1
+    )
+    print("SMS OTP Sent:", response)
+except BlackSMSAPIError as e:
+    print("API Error:", e)
+
+# 2. Send WhatsApp OTP
+response = client.send_whatsapp(
+    sender_id=1,
+    code="123456",
+    numbers="9876543210"
+)
+
+# 3. Send Quick SMS
+response = client.send_quick_sms(
+    sender_id=1,
+    message="Welcome to BlackSMS!",
+    numbers="9876543210"
+)
+
+# 4. Create Bulk SMS Campaign
+campaign = client.create_bulk_sms_campaign(
+    title="Promo Sale",
+    message="Check out our special offers!",
+    contacts=["9876543210", "9123456789"]
+)
+print("Campaign Created:", campaign)
+```

blacksms-1.0.0/blacksms/__init__.py

@@ -0,0 +1,3 @@
+from .client import BlackSMS, BlackSMSError, BlackSMSAPIError
+
+__all__ = ["BlackSMS", "BlackSMSError", "BlackSMSAPIError"]

blacksms-1.0.0/blacksms/client.py

@@ -0,0 +1,123 @@
+import json
+import requests
+from typing import Union, List, Dict, Any, Optional
+
+class BlackSMSError(Exception):
+    """Base exception for BlackSMS SDK."""
+    pass
+
+class BlackSMSAPIError(BlackSMSError):
+    """Exception raised when API returns an error response."""
+    def __init__(self, message: str, status_code: Optional[int] = None, response: Optional[Dict[str, Any]] = None):
+        super().__init__(message)
+        self.status_code = status_code
+        self.response = response
+
+class BlackSMS:
+    """Official Python Client for BlackSMS API."""
+    def __init__(self, api_key: str, base_url: str = "https://blacksms.in", timeout: int = 15):
+        if not api_key:
+            raise BlackSMSError("BlackSMS api_key cannot be empty.")
+        self.api_key = api_key.strip()
+        self.base_url = base_url.rstrip("/")
+        self.timeout = timeout
+
+    def _post(self, path: str, payload: Dict[str, Any]) -> Dict[str, Any]:
+        url = f"{self.base_url}/{path.lstrip('/')}"
+        headers = {
+            "Authorization": self.api_key,
+            "Content-Type": "application/json",
+            "Accept": "application/json"
+        }
+        try:
+            res = requests.post(url, headers=headers, json=payload, timeout=self.timeout)
+            try:
+                data = res.json()
+            except ValueError:
+                data = {"raw": res.text}
+
+            if not res.ok:
+                msg = data.get("message", f"HTTP status {res.status_code}")
+                raise BlackSMSAPIError(msg, status_code=res.status_code, response=data)
+
+            if isinstance(data, dict):
+                if data.get("status") == 0 or data.get("success") is False:
+                    msg = data.get("message", "API Request Failed")
+                    raise BlackSMSAPIError(msg, status_code=res.status_code, response=data)
+
+            return data
+        except requests.RequestException as e:
+            raise BlackSMSError(f"Network error: {str(e)}")
+
+    def send_sms(
+        self,
+        numbers: Union[str, List[str]],
+        code: Optional[str] = None,
+        variables_values: Optional[str] = None,
+        sender_id: Optional[Union[str, int]] = None,
+        route: int = 1
+    ) -> Dict[str, Any]:
+        """Send SMS OTP."""
+        num_str = ",".join(numbers) if isinstance(numbers, list) else str(numbers)
+        val = variables_values or code or ""
+        payload = {
+            "numbers": num_str,
+            "variables_values": val,
+            "route": route
+        }
+        if sender_id:
+            payload["sender_id"] = sender_id
+        return self._post("/sms", payload)
+
+    def send_whatsapp(
+        self,
+        numbers: Union[str, List[str]],
+        code: Optional[str] = None,
+        variables_values: Optional[str] = None,
+        sender_id: Optional[str] = None,
+        route: int = 1
+    ) -> Dict[str, Any]:
+        """Send WhatsApp OTP."""
+        num_str = ",".join(numbers) if isinstance(numbers, list) else str(numbers)
+        val = variables_values or code or ""
+        payload = {
+            "numbers": num_str,
+            "variables_values": val,
+            "route": route
+        }
+        if sender_id:
+            payload["sender_id"] = sender_id
+        return self._post("/wasms", payload)
+
+    def send_quick_sms(
+        self,
+        numbers: Union[str, List[str]],
+        message: str,
+        sender_id: Optional[str] = None,
+        route: Optional[int] = None
+    ) -> Dict[str, Any]:
+        """Send Quick SMS."""
+        num_str = ",".join(numbers) if isinstance(numbers, list) else str(numbers)
+        payload = {
+            "numbers": num_str,
+            "message": message
+        }
+        if sender_id:
+            payload["sender_id"] = sender_id
+        if route is not None:
+            payload["route"] = route
+        return self._post("/quick-sms", payload)
+
+    def create_bulk_sms_campaign(
+        self,
+        title: str,
+        message: str,
+        contacts: List[str]
+    ) -> Dict[str, Any]:
+        """Create Bulk SMS Campaign."""
+        payload = {
+            "title": title,
+            "message": message,
+            "contacts": contacts if isinstance(contacts, list) else [contacts]
+        }
+        return self._post("/endpoints/v1/bulk-sms", payload)

blacksms-1.0.0/blacksms.egg-info/PKG-INFO

@@ -0,0 +1,71 @@
+Metadata-Version: 2.4
+Name: blacksms
+Version: 1.0.0
+Summary: Official Python SDK for BlackSMS API (SMS OTP, WhatsApp OTP, Quick SMS, Bulk SMS)
+Author: BlackSMS
+License: MIT
+Project-URL: Homepage, https://blacksms.in
+Project-URL: Documentation, https://docs.blacksms.in
+Keywords: blacksms,sms,otp,whatsapp,bulk-sms,django,fastapi
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: requests>=2.25.0
+
+# BlackSMS Python SDK (`blacksms`)
+
+Official Python client library for the [BlackSMS API Platform](https://docs.blacksms.in/).
+
+Easily send **SMS OTPs**, **WhatsApp OTPs**, **Quick SMS**, and manage **Bulk SMS Campaigns** in Python, Django, FastAPI, and Flask.
+
+---
+
+## Installation
+
+```bash
+pip install blacksms
+```
+
+---
+
+## Quick Start
+
+```python
+from blacksms import BlackSMS, BlackSMSAPIError
+
+# Initialize client with your API key
+client = BlackSMS(api_key="YOUR_BLACKSMS_API_KEY")
+
+# 1. Send SMS OTP
+try:
+    response = client.send_sms(
+        sender_id=1,          # Your numeric Sender ID (e.g. 1, 2, 10)
+        code="123456",        # OTP code
+        numbers="9876543210", # Recipient number
+        route=1
+    )
+    print("SMS OTP Sent:", response)
+except BlackSMSAPIError as e:
+    print("API Error:", e)
+
+# 2. Send WhatsApp OTP
+response = client.send_whatsapp(
+    sender_id=1,
+    code="123456",
+    numbers="9876543210"
+)
+
+# 3. Send Quick SMS
+response = client.send_quick_sms(
+    sender_id=1,
+    message="Welcome to BlackSMS!",
+    numbers="9876543210"
+)
+
+# 4. Create Bulk SMS Campaign
+campaign = client.create_bulk_sms_campaign(
+    title="Promo Sale",
+    message="Check out our special offers!",
+    contacts=["9876543210", "9123456789"]
+)
+print("Campaign Created:", campaign)
+```

blacksms-1.0.0/blacksms.egg-info/SOURCES.txt

@@ -0,0 +1,9 @@
+README.md
+pyproject.toml
+blacksms/__init__.py
+blacksms/client.py
+blacksms.egg-info/PKG-INFO
+blacksms.egg-info/SOURCES.txt
+blacksms.egg-info/dependency_links.txt
+blacksms.egg-info/requires.txt
+blacksms.egg-info/top_level.txt

blacksms-1.0.0/blacksms.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

blacksms-1.0.0/blacksms.egg-info/requires.txt

@@ -0,0 +1 @@
+requests>=2.25.0

blacksms-1.0.0/blacksms.egg-info/top_level.txt

@@ -0,0 +1 @@
+blacksms

blacksms-1.0.0/pyproject.toml

@@ -0,0 +1,20 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "blacksms"
+version = "1.0.0"
+description = "Official Python SDK for BlackSMS API (SMS OTP, WhatsApp OTP, Quick SMS, Bulk SMS)"
+readme = "README.md"
+authors = [{ name = "BlackSMS" }]
+license = { text = "MIT" }
+requires-python = ">=3.8"
+dependencies = [
+    "requests>=2.25.0"
+]
+keywords = ["blacksms", "sms", "otp", "whatsapp", "bulk-sms", "django", "fastapi"]
+
+[project.urls]
+Homepage = "https://blacksms.in"
+Documentation = "https://docs.blacksms.in"

blacksms-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+