وب سرویس پیامک فراز اس ام اس چیست؟

وب سرویس پیامک فراز اس ام اس یک REST API برای ارسال پیامک از داخل نرمافزار شماست: ارسال پیامک پترن، رمز یکبارمصرف (OTP)، ارسال گروهی و سریع، گزارش تحویل و مدیریت دفترتلفن. آدرس پایه https://api.iranpayamak.com است.

احراز هویت وب سرویس فراز اس ام اس چگونه است؟

کلید دسترسی را از پنل فراز اس ام اس بگیرید و در هدر درخواست با نام Api-Key بفرستید (حساس به حروف). نیازی به لاگین یا توکن نیست.

چطور با API فراز اس ام اس پیامک رمز یکبارمصرف (OTP) بفرستم؟

از وب سرویس ارسال پترن استفاده کنید: POST به /ws/v1/sms/pattern با code و recipient و attributes. ارسال پترن آنی است و وارد صف نمیشود، پس برای OTP بهترین گزینه است.

آیا فراز اس ام اس SDK رسمی دارد؟

بله. SDK رسمی برای PHP (composer require farazsms/php و farazsms/laravel)، Python (pip install farazsms)، Node.js (npm install farazsms)، C# (dotnet add package FarazSMS) و Go (go get github.com/ghaffari273/farazsms-go).

وب سرویس پیامک فراز اس ام اس — مستندات REST API و SDK ارسال پیامک

مستندات رسمیِ وب سرویس پیامک فراز اس ام اس (ایران پیامک) برای ارسال پیامک با REST API: ارسال پیامک پترن، رمز یک‌بارمصرف (OTP)، ارسال گروهی و سریع، گزارش تحویل، دفترتلفن و کیف‌پول. آدرس پایه: https://api.iranpayamak.com — احراز هویت با هدر Api-Key (کلید از پنل، حساس به حروف؛ بدون نیاز به لاگین).

SDK رسمیِ همه‌ی زبان‌ها: pip install farazsms · npm install farazsms · composer require farazsms/php · composer require farazsms/laravel · dotnet add package FarazSMS · go get github.com/ghaffari273/farazsms-go.

دسته‌بندی وب‌سرویس‌ها (63 سرویس)

ارسال پیامک — Send SMS

نقطهٔ شروع. برای OTP از «ارسال با پترن» استفاده کن — سریع‌ترین راه.

POST /ws/v1/sms/pattern — Send Pattern-Based SMS — ارسال پیامک قالب‌دار (OTP، کد تأیید، اعلان تراکنش). سریع‌ترین راه و بدون صف — برای کدهای یک‌بارمصرف از این استفاده کن.
POST /ws/v1/sms/simple — Send Simple SMS from Phonebook — ارسال یک متن ثابت به فهرستی از شماره‌ها یا یک دفترتلفن. مناسب اطلاع‌رسانی و کمپین انبوه (وارد صف می‌شود).
POST /ws/v1/sms/keywords — Send SMS with Variables — ارسال انبوهِ شخصی‌سازی‌شده؛ متغیرها (مثل نام مخاطب) داخل `%...%` در متن جای می‌گیرند.
POST /v1/send/keyword-file — Send SMS with Variables from Excel — همان ارسالِ متغیردار، ولی داده‌ی هر گیرنده از فایل Excel/CSV خوانده می‌شود — برای حجم بالا.
POST /ws/v1/lbs — Create New LBS Request — ساخت کمپین ارسال بر اساس موقعیت جغرافیایی؛ به کسانی که در یک محدوده و بازه‌ی زمانی مشخص هستند پیامک می‌دهد.
GET /ws/v1/lbs — Get LBS Requests List — فهرست کمپین‌های موقعیت‌محورِ ساخته‌شده، برای پیگیری وضعیتشان.
PUT /ws/v1/lbs/{lbsId} — Edit LBS Request — ویرایش یک کمپین موقعیت‌محور پیش از اجرا (متن، محدوده، فیلترها).
GET /ws/v1/lbs/{lbsId} — Show Single LBS Request Details — دیدن جزئیات کاملِ یک کمپین موقعیت‌محور با شناسه‌اش.
PATCH /ws/v1/lbs/{lbsId}/cancel — Cancel LBS Request — لغو یک کمپین موقعیت‌محور پیش از ارسال.
POST /ws/v1/send/peer-to-peer — Send Peer-to-Peer SMS — ارسال نظیربه‌نظیر: به هر گروه گیرنده یک متنِ متفاوت بده — برای پیام‌های کاملاً شخصی در یک درخواست.
POST /ws/v1/send/peer-to-peer-file — Send Peer-to-Peer SMS from Excel — همان نظیربه‌نظیر، ولی جفت‌های متن/گیرنده از فایل Excel می‌آیند.
POST /ws/v1/sms/bank — Send to Number Bank — ارسال هدفمند به «بانک شماره» (شماره‌های آماده بر اساس صنف/منطقه) بدون اینکه دفترتلفن داشته باشی.
POST /ws/v1/sms/sample — Send Sample SMS — ارسال یک نمونه فقط به خودت، برای تست متن و خط فرستنده پیش از کمپین انبوه.
POST /ws/v1/sms/simple-file — Send Simple SMS from Excel — ارسال متن ثابت با فهرست گیرنده‌ها از فایل Excel — برای فهرست‌های بزرگ.
GET /ws/v1/sms/voice/download-file — Download Uploded Voice Message File — دانلود دوباره‌ی یک فایل صوتیِ آپلودشده با `file_id`.
POST /ws/v1/sms/voice/send — Send Voice Message — ارسال تماس صوتی (پیام ضبط‌شده) به گیرنده‌ها؛ ابتدا باید فایل صوتی آپلود شده باشد.
POST /ws/v1/sms/voice/upload-file — Upload Voice Message File — آپلود فایل صوتی و گرفتن `file_id` — پیش‌نیازِ ارسال پیام صوتی.

مدیریت پترن — Patterns

ساخت و مدیریت پترن‌ها — پیش‌نیازِ ارسالِ پترن.

POST /ws/v1/patterns — Create New Pattern — ساخت پترن (قالب) جدید با متغیر؛ پیش‌نیازِ ارسال پترن. پس از ساخت باید تأیید شود.
GET /ws/v1/patterns — Get List of User's Patterns — فهرست پترن‌های حساب؛ از این‌جا `code` پترن را برای ارسال پیدا کن.
PUT /ws/v1/patterns/{code} — Edit Pattern — ویرایش متن یا متغیرهای یک پترن موجود (ممکن است نیاز به تأیید مجدد داشته باشد).
GET /ws/v1/patterns/{code} — Get Pattern Details — دیدن جزئیات یک پترن (نام و تعداد متغیرها) تا ارسالت دقیقاً با آن بخواند.

گزارش و دریافت — Reports & Inbox

بعد از ارسال: وضعیت ارسال‌ها و پیامک‌های دریافتی.

GET /ws/v1/inbox — Get Paged Inbox Messages — خواندن پیامک‌های دریافتی (پاسخ مشتری‌ها)؛ برای دوطرفه‌کردن مکالمه این را به‌صورت دوره‌ای poll کن.
GET /ws/v1/send_request — Get Send Requests — فهرست همه‌ی ارسال‌ها با وضعیت کلی‌شان (صف، ارسال‌شده، رد…)؛ با `status` فیلتر کن.
GET /ws/v1/send_request/{send_request_id} — Show Send Request Details — دیدن جزئیات یک ارسالِ مشخص با شناسه‌اش.
GET /ws/v1/send_request/{send_request_id}/items — Get Send Request Items — وضعیت تحویلِ تک‌تک گیرنده‌ها در یک ارسال (تحویل‌شده، ناموفق، لیست سیاه…).

دفترتلفن و مخاطبین — Phonebook & Contacts

مدیریت مخاطبین و گروه‌ها برای ارسال انبوه.

GET /example/phone-book/{phone_book}/data.xlsx — Get Bulk Excel Sample — دانلود فایل نمونه‌ی Excel آن دفترتلفن؛ ستون‌ها را طبق آن پر کن — پیش‌نیازِ افزودن از Excel.
POST /ws/v1/phone_book — Create New Phonebook — ساخت دفترتلفن جدید برای دسته‌بندی مخاطبین.
GET /ws/v1/phone_book — Get Phonebooks — فهرست دفترتلفن‌ها و شناسه‌هایشان.
PUT /ws/v1/phone_book/{id} — Update Phonebook — تغییر نام یا ستون‌های یک دفترتلفن موجود.
POST /ws/v1/phone_book_attribute — Create New Phonebook Attribute — ساخت ستون/ویژگی دلخواه (مثل تاریخ تولد یا کد ملی) برای مخاطبین.
GET /ws/v1/phone_book_attribute — Get Phonebook Attributes — فهرست ویژگی‌های تعریف‌شده و شناسه‌هایشان (برای استفاده هنگام افزودن مخاطب).
POST /ws/v1/phone_book_data — Add New Contact — افزودن یک مخاطبِ تکی به دفترتلفن.
GET /ws/v1/phone_book_data — Get Phonebook Contacts — گرفتن مخاطبینِ یک دفترتلفن با جستجو و صفحه‌بندی.
POST /ws/v1/phone_book_data/bulk-upsert — Add Bulk Contact — افزودن/به‌روزرسانیِ انبوه مخاطبین در یک درخواست (سقف ۵۰۰ مخاطب).
POST /ws/v1/phone_book_data/excel-upsert — Add Excel Contact — وارد کردن مخاطبین از فایل Excel، بدون محدودیت تعداد.
DELETE /ws/v1/phone_book_data/{id} — Delete Contact — حذف یک مخاطب با شناسه (برگشت‌ناپذیر).

حساب و کیف‌پول — Account & Wallet

اعتبار، شارژ، پروفایل، خطوط و سفارش‌ها. (تستِ اعتبار = تستِ بی‌هزینهٔ کلید)

GET /ws/v1/account/balance — Account Balance — دیدن موجودی حساب؛ بهترین تستِ بی‌هزینه برای اطمینان از درستیِ کلید API.
POST /ws/v1/account/wallet/charge — Charge wallet — شارژ کیف‌پولِ حساب (یک سفارشِ قابل‌پرداخت ساخته می‌شود).
GET /ws/v1/account/profile — Profile — گرفتن اطلاعات پروفایل حساب (نام و مشخصات).
POST /ws/v1/account/register — Register — ثبت‌نام حساب از طریق API (برای ارسال پیامک لازم نیست).
POST /ws/v1/account/update — update — به‌روزرسانی اطلاعات حساب.
GET /ws/v1/lines/accessible — Lines — فهرست خطوط فرستنده‌ی قابل‌استفاده؛ شماره‌ی خط را برای `line_number` از این‌جا بردار.
POST /ws/v1/orders/apply-discount — Apply Discount on Order — اعمال کد تخفیف روی یک سفارش پیش از پرداخت.
POST /ws/v1/orders/cancel — Cancel an Order — لغو یک سفارشِ پرداخت‌نشده.
POST /ws/v1/orders/pay — Pay Created Order — پرداخت یک سفارشِ ساخته‌شده (مثلاً شارژ کیف‌پول).

پشتیبانی — Tickets

ارتباط با پشتیبانی از طریق API.

POST /ws/v1/ticket — Create New Ticket — ساخت تیکت پشتیبانی جدید.
GET /ws/v1/ticket — Get List of Tickets — فهرست تیکت‌های پشتیبانی (فیلتر با وضعیت و دپارتمان).
POST /ws/v1/ticket/closed — Close Ticket — بستن یک تیکت.
GET /ws/v1/ticket/file/download — Download Ticket Attached File — دانلود فایلِ پیوستِ یک پیامِ تیکت.
POST /ws/v1/ticket/replay — Replay to Ticket — پاسخ‌دادن به یک تیکت موجود.
GET /ws/v1/ticket/{id} — Show Ticket Conversations — دیدن کل مکالمات یک تیکت.

مرجع و ابزار — Reference & Tools

داده‌های کمکی: استان/شهر، جنسیت، محاسبه هزینه، بانک شماره.

GET /cities — Get Cities List of Provinces — فهرست شهرهای یک استان (برای فیلترهای ارسال هدفمند).
GET /provinces — Get Provinces List — فهرست استان‌ها؛ با `has_any_banks` فقط استان‌هایی که بانک شماره دارند.
GET /ws/v1/number_bank — Get List of Avalibale Banks — فهرست بانک‌های شماره‌ی موجود برای ارسال هدفمند (فیلتر با استان/شهر).
POST /ws/v1/sms/calculate-cost — Send Postal Code SMS — برآورد هزینه‌ی یک ارسال (مثلاً ارسال کدپستی) پیش از انجام آن.
GET /ws/v1/sms/postal/get-available-lines — Get Available Lines — خطوط مجاز برای ارسال کدپستی را برمی‌گرداند.
GET /ws/v1/sms/postal/get-genders — Get Genders List — فهرست جنسیت‌ها برای فیلترِ ارسال کدپستی.
GET /ws/v1/sms/postal/get-receiver-count — Get Receiver Counts — تخمین تعداد گیرنده پیش از ارسالِ کدپستی، بر اساس فیلترها (کدپستی، جنسیت، بازه‌ی سنی، پیش‌شماره).

ورود و حساب پنل — Panel Login & Account

این‌ها برای ورود به پنل‌اند؛ برای فراخوانی وب‌سرویس‌ها «لازم نیستند».

POST /ws/v1/auth/login — Login — ورودِ کاربر به پنل (نه اتصالِ وب‌سرویس). برای فراخوانی APIها از Api-Key استفاده کن، نه این.
POST /ws/v1/auth/logout — Logout — خروج از نشستِ پنل؛ به وب‌سرویس‌ها ربطی ندارد.
POST /ws/v1/auth/register — Register — ثبت‌نام کاربر در پنل؛ برای کار با APIها لازم نیست.
GET /ws/v1/auth/show_register_form — Show Register Form — فیلدهای موردنیاز فرم ثبت‌نام پنل را برمی‌گرداند.
POST /ws/v1/auth/verify-2fa — Verify 2fa — تأیید کد دومرحله‌ای هنگام ورود به پنل.

برای هوش مصنوعی: llms.txt · llms-full.txt · OpenAPI.