فری اساماس
REST API ساده
وب سرویس پیامکی (API)؛ سریع، امن و توسعهدهنده محور
با چند خط کد، ارسال پیامک، دریافت وضعیت تحویل و ارسال کد یکبار مصرف را به سایت یا اپلیکیشن خود اضافه کنید. مستندات کامل برای پایتون، PHP، Node.js و C# آماده است.
مشاهده مستندات
Reference
مستندات وب سرویس
آدرس پایه: https://api.free-sms.ir/v1
| متد | مسیر | توضیح |
|---|---|---|
| POST | /send | ارسال یک یا چند پیامک انبوه |
| GET | /status/:id | استعلام وضعیت تحویل پیام |
| POST | /otp | ارسال کد یکبار مصرف با قالب از پیش تاییدشده |
| GET | /credit | دریافت اعتبار باقیمانده پنل |
Quickstart
نمونه کدهای برنامهنویسی
نمونهی زیر یک پیامک ساده با پایتون ارسال میکند. برای PHP، Node.js و C# نیز الگو مشابه است.
PythonPHPNode.js
# نصب: pip install requests
import requests
url = "https://api.free-sms.ir/v1/send"
headers = {"Authorization": "Bearer YOUR_API_KEY"}
payload = {
"line": "5000xxxxxx",
"to": ["09121234567"],
"text": "سفارش شما ثبت شد."
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())ارسال پیامک OTP (اعتبارسنجی)
برای ورود دومرحلهای یا تایید شماره موبایل، از اندپوینت اختصاصی /otp استفاده کنید. این مسیر به دلیل استفاده از خط خدماتی، خارج از محدودیت بلکلیست است و میانگین زمان تحویل آن زیر ۳ ثانیه است.
import requests
url = "https://api.free-sms.ir/v1/otp"
headers = {"Authorization": "Bearer YOUR_API_KEY"}
payload = {"to": "09121234567", "template": "login_otp"}
response = requests.post(url, headers=headers, json=payload)
print(response.json()) # {'status': 'sent', 'expires_in': 120}