Presets API

createPreset

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

يقوم بإنشاء إعداد مسبق (preset) جديد.

Request Body

الاسم	النوع	الوصف
auth*	string	API access token من لوحة تحكم Pushwoosh.
name*	string	اسم الإعداد المسبق (Preset).
applicationCode*	string	Pushwoosh application code
campaignCode	string	كود الحملة التي تريد تعيين هذا الإعداد المسبق لها.
content*	object	معلمات محتوى الرسالة.
content.message*	string	سلسلة نصية (String) أو مصفوفة (Array). محتوى الرسائل. في حال كان سلسلة نصية، سيتم استخدام اللغة “الافتراضية”.
content.action	object	معلمات الإجراء المخصص. انظر المثال أدناه.
content.userData	array	بيانات مستخدم مخصصة. سيتم تمريرها كمعلمة “u” في الحمولة (محولة إلى سلسلة JSON).
content.properties	array	محتوى محدد لمنصات مختلفة. انظر المثال أدناه.
scheduling.sendRate	integer	التقييد (Throttling). القيم الصالحة هي من 100 إلى 1000 إشعار/ثانية.
segmentation	object	معلمات التقسيم (Segmentation).
segmentation.filter	string	اسم الشريحة (Filter)
segmentation.platforms*	array	مصفوفة من الأعداد الصحيحة. قائمة معرفات المنصات. 1 - iOS، 3 - Android، 7 - Mac OS X، 8 - Windows، 9 - Amazon، 10 - Safari، 11 - Chrome، 12 - Firefox.

200

{
  "status_code": 200,
  "status_message": "OK"
}

Example

{
  "request": {
    "auth": "yxoPUlwqm…………pIyEX4H",        // مطلوب. API access token من لوحة تحكم Pushwoosh.
    "name": "PRESET_NAME",                 // مطلوب.
    "applicationCode": "XXXXX-XXXXX",      // مطلوب. Pushwoosh application code.
    "applicationGroupCode": "AAAAA-BBBBB", // اختياري. يمكن استخدامه بدلاً من "applicationCode".
    "campaignCode": "CCCCC-DDDDD",         // اختياري. Campaign code.
    "content": {                           // مطلوب. يحتوي على بيانات الرسالة.
      "message": {                         // مطلوب. string أو object. محتوى الرسالة. في حال كان
        "en": "English message",           //           سلسلة نصية، سيتم استخدام اللغة الافتراضية.
        "fr": "French message"             //           محتوى الرسالة مترجم للغات مختلفة.
      },                                   //           فقط ISO 639-1:2002 لرموز اللغات.
      "title": {                           // اختياري. string أو object. لتعدد اللغات، قم بتعيين العنوان
        "en": "English title",             //           لكل لغة في الكائن. يتم تجاهله إذا تم تحديد
        "fr": "French title"               //           عناوين خاصة بالمنصة (مثل،
      },                                   //           'ios_title', 'android_header', إلخ؛ انظر أمثلة
                                           //           المعلمات الخاصة بالمنصة في
                                           //           API /createMessage).
      "subtitle": {                        // اختياري. string أو object. لتعدد اللغات، قم بتعيين العنوان
        "en": "English subtitle",          //           لكل لغة في الكائن. يتم تجاهله إذا تم تحديد
        "fr": "French subtitle"            //           عناوين فرعية خاصة بالمنصة (مثل،
      },                                   //           'ios_subtitle', إلخ؛ انظر أمثلة المعلمات
                                           //           الخاصة بالمنصة في API /createMessage).
      "action": {                          // اختياري. الإجراء الذي سيتم تنفيذه بمجرد فتح المستخدم للرسالة.
        "type": "url",                     // اختياري. نوع الإجراء. الأنواع المتاحة: "url", "deepLink",
                                           //            "richMedia", "openApp"(default).
        "options": {                       // اختياري. خيارات لأنواع الإجراءات. مطلوب لجميع أنواع
                                           //           الإجراءات باستثناء "openApp".
          "url": "https://example.com",    // مطلوب لنوع الإجراء "url"، string. سيتم تقصيره
                                           //           إذا تم تحديد أداة تقصير الروابط.
          "shortener": 2,                  // اختياري. القيم المتاحة: 0 - عدم التصغير، 2 - bit.ly.
                                           //           إذا لم يتم تحديد أداة تقصير، سيتم استخدام bit.ly
                                           //           بشكل افتراضي.
          "richMediaCode": "BBBBB-AAAAA",  // مطلوب لنوع الإجراء "richMedia"، string.
                                           //           كود Rich Media من لوحة تحكم Pushwoosh.
          "id": 123,                       // مطلوب لنوع الإجراء "deepLink"، integer. معرف Deep Link ID.
          "params": {                      // اختياري، معلمات مخصصة، مطلوب لنوع الإجراء "deepLink"، array.
            "param1": "value1",
            "param2": "value2"
          }
        }
      },
      "userData": {                        // اختياري. بيانات مستخدم مخصصة. سيتم تمريرها كمعلمة "u"
        "CustomData": "value"              //           في الحمولة (محولة إلى سلسلة JSON).
      },
      "platforms": {
        "ios": {
          "sound": "default",
          "silent": 1,
          "ttl": 604800,
          "rootParams": {
            "rule_id": "12345",
            "screen_id": "34567"
          },
          "interruptionLevel": "active"
        },
        "android": {
          "rootParams": {
            "rule_id": "12345",
            "screen_id": "34567"
          }
        }
      }
    },
    "scheduling": {            // اختياري. خيارات الجدولة.
      "sendRate": 1000         // اختياري. التقييد. القيم الصالحة هي من 100 إلى 1000 إشعار/ثانية.
    },
    "segmentation": {          // مطلوب. خيارات التقسيم.
      "filter": "FILTER NAME", // اختياري. اسم الفلتر من لوحة تحكم Pushwoosh الخاصة بك.
      "platforms": [1, 3]      // مطلوب. قائمة معرفات المنصات: 1 — iOS; 3 — Android;
                               //           7 — Mac OS X; 8 — Windows; 9 — Amazon; 10 — Safari;
                               //           11 — Chrome; 12 — Firefox;
    }
  }
}

ملاحظة

بالنسبة للمعلمات الخاصة بالمنصة، يرجى الرجوع إلى /createMessage.

getPreset

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

يسترجع معلمات إعداد الدفع المسبق (push preset) المحدد.

Request Body

الاسم	النوع	الوصف
auth*	string	API access token من لوحة تحكم Pushwoosh.
preset_code*	string	كود الإعداد المسبق لاسترجاع المعلومات الخاصة به.

200

{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "preset": {
      "code": "XXXXX-XXXXX",
      "name": "Full preset",
      "page_id": 26,
      "url": null,
      "content": {
        "en": "Some message",
        "de": "Eine Nachricht"
      },
      "properties": {
        "ignore_user_timezone": 1,
        "ios_badges": "5",
        "ios_sound": "default",
        "ios_ttl": "43200",
        "android_sound": "Sound1.wav",
        "android_custom_icon": "icon.png",
        "android_header": "android_header",
        "android_gcm_ttl": "43200",
        "wns_type": "toast",
        "wns_content": {
          "template": "ToastImageAndText02",
          "lang-en": {
            "headlinetext": "Title",
            "bodytext": "super text"
          },
          "languages": ["en", "zh", "it", "sv", "de", "fr", "pt", "nl", "es"],
          "lang-zh": {
            "headlinetext": "",
            "bodytext": ""
          },
          "lang-it": {
            "headlinetext": "",
            "bodytext": ""
          },
          "lang-sv": {
            "headlinetext": "",
            "bodytext": ""
          },
          "lang-de": {
            "headlinetext": "",
            "bodytext": ""
          },
          "lang-fr": {
            "headlinetext": "",
            "bodytext": ""
          },
          "lang-pt": {
            "headlinetext": "",
            "bodytext": ""
          },
          "lang-nl": {
            "headlinetext": "",
            "bodytext": ""
          },
          "lang-es": {
            "headlinetext": "",
            "bodytext": ""
          },
          "imagesource": "https:\/\/image.com\/jpg"
        },
        "adm_sound": "song",
        "adm_custom_icon": "i5.bmp",
        "adm_header": "Amazon Header",
        "adm_ttl": "7200",
        "safari_title": "Safari title",
        "safari_action": "OK",
        "safari_url_args": ["hello.com", ""],
        "safari_ttl": "43200",
        "userdata": "{\"custom\":\"data\"}",
        "created_via": "CP",
        "user_id": 2,
        "filter_id": "1"
      },
      "platforms": [1, 3, 7, 10, 11]
    }
  }
}

Example

{
  "request":{
    "auth": "yxoPUlwqm…………pIyEX4H", // مطلوب. API access token من لوحة تحكم Pushwoosh
    "preset_code": "AAAAA-BBBBB"    // مطلوب. كود الإعداد المسبق لاسترجاع المعلومات الخاصة به
  }
}

listPresets

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

يسترجع قائمة الإعدادات المسبقة التي تم إنشاؤها للتطبيق.

Request Body

الاسم	النوع	الوصف
auth*	string	API access token من لوحة تحكم Pushwoosh.
application*	string	Pushwoosh application code

No presets

{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "presets": []
  }
}

Presets list

{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "presets": [{
      "name": "test",
      "code": "AAAAA-BBBBB"
    }]
  }
}

{
  "request": {
    "auth": "yxoPUlwqm…………pIyEX4H",  // مطلوب. API access token من لوحة تحكم Pushwoosh
    "application": "XXXXX-XXXXX"     // مطلوب. Pushwoosh application code
  }
}

deletePreset

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

يحذف إعداداً مسبقاً من حسابك.

Request Body

الاسم	النوع	الوصف
auth*	string	API access token من لوحة تحكم Pushwoosh.
preset_code*	string	كود الإعداد المسبق المسترجع من لوحة تحكم Pushwoosh أو استجابة API /listPresets.

200

{
  "status_code": 200,
  "status_message": "OK",
  "response": null
}

Example

{
  "request": {
    "auth": "yxoPUlwqm…………pIyEX4H", // مطلوب. API access token من لوحة تحكم Pushwoosh
    "preset_code": "AAAAA-BBBBB"    // مطلوب. كود الإعداد المسبق المراد حذفه
  }
}