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

لغو دستهٔ زمان‌بندی‌شده

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

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

فقط پیام‌هایی لغو می‌شوند که هنوز به صف ارسال نرفته‌اند (دستهٔ زمان‌بندی‌شده یا باقی‌ماندهٔ ارسال تدریجی). مبلغ بازگشتی به کیف پول برمی‌گردد. **فیلدهای پاسخ:** cancelled تعداد پیام لغوشده، refunded مبلغ بازگشتی به ریال.

پارامترها

ناممحلنوعتوضیح
id *مسیرstringشناسهٔ دسته (batchId پاسخ ارسال).

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

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

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

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

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

curl -X POST 'https://api.irnoti.com/v1/sms/batches/918/cancel' \
  -H "Authorization: Bearer $IRNOTI_KEY"
پاسخ نمونه200 OK
{
  "batchId": "918",
  "refunded": "490000",
  "cancelled": 500
}
لغو دستهٔ زمان‌بندی‌شده — مستندات API | ایران ناتیفیکیشن