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

شروع نشست تأیید

کد یک‌بارمصرف یا پیوند تأیید را به موبایل، بات یا پوش می‌فرستد.

POSThttps://api.irnoti.com/v1/verify/sessions
scope: verify.send

دقیقاً یکی از to (موبایل) یا bot را بدهید. کلید سندباکس پیامک نمی‌فرستد و خود code را در پاسخ برمی‌گرداند تا بدون گوشی تست کنید. mode: code (کد)، link (پیوند) یا both. سقف ۳۰۰ درخواست در دقیقه. نتیجه را از callbackUrl (وب‌هوک) یا GET /verify/sessions/{id} بگیرید.

پارامترها

ناممحلنوعتوضیح
toبدنهstringموبایل مقصد.
botبدنه{id, ref}مقصد از طریق بات پیام‌رسان.
lineIdبدنهstringشناسهٔ خط ارسال، یا sandbox.
pushبدنه{appId, fallbackSms?}ارسال به‌صورت پوش با بازگشت به پیامک؛ نیازمند to.
modeبدنه'code' | 'link' | 'both'شیوهٔ تأیید.
lengthبدنهintegerطول کد، ۴ تا ۸.
ttlSecبدنهintegerاعتبار نشست به ثانیه، ۶۰ تا ۱۸۰۰.
maxAttemptsبدنهintegerحداکثر تلاش، ۳ تا ۱۰.
redirectUrlبدنهstringآدرس بازگشت کاربر پس از تأیید.
callbackUrlبدنهstringآدرس وب‌هوک نتیجه.
clientRefبدنهstringشناسهٔ دلخواه شما (حداکثر ۱۰۰ نویسه).
brandNameبدنهstringنام برند در صفحه و پیام.
brandColorبدنهstringرنگ برند، مثل #FF3300.

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

400validation_errorهیچ‌کدام یا هر دو از to/bot داده شده‌اند.
402insufficient_balanceاعتبار کافی نیست.
429rate_limitedتعداد درخواست یا ارسال به این مقصد زیاد است.

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

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

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

curl -X POST 'https://api.irnoti.com/v1/verify/sessions' \
  -H "Authorization: Bearer $IRNOTI_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
  "to": "09121234567",
  "mode": "code",
  "length": 6,
  "ttlSec": 300,
  "clientRef": "login-8841"
}'
پاسخ نمونه200 OK
{
  "id": "312",
  "to": "0912***4567",
  "link": "https://irnoti.com/v/vt_x9…",
  "mode": "code",
  "token": "vt_x9…",
  "status": "pending",
  "channel": "sms",
  "expiresAt": "2026-10-27T10:05:00.000Z"
}
شروع نشست تأیید — مستندات API | ایران ناتیفیکیشن