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

ارسال کد تأیید از ربات

کدی عددی می‌سازد، برای مشترک می‌فرستد و خودِ کد را برمی‌گرداند.

POSThttps://api.irnoti.com/v1/botbuilder/bots/{id}/otp
scope: bot.send

برای تأیید ورود از طریق ربات به‌جای پیامک. length بین ۴ تا ۸ و template متنی با {code}. کد را شما باید با ورودی کاربر مقایسه کنید؛ اعتبار پیش‌فرض چند دقیقه است (expiresInSec).

پارامترها

ناممحلنوعتوضیح
id *مسیرstringشناسهٔ ربات.
to *بدنهobjectمخاطب؛ دقیقاً یکی از chatId، ref (برچسب لینک عضویت)، phone (شمارهٔ ثبت‌شده در ربات) یا all: true (همهٔ مشترکین).
lengthبدنهintegerتعداد ارقام (۴ تا ۸).
templateبدنهstringمتن پیام شامل {code}.
Idempotency-Keyهدرstringکلید یکتا (حداکثر ۱۰۰ نویسه). ارسال دوباره با همان کلید، کار تکراری نمی‌سازد و نتیجهٔ قبلی را برمی‌گرداند.

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

401unauthorizedکلید API نامعتبر یا منقضی است.
403insufficient_scopeکلید API دامنهٔ دسترسی لازم را ندارد.
400validation_errorورودی نامعتبر است (جزئیات در پاسخ).
404not_foundربات یا مشترک پیدا نشد یا متعلق به شما نیست.

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

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

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

curl -X POST 'https://api.irnoti.com/v1/botbuilder/bots/5/otp' \
  -H "Authorization: Bearer $IRNOTI_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
  "to": {
    "phone": "09121234567"
  },
  "length": 6
}'
پاسخ نمونه200 OK
{
  "code": "482910",
  "queued": 1,
  "recipient": {
    "ref": null,
    "chatId": "123456"
  },
  "expiresInSec": 300
}
ارسال کد تأیید از ربات — مستندات API | ایران ناتیفیکیشن