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

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

    English
    في الصفحة دي

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

    المستلمين وردود الأزرار

    GET/v2/campaigns/{campaignId}/recipients
    • الصلاحية:campaigns:read
    • Idempotency-Key:مش مستخدم
    • قراءة بس

    متاحة وقت التشغيل وخلال فترة الحفظ.

    البارامترات

    المسار

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

    الاستعلام (Query)

    الاسمالنوعالقيودالوصف
    limitاختياريالنوعstringالقيود—الوصفمن 1 لـ 500 (الافتراضي 50).
    cursorاختياريالنوعstringالقيود—الوصفnextCursor من الصفحة اللي قبلها.
    statusاختياريالنوعstringالقيود—الوصفQUEUED | SENDING | SENT | FAILED | SKIPPED
    replyاختياريالنوعstringالقيود—الوصففلتر رد الأزرار: id اختيار أو ANY أو NONE.

    الهيدرز

    الاسمالنوعالقيودالوصف
    X-Request-Idاختياريالنوعstringالقيود—الوصفاختياري: id الطلب بتاعك وبيرجعلك (غير كده بنعمل req_…). اديه للدعم لو احتجت.

    الطلب

    curl -X GET "https://mursilat.com/api/v2/campaigns/cm2camp0001xyz/recipients?status=FAILED" \
      -H "Authorization: Bearer $WASLA_API_KEY"

    الرد

    200مثال

    200 — application/json
    {
      "data": [
        {
          "phone": "201001234567",
          "status": "sent",
          "errorCode": null,
          "sentAt": "…",
          "deliveredAt": "…",
          "readAt": null,
          "repliedAt": null,
          "optedOut": false,
          "buttonReply": {
            "id": "yes",
            "title": "مهتم",
            "index": 1,
            "at": "…"
          }
        }
      ],
      "nextCursor": null
    }

    شكل الرد

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

    • responseobject2 حقل
      • dataarray1 عنصر
        • [0]object9 حقل
          • phonestring "201001234567"
          • statusstring "sent"
          • errorCodenull null
          • sentAtstring "…"
          • deliveredAtstring "…"
          • readAtnull null
          • repliedAtnull null
          • optedOutboolean false
          • buttonReplyobject4 حقل
            • idstring "yes"
            • titlestring "مهتم"
            • indexinteger 1
            • atstring "…"
      • nextCursornull null

    الأخطاء

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

    • 410CAMPAIGN_PURGEDالمستلمين اتمسحوا بعد ما الحملة خلصت (خصوصية).

    الأخطاء →

    جرّب

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

    مثال موثّق

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

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

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

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

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

    GET /v2/campaigns/{campaignId}/recipients