انتقل إلى المحتوى
أدلة المستخدمالدعم طلب عرض توضيحي تسجيل الدخول
Pushwoosh.com

واجهة برمجة تطبيقات البريد الإلكتروني

createEmailMessage مهملة

Anchor link to

تُنشئ رسالة بريد إلكتروني.

POST https://api.pushwoosh.com/json/1.3/createEmailMessage

معلمات نص الطلب

Anchor link to
الاسمالنوع
مطلوبالوصف
authstringنعمرمز الوصول إلى API من لوحة تحكم Pushwoosh.
applicationstringنعمرمز تطبيق Pushwoosh
notificationsarrayنعممصفوفة JSON تحتوي على تفاصيل رسالة البريد الإلكتروني. انظر جدول معلمات الإشعارات أدناه.

معلمات الإشعارات

Anchor link to
الاسمالنوع
مطلوبالوصف
send_datestringنعمتحدد متى يتم إرسال البريد الإلكتروني. التنسيق: YYYY-MM-DD HH:mm أو "now".
presetstringنعمرمز الإعداد المسبق للبريد الإلكتروني. انسخه من شريط عنوان URL في محرر محتوى البريد الإلكتروني في لوحة تحكم Pushwoosh.
subjectstring or objectلاسطر موضوع البريد الإلكتروني. سيكون البريد الإلكتروني دائمًا بلغة المحتوى. إذا لم يحتوي subject على لغة مطابقة لـ content، فسيكون الموضوع فارغًا.
contentstring or objectلامحتوى نص البريد الإلكتروني. يمكن أن يكون سلسلة نصية لمحتوى HTML عادي أو كائنًا للإصدارات المترجمة.
attachmentsarrayلامرفقات البريد الإلكتروني. يتوفر مرفقان فقط. يجب ألا يتجاوز كل مرفق 1 ميجابايت (بترميز base64).
list_unsubscribestringلايسمح بتعيين عنوان URL مخصص لترويسة “Link-Unsubscribe”.
campaignstringلارمز الحملة لربط البريد الإلكتروني بحملة معينة.
ignore_user_timezonebooleanلاإذا كانت القيمة true، يتم إرسال البريد الإلكتروني فورًا، مع تجاهل المناطق الزمنية للمستخدم.
timezonestringلايرسل البريد الإلكتروني وفقًا للمنطقة الزمنية للمستخدم. مثال: "America/New_York".
filterstringلايرسل البريد الإلكتروني للمستخدمين الذين يطابقون شرط فلتر معين.
devicesarrayلاقائمة بعناوين البريد الإلكتروني (بحد أقصى 1000) لإرسال رسائل بريد إلكتروني مستهدفة. إذا تم استخدامها، يتم إرسال الرسالة فقط إلى هذه العناوين. يتم تجاهلها إذا تم استخدام مجموعة التطبيقات.
use_auto_registrationbooleanلاإذا كانت القيمة true، يتم تسجيل رسائل البريد الإلكتروني من معلمة devices تلقائيًا.
usersarrayلاإذا تم تعيينها، سيتم تسليم رسالة البريد الإلكتروني فقط إلى معرفات المستخدم المحددة (المسجلة عبر استدعاء /registerEmail). لا يزيد عن 1000 معرف مستخدم في مصفوفة. إذا تم تحديد معلمة “devices”، فسيتم تجاهل معلمة “users”.
dynamic_content_placeholdersobjectلاعناصر نائبة للمحتوى الديناميكي بدلاً من قيم وسوم الجهاز.
conditionsarrayلاشروط التقسيم باستخدام الوسوم. مثال: [["Country", "EQ", "BR"]].
fromobjectلاحدد اسم مرسل وبريد إلكتروني مخصصين، متجاوزًا الإعداد الافتراضي في خصائص التطبيق.
reply-toobjectلاحدد بريدًا إلكترونيًا مخصصًا للرد، متجاوزًا الإعداد الافتراضي في خصائص التطبيق.
bccarrayلاBCC (نسخة كربونية مخفية): مصفوفة من عناوين البريد الإلكتروني التي تتلقى نسخة من البريد الإلكتروني دون أن يراها المستلمون الآخرون.
email_typestringلاحدد نوع البريد الإلكتروني: "marketing" أو "transactional". إذا تم حذفه، فلن يتلقى المستخدمون الذين لديهم PW_ControlGroup: true الرسالة.
email_categorystringمطلوب عندما يكون email_type هو "marketing".حدد أحد أسماء الفئات التي تم تكوينها في مركز تفضيلات الاشتراك (على سبيل المثال، النشرة الإخبارية، العروض الترويجية، تحديثات المنتج).
transactionIdstringلامعرف رسالة فريد لمنع إعادة الإرسال في حالة وجود مشاكل في الشبكة. يتم تخزينه على جانب Pushwoosh لمدة 5 دقائق.
capping_daysintegerلاعدد الأيام (بحد أقصى 30) لتطبيق تحديد التكرار لكل جهاز. ملاحظة: تأكد من تكوين تحديد التكرار العالمي في لوحة التحكم.
capping_countintegerلاالحد الأقصى لعدد رسائل البريد الإلكتروني التي يمكن إرسالها من تطبيق معين إلى جهاز معين خلال فترة capping_days. في حالة تجاوز الرسالة التي تم إنشاؤها حد capping_count لجهاز ما، فلن يتم إرسالها إلى ذلك الجهاز.
capping_excludebooleanلاإذا تم تعيينها على true، فلن يتم احتساب هذا البريد الإلكتروني ضمن تحديد التكرار للرسائل المستقبلية.
capping_avoidbooleanلاإذا تم تعيينها على true، فلن يتم تطبيق تحديد التكرار على هذا البريد الإلكتروني المحدد.
send_rateintegerلاحدد عدد الرسائل التي يمكن إرسالها في الثانية عبر جميع المستخدمين. يساعد على منع الحمل الزائد على الواجهة الخلفية أثناء عمليات الإرسال كبيرة الحجم.
send_rate_avoidbooleanلاإذا تم تعيينها على true، فلن يتم تطبيق حد التقييد على هذا البريد الإلكتروني المحدد.

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

Anchor link to
{
  "request": {
    "auth": "API_ACCESS_TOKEN",         // مطلوب. رمز الوصول إلى API من لوحة تحكم Pushwoosh
    "application": "APPLICATION_CODE",  // مطلوب. رمز تطبيق Pushwoosh.
    "notifications": [{
      "send_date": "now",               // مطلوب. YYYY-MM-DD HH:mm أو 'now'
      "preset": "ERXXX-32XXX",          // مطلوب. انسخ رمز الإعداد المسبق للبريد الإلكتروني من شريط عنوان URL
                                        //           لصفحة محرر محتوى البريد الإلكتروني في لوحة تحكم Pushwoosh.
      "subject": {                      // اختياري. سطر موضوع رسالة البريد الإلكتروني.
        "de": "subject de",
        "en": "subject en"
      },
      "content": {                      // اختياري. محتوى نص البريد الإلكتروني.
        "de": "<html><body>de Hello, moto</body></html>",
        "default": "<html><body>default Hello, moto</body></html>"
      },
      "attachments": [{                 // اختياري. مرفقات البريد الإلكتروني
        "name": "image.png",            //           "name" - اسم الملف
        "content": "iVBANA...AFTkuQmwC" //           "content" - محتوى الملف بترميز base64
      }, {
        "name": "file.pdf",
        "content": "JVBERi...AFTarEGC"
      }],
      "list_unsubscribe": "URL",        // اختياري. يسمح بتعيين عنوان URL مخصص لترويسة "Link-Unsubscribe"
      "campaign": "CAMPAIGN_CODE",      // اختياري. لتعيين رسالة البريد الإلكتروني هذه إلى حملة معينة،
                                        //           أضف رمز الحملة هنا.
      "ignore_user_timezone": true,     // اختياري.
      "timezone": "America/New_York",   // اختياري. حدد لإرسال الرسالة وفقًا لـ
                                        //           المنطقة الزمنية المحددة على جهاز المستخدم.
      "filter": "FILTER_NAME",          // اختياري. أرسل الرسالة إلى مستخدمين محددين يستوفون شروط الفلتر.
      "devices": [                      // اختياري. حدد عناوين البريد الإلكتروني لإرسال رسائل بريد إلكتروني مستهدفة.
        "email_address1",               //           لا يزيد عن 1000 عنوان في مصفوفة.
        "email_address2"                //           إذا تم تعيينها، سيتم إرسال الرسالة فقط إلى العناوين الموجودة
      ],                                //           في القائمة. يتم تجاهلها إذا تم استخدام مجموعة التطبيقات.
      "use_auto_registration": true,    // اختياري. تسجيل رسائل البريد الإلكتروني المحددة في معلمة "devices" تلقائيًا
      "users": [                        // اختياري. إذا تم تعيينها، سيتم تسليم رسالة البريد الإلكتروني فقط إلى
        "userId1",                      //           معرفات المستخدم المحددة (المسجلة عبر استدعاء /registerEmail).
        "userId2"                       //           لا يزيد عن 1000 معرف مستخدم في مصفوفة.
      ],                                //           إذا تم تحديد معلمة "devices"،
                                        //           فسيتم تجاهل معلمة "users".
      "dynamic_content_placeholders": { // اختياري. عناصر نائبة للمحتوى الديناميكي بدلاً من قيم وسوم الجهاز.
        "firstname": "John",
        "firstname_en": "John"
      },
      "conditions": [                   // اختياري. شروط التقسيم، انظر الملاحظة أدناه.
        ["Country", "EQ", "BR"],
        ["Language", "EQ", "pt"]
      ],
      "from": {                         // اختياري. حدد اسم مرسل وعنوان بريد إلكتروني للمرسل
        "name": "alias from",           //           لاستبدال "اسم المرسل" و "بريد المرسل" الافتراضيين
        "email": "from-email@email.com" //           المحددين في خصائص التطبيق.
      },
      "reply-to": {                     // اختياري. حدد عنوان بريد إلكتروني لاستبدال
        "name": "alias reply to ",      //           "الرد على" الافتراضي المحدد في خصائص التطبيق.
        "email": "reply-to@email.com"
      },
      "bcc": [                          // اختياري. BCC: مصفوفة من عناوين البريد الإلكتروني التي تتلقى نسخة دون أن يراها المستلمون الآخرون.
        "bcc1@example.com",
        "bcc2@example.com"
      ],
      "email_type": "marketing",        // اختياري. "marketing" أو "transactional".
                                        // إذا تم حذفه، فلن يتلقى المستخدمون الذين لديهم PW_ControlGroup: true الرسالة.
      "email_category": "category name",// مطلوب عندما يكون email_type هو "marketing". اسم الفئة.
      "transactionId": "unique UUID",   // اختياري. معرف رسالة فريد لمنع إعادة الإرسال
                                        //           في حالة وجود مشاكل في الشبكة. يتم تخزينه على جانب
                                        //           Pushwoosh لمدة 5 دقائق.
      // معلمات تحديد التكرار. تأكد من تكوين تحديد التكرار العالمي في لوحة التحكم.
      // لا ينطبق تحديد التكرار على الرسائل المتعلقة بالمعاملات.
      // في جميع الحالات الأخرى، بما في ذلك "email_type" المحذوف، يتم تطبيق تحديد التكرار.
      "capping_days": 30,               // اختياري. عدد أيام تحديد التكرار (بحد أقصى 30 يومًا)
      "capping_count": 10,              // اختياري. الحد الأقصى لعدد رسائل البريد الإلكتروني التي يمكن إرسالها من
                                        //           تطبيق معين إلى جهاز معين خلال فترة 'capping_days'
                                        //           . في حالة تجاوز الرسالة التي تم إنشاؤها
                                        //           حد 'capping_count' لجهاز ما، فلن
                                        //           يتم إرسالها إلى ذلك الجهاز.
      "capping_exclude": true,          // اختياري. إذا تم تعيينها على true، فلن يتم
                                        //           احتساب هذا البريد الإلكتروني ضمن تحديد التكرار للرسائل المستقبلية.
      "capping_avoid": true,            // اختياري. إذا تم تعيينها على true، فلن يتم تطبيق تحديد التكرار على
                                        //           هذا البريد الإلكتروني المحدد.
      "send_rate": 100,                 // اختياري. حد التقييد.
                                        //           حدد عدد الرسائل التي يمكن إرسالها في الثانية عبر جميع المستخدمين.
                                        //           يساعد على منع الحمل الزائد على الواجهة الخلفية أثناء عمليات الإرسال كبيرة الحجم.
      "send_rate_avoid": true,          // اختياري. إذا تم تعيينها على true، فلن يتم تطبيق حد التقييد على
                                        //           هذا البريد الإلكتروني المحدد.
    }]
  }
}

أمثلة على الاستجابة

Anchor link to
{
  "status_code": 200,
  "status_message": "OK",
  "response": null
}

شروط الوسوم

Anchor link to

كل شرط وسم هو مصفوفة مثل [tagName, operator, operand] حيث

  • tagName: اسم الوسم
  • operator: “EQ” | “IN” | “NOTEQ” | “NOTIN” | “LTE” | “GTE” | “BETWEEN”
  • operand: string | integer | array | date

وصف المعامل

Anchor link to
  • EQ: قيمة الوسم تساوي المعامل؛
  • IN: قيمة الوسم تتقاطع مع المعامل (يجب أن يكون المعامل دائمًا مصفوفة)؛
  • NOTEQ: قيمة الوسم لا تساوي المعامل؛
  • NOTIN: قيمة الوسم لا تتقاطع مع المعامل (يجب أن يكون المعامل دائمًا مصفوفة)؛
  • GTE: قيمة الوسم أكبر من أو تساوي المعامل؛
  • LTE: قيمة الوسم أصغر من أو تساوي المعامل؛
  • BETWEEN: قيمة الوسم أكبر من أو تساوي قيمة المعامل الدنيا ولكنها أصغر من أو تساوي قيمة المعامل القصوى (يجب أن يكون المعامل دائمًا مصفوفة).

وسوم السلاسل النصية

Anchor link to

العوامل الصالحة: EQ, IN, NOTEQ, NOTIN
المعاملات الصالحة:

  • EQ, NOTEQ: يجب أن يكون المعامل سلسلة نصية؛
  • IN, NOTIN: يجب أن يكون المعامل مصفوفة من السلاسل النصية مثل ["value 1", "value 2", "value N"]؛

وسوم الأعداد الصحيحة

Anchor link to

العوامل الصالحة: EQ, IN, NOTEQ, NOTIN, BETWEEN, GTE, LTE
المعاملات الصالحة:

  • EQ, NOTEQ, GTE, LTE: يجب أن يكون المعامل عددًا صحيحًا؛
  • IN, NOTIN: يجب أن يكون المعامل مصفوفة من الأعداد الصحيحة مثل [value 1, value 2, value N]؛
  • BETWEEN: يجب أن يكون المعامل مصفوفة من الأعداد الصحيحة مثل [min_value, max_value].

وسوم التاريخ

Anchor link to

العوامل الصالحة: EQ, IN, NOTEQ, NOTIN, BETWEEN, GTE, LTE
المعاملات الصالحة:

  • "YYYY-MM-DD 00:00" (سلسلة نصية)
  • الطابع الزمني يونكس 1234567890 (عدد صحيح)
  • "N days ago" (سلسلة نصية) للعوامل EQ, BETWEEN, GTE, LTE

وسوم القيم المنطقية

Anchor link to

العوامل الصالحة: EQ
المعاملات الصالحة: 0, 1, true, false

وسوم القوائم

Anchor link to

العوامل الصالحة: IN
المعاملات الصالحة: يجب أن يكون المعامل مصفوفة من السلاسل النصية مثل ["value 1", "value 2", "value N"].

registerEmail

Anchor link to

تسجيل عنوان البريد الإلكتروني للتطبيق.

POST https://api.pushwoosh.com/json/1.3/registerEmail

ترويسات الطلب

Anchor link to
الاسممطلوبالقيمةالوصف
AuthorizationنعمToken XXXXرمز جهاز API للوصول إلى واجهة برمجة تطبيقات الجهاز. استبدل XXXX برمز جهاز API الفعلي الخاص بك.

نص الطلب

Anchor link to
الاسمالنوعالوصف
application*stringرمز تطبيق Pushwoosh
email*stringعنوان البريد الإلكتروني.
languagestringلغة الجهاز المحلية. يجب أن تكون رمزًا من حرفين صغيرين وفقًا لمعيار ISO-639-1.
userIdstringمعرف المستخدم لربطه بعنوان البريد الإلكتروني.
tz_offsetintegerفارق المنطقة الزمنية بالثواني.
tagsobjectقيم الوسوم لتعيينها للجهاز المسجل.
{
  "status_code": 200,
  "status_message": "OK",
  "response": null
}
مثال
{
  "request": {
    "application": "APPLICATION_CODE",   // مطلوب. رمز تطبيق Pushwoosh.
    "email":"email@domain.com",          // مطلوب. عنوان البريد الإلكتروني المراد تسجيله.
    "language": "en",                    // اختياري. لغة الجهاز المحلية.
    "userId": "userId",                  // اختياري. معرف المستخدم لربطه بعنوان البريد الإلكتروني.
    "tz_offset": 3600,                   // اختياري. فارق المنطقة الزمنية بالثواني.
    "tags": {                            // اختياري. قيم الوسوم لتعيينها للجهاز المسجل.
       "StringTag": "string value",
       "IntegerTag": 42,
       "ListTag": ["string1","string2"], // يحدد قائمة القيم للوسوم من نوع القائمة
       "DateTag": "2024-10-02 22:11",    // لاحظ أن الوقت يجب أن يكون بتوقيت UTC
       "BooleanTag": true                // القيم الصالحة هي: true, false
    }
  }
}

deleteEmail

Anchor link to

إزالة عنوان البريد الإلكتروني من قاعدة المستخدمين الخاصة بك.

POST https://api.pushwoosh.com/json/1.3/deleteEmail

ترويسات الطلب

Anchor link to
الاسممطلوبالقيمةالوصف
AuthorizationنعمToken XXXXرمز جهاز API للوصول إلى واجهة برمجة تطبيقات الجهاز. استبدل XXXX برمز جهاز API الفعلي الخاص بك.

نص الطلب

Anchor link to
الاسمالنوعالوصف
applicationstringرمز تطبيق Pushwoosh
emailstringعنوان البريد الإلكتروني المستخدم في طلب /registerEmail.
{
  "status_code": 200,
  "status_message": "OK",
  "response": null
}
مثال
{
  "request": {
    "application": "APPLICATION_CODE",  // مطلوب. رمز تطبيق Pushwoosh
    "email": "email@domain.com"         // مطلوب. البريد الإلكتروني لحذفه من مشتركي التطبيق.
  }
}

setEmailTags

Anchor link to

تعيين قيم الوسوم لعنوان البريد الإلكتروني.

POST https://api.pushwoosh.com/json/1.3/setEmailTags

ترويسات الطلب

Anchor link to
الاسممطلوبالقيمةالوصف
AuthorizationنعمToken XXXXرمز جهاز API للوصول إلى واجهة برمجة تطبيقات الجهاز. استبدل XXXX برمز جهاز API الفعلي الخاص بك.

نص الطلب

Anchor link to
الاسمالنوعالوصف
applicationstringرمز تطبيق Pushwoosh
emailstringعنوان البريد الإلكتروني.
tagsobjectكائن JSON للوسوم المراد تعيينها، أرسل ‘null’ لإزالة القيمة.
userIdstringمعرف المستخدم المرتبط بعنوان البريد الإلكتروني.
{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "skipped": []
  }
}
مثال
{
  "request": {
    "email": "email@domain.com",                  // مطلوب. عنوان البريد الإلكتروني لتعيين الوسوم له.
    "application": "APPLICATION_CODE",            // مطلوب. رمز تطبيق Pushwoosh.
    "tags": {
      "StringTag": "string value",
      "IntegerTag": 42,
      "ListTag": ["string1", "string2"],
      "DateTag": "2024-10-02 22:11",              // الوقت بتوقيت UTC
      "BooleanTag": true                          // القيم الصالحة هي: true, false
    },
    "userId": "userId"                            // اختياري. معرف المستخدم المرتبط بعنوان البريد الإلكتروني.
  }
}

registerEmailUser

Anchor link to

ربط معرف مستخدم خارجي بعنوان بريد إلكتروني محدد.

POST https://api.pushwoosh.com/json/1.3/registerEmailUser

يمكن استخدامها في استدعاء واجهة برمجة التطبيقات /createEmailMessage (معلمة ‘users’).

ترويسات الطلب

Anchor link to
الاسممطلوبالقيمةالوصف
AuthorizationنعمToken XXXXرمز جهاز API للوصول إلى واجهة برمجة تطبيقات الجهاز. استبدل XXXX برمز جهاز API الفعلي الخاص بك.

نص الطلب

Anchor link to
الاسمالنوعالوصف
application*stringرمز تطبيق Pushwoosh
email*stringعنوان البريد الإلكتروني.
userId*stringمعرف المستخدم لربطه بعنوان البريد الإلكتروني.
tz_offsetintegerفارق المنطقة الزمنية بالثواني.
{
  "status_code": 200,
  "status_message": "OK",
  "response": null
}
مثال
{
  "request": {
    "application": "APPLICATION_CODE", // مطلوب. رمز تطبيق Pushwoosh.
    "email": "email@domain.com",       // مطلوب. عنوان البريد الإلكتروني للمستخدم.
    "userId": "userId",                // مطلوب. معرف المستخدم لربطه بعنوان البريد الإلكتروني.
    "tz_offset": 3600                  // اختياري. فارق المنطقة الزمنية بالثواني.
  }
}