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

لغو کمپین

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

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

وضعیت جدید کمپین برمی‌گردد.

پارامترها

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

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

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

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

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

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

curl -X POST 'https://api.irnoti.com/v1/voip/campaigns/5/cancel' \
  -H "Authorization: Bearer $IRNOTI_KEY"
پاسخ نمونه200 OK
{
  "id": "5",
  "status": "cancelled"
}
لغو کمپین — مستندات API | ایران ناتیفیکیشن