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

ارسال پیامک پترن (قالب‌دار) — وب سرویس پیامک فراز اس ام اس

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

کاربرد: ارسال پیامک قالب‌دار (OTP، کد تأیید، اعلان تراکنش). سریع‌ترین راه و بدون صف — برای کدهای یک‌بارمصرف از این استفاده کن.

Send a pattern-based message, the pattern UID must be creadted and get from user panel.

احراز هویت

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

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

code (string) — الزامی
attributes (array) — اختیاری
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.
line_number (string) — الزامی
number_format (string) — الزامی — english | persian
recipient (string) — الزامی — Like: 09120000000

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

پیش‌نیاز: پترن باید از قبل در پنل ساخته و تأیید شده باشد.
همهٔ متغیرهای تعریف‌شده در پترن باید در attributes باشند؛ اگر یکی جا بیفتد پاسخ «فیلد X باید ارسال شود» می‌گیرید. مقدار خالی مجاز است، نبودنِ کلید نه.
نوع مقدار مهم نیست مگر متغیر در پنل از نوع int تعریف شده باشد — آن‌وقت مقدار باید عددی باشد. عدد بدون گیومه (41597) مشکلی ندارد.
⚠️ اگر مقدارِ یک متغیر از طولِ تعریف‌شده‌اش در پنل بلندتر باشد، پیامک به‌جای ارسالِ آنی به صف تأیید ناظر انسانی می‌رود — پاسخ همچنان success است ولی پیامک تا تأیید ارسال نمی‌شود. طول متغیرها را در پنل با بلندترین مقدار واقعی‌تان تطبیق دهید.
code همان UID پترن از پنل است.
کلیدهای داخل attributes باید دقیقاً با نام متغیرهای پترن یکی باشند.
line_number خط فرستنده (پیش‌فرض 90008361)، recipient بدون +۹۸.
برای OTP از این استفاده کن — سریع است و وارد صف نمی‌شود.
number_format را english یا persian بدهید (نه en/fa).
برای ارسال آنی schedule را نفرستید؛ تاریخِ آینده یعنی زمان‌بندی و کسرِ هزینه در همان لحظه.
پاسخ in-queue یعنی ثبت شد، نه تحویل شد — تحویل را از send_request/{id}/items با همان data.id بگیرید.

نمونه بدنه

{
  "code": "SJ3FgPrE0C",
  "attributes": {
    "var1": "1",
    "var2": "2"
  },
  "recipient": "09120000000",
  "line_number": "50002178584000",
  "number_format": "english"
}

پاسخ‌ها

201 — Pattern message sent successfully.

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

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