ارسال کد تأیید از ربات
کدی عددی میسازد، برای مشترک میفرستد و خودِ کد را برمیگرداند.
POST
scope: bot.sendhttps://api.irnoti.com/v1/botbuilder/bots/{id}/otpبرای تأیید ورود از طریق ربات بهجای پیامک. length بین ۴ تا ۸ و template متنی با {code}. کد را شما باید با ورودی کاربر مقایسه کنید؛ اعتبار پیشفرض چند دقیقه است (expiresInSec).
پارامترها
| نام | محل | نوع | توضیح |
|---|---|---|---|
| id * | مسیر | string | شناسهٔ ربات. |
| to * | بدنه | object | مخاطب؛ دقیقاً یکی از chatId، ref (برچسب لینک عضویت)، phone (شمارهٔ ثبتشده در ربات) یا all: true (همهٔ مشترکین). |
| length | بدنه | integer | تعداد ارقام (۴ تا ۸). |
| template | بدنه | string | متن پیام شامل {code}. |
| Idempotency-Key | هدر | string | کلید یکتا (حداکثر ۱۰۰ نویسه). ارسال دوباره با همان کلید، کار تکراری نمیسازد و نتیجهٔ قبلی را برمیگرداند. |
خطاهای خاص این endpoint
| 401 | unauthorized | کلید API نامعتبر یا منقضی است. |
| 403 | insufficient_scope | کلید API دامنهٔ دسترسی لازم را ندارد. |
| 400 | validation_error | ورودی نامعتبر است (جزئیات در پاسخ). |
| 404 | not_found | ربات یا مشترک پیدا نشد یا متعلق به شما نیست. |
اجرای زنده (محیط تست)
باز کردن در کنسول کامل ←این endpoint در محیط تست پشتیبانی نمیشود؛ برای اجرا، کلید واقعی را در حالت «اجرای واقعی» وارد کنید.