ایران ناتیفیکیشن
REST API · JSON · v1

مستندات API پیامک

وب‌سرویس REST با بدنه JSON. هر کاری که در پنل انجام می‌دهید با API هم ممکن است. همه نمونه‌ها برای ۱۱ زبان تولید می‌شود و می‌توانید هر درخواست را همین‌جا با کلید آزمایشی اجرا کنید.

تست سرعت ارسال (رایگان، بدون ثبت‌نام)

شمارهٔ موبایل خودتان را وارد کنید تا یک پیامک آزمایشی دریافت کنید و سرعت واقعی ارسال را ببینید.

شروع سریع

  1. ۱در پنل ثبت‌نام کنید و از بخش «وب‌سرویس» یک کلید آزمایشی بسازید.
  2. ۲با lineId: "sandbox" یک پیام بفرستید — بدون هزینه و بدون ارسال واقعی.
  3. ۳پس از احراز هویت، کلید واقعی بسازید و شناسه خط واقعی را از خطوط من بگیرید.

برای شروع سریع‌تر می‌توانید از SDKها و پکیج‌های آماده استفاده کنید، به‌جای اینکه درخواست‌ها را از ابتدا بنویسید.

آدرس پایه
BASEhttps://api.irnoti.com/v1

احراز هویت

هر درخواست باید کلید دسترسی را در هدر Authorization: Bearer irn_live_… داشته باشد. کلید فقط هنگام ساخت یک‌بار نمایش داده می‌شود و در سرور ما فقط به‌صورت هش نگهداری می‌شود؛ آن را در کد سمت کاربر (مرورگر/اپ) قرار ندهید.

دسترسی (scope)اجازه
sms.sendارسال پیامک و پترن
sms.readبرآورد هزینه، گزارش پیام‌ها و خطوط
wallet.readمشاهده اعتبار
phonebook.readخواندن دفترچه تلفن
phonebook.writeویرایش دفترچه تلفن
bot.sendربات‌ساز: ارسال پیام و کد تأیید
bot.readربات‌ساز: مشاهده ربات‌ها و مشترکین
verify.sendتأیید با لینک: ساخت و لغو جلسه
verify.readتأیید با لینک: مشاهده وضعیت
broker.readبروکر رویداد: مشاهدهٔ لینک‌ها و وب‌هوک
broker.writeبروکر رویداد: ثبت، ویرایش و حذف لینک سرویس‌ها و تنظیم وب‌هوک
broker.requestبروکر رویداد: ارسال درخواست به تلگرام و دریافت آپدیت‌ها (ویژهٔ ربات تلگرام)
tts.sayتبدیل متن به گفتار (TTS) برای VoIP و IVR
  • برای هر کلید می‌توانید فهرست IP مجاز تعیین کنید؛ درخواست از IP دیگر ۴۰۱ می‌گیرد.
  • کلید آزمایشی با پیشوند irn_test_ شروع می‌شود و هرگز پیام واقعی نمی‌فرستد.
  • ساخت و حذف کلید فقط از پنل ممکن است، نه با خودِ کلید.

قراردادها

  • آدرس پایه: https://api.irnoti.com/v1
  • مبلغ‌ها عدد صحیح به ریال و به‌صورت رشته هستند (مثلا "1960")؛ هرگز اعشار نیستند.
  • شماره‌ها: 09121234567، +989121234567 و ارقام فارسی پذیرفته می‌شود.
  • زمان‌ها ISO 8601 در UTC هستند.
  • Idempotency: برای ارسال، هدر Idempotency-Key بفرستید تا تلاش دوباره (timeout، قطع اینترنت) پیام تکراری نسازد.
  • محدودیت نرخ: ارسال تا ۶۰۰ و پترن تا ۱۲۰۰ درخواست در دقیقه برای هر IP؛ پاسخ 429 یعنی کمی صبر کنید.

محدودیت نرخ

در صورت عبور از محدودیت، پاسخ 429 برگردانده می‌شود. محدودیت‌ها به‌ازای هر IP و در هر دقیقه‌اند.

ارسال پیامک600 req/min
ارسال پترن1200 req/min

خطاها

کد وضعیت HTTP نتیجه را مشخص می‌کند. بدنه خطا شامل message و گاهی code و details است.

400درخواست نامعتبر (فیلد ناقص، شماره نامعتبر…)
401کلید نامعتبر، حذف‌شده یا IP مجاز نیست
402اعتبار کافی نیست
403دسترسی (scope) یا احراز هویت حساب کافی نیست
404منبع یافت نشد
409تعارض (مثلا نام تکراری)
422تعرفه تعریف نشده
429تعداد درخواست زیاد
5xxخطای سرور — با همان Idempotency-Key دوباره تلاش کنید

مرجع endpointها

POST/sms/sos
ارسال تضمین‌شده (SOS)

ارسال پیام حیاتی از مسیرهای پلتفرم با جایگزینی خودکار پرووایدر.

POST/sms/send
ارسال پیامک

ارسال یک متن به یک یا چند گیرنده، یا به گروه‌های دفترچه تلفن.

POST/sms/quote
برآورد هزینه

هزینه دقیق یک ارسال را بدون ارسال و بدون کسر اعتبار برمی‌گرداند.

POST/sms/pattern
ارسال پترن (قالب)

ارسال پیام بر اساس یک قالب تأییدشده با جایگذاری پارامترها — مناسب کد تأیید و پیام‌های تراکنشی.

GET/sms/messages
فهرست پیام‌ها

پیام‌های ارسالی اخیر با وضعیت تحویل.

GET/sms/messages/{id}
جزئیات یک پیام

وضعیت و جزئیات یک پیام با شناسه.

GET/sms/lines
خطوط من

خطوطی که می‌توانید از آن‌ها ارسال کنید.

GET/sms/scheduled
ارسال‌های زمان‌بندی‌شده و تدریجی

دسته‌های زمان‌بندی‌شده یا تدریجی که هنوز تمام نشده‌اند.

POST/sms/batches/{id}/cancel
لغو دستهٔ زمان‌بندی‌شده

پیام‌های ارسال‌نشدهٔ یک دسته را لغو و هزینهٔ آن‌ها را برمی‌گرداند.

POST/sms/batches/{id}/pause
توقف ارسال تدریجی

آزادسازی نوبت‌های بعدی یک دستهٔ تدریجی را متوقف می‌کند.

POST/sms/batches/{id}/resume
ادامهٔ ارسال تدریجی

ارسال تدریجیِ متوقف‌شده را از سر می‌گیرد.

POST/sms/messages/{id}/check
استعلام فوری وضعیت تحویل

وضعیت نهایی پیام را همین حالا از اپراتور می‌پرسد.

GET/broker/bots
فهرست ربات‌ها

فهرست رباتِ ثبت‌شده در بروکر با لینک اختصاصی و وضعیت.

GET/broker/bots/{id}
مشاهدهٔ یک ربات

جزئیات یک ربات شامل لینک و آدرس وب‌هوک ثبت‌شده.

POST/broker/bots
ثبت ربات

توکن ربات را ثبت کنید و لینک اختصاصی بگیرید.

PATCH/broker/bots/{id}
ویرایش نام

نام نمایشی ربات را عوض کنید.

PUT/broker/bots/{id}/token
تعویض توکن

بعد از ساخت توکن جدید در BotFather، آن را برای همین ربات جایگزین کنید.

POST/broker/bots/{id}/rotate
لینک جدید

اگر لینک لو رفت، لینک تازه بسازید؛ لینک قبلی از کار می‌افتد.

DELETE/broker/bots/{id}
حذف ربات

ربات را از بروکر حذف کنید؛ لینک و ثبت بروکر پاک می‌شود.

POST/broker/bots/{id}/request
ارسال درخواست به تلگرام

هر متد Bot API (sendMessage، sendPhoto، getChat، …) را از طریق بروکر اجرا کنید.

POST/broker/bots/{id}/updates
دریافت درخواست‌ها (Polling)

پیام‌های رسیده به ربات را بخوانید (getUpdates)، بدون نیاز به سرور وب‌هوک.

GET/broker/bots/{id}/webhook
وضعیت وب‌هوک

آدرس بازگشتی (وب‌هوک) تنظیم‌شده و وضعیت تحویل آن.

PUT/broker/bots/{id}/webhook
تنظیم آدرس بازگشتی (وب‌هوک)

آدرس سرور خودتان را بدهید؛ آپدیت‌های تلگرام از طریق بروکر به همان آدرس POST می‌شوند.

DELETE/broker/bots/{id}/webhook
حذف وب‌هوک

وب‌هوک را بردارید (برای استفاده از getUpdates).

POST/broker/bots/{id}/move
انتقال ربات به پروژه

ربات را به یک پروژهٔ سازمانی منتقل می‌کند.

GET/phonebook/groups
گروه‌های دفترچه تلفن

فهرست گروه‌ها با تعداد مخاطبین.

POST/phonebook/groups
ساخت گروه

یک گروه جدید در دفترچه تلفن بسازید.

POST/phonebook/groups/{id}/contacts
افزودن مخاطب

افزودن چند مخاطب به یک گروه.

GET/phonebook/groups/{id}
جزئیات گروه

مشخصات یک گروه و تعداد اعضا.

PATCH/phonebook/groups/{id}
ویرایش گروه

نام یا توضیح گروه را تغییر می‌دهد.

DELETE/phonebook/groups/{id}
حذف گروه

گروه را حذف می‌کند.

GET/phonebook/groups/{id}/contacts
مخاطبین یک گروه

فهرست اعضای گروه با جست‌وجو و صفحه‌بندی.

POST/phonebook/groups/{id}/import
درون‌ریزی مخاطب از فایل

فایل CSV/TXT را به گروه اضافه می‌کند.

POST/phonebook/groups/{id}/members
افزودن مخاطب موجود به گروه

مخاطبین موجود را به گروه هم اضافه می‌کند (عضویت در چند گروه ممکن است).

DELETE/phonebook/groups/{id}/contacts/{contactId}
خروج یک مخاطب از گروه

مخاطب را فقط از این گروه خارج می‌کند.

POST/phonebook/groups/{id}/members/remove
خروج چند مخاطب از گروه

چند مخاطب را یک‌جا از گروه بیرون می‌آورد.

GET/phonebook/contacts
همهٔ مخاطبان

همهٔ افراد دفترچه (پیامک، ایمیل، دستگاه‌های اپ، فرم‌ها).

POST/phonebook/contacts
ساخت مخاطب

یک مخاطب با جزئیات کامل می‌سازد و می‌تواند هم‌زمان به گروه‌ها اضافه کند.

POST/phonebook/contacts/delete
حذف گروهی مخاطبان

چند مخاطب را از همهٔ گروه‌ها، ایمیل و دستگاه‌ها حذف می‌کند.

PATCH/phonebook/contacts/{id}
ویرایش مخاطب

فیلدهای مخاطب را به‌روز می‌کند.

DELETE/phonebook/contacts/{id}
حذف مخاطب

مخاطب را از همه‌جا حذف می‌کند.

GET/wallet
اعتبار

موجودی کیف پول به ریال.

GET/wallet/transactions
تراکنش‌های کیف پول

تاریخچهٔ تراکنش‌های مالی (شارژ، کسر، بازگشت).

POST/email/send
ارسال ایمیل

ارسال ایمیل تراکنشی با متن/HTML، پیوست، قالب و زمان‌بندی.

GET/email/outbound/{id}
وضعیت و رویدادهای یک ایمیل

وضعیت ارسال و خط زمانی رویدادها (ارسال، تحویل، بازگشت، شکایت).

GET/email/outbound
فهرست ایمیل‌های ارسالی

ارسال‌های شما با فیلتر وضعیت و جستجو؛ صفحه‌بندی با `before`.

POST/email/outbound/{id}/cancel
لغو ایمیل زمان‌بندی‌شده

نامهٔ زمان‌بندی‌شدهٔ هنوز ارسال‌نشده را لغو و هزینه را برمی‌گرداند.

GET/email/otp
آخرین کدهای تأیید در صندوق

کدهای OTP که در نامه‌های رسیده شناسایی شده‌اند (جدیدترین اول).

GET/email/otp/wait
انتظار برای کد تأیید جدید

تا رسیدن کد جدید (حداکثر ۶۰ ثانیه) صندوق را بررسی می‌کند؛ مناسب تست خودکار ورود.

GET/email/messages
فهرست نامه‌های دریافتی

نامه‌های صندوق با پوشه، دسته، جستجو و صفحه‌بندی.

GET/email/messages/{id}
خواندن یک نامه

متن کامل نامه با HTML امن‌شده و فهرست پیوست‌ها.

POST/email/messages/actions
عملیات روی نامه‌ها

خوانده/ستاره/انتقال/حذف/هرزنامه/برچسب برای چند نامه.

GET/email/domains
فهرست دامنه‌ها

دامنه‌های شما با وضعیت تأیید و شمار صندوق.

POST/email/domains
افزودن دامنه

دامنه را ثبت و رکوردهای DNS لازم را برمی‌گرداند.

POST/email/domains/{id}/check
بررسی رکوردهای DNS

DNS را بررسی و در صورت کامل بودن دامنه را تأیید می‌کند.

POST/email/mailboxes
ساخت صندوق سازمانی

برای دامنهٔ خود صندوق (و زیرمجموعه) بسازید.

PUT/email/templates
ساخت یا بروزرسانی قالب

قالب ایمیل تراکنشی با متغیر `{{name}}`.

POST/email/suppressions
افزودن به فهرست ممنوعه

به نشانی اضافه‌شده دیگر ایمیل ارسال نمی‌شود.

GET/email/me
وضعیت اشتراک و مصرف ایمیل

اشتراک فعال، سقف‌ها، سهمیهٔ ماهانه، بستهٔ ارسال و موجودی کیف پول برای ایمیل.

GET/email/info
نشانی SMTP و رویدادهای وب‌هوک

میزبان و پورت درگاه SMTP و فهرست رویدادهایی که می‌توان به آن‌ها مشترک شد.

GET/email/report
گزارش مصرف و کیفیت ارسال

جمع ارسال، تحویل، بازگشت، شکایت و دریافت به‌همراه روند روزانه.

GET/email/outbound.csv
خروجی CSV ارسال‌ها

همان فهرست ارسال‌ها با فیلترهای یکسان، به‌صورت فایل CSV.

GET/email/counts
تعداد خوانده‌نشده‌ها

تعداد نامهٔ خوانده‌نشده به تفکیک پوشه و دسته، به‌همراه ستاره‌دارها و پیش‌نویس‌ها.

GET/email/threads/{threadId}
رشتهٔ گفتگو

همهٔ نامه‌های یک گفتگو به ترتیب زمان.

POST/email/messages/{id}/check-sender
بررسی اصالت فرستنده

سرایند احراز هویت همان نامه را از سرور دوباره می‌خواند و می‌گوید چرا «تیک آبی» ندارد یا دارد.

POST/email/drafts
ذخیرهٔ پیش‌نویس

پیش‌نویس جدید می‌سازد یا با `id` پیش‌نویس موجود را ویرایش می‌کند.

POST/email/messages/empty
خالی‌کردن سطل زباله یا هرزنامه

همهٔ نامه‌های پوشهٔ `trash` یا `spam` را برای همیشه حذف می‌کند.

POST/email/sync
همگام‌سازی فوری صندوق

نامه‌های جدید را همین الان از سرور می‌گیرد، به‌جای انتظار برای همگام‌سازی دوره‌ای.

GET/email/mailboxes
فهرست صندوق‌ها

صندوق‌های سازمانی و حساب‌های شخصی متصل‌شدهٔ شما، و صندوق‌هایی که به شما تخصیص داده شده است.

GET/email/mailboxes/{id}/settings
تنظیمات اتصال نرم‌افزار ایمیل

میزبان، پورت و امنیت IMAP، POP3 و SMTP برای وصل‌کردن Outlook، Thunderbird یا موبایل.

PATCH/email/mailboxes/{id}
ویرایش صندوق

نام نمایشی، امضا، پاسخ خودکار، تخصیص به همکار و سهمیهٔ فضا را تغییر می‌دهد.

POST/email/mailboxes/{id}/password
رمز جدید صندوق

برای صندوق سازمانی رمز تازه می‌سازد (یا رمز دلخواه شما را می‌گذارد) و همان‌جا یک‌بار برمی‌گرداند.

DELETE/email/mailboxes/{id}
حذف صندوق

صندوق و همهٔ نامه‌های آن را حذف می‌کند.

GET/email/domains/{id}
جزئیات دامنه و رکوردهای DNS

وضعیت دامنه و رکوردهای DNS که باید بسازید (تأیید مالکیت، MX، SPF، DKIM، DMARC).

PUT/email/domains/{id}/catch-all
تنظیم Catch-all

نامهٔ ارسال‌شده به هر نشانی ناموجود دامنه را به یک صندوق می‌رساند.

DELETE/email/domains/{id}
حذف دامنه

دامنه با همهٔ صندوق‌ها، نام‌های مستعار و نامه‌هایش حذف می‌شود.

GET/email/domains/{id}/aliases
فهرست نام‌های مستعار

نام‌های مستعار (فوروارد) یک دامنه.

POST/email/domains/{id}/aliases
افزودن نام مستعار

نشانی تازه می‌سازد که نامه‌هایش به صندوق‌های مقصد می‌رسد.

PATCH/email/aliases/{id}
ویرایش مقصدهای نام مستعار

فهرست مقصدهای یک نام مستعار را جایگزین می‌کند.

DELETE/email/aliases/{id}
حذف نام مستعار

نام مستعار را حذف می‌کند.

GET/email/contacts
فهرست مخاطبین

مخاطبین ایمیل با جستجو و فیلتر گروه.

POST/email/contacts
افزودن مخاطب

مخاطب جدید می‌سازد.

PATCH/email/contacts/{id}
ویرایش مخاطب

فقط فیلدهای ارسال‌شده تغییر می‌کنند.

DELETE/email/contacts/{id}
حذف مخاطب

مخاطب را حذف می‌کند.

GET/email/contacts.csv
خروجی CSV مخاطبین

همهٔ مخاطبین به‌صورت فایل CSV.

POST/email/contacts/import/csv
ورود مخاطبین از CSV

متن CSV را می‌خواند و مخاطبین تازه را اضافه می‌کند.

POST/email/contacts/import/vcard
ورود مخاطبین از vCard

فایل vCard (‎.vcf) را می‌خواند و مخاطبین را اضافه می‌کند.

GET/email/labels
فهرست برچسب‌ها

برچسب‌های شما.

POST/email/labels
ساخت برچسب

برچسب جدید.

PATCH/email/labels/{id}
ویرایش برچسب

نام یا رنگ برچسب.

DELETE/email/labels/{id}
حذف برچسب

برچسب را از همهٔ نامه‌ها برمی‌دارد.

GET/email/rules
فهرست قوانین

قوانین خودکار پردازش نامهٔ ورودی.

POST/email/rules
ساخت قانون

قانون جدید برای نامه‌های ورودی.

PATCH/email/rules/{id}
ویرایش قانون

فقط فیلدهای ارسال‌شده تغییر می‌کنند.

DELETE/email/rules/{id}
حذف قانون

قانون را حذف می‌کند.

GET/email/templates
فهرست قالب‌ها

قالب‌های ذخیره‌شدهٔ ارسال.

DELETE/email/templates/{id}
حذف قالب

قالب را حذف می‌کند.

GET/email/suppressions
فهرست ممنوعه

نشانی‌هایی که ارسال به آن‌ها انجام نمی‌شود.

DELETE/email/suppressions
خارج‌کردن از فهرست ممنوعه

یک نشانی را دوباره مجاز می‌کند.

GET/email/otp-relays
فهرست بازارسال کد تأیید

قوانینی که کد تأیید رسیده به ایمیل را به پیامک، بله یا تلگرام می‌فرستند.

POST/email/otp-relays
ساخت بازارسال کد تأیید

کد OTP تشخیص‌داده‌شده در صندوق را خودکار به مقصد دلخواه می‌فرستد.

POST/email/otp-relays/{id}/verify
تأیید مقصد بازارسال

کد ۶ رقمی رسیده به مقصد را تأیید می‌کند.

POST/email/otp-relays/{id}/resend
ارسال دوباره کد تأیید مقصد

کد تأیید مقصد را دوباره می‌فرستد.

POST/email/otp-relays/{id}/test
ارسال آزمایشی

یک کد نمونه به مقصد می‌فرستد تا مسیر را امتحان کنید.

PATCH/email/otp-relays/{id}
روشن یا خاموش کردن بازارسال

بازارسال را بدون حذف فعال یا غیرفعال می‌کند.

DELETE/email/otp-relays/{id}
حذف بازارسال

بازارسال را حذف می‌کند.

GET/email/sender-icon/{domain}
آیکن فرستنده

تصویر نمادِ دامنهٔ فرستنده برای نمایش در صندوق.

GET/tts/say
تبدیل متن به گفتار (GET)

متن فارسی ← فایل صوتی ۸ کیلوهرتز برای IVR و VoIP؛ مناسب آدرس ttsUrl سانترال.

POST/tts/say
تبدیل متن به گفتار (POST)

همان عملیات GET با بدنهٔ JSON؛ برای متن‌های بلند یا وقتی نمی‌خواهید متن در آدرس بیاید.

GET/public/tts/info
صداها، قالب‌ها و تعرفهٔ TTS

فهرست صداها و قالب‌های در دسترس، سقف‌ها و تعرفهٔ پایه؛ بدون کلید.

GET/ai/models
فهرست مدل‌های هوش مصنوعی

مدل‌های فعال و ضریب اعتبار هر کدام، به قالب OpenAI.

GET/ai/balance
موجودی اعتبار هوش مصنوعی

اعتبار قابل‌مصرف، اعتبار رزروشده و تخفیف شما.

POST/ai/chat/completions
گفتگو با مدل (Chat Completions)

درخواست چت سازگار با OpenAI، با پاسخ عادی یا جریانی (SSE).

POST/ai/images/generations
ساخت تصویر

ساخت تصویر از متن، سازگار با OpenAI.

POST/ai/embeddings
بردار معنایی (Embedding)

تبدیل متن به بردار، سازگار با OpenAI.

POST/ai/moderations
پایش محتوا (Moderation)

تشخیص محتوای نامناسب، سازگار با OpenAI.

POST/ai/audio/transcriptions
تبدیل گفتار به متن

رونویسی فایل صوتی، سازگار با OpenAI.

GET/video/models
فهرست مدل‌های ویدئو

مدل‌های ساخت ویدئو، حداکثر مدت و اعتبار هر ثانیه.

POST/video/jobs
ثبت درخواست ساخت ویدئو

یک کار ساخت ویدئو در صف می‌گذارد و `201` برمی‌گرداند.

GET/video/jobs
فهرست ویدئوها

کارهای ساخت ویدئوی شما، صفحه‌بندی‌شده.

GET/video/jobs/{id}
وضعیت یک ویدئو

وضعیت و پیشرفت کار.

POST/video/jobs/{id}/cancel
لغو ساخت ویدئو

کار در صف یا در حال اجرا را لغو و رزرو اعتبار را آزاد می‌کند.

GET/video/jobs/{id}/file
دریافت فایل ویدئو

فایل ویدئوی ساخته‌شده؛ از `Range` پشتیبانی می‌کند.

GET/verify/info
قیمت هر تأیید

بهای هر نشست تأیید به ریال.

POST/verify/sessions
شروع نشست تأیید

کد یک‌بارمصرف یا پیوند تأیید را به موبایل، بات یا پوش می‌فرستد.

GET/verify/sessions
فهرست نشست‌های تأیید

نشست‌های اخیر با صفحه‌بندی مبتنی بر شناسه.

GET/verify/sessions/{id}
وضعیت یک نشست

وضعیت: `pending`، `verified`، `expired`، `locked` یا `canceled`.

POST/verify/sessions/{id}/cancel
لغو نشست

نشست در انتظار را لغو می‌کند (`204`).

GET/verify/stats
آمار تأیید

شمار کل، موفق، لغو و قفل‌شده و نرخ موفقیت.

GET/verify/{token}
اطلاعات صفحهٔ تأیید

اطلاعات نمایشی یک نشست تأیید برای صفحهٔ عمومی (بدون کلید).

POST/verify/{token}/confirm
تأیید نشست با کاربر

کد را (در حالت کدی) یا تأیید لینکی را ثبت می‌کند.

POST/verify/{token}/resend
ارسال دوبارهٔ کد

کد را دوباره می‌فرستد.

GET/services/availability
سرویس‌های فعال

کدام سرویس‌های سفارشی در دسترس است.

GET/services/prices
تعرفهٔ سرویس‌ها

قیمت واحد هر محصول برای گروه کاربری شما.

GET/services/international/rates
نرخ پیامک بین‌المللی

مقصدها و قیمت هر بخش پیامک.

POST/services/{product}/quote
برآورد قیمت سفارش

بدون ثبت و کسر اعتبار، قیمت سفارش را می‌دهد.

POST/services/{product}
ثبت سفارش سرویس

سفارش را ثبت و هزینه را از کیف پول کسر می‌کند.

GET/services/{product}
سفارش‌های یک سرویس

سفارش‌های شما برای یک محصول.

GET/services/{product}/{id}
جزئیات سفارش

وضعیت یک سفارش.

POST/services/{product}/{id}/refresh
به‌روزرسانی وضعیت سفارش

وضعیت یک سفارش را از تأمین‌کننده دوباره می‌پرسد.

POST/services/{product}/{id}/cancel
لغو سفارش

سفارشی را که هنوز اجرا نشده لغو و هزینه را برمی‌گرداند.

GET/voip/price
تعرفهٔ تماس

قیمت هر دقیقه تماس برای شما.

POST/voip/calls
برقراری تماس (Click-to-Call)

ابتدا با `from` تماس می‌گیرد و پس از پاسخ، به `to` وصل می‌کند.

GET/voip/calls
تاریخچهٔ تماس‌ها

تماس‌های ثبت‌شده، با فیلتر پروژه.

POST/voip/otp
کد تأیید صوتی

کد تأیید را با تماس تلفنی می‌خواند (`201`).

GET/voip/live
تماس‌های زنده

تماس‌های در جریان.

POST/link-tracker/send
ارسال با لینک کوتاه ردیابی‌شده

پیامک حاوی لینک کوتاه یکتا برای هر گیرنده؛ کلیک‌ها شمارش می‌شود و می‌توانید آزمون A/B بگیرید.

GET/link-tracker/holdouts
آزمون‌های در انتظار تصمیم

آزمون‌های A/B که هنوز برنده‌شان تعیین نشده.

POST/link-tracker/holdouts/{id}/send-now
تعیین فوری برندهٔ آزمون

برنده را همین حالا انتخاب و برای مخاطبان نگه‌داشته‌شده ارسال می‌کند.

GET/link-tracker/campaigns
کمپین‌های لینک‌دار

فهرست ارسال‌های ردیابی‌شده با تعداد لینک و کلیک.

GET/link-tracker/campaigns/{batchId}
گزارش کمپین لینک‌دار

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

GET/number-banks
فهرست بانک‌های شماره

بانک‌های شمارهٔ در دسترس برای ارسال هدفمند به مخاطبان خارج از دفترچهٔ شما.

GET/number-banks/{id}/facets
فیلترهای بانک

مقادیر قابل‌انتخاب (اپراتور، استان، شهر، برچسب) و شمارش هر کدام.

POST/number-banks/quote
برآورد هزینهٔ ارسال از بانک

هزینهٔ ارسال به `count` شمارهٔ فیلترشده را بدون ارسال محاسبه می‌کند.

POST/number-banks/send
ارسال به شماره‌های بانک

پیام را برای `count` شمارهٔ فیلترشده از بانک می‌فرستد؛ کارمزد بانک و هزینهٔ پیامک با هم کسر می‌شود.

POST/project-sms/send
ارسال پیامک پروژه

ارسال از بستهٔ پیامک پروژه (نه کیف پول شخصی).

POST/project-sms/pattern
ارسال پترن پروژه

ارسال پیام الگو‌محور (مثل OTP) از بستهٔ پروژه.

POST/project-sms/quote
برآورد هزینهٔ پیامک پروژه

هزینه و تعداد بخش‌ها را بدون ارسال حساب می‌کند.

GET/project-sms/messages
پیام‌های پروژه

تاریخچهٔ پیامک‌های ارسالی پروژه، جدیدترین اول.

GET/project-sms/usage
مصرف بستهٔ پروژه

باقی‌ماندهٔ بسته و مصرف پروژه.

GET/botbuilder/info
اطلاعات ربات‌ساز

انواع ربات، تعرفه و محدودیت‌های حساب شما.

GET/botbuilder/bots
فهرست ربات‌ها

ربات‌های ساخته‌شده با ربات‌ساز.

GET/botbuilder/bots/{id}
جزئیات ربات

مشخصات یک ربات.

GET/botbuilder/bots/{id}/customers
مشتریان ربات

مشتریان ثبت‌نام‌کرده (نام، تلفن، نشانی).

GET/botbuilder/bots/{id}/subscribers
مشترکین ربات

کاربرانی که ربات را شروع کرده‌اند.

GET/botbuilder/bots/{id}/messages
پیام‌های ارسالی ربات

تاریخچهٔ پیام‌هایی که ربات فرستاده.

GET/botbuilder/bots/{id}/stats
آمار ارسال ربات

شمار پیام‌های ارسال‌شده، ناموفق و در صف.

GET/botbuilder/bots/{id}/shop/orders
سفارش‌های فروشگاه ربات

سفارش‌های ثبت‌شده در ربات فروشگاهی.

GET/botbuilder/bots/{id}/shop/stats
آمار فروشگاه ربات

مجموع سفارش و فروش.

POST/botbuilder/bots/{id}/send
ارسال پیام از ربات

به یک مشترک (یا همه) پیام یا رسانه می‌فرستد.

POST/botbuilder/bots/{id}/otp
ارسال کد تأیید از ربات

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

GET/sdk-apps
فهرست اپ‌های پوش

اپ‌های SDK پوش حساب یا پروژه.

GET/sdk-apps/{id}
جزئیات اپ پوش

مشخصات یک اپ.

POST/sdk-apps
ساخت اپ پوش

اپ می‌سازد و کلید عمومی SDK را برمی‌گرداند.

PATCH/sdk-apps/{id}
ویرایش اپ پوش

نام، توضیح، لوگو یا پلتفرم‌ها را تغییر می‌دهد.

PUT/sdk-apps/{id}/credential
جایگزینی اعتبارنامهٔ Firebase

حساب سرویس Firebase را عوض می‌کند.

POST/sdk-apps/{id}/rotate-key
چرخش کلید عمومی

کلید عمومی جدید می‌سازد.

POST/sdk-apps/{id}/move
انتقال اپ به پروژه

اپ را به یک پروژهٔ سازمانی می‌برد.

DELETE/sdk-apps/{id}
حذف اپ پوش

اپ و دستگاه‌هایش را حذف می‌کند.

GET/sdk-apps/{id}/devices
دستگاه‌های اپ

دستگاه‌های ثبت‌شده با فیلتر و صفحه‌بندی.

GET/sdk-apps/{id}/devices/{deviceId}
جزئیات دستگاه

مشخصات، برچسب‌ها، مخاطب وصل‌شده و آخرین رویدادهای یک دستگاه.

DELETE/sdk-apps/{id}/devices/{deviceId}
حذف دستگاه

دستگاه را از اپ حذف می‌کند.

GET/sdk-apps/{id}/contacts
جست‌وجوی مخاطب برای اتصال

مخاطبان دفترچهٔ مالک را بر اساس موبایل/ایمیل/نام می‌یابد.

PUT/sdk-apps/{id}/devices/{deviceId}/contact
اتصال دستگاه به مخاطب

دستگاه را به یک مخاطب موجود یا جدید وصل می‌کند.

DELETE/sdk-apps/{id}/devices/{deviceId}/contact
جدا کردن دستگاه از مخاطب

ارتباط دستگاه با مخاطب را برمی‌دارد.

POST/sdk-apps/{id}/send
ارسال پوش

پوش را به همهٔ دستگاه‌ها، یک موضوع، شناسه‌ها، موبایل‌ها، گروه دفترچه یا یک بخش‌بندی می‌فرستد.

POST/sdk-apps/{id}/messages/{messageId}/cancel
لغو پوش زمان‌بندی‌شده

پوشی را که هنوز ارسال نشده لغو می‌کند.

GET/sdk-apps/{id}/messages
پوش‌های ارسالی

تاریخچهٔ پوش‌ها با وضعیت و شمارنده‌ها.

GET/sdk-apps/{id}/messages/{messageId}/stats
آمار یک پوش

تحویل، باز شدن و کلیک و ریز هر نسخهٔ A/B.

GET/sdk-apps/{id}/messages/export.csv
خروجی CSV پوش‌ها

همهٔ پوش‌های اپ را به‌صورت فایل CSV می‌دهد.

GET/sdk-apps/{id}/analytics
تحلیل اپ

شمار دستگاه فعال، ارسال، تحویل و باز شدن در بازهٔ روزهای اخیر.

GET/sdk-apps/{id}/insights
بینش رفتار کاربران

ترکیب پلتفرم، کشور، نسخه و رویدادهای پرتکرار اپ.

GET/sdk-apps/{id}/transports
وضعیت کانال‌های ارسال

کدام کانال‌ها (FCM، APNs مستقیم، وب‌پوش) تنظیم شده‌اند.

PUT/sdk-apps/{id}/apns
تنظیم APNs مستقیم

کلید APNs اپل را برای ارسال مستقیم به iOS ثبت می‌کند.

DELETE/sdk-apps/{id}/apns
حذف APNs

تنظیمات APNs را پاک می‌کند.

POST/sdk-apps/{id}/webpush
فعال‌سازی وب‌پوش

کلید VAPID می‌سازد (یا می‌چرخاند) و کلید عمومی را برمی‌گرداند.

DELETE/sdk-apps/{id}/webpush
حذف وب‌پوش

کلیدهای VAPID را حذف می‌کند.

GET/sdk-apps/{id}/automations
اتوماسیون‌های پوش

پوش‌های رویدادمحور اپ.

POST/sdk-apps/{id}/automations
ساخت اتوماسیون پوش

یک پوش رویدادمحور تعریف می‌کند.

PATCH/sdk-apps/{id}/automations/{aid}
ویرایش اتوماسیون

فیلدهای اتوماسیون یا وضعیت (`active`/`paused`) را تغییر می‌دهد.

DELETE/sdk-apps/{id}/automations/{aid}
حذف اتوماسیون

اتوماسیون را حذف می‌کند.

GET/sdk-apps/{id}/automations/{aid}/runs
اجراهای اتوماسیون

اجراهای اخیر (در انتظار، ارسال‌شده، لغوشده).

GET/sdk-apps/{id}/forms
فرم‌های اپ

فرم‌های ثبت‌نام/نظرسنجی که در اپ یا وب نمایش داده می‌شود.

POST/sdk-apps/{id}/forms
ساخت فرم

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

PATCH/sdk-apps/{id}/forms/{fid}
ویرایش فرم

فیلدهای فرم را تغییر می‌دهد.

DELETE/sdk-apps/{id}/forms/{fid}
حذف فرم

فرم را حذف می‌کند.

GET/sdk-apps/{id}/forms/{fid}/stats
آمار فرم

نمایش، ثبت و نرخ تبدیل فرم.

GET/sdk-apps/{id}/feeds
فیدهای خودکار

فیدهای RSS/Atom که با انتشار مطلب جدید پوش می‌فرستند.

POST/sdk-apps/{id}/feeds
ساخت فید

یک فید را به اپ وصل می‌کند.

PATCH/sdk-apps/{id}/feeds/{fid}
ویرایش فید

تنظیمات یا وضعیت فید را تغییر می‌دهد.

DELETE/sdk-apps/{id}/feeds/{fid}
حذف فید

فید را حذف می‌کند.

POST/sdk-apps/{id}/feeds/{fid}/check
بررسی فوری فید

فید را همین حالا می‌خواند و مطالب جدید را پوش می‌کند.

GET/voip/routes
مسیر تماس شماره‌ها

مسیر تماس ورودیِ شماره‌های شما.

PUT/voip/routes/{numberId}
تنظیم مسیر یک شماره

مسیر تماس ورودی یک شماره را ذخیره می‌کند.

DELETE/voip/routes/{numberId}
حذف مسیر شماره

مسیر شماره را برمی‌دارد.

GET/voip/routes/{numberId}/preview
پیش‌نمایش مسیر در یک زمان

نشان می‌دهد در زمان داده‌شده تماس به کجا می‌رود.

GET/voip/groups
گروه‌های زنگ

گروه‌هایی که تماس را بین چند نفر پخش می‌کنند.

POST/voip/groups
ساخت گروه زنگ

گروه زنگ جدید.

PUT/voip/groups/{id}
ویرایش گروه زنگ

گروه را به‌طور کامل بازنویسی می‌کند.

DELETE/voip/groups/{id}
حذف گروه زنگ

گروه را حذف می‌کند.

GET/voip/ivrs
منوهای صوتی (IVR)

منوهای تعاملی ساخته‌شده.

POST/voip/ivrs
ساخت IVR

منوی صوتی جدید.

PUT/voip/ivrs/{id}
ویرایش IVR

IVR را بازنویسی می‌کند.

DELETE/voip/ivrs/{id}
حذف IVR

IVR را حذف می‌کند.

GET/voip/time-conditions
شرط‌های زمانی

قاعده‌هایی که مقصد تماس را بر اساس ساعت و تعطیلات عوض می‌کنند.

POST/voip/time-conditions
ساخت شرط زمانی

شرط زمانی جدید.

PUT/voip/time-conditions/{id}
ویرایش شرط زمانی

شرط را بازنویسی می‌کند.

DELETE/voip/time-conditions/{id}
حذف شرط زمانی

شرط را حذف می‌کند.

GET/voip/extensions
شماره‌های داخلی

داخلی‌های مرکز تلفن (تا ۱۰۰ عدد).

POST/voip/extensions
ساخت داخلی

داخلی جدید.

PUT/voip/extensions/{id}
ویرایش داخلی

داخلی را بازنویسی می‌کند.

DELETE/voip/extensions/{id}
حذف داخلی

داخلی را حذف می‌کند.

GET/voip/sip-accounts
حساب‌های SIP

سافت‌فون‌های شما (موبایل، دسکتاپ، وب‌رتی‌سی).

POST/voip/sip-accounts
ساخت حساب SIP

حساب سافت‌فون جدید و رمز آن را (فقط همین یک بار) می‌دهد.

PATCH/voip/sip-accounts/{id}
تغییر داخلیِ حساب

شمارهٔ داخلی حساب را عوض یا پاک (`null`) می‌کند.

GET/voip/sip-accounts/{id}/config
تنظیمات اتصال سافت‌فون

سرور، پورت، پروتکل و نشانی WebRTC برای وارد کردن در سافت‌فون.

POST/voip/sip-accounts/{id}/credentials
دریافت اطلاعات ورود

اعتبارنامهٔ ورود حساب را نشان می‌دهد.

POST/voip/sip-accounts/{id}/sync
همگام‌سازی با مرکز تلفن

حساب را دوباره روی سرور تلفن اعمال می‌کند.

POST/voip/sip-accounts/{id}/rotate
چرخش رمز

رمز تازه می‌سازد؛ رمز قبلی بی‌اعتبار می‌شود.

DELETE/voip/sip-accounts/{id}
حذف حساب SIP

حساب را حذف می‌کند.

POST/voip/calls/{id}/hangup
قطع تماس

تماس در جریان را قطع می‌کند.

POST/voip/calls/{id}/hold
نگه‌داشتن تماس

تماس را روی انتظار می‌گذارد یا برمی‌دارد.

POST/voip/calls/{id}/transfer
انتقال تماس

تماس را به شماره یا داخلی دیگری منتقل می‌کند.

POST/voip/calls/{id}/spy
شنود سرپرست

یک سرپرست را به تماس وصل می‌کند.

GET/voip/conferences
کنفرانس‌ها

کنفرانس‌های فعال و اخیر.

POST/voip/conferences
ساخت کنفرانس

اتاق کنفرانس می‌سازد و به شرکت‌کنندگان زنگ می‌زند.

POST/voip/conferences/{id}/participants
افزودن شرکت‌کننده

به کنفرانس شخص دیگری را دعوت می‌کند.

POST/voip/conferences/{id}/end
پایان کنفرانس

کنفرانس را می‌بندد و همه را قطع می‌کند.

GET/voip/campaigns
کمپین‌های تماس

کمپین‌های پخش پیام و نظرسنجی تلفنی.

POST/voip/campaigns
ساخت کمپین تماس

کمپین می‌سازد؛ با `start` شروع می‌شود.

GET/voip/campaigns/{id}
جزئیات کمپین

پیشرفت و شمارنده‌های کمپین.

GET/voip/campaigns/{id}/targets
مخاطبان کمپین

وضعیت تماس با هر شماره.

GET/voip/campaigns/{id}/results
نتایج کمپین

خلاصهٔ نتایج و توزیع پاسخ‌های نظرسنجی.

POST/voip/campaigns/{id}/start
شروع کمپین

کمپین را شروع می‌کند و هزینه را رزرو می‌کند.

POST/voip/campaigns/{id}/pause
توقف کمپین

تماس‌های جدید را متوقف می‌کند.

POST/voip/campaigns/{id}/cancel
لغو کمپین

کمپین را پایان می‌دهد و هزینهٔ باقی‌مانده را برمی‌گرداند.

POST/voice-confirm
تأیید تلفنی

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

GET/voice-confirm
فهرست تأییدهای تلفنی

تأییدهای اخیر و وضعیتشان.

GET/voice-confirm/{id}
نتیجهٔ تأیید تلفنی

وضعیت و پاسخ مخاطب.

GET/voip/otp-voices
صداهای کد تأیید صوتی

فهرست صداهای آمادهٔ OTP صوتی.

GET/voip/recordings
ضبط‌ها و پیام‌های صوتی

ضبط مکالمه‌ها و صندوق پیام صوتی.

GET/voip/recordings/{id}
جزئیات ضبط

مشخصات یک ضبط یا پیام صوتی.

POST/voip/recordings/{id}/link
لینک موقت شنیدن

نشانی کوتاه‌مدت و بدون کلید برای پخش فایل.

POST/voip/recordings/{id}/transcribe
رونویسی ضبط

ضبط را به متن تبدیل می‌کند.

DELETE/voip/recordings/{id}
حذف ضبط

ضبط را برای همیشه حذف می‌کند.

GET/voip/reports/summary
خلاصهٔ تماس‌ها

شمار و مدت تماس‌ها در بازه.

GET/voip/reports/calls
گزارش تماس‌ها

جزئیات هر تماس (CDR) با فیلتر.

GET/voip/reports/calls.csv
خروجی CSV تماس‌ها

همان گزارش تماس‌ها به‌صورت فایل CSV.

GET/voip/blocklist
فهرست مسدودی

شماره‌هایی که تماسشان رد می‌شود.

POST/voip/blocklist
مسدود کردن شماره

شماره را به فهرست مسدودی اضافه می‌کند.

DELETE/voip/blocklist/{id}
رفع مسدودی

شماره را از فهرست مسدودی بیرون می‌آورد.

GET/voip/pricing
تعرفهٔ VoIP حساب من

طرح، قیمت ماهانهٔ سرور و وضعیت پرداخت VoIP شما.

GET/voip/flows
بوم‌های مسیر تماس

بوم ذخیره‌شدهٔ هر شماره و وضعیت انتشارش.

GET/voip/flows/{numberId}
بوم یک شماره

نمودار ذخیره‌شده و وضعیت.

PUT/voip/flows/{numberId}
ذخیرهٔ پیش‌نویس بوم

نمودار را ذخیره می‌کند (منتشر نمی‌کند).

DELETE/voip/flows/{numberId}
حذف بوم

بوم و نسخهٔ منتشرشده را حذف می‌کند.

POST/voip/flows/{numberId}/publish
انتشار بوم

نمودار را به مسیر زندهٔ شماره کامپایل می‌کند.

POST/voip/flows/{numberId}/unpublish
لغو انتشار

مسیر زنده را برمی‌دارد و پیش‌نویس می‌ماند.

POST/voip/flows/{numberId}/import
درون‌ریزی مسیر موجود به بوم

مسیر فعلی شماره را به نمودار تبدیل می‌کند.

POST/voip/flows/{numberId}/simulate
شبیه‌سازی تماس روی بوم

مسیر یک تماس فرضی را روی نمودار دنبال می‌کند.

POST/voip/flows/check
اعتبارسنجی نمودار

نمودار را بدون ذخیره بررسی می‌کند.

POST/voip/flows/layout
چیدمان خودکار نمودار

مختصات گره‌ها را مرتب می‌کند.

POST/voip/flows/ai/draft
پیش‌نویس هوشمند بوم

از روی توضیح فارسی یک نمودار پیشنهاد می‌دهد.

GET/voip/notify/secrets
رمزهای امضای وب‌هوک

رمزهایی که با آن‌ها اعلان‌های وب‌هوک تماس امضا می‌شود.

POST/voip/notify/secrets
ساخت رمز امضا

رمز جدید می‌سازد و فقط همین یک بار نمایش می‌دهد.

DELETE/voip/notify/secrets/{id}
حذف رمز امضا

رمز را حذف می‌کند.

GET/voip/notify/jobs
اعلان‌های اخیر

آخرین اعلان‌های ارسال‌شده (وب‌هوک، پیامک، ایمیل) برای تماس‌ها.

GET/voip/dial-actions
کدهای شماره‌گیری

کدهایی که با شماره‌گیری روی سافت‌فون یک اعلان را فعال می‌کنند.

POST/voip/dial-actions
ساخت کد شماره‌گیری

کد و اعلان جدید.

PUT/voip/dial-actions/{id}
ویرایش کد شماره‌گیری

تعریف را بازنویسی می‌کند.

DELETE/voip/dial-actions/{id}
حذف کد شماره‌گیری

کد را حذف می‌کند.

curl -X POST 'https://api.irnoti.com/v1/sms/sos' \
  -H "Authorization: Bearer $IRNOTI_KEY" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: alert-77' \
  -d '{
  "to": [
    "09121234567"
  ],
  "text": "هشدار: قطعی سرویس",
  "lineId": "sandbox"
}'
پاسخ نمونه200 OK
{
  "count": 1,
  "batchId": "920",
  "replayed": false,
  "totalPrice": "5000"
}
مستندات API پیامک | ایران ناتیفیکیشن