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

توقف ارسال تدریجی

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

POSThttps://api.irnoti.com/v1/sms/batches/{id}/pause
scope: sms.send

پاسخ موفق بدون بدنه (۲۰۴) است. پیام‌هایی که تا حالا به صف رفته‌اند ارسال می‌شوند؛ بقیه تا resume منتظر می‌مانند و هزینه‌شان رزرو می‌ماند.

پارامترها

ناممحلنوعتوضیح
id *مسیرstringشناسهٔ دستهٔ تدریجی.

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

401unauthorizedکلید API نامعتبر یا منقضی است.
403insufficient_scopeکلید API دامنهٔ دسترسی لازم را ندارد.
404not_foundدسته پیدا نشد یا متعلق به شما نیست.
409conflictدسته تدریجی نیست یا قبلاً تمام شده است.

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

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

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

curl -X POST 'https://api.irnoti.com/v1/sms/batches/918/pause' \
  -H "Authorization: Bearer $IRNOTI_KEY"
پاسخ نمونه200 OK
{}
توقف ارسال تدریجی — مستندات API | ایران ناتیفیکیشن