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

تأیید تلفنی

به مخاطب زنگ می‌زند تا کدی را تایپ یا گزینه‌ای را انتخاب کند.

POSThttps://api.irnoti.com/v1/voice-confirm
scope: sms.send

مناسب تأیید پرداخت، سفارش یا هویت. نتیجه را با GET /voice-confirm/{id} بگیرید. سقف ۲۰ در دقیقه.

پارامترها

ناممحلنوعتوضیح
to *بدنهstringشمارهٔ مخاطب.
mode *بدنهstringcode (کاربر کد را تایپ کند) یا choice (انتخاب با کلید).
prompt *بدنهobjectپیام ابتدایی: متن گفتار یا فایل صوتی.
codeبدنهstringحالت code: ارقام (۳ تا ۸) که کاربر باید وارد کند.
optionsبدنهobjectحالت choice: کلید ← برچسب (۲ تا ۹ گزینه).
transfersبدنهobjectحالت choice: کلید ← داخلی برای وصل شدن.

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

401unauthorizedکلید API نامعتبر یا منقضی است.
403insufficient_scopeکلید API دامنهٔ دسترسی لازم را ندارد.
400validation_errorورودی نامعتبر است (جزئیات در پاسخ).
402insufficient_balanceاعتبار کافی نیست.
429rate_limitedتعداد درخواست از سقف مجاز بیشتر شد؛ پس از زمان Retry-After دوباره تلاش کنید.

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

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

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

curl -X POST 'https://api.irnoti.com/v1/voice-confirm' \
  -H "Authorization: Bearer $IRNOTI_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
  "to": "09121234567",
  "mode": "choice",
  "prompt": {
    "text": "سفارش شما را تأیید می‌کنید؟ یک برای بله و دو برای خیر"
  },
  "options": {
    "1": "بله",
    "2": "خیر"
  }
}'
پاسخ نمونه200 OK
{
  "id": "17",
  "status": "calling"
}
تأیید تلفنی — مستندات API | ایران ناتیفیکیشن