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

Messaging API v2 هي نقطة نهاية REST/JSON واحدة لإنشاء رسائل صادرة عبر كل قناة يدعمها Pushwoosh:

إشعارات الدفع: iOS, Android, Huawei, Baidu, macOS, Amazon, Windows, Safari, Chrome, Firefox, IE
البريد الإلكتروني
الرسائل القصيرة (SMS)
Telegram, Kakao, LINE, WhatsApp

يتم تحديد القناة (Channel) حسب نوع الحمولة (payload لإشعارات الدفع / الرسائل القصيرة / تطبيقات المراسلة، وemail_payload للبريد الإلكتروني).

يتم تحديد الاستهداف (Targeting) حسب نوع الطلب (segment لشرائح الجمهور، وtransactional لقوائم الأجهزة أو المستخدمين الصريحة).

عنوان URL الأساسي

https://api.pushwoosh.com

إذا كنت تستخدم منطقة مخصصة أو نشرًا خاصًا، فتأكد من عنوان URL الأساسي الدقيق مع مدير نجاح العملاء في Pushwoosh.

المصادقة

يجب أن يتضمن كل طلب ترويسة Authorization مع رمز وصول API من جانب الخادم لـ Pushwoosh:

Authorization: Token YOUR_API_TOKEN

استخدم نفس الرمز الذي تصدره بالفعل لمكالمات API من خادم إلى خادم. لا تكشف عن هذا الرمز في تطبيقات العميل.

الطرق (Methods)

Notify: POST /messaging/v2/notify. إنشاء وإرسال رسالة واحدة (لشريحة أو تعاملية).

تنسيق الطلب والاستجابة

نوع المحتوى: application/json.
تستخدم أسماء الحقول snake_case. تظهر مجموعات oneof ككائنات متداخلة مع مجموعة مفاتيح واحدة بالضبط.
يتم تحويل قيم Enum إلى أسماء سلاسلها النصية (على سبيل المثال، "IOS"، "MESSAGE_TYPE_MARKETING").
تعيد الاستجابات الناجحة HTTP 200 مع جسم JSON؛ تستخدم الأخطاء مغلف الخطأ القياسي لـ gRPC-Gateway — { "code": ..., "message": ..., "details": [...] }.

بداية سريعة

curl -X POST https://api.pushwoosh.com/messaging/v2/notify \
  -H "Authorization: Token YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "segment": {
      "application": "XXXXX-XXXXX",
      "platforms": ["IOS", "ANDROID"],
      "code": "active_users",
      "payload": {
        "content": {
          "localized_content": {
            "en": {
              "ios":     { "body": "Hello from v2!" },
              "android": { "body": "Hello from v2!" }
            }
          }
        }
      },
      "schedule": { "at": "2026-05-01T12:00:00Z" },
      "message_type": "MESSAGE_TYPE_MARKETING"
    }
  }'

الخطوات التالية

Notify

مرجع الحمولة (Payload)

مرجع حمولة البريد الإلكتروني (Email payload)

الترحيل من الإصدار v1