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

ساخت فرم

فرم با فیلدهای دلخواه می‌سازد.

POSThttps://api.irnoti.com/v1/sdk-apps/{id}/forms
scope: broker.write

fields فهرست فیلد (نوع، برچسب، الزامی بودن). consentText تیک رضایت اجباری می‌گذارد. اگر تأیید پیامکی شمارهٔ موبایل لازم است، verifyLineId خطی را بدهید که کدها را می‌فرستد و هزینه‌اش را می‌پردازد.

پارامترها

ناممحلنوعتوضیح
id *مسیرstringشناسهٔ اپ.
name *بدنهstringنام داخلی (≤۸۰).
title *بدنهstringعنوان نمایشی (≤۱۲۰).
descriptionبدنهstringتوضیح (≤۵۰۰).
fieldsبدنهobject[]فیلدهای فرم.
groupNameبدنهstringگروه دفترچه برای ثبت‌ها.
consentTextبدنهstringمتن رضایت (≤۳۰۰).
submitTextبدنهstringمتن دکمه.
successMessageبدنهstringپیام موفقیت.
verifyLineIdبدنهstringخط ارسال کد تأیید موبایل.

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

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

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

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

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

curl -X POST 'https://api.irnoti.com/v1/sdk-apps/8/forms' \
  -H "Authorization: Bearer $IRNOTI_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "ثبت‌نام خبرنامه",
  "title": "عضو خبرنامه شوید",
  "fields": [
    {
      "key": "mobile",
      "type": "mobile",
      "label": "موبایل",
      "required": true
    }
  ],
  "consentText": "با دریافت پیام موافقم"
}'
پاسخ نمونه200 OK
{
  "id": "4",
  "name": "ثبت‌نام خبرنامه",
  "status": "active"
}
ساخت فرم — مستندات API | ایران ناتیفیکیشن