ایران ناتیفیکیشن

ارسال پترن پروژه

ارسال پیام الگو‌محور (مثل OTP) از بستهٔ پروژه.

POSThttps://api.irnoti.com/v1/project-sms/pattern
scope: project.sms.send

مانند POST /sms/pattern؛ params جایگزین متغیرهای قالب می‌شود (هر مقدار حداکثر ۵۰۰ نویسه). سقف ۱۲۰۰ درخواست در دقیقه.

پارامترها

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

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

401unauthorizedکلید API نامعتبر یا منقضی است.
403insufficient_scopeکلید API دامنهٔ دسترسی لازم را ندارد.
404not_foundپترن پیدا نشد یا متعلق به شما نیست.

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

باز کردن در کنسول کامل ←

این endpoint در محیط تست پشتیبانی نمی‌شود؛ برای اجرا، کلید واقعی را در حالت «اجرای واقعی» وارد کنید.

curl -X POST 'https://api.irnoti.com/v1/project-sms/pattern' \
  -H "Authorization: Bearer $IRNOTI_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
  "to": "09121234567",
  "code": "login-otp",
  "params": {
    "code": "123456"
  }
}'
پاسخ نمونه200 OK
{
  "count": 1,
  "batchId": "78",
  "replayed": false,
  "totalPrice": "980"
}
ارسال پترن پروژه — مستندات API | ایران ناتیفیکیشن