IRNoti
ورودشروع رایگان
مستنداتv1 stable
دریافت کلید API

ارسال پترن (قالب)

ارسال پیام بر اساس یک قالب تأییدشده با جایگذاری پارامترها — مناسب کد تأیید و پیام‌های تراکنشی.

POST/sms/pattern
scope: sms.send

ابتدا قالب را در پنل («الگوهای پیام») بسازید و منتظر تأیید بمانید. متغیرها در متن به شکل {name} نوشته می‌شوند و باید همگی در params بیایند.

پارامترها

ناممحلنوعتوضیح
code *بدنهstringکد الگو که پس از ساخت قالب در پنل نمایش داده می‌شود.
to *بدنهstringشماره گیرنده (یک شماره).
paramsبدنهobjectمقادیر متغیرهای قالب، مثلا {"code": "4821"}.
Idempotency-Keyهدرstringکلید یکتا (حداکثر ۱۰۰ نویسه). ارسال دوباره با همان کلید، پیام تکراری نمی‌سازد و نتیجه قبلی را برمی‌گرداند.

خطاهای خاص این endpoint

400missing_paramsیکی از متغیرهای قالب در params نیست.
403الگو هنوز تأیید نشده است.
404الگو یافت نشد.

اجرای زنده (محیط تست)

با یک کلید آزمایشی (در پنل ← وب‌سرویس ← «کلید آزمایشی») این درخواست را همین‌جا اجرا کنید. پیام واقعی ارسال نمی‌شود و هزینه‌ای کسر نمی‌شود.

→ قبلی
برآورد هزینه
بعدی ←
فهرست پیام‌ها
curl -X POST '/sms/pattern' \
  -H "Authorization: Bearer $IRNOTI_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
  "code": "k3f9a2",
  "to": "09121234567",
  "params": {
    "code": "4821"
  }
}'
پاسخ نمونه200 OK
{
  "batchId": "919",
  "count": 1,
  "totalPrice": "980",
  "replayed": false
}
ارسال پترن (قالب) — مستندات API | ایران ناتیفیکیشن