Presets API

createPreset

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

Создает новый пресет.

Request Body

Name	Type	Description
auth*	string	Токен доступа API из Панели управления Pushwoosh.
name*	string	Имя пресета.
applicationCode*	string	Код приложения Pushwoosh
campaignCode	string	Код кампании, которой вы хотите назначить этот пресет.
content*	object	Параметры содержимого сообщения.
content.message*	string	Строка или массив. Содержимое сообщения. Если это строка, будет использован язык «по умолчанию».
content.action	object	Параметры кастомного действия. См. пример ниже.
content.userData	array	Пользовательские данные. Будут переданы как параметр “u” в полезной нагрузке (преобразованы в JSON-строку).
content.properties	array	Специфический контент для разных платформ. См. пример ниже.
scheduling.sendRate	integer	Троттлинг. Допустимые значения от 100 до 1000 пушей в секунду.
segmentation	object	Параметры сегментации
segmentation.filter	string	Имя сегмента (фильтра)
segmentation.platforms*	array	Массив целых чисел. Список ID платформ. 1 - iOS, 3 - Android, 7 - Mac OS X, 8 - Windows, 9 - Amazon, 10 - Safari, 11 - Chrome, 12 - Firefox.

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

{
  "request": {
    "auth": "yxoPUlwqm…………pIyEX4H",        // обязательно. Токен доступа API из Панели управления Pushwoosh.
    "name": "PRESET_NAME",                 // обязательно.
    "applicationCode": "XXXXX-XXXXX",      // обязательно. Код приложения Pushwoosh.
    "applicationGroupCode": "AAAAA-BBBBB", // необязательно. Может использоваться вместо "applicationCode".
    "campaignCode": "CCCCC-DDDDD",         // необязательно. Код кампании.
    "content": {                           // обязательно. Содержит данные сообщения.
      "message": {                         // обязательно. строка или объект. Содержимое сообщения. Если это
        "en": "English message",           //           строка, будет использован язык по умолчанию.
        "fr": "French message"             //           Содержимое сообщения, локализованное для разных языков.
      },                                   //           Только коды языков ISO 639-1:2002.
      "title": {                           // необязательно. строка или объект. Для мультиязычности установите заголовок
        "en": "English title",             //           для каждого языка в объекте. Игнорируется, если
        "fr": "French title"               //           указаны заголовки для конкретных платформ (например,
      },                                   //           'ios_title', 'android_header' и т.д.; см. примеры
                                           //           параметров для конкретных платформ в
                                           //           API /createMessage).
      "subtitle": {                        // необязательно. строка или объект. Для мультиязычности установите заголовок
        "en": "English subtitle",          //           для каждого языка в объекте. Игнорируется, если
        "fr": "French subtitle"            //           указаны подзаголовки для конкретных платформ (например,
      },                                   //           'ios_subtitle' и т.д.; см. примеры параметров
                                           //           для конкретных платформ в API /createMessage).
      "action": {                          // необязательно. Действие, выполняемое при открытии сообщения пользователем.
        "type": "url",                     // необязательно. Тип действия. Доступные типы: "url", "deepLink",
                                           //            "richMedia", "openApp"(по умолчанию).
        "options": {                       // необязательно. Опции для типов действий. Обязательно для всех типов
                                           //           действий, кроме "openApp".
          "url": "https://example.com",    // обязательно для типа действия "url", строка. Будет сокращена,
                                           //           если определен сокращатель ссылок.
          "shortener": 2,                  // необязательно. Доступные значения: 0 - не сокращать, 2 - bit.ly.
                                           //           Если сокращатель не указан, по умолчанию будет
                                           //           использоваться bit.ly.
          "richMediaCode": "BBBBB-AAAAA",  // обязательно для типа действия "richMedia", строка.
                                           //           Код Rich Media из Панели управления Pushwoosh.
          "id": 123,                       // обязательно для типа действия "deepLink", целое число. ID Deep Link.
          "params": {                      // необязательно, кастомные параметры, обязательно для типа действия "deepLink", массив.
            "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]      // обязательно. Список ID платформ: 1 — iOS; 3 — Android;
                               //           7 — Mac OS X; 8 — Windows; 9 — Amazon; 10 — Safari;
                               //           11 — Chrome; 12 — Firefox;
    }
  }
}

getPreset

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

Возвращает параметры указанного push-пресета.

Request Body

Name	Type	Description
auth*	string	Токен доступа API из Панели управления Pushwoosh.
preset_code*	string	Код push-пресета для получения информации.

{
  "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]
    }
  }
}

{
  "request":{
    "auth": "yxoPUlwqm…………pIyEX4H", // обязательно. Токен доступа API из Панели управления Pushwoosh
    "preset_code": "AAAAA-BBBBB"    // обязательно. Код push-пресета для получения информации
  }
}

listPresets

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

Возвращает список пресетов, созданных для приложения.

Request Body

Name	Type	Description
auth*	string	Токен доступа API из Панели управления Pushwoosh.
application*	string	Код приложения Pushwoosh

Нет пресетов
Список пресетов

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

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

{
  "request": {
    "auth": "yxoPUlwqm…………pIyEX4H",  // обязательно. Токен доступа API из Панели управления Pushwoosh
    "application": "XXXXX-XXXXX"     // обязательно. Код приложения Pushwoosh
  }
}

deletePreset

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

Удаляет пресет из вашего аккаунта.

Request Body

Name	Type	Description
auth*	string	Токен доступа API из Панели управления Pushwoosh.
preset_code*	string	Код пресета, полученный из Панели управления Pushwoosh или ответа API `/listPresets`.

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

{
  "request": {
    "auth": "yxoPUlwqm…………pIyEX4H", // обязательно. Токен доступа API из Панели управления Pushwoosh
    "preset_code": "AAAAA-BBBBB"    // обязательно. Код пресета для удаления
  }
}