إلغاء

POST https://api.pushwoosh.com/messaging/v2/cancel

إلغاء رسالة تم إنشاؤها مسبقًا، يتم تحديدها بواسطة message_code الخاص بها. الإلغاء متاح فقط عندما تكون الرسالة في إحدى هذه الحالات:

pending: تم إنشاؤها ولكن لم يتم التقاطها بعد للإرسال.
waiting: مجدولة لوقت إرسال مستقبلي.
processing: يتم حاليًا إعدادها للتسليم.

للتحقق مما إذا كانت الرسالة لا تزال في حالة قابلة للإلغاء، راجع التحقق من حالة الرسالة.

الطلب

المصادقة باستخدام رمز Server API token الخاص بك في ترويسة Authorization: Token <API_TOKEN>.

الحقل	النوع	مطلوب	الوصف
`message_code`	string	نعم	رمز الرسالة (Message code) للرسالة المراد إلغاؤها، كما تم إرجاعه بواسطة `Notify` في `result.message_code`.

مثال على الطلب

curl -X POST https://api.pushwoosh.com/messaging/v2/cancel \
  -H "Authorization: Token YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "message_code": "XXXX-XXXXXXXX-XXXXXXXX"
  }'

الاستجابة

عند النجاح، تُرجع HTTP 200 مع نص JSON فارغ.

{}

الأخطاء

تستخدم الأخطاء مغلف الخطأ القياسي لـ gRPC-Gateway: { "code": ..., "message": ..., "details": [...] }.

حالة HTTP	الشرط
`400`	`message_code` مفقود.
`400`	الرسالة ليست في حالة قابلة للإلغاء (لم تعد `pending` أو `waiting` أو `processing`).
`403`	الرسالة تنتمي إلى حساب آخر.
`404`	لا توجد رسالة لـ `message_code` المحدد.
`500`	حدث خطأ داخلي أثناء تحميل الرسالة أو نشر الإلغاء. أعد محاولة الطلب.

مثال

إلغاء رسالة لم تعد موجودة يُرجع HTTP 404:

{
  "code": 5,
  "message": "message not found",
  "details": []
}

التحقق من حالة الرسالة

قبل الإلغاء، يمكنك التحقق مما إذا كانت الرسالة لا تزال في حالة قابلة للإلغاء. بالإضافة إلى قراءة عمود الحالة (Status) في جدول الرسائل في لوحة التحكم (الحملات ← الرسائل لمرة واحدة)، يمكنك الاستعلام عن الحالة برمجيًا باستخدام messages:list:

مرر message_code في مصفوفة filters.messages_codes (إلى جانب filters.application المطلوب).
اقرأ حقل status للإدخال المطابق في items[].

مواضيع ذات صلة

إعلام

تحديث

إحصائيات الرسائل

نظرة عامة على Messaging API v2

الترحيل من v1