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

لغو پوش زمان‌بندی‌شده

پوشی را که هنوز ارسال نشده لغو می‌کند.

POSThttps://api.irnoti.com/v1/sdk-apps/{id}/messages/{messageId}/cancel
scope: broker.write

پوش‌های در حال ارسال یا تمام‌شده قابل لغو نیستند.

پارامترها

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

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

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

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

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

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

curl -X POST 'https://api.irnoti.com/v1/sdk-apps/8/messages/msg_901/cancel' \
  -H "Authorization: Bearer $IRNOTI_KEY"
پاسخ نمونه200 OK
{
  "status": "cancelled",
  "messageId": "msg_901"
}
لغو پوش زمان‌بندی‌شده — مستندات API | ایران ناتیفیکیشن