لغو دستهٔ زمانبندیشده
پیامهای ارسالنشدهٔ یک دسته را لغو و هزینهٔ آنها را برمیگرداند.
POST
scope: sms.sendhttps://api.irnoti.com/v1/sms/batches/{id}/cancelفقط پیامهایی لغو میشوند که هنوز به صف ارسال نرفتهاند (دستهٔ زمانبندیشده یا باقیماندهٔ ارسال تدریجی). مبلغ بازگشتی به کیف پول برمیگردد.
**فیلدهای پاسخ:** cancelled تعداد پیام لغوشده، refunded مبلغ بازگشتی به ریال.
پارامترها
| نام | محل | نوع | توضیح |
|---|---|---|---|
| id * | مسیر | string | شناسهٔ دسته (batchId پاسخ ارسال). |
خطاهای خاص این endpoint
| 401 | unauthorized | کلید API نامعتبر یا منقضی است. |
| 403 | insufficient_scope | کلید API دامنهٔ دسترسی لازم را ندارد. |
| 404 | not_found | دسته پیدا نشد یا متعلق به شما نیست. |
اجرای زنده (محیط تست)
باز کردن در کنسول کامل ←این endpoint در محیط تست پشتیبانی نمیشود؛ برای اجرا، کلید واقعی را در حالت «اجرای واقعی» وارد کنید.