انتقل للمحتوى

    عربي أو إنجليزي · ↑↓ للتنقل · Enter للفتح · Esc للقفل

    English
    في الصفحة دي

    الحملات (إرسال جماعي)

    إلغاء

    POST/v2/campaigns/{campaignId}/cancel
    • الصلاحية:campaigns:write
    • Idempotency-Key:اختياري
    • بيمسح

    المستلمين اللي مستنيين بيتلغوا.

    البارامترات

    المسار

    الاسمالنوعالقيودالوصف
    campaignIdإجباريالنوعstringالقيود—الوصفid الحملة.

    الهيدرز

    الاسمالنوعالقيودالوصف
    Idempotency-Keyاختياريالنوعstringالقيود≤ 191 حرفالوصفid فريد من عندك للعملية دي (حد أقصى 191 حرف ASCII). لو كررت بنفس المفتاح ونفس الـ body بيرجعلك أول رد ومعاه Idempotent-Replayed: true — عمرها ما تتنفذ مرتين. بيتحفظ 24 ساعة.
    X-Request-Idاختياريالنوعstringالقيود—الوصفاختياري: id الطلب بتاعك وبيرجعلك (غير كده بنعمل req_…). اديه للدعم لو احتجت.

    الطلب

    curl -X POST "https://mursilat.com/api/v2/campaigns/cm2camp0001xyz/cancel" \
      -H "Authorization: Bearer $WASLA_API_KEY" \
      -H "Idempotency-Key: order-1042-confirm"

    الرد

    200مثال

    200 — application/json
    {
      "id": "cm2camp0001xyz",
      "numberId": "cm1abcd2345efgh6789ijkl",
      "name": "عرض الجمعة",
      "status": "cancelled",
      "contentType": "cta_url",
      "createdVia": "api",
      "speed": "SAFE",
      "scheduledAt": null,
      "startedAt": "2026-10-13T09:00:00.000Z",
      "pausedAt": null,
      "completedAt": null,
      "pause": null,
      "progress": {
        "total": 500,
        "queued": 380,
        "sent": 120,
        "delivered": 115,
        "read": 70,
        "replied": 9,
        "failed": 0,
        "skipped": 3,
        "optOuts": 1,
        "percent": 24
      },
      "replies": null,
      "eta": {
        "remaining": 380,
        "perDayCap": 200,
        "remainingToday": 80,
        "estimatedMinutesToday": 34,
        "extraDays": 2,
        "note": "Estimate from the number warm-up caps and pacing."
      },
      "purged": false,
      "purgedAt": null,
      "createdAt": "2026-10-13T08:55:00.000Z",
      "updatedAt": "2026-10-13T09:30:00.000Z"
    }

    شكل الرد

    حقول الرد في المثال. افتح الكائنات والقوايم.

    • responseobject19 حقل
      • idstring "cm2camp0001xyz"
      • numberIdstring "cm1abcd2345efgh6789ijkl"
      • namestring "عرض الجمعة"
      • statusstring "cancelled"
      • contentTypestring "cta_url"
      • createdViastring "api"
      • speedstring "SAFE"
      • scheduledAtnull null
      • startedAtstring "2026-10-13T09:00:00.000Z"
      • pausedAtnull null
      • completedAtnull null
      • pausenull null
      • progressobject10 حقل
        • totalinteger 500
        • queuedinteger 380
        • sentinteger 120
        • deliveredinteger 115
        • readinteger 70
        • repliedinteger 9
        • failedinteger 0
        • skippedinteger 3
        • optOutsinteger 1
        • percentinteger 24
      • repliesnull null
      • etaobject6 حقل
        • remaininginteger 380
        • perDayCapinteger 200
        • remainingTodayinteger 80
        • estimatedMinutesTodayinteger 34
        • extraDaysinteger 2
        • notestring "Estimate from the number warm-up caps and pacing."
      • purgedboolean false
      • purgedAtnull null
      • createdAtstring "2026-10-13T08:55:00.000Z"
      • updatedAtstring "2026-10-13T09:30:00.000Z"

    الأخطاء

    غير أخطاء المصادقة وحدود الطلبات والتحقق اللي ممكن ترجع من أي endpoint:

    الأخطاء →

    جرّب

    ابعت الطلب ده من متصفحك لـ API مرسلات.

    مثال موثّق

    معاينة — النسخة دي من التوثيق مش على mursilat.com، فالكونسول بيعرض المثال الموثّق بدل ما يكلم الـ API.

    الطلبات الحقيقية بتستخدم رقمك وباقتك الحقيقيين: ممكن تبعت رسايل واتساب وتصرف من رصيدك وتمسح بيانات. (بيمسح)

    متخزن في ذاكرة التبويب ده بس: عمره ما بيتحفظ ولا بيتحط في الرابط، وبيتبعت لـ mursilat.com بس. لو عملت reload بيتنسي.

    بارامترات المسار

    تبعت الطلب ده بجد؟

    ده بيمسح أو يفك ربط حاجة. مينفعش يترجع.

    POST /v2/campaigns/{campaignId}/cancel