مستندات API پیامک
وبسرویس REST با بدنه JSON. هر کاری که در پنل انجام میدهید با API هم ممکن است. همه نمونهها برای ۱۱ زبان تولید میشود و میتوانید هر درخواست را همینجا با کلید آزمایشی اجرا کنید.
شروع سریع
- ۱در پنل ثبتنام کنید و از بخش «وبسرویس» یک کلید آزمایشی بسازید.
- ۲با
lineId: "sandbox"یک پیام بفرستید — بدون هزینه و بدون ارسال واقعی. - ۳پس از احراز هویت، کلید واقعی بسازید و شناسه خط واقعی را از خطوط من بگیرید.
برای شروع سریعتر میتوانید از SDKها و پکیجهای آماده استفاده کنید، بهجای اینکه درخواستها را از ابتدا بنویسید.
احراز هویت
هر درخواست باید کلید دسترسی را در هدر 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 و در هر دقیقهاند.
خطاها
کد وضعیت HTTP نتیجه را مشخص میکند. بدنه خطا شامل message و گاهی code و details است.
| 400 | درخواست نامعتبر (فیلد ناقص، شماره نامعتبر…) |
| 401 | کلید نامعتبر، حذفشده یا IP مجاز نیست |
| 402 | اعتبار کافی نیست |
| 403 | دسترسی (scope) یا احراز هویت حساب کافی نیست |
| 404 | منبع یافت نشد |
| 409 | تعارض (مثلا نام تکراری) |
| 422 | تعرفه تعریف نشده |
| 429 | تعداد درخواست زیاد |
| 5xx | خطای سرور — با همان Idempotency-Key دوباره تلاش کنید |
مرجع endpointها
/sms/sosارسال پیام حیاتی از مسیرهای پلتفرم با جایگزینی خودکار پرووایدر.
/sms/sendارسال یک متن به یک یا چند گیرنده، یا به گروههای دفترچه تلفن.
/sms/quoteهزینه دقیق یک ارسال را بدون ارسال و بدون کسر اعتبار برمیگرداند.
/sms/patternارسال پیام بر اساس یک قالب تأییدشده با جایگذاری پارامترها — مناسب کد تأیید و پیامهای تراکنشی.
/sms/messagesپیامهای ارسالی اخیر با وضعیت تحویل.
/sms/messages/{id}وضعیت و جزئیات یک پیام با شناسه.
/sms/linesخطوطی که میتوانید از آنها ارسال کنید.
/sms/scheduledدستههای زمانبندیشده یا تدریجی که هنوز تمام نشدهاند.
/sms/batches/{id}/cancelپیامهای ارسالنشدهٔ یک دسته را لغو و هزینهٔ آنها را برمیگرداند.
/sms/batches/{id}/pauseآزادسازی نوبتهای بعدی یک دستهٔ تدریجی را متوقف میکند.
/sms/batches/{id}/resumeارسال تدریجیِ متوقفشده را از سر میگیرد.
/sms/messages/{id}/checkوضعیت نهایی پیام را همین حالا از اپراتور میپرسد.
/broker/botsفهرست رباتِ ثبتشده در بروکر با لینک اختصاصی و وضعیت.
/broker/bots/{id}جزئیات یک ربات شامل لینک و آدرس وبهوک ثبتشده.
/broker/botsتوکن ربات را ثبت کنید و لینک اختصاصی بگیرید.
/broker/bots/{id}نام نمایشی ربات را عوض کنید.
/broker/bots/{id}/tokenبعد از ساخت توکن جدید در BotFather، آن را برای همین ربات جایگزین کنید.
/broker/bots/{id}/rotateاگر لینک لو رفت، لینک تازه بسازید؛ لینک قبلی از کار میافتد.
/broker/bots/{id}ربات را از بروکر حذف کنید؛ لینک و ثبت بروکر پاک میشود.
/broker/bots/{id}/requestهر متد Bot API (sendMessage، sendPhoto، getChat، …) را از طریق بروکر اجرا کنید.
/broker/bots/{id}/updatesپیامهای رسیده به ربات را بخوانید (getUpdates)، بدون نیاز به سرور وبهوک.
/broker/bots/{id}/webhookآدرس بازگشتی (وبهوک) تنظیمشده و وضعیت تحویل آن.
/broker/bots/{id}/webhookآدرس سرور خودتان را بدهید؛ آپدیتهای تلگرام از طریق بروکر به همان آدرس POST میشوند.
/broker/bots/{id}/webhookوبهوک را بردارید (برای استفاده از getUpdates).
/broker/bots/{id}/moveربات را به یک پروژهٔ سازمانی منتقل میکند.
/phonebook/groupsفهرست گروهها با تعداد مخاطبین.
/phonebook/groupsیک گروه جدید در دفترچه تلفن بسازید.
/phonebook/groups/{id}/contactsافزودن چند مخاطب به یک گروه.
/phonebook/groups/{id}مشخصات یک گروه و تعداد اعضا.
/phonebook/groups/{id}نام یا توضیح گروه را تغییر میدهد.
/phonebook/groups/{id}گروه را حذف میکند.
/phonebook/groups/{id}/contactsفهرست اعضای گروه با جستوجو و صفحهبندی.
/phonebook/groups/{id}/importفایل CSV/TXT را به گروه اضافه میکند.
/phonebook/groups/{id}/membersمخاطبین موجود را به گروه هم اضافه میکند (عضویت در چند گروه ممکن است).
/phonebook/groups/{id}/contacts/{contactId}مخاطب را فقط از این گروه خارج میکند.
/phonebook/groups/{id}/members/removeچند مخاطب را یکجا از گروه بیرون میآورد.
/phonebook/contactsهمهٔ افراد دفترچه (پیامک، ایمیل، دستگاههای اپ، فرمها).
/phonebook/contactsیک مخاطب با جزئیات کامل میسازد و میتواند همزمان به گروهها اضافه کند.
/phonebook/contacts/deleteچند مخاطب را از همهٔ گروهها، ایمیل و دستگاهها حذف میکند.
/phonebook/contacts/{id}فیلدهای مخاطب را بهروز میکند.
/phonebook/contacts/{id}مخاطب را از همهجا حذف میکند.
/walletموجودی کیف پول به ریال.
/wallet/transactionsتاریخچهٔ تراکنشهای مالی (شارژ، کسر، بازگشت).
/email/sendارسال ایمیل تراکنشی با متن/HTML، پیوست، قالب و زمانبندی.
/email/outbound/{id}وضعیت ارسال و خط زمانی رویدادها (ارسال، تحویل، بازگشت، شکایت).
/email/outboundارسالهای شما با فیلتر وضعیت و جستجو؛ صفحهبندی با `before`.
/email/outbound/{id}/cancelنامهٔ زمانبندیشدهٔ هنوز ارسالنشده را لغو و هزینه را برمیگرداند.
/email/otpکدهای OTP که در نامههای رسیده شناسایی شدهاند (جدیدترین اول).
/email/otp/waitتا رسیدن کد جدید (حداکثر ۶۰ ثانیه) صندوق را بررسی میکند؛ مناسب تست خودکار ورود.
/email/messagesنامههای صندوق با پوشه، دسته، جستجو و صفحهبندی.
/email/messages/{id}متن کامل نامه با HTML امنشده و فهرست پیوستها.
/email/messages/actionsخوانده/ستاره/انتقال/حذف/هرزنامه/برچسب برای چند نامه.
/email/domainsدامنههای شما با وضعیت تأیید و شمار صندوق.
/email/domainsدامنه را ثبت و رکوردهای DNS لازم را برمیگرداند.
/email/domains/{id}/checkDNS را بررسی و در صورت کامل بودن دامنه را تأیید میکند.
/email/mailboxesبرای دامنهٔ خود صندوق (و زیرمجموعه) بسازید.
/email/templatesقالب ایمیل تراکنشی با متغیر `{{name}}`.
/email/suppressionsبه نشانی اضافهشده دیگر ایمیل ارسال نمیشود.
/email/meاشتراک فعال، سقفها، سهمیهٔ ماهانه، بستهٔ ارسال و موجودی کیف پول برای ایمیل.
/email/infoمیزبان و پورت درگاه SMTP و فهرست رویدادهایی که میتوان به آنها مشترک شد.
/email/reportجمع ارسال، تحویل، بازگشت، شکایت و دریافت بههمراه روند روزانه.
/email/outbound.csvهمان فهرست ارسالها با فیلترهای یکسان، بهصورت فایل CSV.
/email/countsتعداد نامهٔ خواندهنشده به تفکیک پوشه و دسته، بههمراه ستارهدارها و پیشنویسها.
/email/threads/{threadId}همهٔ نامههای یک گفتگو به ترتیب زمان.
/email/messages/{id}/check-senderسرایند احراز هویت همان نامه را از سرور دوباره میخواند و میگوید چرا «تیک آبی» ندارد یا دارد.
/email/draftsپیشنویس جدید میسازد یا با `id` پیشنویس موجود را ویرایش میکند.
/email/messages/emptyهمهٔ نامههای پوشهٔ `trash` یا `spam` را برای همیشه حذف میکند.
/email/syncنامههای جدید را همین الان از سرور میگیرد، بهجای انتظار برای همگامسازی دورهای.
/email/mailboxesصندوقهای سازمانی و حسابهای شخصی متصلشدهٔ شما، و صندوقهایی که به شما تخصیص داده شده است.
/email/mailboxes/{id}/settingsمیزبان، پورت و امنیت IMAP، POP3 و SMTP برای وصلکردن Outlook، Thunderbird یا موبایل.
/email/mailboxes/{id}نام نمایشی، امضا، پاسخ خودکار، تخصیص به همکار و سهمیهٔ فضا را تغییر میدهد.
/email/mailboxes/{id}/passwordبرای صندوق سازمانی رمز تازه میسازد (یا رمز دلخواه شما را میگذارد) و همانجا یکبار برمیگرداند.
/email/mailboxes/{id}صندوق و همهٔ نامههای آن را حذف میکند.
/email/domains/{id}وضعیت دامنه و رکوردهای DNS که باید بسازید (تأیید مالکیت، MX، SPF، DKIM، DMARC).
/email/domains/{id}/catch-allنامهٔ ارسالشده به هر نشانی ناموجود دامنه را به یک صندوق میرساند.
/email/domains/{id}دامنه با همهٔ صندوقها، نامهای مستعار و نامههایش حذف میشود.
/email/domains/{id}/aliasesنامهای مستعار (فوروارد) یک دامنه.
/email/domains/{id}/aliasesنشانی تازه میسازد که نامههایش به صندوقهای مقصد میرسد.
/email/aliases/{id}فهرست مقصدهای یک نام مستعار را جایگزین میکند.
/email/aliases/{id}نام مستعار را حذف میکند.
/email/contactsمخاطبین ایمیل با جستجو و فیلتر گروه.
/email/contactsمخاطب جدید میسازد.
/email/contacts/{id}فقط فیلدهای ارسالشده تغییر میکنند.
/email/contacts/{id}مخاطب را حذف میکند.
/email/contacts.csvهمهٔ مخاطبین بهصورت فایل CSV.
/email/contacts/import/csvمتن CSV را میخواند و مخاطبین تازه را اضافه میکند.
/email/contacts/import/vcardفایل vCard (.vcf) را میخواند و مخاطبین را اضافه میکند.
/email/labelsبرچسبهای شما.
/email/labelsبرچسب جدید.
/email/labels/{id}نام یا رنگ برچسب.
/email/labels/{id}برچسب را از همهٔ نامهها برمیدارد.
/email/rulesقوانین خودکار پردازش نامهٔ ورودی.
/email/rulesقانون جدید برای نامههای ورودی.
/email/rules/{id}فقط فیلدهای ارسالشده تغییر میکنند.
/email/rules/{id}قانون را حذف میکند.
/email/templatesقالبهای ذخیرهشدهٔ ارسال.
/email/templates/{id}قالب را حذف میکند.
/email/suppressionsنشانیهایی که ارسال به آنها انجام نمیشود.
/email/suppressionsیک نشانی را دوباره مجاز میکند.
/email/otp-relaysقوانینی که کد تأیید رسیده به ایمیل را به پیامک، بله یا تلگرام میفرستند.
/email/otp-relaysکد OTP تشخیصدادهشده در صندوق را خودکار به مقصد دلخواه میفرستد.
/email/otp-relays/{id}/verifyکد ۶ رقمی رسیده به مقصد را تأیید میکند.
/email/otp-relays/{id}/resendکد تأیید مقصد را دوباره میفرستد.
/email/otp-relays/{id}/testیک کد نمونه به مقصد میفرستد تا مسیر را امتحان کنید.
/email/otp-relays/{id}بازارسال را بدون حذف فعال یا غیرفعال میکند.
/email/otp-relays/{id}بازارسال را حذف میکند.
/email/sender-icon/{domain}تصویر نمادِ دامنهٔ فرستنده برای نمایش در صندوق.
/tts/sayمتن فارسی ← فایل صوتی ۸ کیلوهرتز برای IVR و VoIP؛ مناسب آدرس ttsUrl سانترال.
/tts/sayهمان عملیات GET با بدنهٔ JSON؛ برای متنهای بلند یا وقتی نمیخواهید متن در آدرس بیاید.
/public/tts/infoفهرست صداها و قالبهای در دسترس، سقفها و تعرفهٔ پایه؛ بدون کلید.
/ai/modelsمدلهای فعال و ضریب اعتبار هر کدام، به قالب OpenAI.
/ai/balanceاعتبار قابلمصرف، اعتبار رزروشده و تخفیف شما.
/ai/chat/completionsدرخواست چت سازگار با OpenAI، با پاسخ عادی یا جریانی (SSE).
/ai/images/generationsساخت تصویر از متن، سازگار با OpenAI.
/ai/embeddingsتبدیل متن به بردار، سازگار با OpenAI.
/ai/moderationsتشخیص محتوای نامناسب، سازگار با OpenAI.
/ai/audio/transcriptionsرونویسی فایل صوتی، سازگار با OpenAI.
/video/modelsمدلهای ساخت ویدئو، حداکثر مدت و اعتبار هر ثانیه.
/video/jobsیک کار ساخت ویدئو در صف میگذارد و `201` برمیگرداند.
/video/jobsکارهای ساخت ویدئوی شما، صفحهبندیشده.
/video/jobs/{id}وضعیت و پیشرفت کار.
/video/jobs/{id}/cancelکار در صف یا در حال اجرا را لغو و رزرو اعتبار را آزاد میکند.
/video/jobs/{id}/fileفایل ویدئوی ساختهشده؛ از `Range` پشتیبانی میکند.
/verify/infoبهای هر نشست تأیید به ریال.
/verify/sessionsکد یکبارمصرف یا پیوند تأیید را به موبایل، بات یا پوش میفرستد.
/verify/sessionsنشستهای اخیر با صفحهبندی مبتنی بر شناسه.
/verify/sessions/{id}وضعیت: `pending`، `verified`، `expired`، `locked` یا `canceled`.
/verify/sessions/{id}/cancelنشست در انتظار را لغو میکند (`204`).
/verify/statsشمار کل، موفق، لغو و قفلشده و نرخ موفقیت.
/verify/{token}اطلاعات نمایشی یک نشست تأیید برای صفحهٔ عمومی (بدون کلید).
/verify/{token}/confirmکد را (در حالت کدی) یا تأیید لینکی را ثبت میکند.
/verify/{token}/resendکد را دوباره میفرستد.
/services/availabilityکدام سرویسهای سفارشی در دسترس است.
/services/pricesقیمت واحد هر محصول برای گروه کاربری شما.
/services/international/ratesمقصدها و قیمت هر بخش پیامک.
/services/{product}/quoteبدون ثبت و کسر اعتبار، قیمت سفارش را میدهد.
/services/{product}سفارش را ثبت و هزینه را از کیف پول کسر میکند.
/services/{product}سفارشهای شما برای یک محصول.
/services/{product}/{id}وضعیت یک سفارش.
/services/{product}/{id}/refreshوضعیت یک سفارش را از تأمینکننده دوباره میپرسد.
/services/{product}/{id}/cancelسفارشی را که هنوز اجرا نشده لغو و هزینه را برمیگرداند.
/voip/priceقیمت هر دقیقه تماس برای شما.
/voip/callsابتدا با `from` تماس میگیرد و پس از پاسخ، به `to` وصل میکند.
/voip/callsتماسهای ثبتشده، با فیلتر پروژه.
/voip/otpکد تأیید را با تماس تلفنی میخواند (`201`).
/voip/liveتماسهای در جریان.
/link-tracker/sendپیامک حاوی لینک کوتاه یکتا برای هر گیرنده؛ کلیکها شمارش میشود و میتوانید آزمون A/B بگیرید.
/link-tracker/holdoutsآزمونهای A/B که هنوز برندهشان تعیین نشده.
/link-tracker/holdouts/{id}/send-nowبرنده را همین حالا انتخاب و برای مخاطبان نگهداشتهشده ارسال میکند.
/link-tracker/campaignsفهرست ارسالهای ردیابیشده با تعداد لینک و کلیک.
/link-tracker/campaigns/{batchId}نرخ کلیک هر نسخه بههمراه توزیع کشور، دستگاه و ساعت.
/number-banksبانکهای شمارهٔ در دسترس برای ارسال هدفمند به مخاطبان خارج از دفترچهٔ شما.
/number-banks/{id}/facetsمقادیر قابلانتخاب (اپراتور، استان، شهر، برچسب) و شمارش هر کدام.
/number-banks/quoteهزینهٔ ارسال به `count` شمارهٔ فیلترشده را بدون ارسال محاسبه میکند.
/number-banks/sendپیام را برای `count` شمارهٔ فیلترشده از بانک میفرستد؛ کارمزد بانک و هزینهٔ پیامک با هم کسر میشود.
/project-sms/sendارسال از بستهٔ پیامک پروژه (نه کیف پول شخصی).
/project-sms/patternارسال پیام الگومحور (مثل OTP) از بستهٔ پروژه.
/project-sms/quoteهزینه و تعداد بخشها را بدون ارسال حساب میکند.
/project-sms/messagesتاریخچهٔ پیامکهای ارسالی پروژه، جدیدترین اول.
/project-sms/usageباقیماندهٔ بسته و مصرف پروژه.
/botbuilder/infoانواع ربات، تعرفه و محدودیتهای حساب شما.
/botbuilder/botsرباتهای ساختهشده با رباتساز.
/botbuilder/bots/{id}مشخصات یک ربات.
/botbuilder/bots/{id}/customersمشتریان ثبتنامکرده (نام، تلفن، نشانی).
/botbuilder/bots/{id}/subscribersکاربرانی که ربات را شروع کردهاند.
/botbuilder/bots/{id}/messagesتاریخچهٔ پیامهایی که ربات فرستاده.
/botbuilder/bots/{id}/statsشمار پیامهای ارسالشده، ناموفق و در صف.
/botbuilder/bots/{id}/shop/ordersسفارشهای ثبتشده در ربات فروشگاهی.
/botbuilder/bots/{id}/shop/statsمجموع سفارش و فروش.
/botbuilder/bots/{id}/sendبه یک مشترک (یا همه) پیام یا رسانه میفرستد.
/botbuilder/bots/{id}/otpکدی عددی میسازد، برای مشترک میفرستد و خودِ کد را برمیگرداند.
/sdk-appsاپهای SDK پوش حساب یا پروژه.
/sdk-apps/{id}مشخصات یک اپ.
/sdk-appsاپ میسازد و کلید عمومی SDK را برمیگرداند.
/sdk-apps/{id}نام، توضیح، لوگو یا پلتفرمها را تغییر میدهد.
/sdk-apps/{id}/credentialحساب سرویس Firebase را عوض میکند.
/sdk-apps/{id}/rotate-keyکلید عمومی جدید میسازد.
/sdk-apps/{id}/moveاپ را به یک پروژهٔ سازمانی میبرد.
/sdk-apps/{id}اپ و دستگاههایش را حذف میکند.
/sdk-apps/{id}/devicesدستگاههای ثبتشده با فیلتر و صفحهبندی.
/sdk-apps/{id}/devices/{deviceId}مشخصات، برچسبها، مخاطب وصلشده و آخرین رویدادهای یک دستگاه.
/sdk-apps/{id}/devices/{deviceId}دستگاه را از اپ حذف میکند.
/sdk-apps/{id}/contactsمخاطبان دفترچهٔ مالک را بر اساس موبایل/ایمیل/نام مییابد.
/sdk-apps/{id}/devices/{deviceId}/contactدستگاه را به یک مخاطب موجود یا جدید وصل میکند.
/sdk-apps/{id}/devices/{deviceId}/contactارتباط دستگاه با مخاطب را برمیدارد.
/sdk-apps/{id}/sendپوش را به همهٔ دستگاهها، یک موضوع، شناسهها، موبایلها، گروه دفترچه یا یک بخشبندی میفرستد.
/sdk-apps/{id}/messages/{messageId}/cancelپوشی را که هنوز ارسال نشده لغو میکند.
/sdk-apps/{id}/messagesتاریخچهٔ پوشها با وضعیت و شمارندهها.
/sdk-apps/{id}/messages/{messageId}/statsتحویل، باز شدن و کلیک و ریز هر نسخهٔ A/B.
/sdk-apps/{id}/messages/export.csvهمهٔ پوشهای اپ را بهصورت فایل CSV میدهد.
/sdk-apps/{id}/analyticsشمار دستگاه فعال، ارسال، تحویل و باز شدن در بازهٔ روزهای اخیر.
/sdk-apps/{id}/insightsترکیب پلتفرم، کشور، نسخه و رویدادهای پرتکرار اپ.
/sdk-apps/{id}/transportsکدام کانالها (FCM، APNs مستقیم، وبپوش) تنظیم شدهاند.
/sdk-apps/{id}/apnsکلید APNs اپل را برای ارسال مستقیم به iOS ثبت میکند.
/sdk-apps/{id}/apnsتنظیمات APNs را پاک میکند.
/sdk-apps/{id}/webpushکلید VAPID میسازد (یا میچرخاند) و کلید عمومی را برمیگرداند.
/sdk-apps/{id}/webpushکلیدهای VAPID را حذف میکند.
/sdk-apps/{id}/automationsپوشهای رویدادمحور اپ.
/sdk-apps/{id}/automationsیک پوش رویدادمحور تعریف میکند.
/sdk-apps/{id}/automations/{aid}فیلدهای اتوماسیون یا وضعیت (`active`/`paused`) را تغییر میدهد.
/sdk-apps/{id}/automations/{aid}اتوماسیون را حذف میکند.
/sdk-apps/{id}/automations/{aid}/runsاجراهای اخیر (در انتظار، ارسالشده، لغوشده).
/sdk-apps/{id}/formsفرمهای ثبتنام/نظرسنجی که در اپ یا وب نمایش داده میشود.
/sdk-apps/{id}/formsفرم با فیلدهای دلخواه میسازد.
/sdk-apps/{id}/forms/{fid}فیلدهای فرم را تغییر میدهد.
/sdk-apps/{id}/forms/{fid}فرم را حذف میکند.
/sdk-apps/{id}/forms/{fid}/statsنمایش، ثبت و نرخ تبدیل فرم.
/sdk-apps/{id}/feedsفیدهای RSS/Atom که با انتشار مطلب جدید پوش میفرستند.
/sdk-apps/{id}/feedsیک فید را به اپ وصل میکند.
/sdk-apps/{id}/feeds/{fid}تنظیمات یا وضعیت فید را تغییر میدهد.
/sdk-apps/{id}/feeds/{fid}فید را حذف میکند.
/sdk-apps/{id}/feeds/{fid}/checkفید را همین حالا میخواند و مطالب جدید را پوش میکند.
/voip/routesمسیر تماس ورودیِ شمارههای شما.
/voip/routes/{numberId}مسیر تماس ورودی یک شماره را ذخیره میکند.
/voip/routes/{numberId}مسیر شماره را برمیدارد.
/voip/routes/{numberId}/previewنشان میدهد در زمان دادهشده تماس به کجا میرود.
/voip/groupsگروههایی که تماس را بین چند نفر پخش میکنند.
/voip/groupsگروه زنگ جدید.
/voip/groups/{id}گروه را بهطور کامل بازنویسی میکند.
/voip/groups/{id}گروه را حذف میکند.
/voip/ivrsمنوهای تعاملی ساختهشده.
/voip/ivrsمنوی صوتی جدید.
/voip/ivrs/{id}IVR را بازنویسی میکند.
/voip/ivrs/{id}IVR را حذف میکند.
/voip/time-conditionsقاعدههایی که مقصد تماس را بر اساس ساعت و تعطیلات عوض میکنند.
/voip/time-conditionsشرط زمانی جدید.
/voip/time-conditions/{id}شرط را بازنویسی میکند.
/voip/time-conditions/{id}شرط را حذف میکند.
/voip/extensionsداخلیهای مرکز تلفن (تا ۱۰۰ عدد).
/voip/extensionsداخلی جدید.
/voip/extensions/{id}داخلی را بازنویسی میکند.
/voip/extensions/{id}داخلی را حذف میکند.
/voip/sip-accountsسافتفونهای شما (موبایل، دسکتاپ، وبرتیسی).
/voip/sip-accountsحساب سافتفون جدید و رمز آن را (فقط همین یک بار) میدهد.
/voip/sip-accounts/{id}شمارهٔ داخلی حساب را عوض یا پاک (`null`) میکند.
/voip/sip-accounts/{id}/configسرور، پورت، پروتکل و نشانی WebRTC برای وارد کردن در سافتفون.
/voip/sip-accounts/{id}/credentialsاعتبارنامهٔ ورود حساب را نشان میدهد.
/voip/sip-accounts/{id}/syncحساب را دوباره روی سرور تلفن اعمال میکند.
/voip/sip-accounts/{id}/rotateرمز تازه میسازد؛ رمز قبلی بیاعتبار میشود.
/voip/sip-accounts/{id}حساب را حذف میکند.
/voip/calls/{id}/hangupتماس در جریان را قطع میکند.
/voip/calls/{id}/holdتماس را روی انتظار میگذارد یا برمیدارد.
/voip/calls/{id}/transferتماس را به شماره یا داخلی دیگری منتقل میکند.
/voip/calls/{id}/spyیک سرپرست را به تماس وصل میکند.
/voip/conferencesکنفرانسهای فعال و اخیر.
/voip/conferencesاتاق کنفرانس میسازد و به شرکتکنندگان زنگ میزند.
/voip/conferences/{id}/participantsبه کنفرانس شخص دیگری را دعوت میکند.
/voip/conferences/{id}/endکنفرانس را میبندد و همه را قطع میکند.
/voip/campaignsکمپینهای پخش پیام و نظرسنجی تلفنی.
/voip/campaignsکمپین میسازد؛ با `start` شروع میشود.
/voip/campaigns/{id}پیشرفت و شمارندههای کمپین.
/voip/campaigns/{id}/targetsوضعیت تماس با هر شماره.
/voip/campaigns/{id}/resultsخلاصهٔ نتایج و توزیع پاسخهای نظرسنجی.
/voip/campaigns/{id}/startکمپین را شروع میکند و هزینه را رزرو میکند.
/voip/campaigns/{id}/pauseتماسهای جدید را متوقف میکند.
/voip/campaigns/{id}/cancelکمپین را پایان میدهد و هزینهٔ باقیمانده را برمیگرداند.
/voice-confirmبه مخاطب زنگ میزند تا کدی را تایپ یا گزینهای را انتخاب کند.
/voice-confirmتأییدهای اخیر و وضعیتشان.
/voice-confirm/{id}وضعیت و پاسخ مخاطب.
/voip/otp-voicesفهرست صداهای آمادهٔ OTP صوتی.
/voip/recordingsضبط مکالمهها و صندوق پیام صوتی.
/voip/recordings/{id}مشخصات یک ضبط یا پیام صوتی.
/voip/recordings/{id}/linkنشانی کوتاهمدت و بدون کلید برای پخش فایل.
/voip/recordings/{id}/transcribeضبط را به متن تبدیل میکند.
/voip/recordings/{id}ضبط را برای همیشه حذف میکند.
/voip/reports/summaryشمار و مدت تماسها در بازه.
/voip/reports/callsجزئیات هر تماس (CDR) با فیلتر.
/voip/reports/calls.csvهمان گزارش تماسها بهصورت فایل CSV.
/voip/blocklistشمارههایی که تماسشان رد میشود.
/voip/blocklistشماره را به فهرست مسدودی اضافه میکند.
/voip/blocklist/{id}شماره را از فهرست مسدودی بیرون میآورد.
/voip/pricingطرح، قیمت ماهانهٔ سرور و وضعیت پرداخت VoIP شما.
/voip/flowsبوم ذخیرهشدهٔ هر شماره و وضعیت انتشارش.
/voip/flows/{numberId}نمودار ذخیرهشده و وضعیت.
/voip/flows/{numberId}نمودار را ذخیره میکند (منتشر نمیکند).
/voip/flows/{numberId}بوم و نسخهٔ منتشرشده را حذف میکند.
/voip/flows/{numberId}/publishنمودار را به مسیر زندهٔ شماره کامپایل میکند.
/voip/flows/{numberId}/unpublishمسیر زنده را برمیدارد و پیشنویس میماند.
/voip/flows/{numberId}/importمسیر فعلی شماره را به نمودار تبدیل میکند.
/voip/flows/{numberId}/simulateمسیر یک تماس فرضی را روی نمودار دنبال میکند.
/voip/flows/checkنمودار را بدون ذخیره بررسی میکند.
/voip/flows/layoutمختصات گرهها را مرتب میکند.
/voip/flows/ai/draftاز روی توضیح فارسی یک نمودار پیشنهاد میدهد.
/voip/notify/secretsرمزهایی که با آنها اعلانهای وبهوک تماس امضا میشود.
/voip/notify/secretsرمز جدید میسازد و فقط همین یک بار نمایش میدهد.
/voip/notify/secrets/{id}رمز را حذف میکند.
/voip/notify/jobsآخرین اعلانهای ارسالشده (وبهوک، پیامک، ایمیل) برای تماسها.
/voip/dial-actionsکدهایی که با شمارهگیری روی سافتفون یک اعلان را فعال میکنند.
/voip/dial-actionsکد و اعلان جدید.
/voip/dial-actions/{id}تعریف را بازنویسی میکند.
/voip/dial-actions/{id}کد را حذف میکند.