شروع نشست تأیید
کد یکبارمصرف یا پیوند تأیید را به موبایل، بات یا پوش میفرستد.
POST
scope: verify.sendhttps://api.irnoti.com/v1/verify/sessionsدقیقاً یکی از 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
| 400 | validation_error | هیچکدام یا هر دو از to/bot داده شدهاند. |
| 402 | insufficient_balance | اعتبار کافی نیست. |
| 429 | rate_limited | تعداد درخواست یا ارسال به این مقصد زیاد است. |
اجرای زنده (محیط تست)
باز کردن در کنسول کامل ←با یک کلید آزمایشی (در پنل ← وبسرویس ← «کلید آزمایشی») این درخواست را همینجا اجرا کنید. پیام واقعی ارسال نمیشود و هزینهای کسر نمیشود.