خانه › ارسال پیامک

ارسال پیامک ساده (گروهی) از طریق وب‌سرویس — وب سرویس پیامک فراز اس ام اس

POST https://api.iranpayamak.com/ws/v1/sms/simple

کاربرد: متن خودتان را می‌نویسید و برای یک یا چند شماره می‌فرستید — ساده‌ترین راه برای شروع و تستِ اتصال. مناسب اطلاع‌رسانی و پیامک تبلیغاتی گروهی. پیامک پیش از ارسال به تأیید ناظر انسانی می‌رسد، پس ممکن است چند دقیقه طول بکشد؛ برای کد تأیید و هر پیامکی که باید زیر ۵ ثانیه برسد از «ارسال با پترن» استفاده کنید.

Send one text to many recipients. Provide `recipients` (an array of numbers) and/or `selectedPhoneBooks`; at least one of the two is required. This endpoint is queued and moderated — use /ws/v1/sms/pattern for OTP.

احراز هویت

این سرویس به هدر Api-Key نیاز دارد — کلید را از پنل فراز اس ام اس بگیرید. نام هدر حساس به حروف بزرگ و کوچک است و کلید نباید در query string برود.

فیلدهای درخواست

text (string) — الزامی
line_number (string) — الزامی
recipients (array) — اختیاری
number_format (string) — الزامی
schedule (string) — اختیاری — Optional. Omit it or send null to send immediately. A future "YYYY-MM-DD HH:MM:SS" schedules the send — the message is accepted and its cost is reserved at submit time, and it is delivered at that moment, not now. A past date is rejected with a validation error.
selectedPhoneBooks (array) — اختیاری

نکات مهم این سرویس

🚦 کِی این، کِی پترن؟ این سرویس برای ارسال گروهی/تبلیغاتی است. برای کد تأیید (OTP)، رمز یک‌بارمصرف و هشدار فوری مناسب نیست.
⏱ ارسال ساده در صف تأیید ناظر انسانی می‌نشیند و ممکن است چند دقیقه‌ای طول بکشد. پترن ۲۴ ساعت شبانه‌روز بدون صف است (معمولاً زیر ۵ ثانیه).
🧭 مسیر پیشنهادی: اول با همین سرویس اتصال و کلیدتان را تست کنید؛ بعد متن‌های تکراری‌تان را به‌صورت پترن در پنل بسازید و ارسال‌های حساس را از پترن بفرستید.
recipients (آرایه شماره) یا selectedPhoneBooks را بده.
number_format یکی از english یا persian.
برای ارسال آنی schedule را حذف کنید یا null بگذارید — هرگز با // کامنتش نکنید (JSON کامنت ندارد).
تاریخِ آینده در schedule = زمان‌بندی؛ هزینه همان لحظه کسر می‌شود ولی پیامک بعداً می‌رود. تاریخِ گذشته = خطا.
بدنه‌ی JSON را با ابزار زبان خودتان بسازید (مثلاً json_encode در PHP)، نه با چسباندنِ رشته — وگرنه متغیرها و کاراکترهای ویژه خراب می‌شوند.

نمونه بدنه

{
  "text": "سلام، این یک پیامک آزمایشی است.",
  "line_number": "90008361",
  "recipients": [
    "09120000000"
  ],
  "number_format": "english",
  "schedule": null
}

پاسخ‌ها

201 — SMS request is enqueued successfully.

سرویس‌های مرتبط در دستهٔ «ارسال پیامک»

همه‌ی وب‌سرویس‌های فراز اس ام اس · llms.txt · OpenAPI