farazsms 1.0.1

Official client for FarazSMS · IranPayamak (فراز اس ام اس · ایران پیامک) — https://farazsms.com. Send pattern/OTP, bulk SMS, reports, phonebook, and all 63 endpoints.

farazsms

FarazSMS · IranPayamak — فراز اس ام اس · ایران پیامک 🌐 farazsms.com · iranpayamak.com

Official Python client for the FarazSMS / IranPayamak web services — send pattern/OTP, simple & bulk SMS, pull reports, manage your phonebook, and reach all 63 endpoints through a low-level request().

Python 3.7+ · depends only on requests · raises on API errors.

Install

pip install farazsms

Quick start

from farazsms import FarazSMS, FarazError

sms = FarazSMS("YOUR_API_KEY")  # key from the panel → Web Service / API Key

print(sms.balance())                                              # verify the key — free
sms.send_pattern("SJ3FgPrE0C", "09120000000", {"code": "1234"})   # OTP (instant)
sms.send_simple("Hello!", ["09120000000", "09130000000"])         # bulk
print(sms.inbox(page=1, limit=20))                                # inbound replies

try:
    sms.send_pattern("BAD", "09120000000", {"code": "1"})
except FarazError as e:
    print(e.status, e.body)

Recipients use the local format 09120000000 (no +98). Default sender line 90008361.

Bundled helpers

Area	Methods
Account	balance() · profile() · lines()
Send	send_pattern() · send_simple() · send_variable()
Patterns	create_pattern() · patterns()
Reports	inbox() · send_requests() · send_request_items()
Phonebook	phonebooks() · add_contact()
Reference	provinces() · number_banks()

Anything else (tickets, orders, voice, LBS, …) via request(method, path, body).

License

MIT