API для пресетов

createPreset

POST https://wavesend.ru/json/1.3/createPreset

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

Тело запроса

Название	Тип	Описание
auth*	string	API access token из Wavesend Control Panel.
name*	string	Название пресета.
applicationCode*	string	Application code Wavesend
campaignCode	string	Код кампании, к которой вы хотите привязать этот пресет.
content*	object	Параметры содержимого сообщения.
content.message*	string	Строка или массив. Содержимое сообщений. Если это строка, будет использован язык “Default”.
content.action	object	Параметры пользовательского действия. См. пример ниже.
content.userData	array	Пользовательские данные. Будут переданы как параметр “u” в полезной нагрузке (преобразованные в строку JSON).
content.properties	array	Специфичное для платформы содержимое. См. пример ниже.
scheduling.sendRate	integer	Ограничение скорости отправки. Допустимые значения от 100 до 1000 push-уведомлений в секунду.
segmentation	object	Параметры сегментации
segmentation.filter	string	Название фильтра
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"
}

Пример

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

Note

Информацию о параметрах для конкретных платформ см. в /createMessage.

getPreset

POST https://wavesend.ru/json/1.3/getPreset

Получает параметры определенного пресета push-уведомлений.

Тело запроса

Название	Тип	Описание
auth*	string	API access token из Wavesend Control Panel.
preset_code*	string	Код пресета push-уведомлений для получения информации.

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

Пример

{
  "request":{
    "auth": "yxoPUlwqm…………pIyEX4H", // required. API access token из Wavesend Control Panel
    "preset_code": "AAAAA-BBBBB"    // required. Код пресета push-уведомлений для получения информации
  }
}

listPresets

POST https://wavesend.ru/json/1.3/listPresets

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

Тело запроса

Название	Тип	Описание
auth*	string	API access token из Wavesend Control Panel.
application*	string	Application code Wavesend

Нет пресетов

{
  "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",  // required. API access token из Wavesend Control Panel
    "application": "XXXXX-XXXXX"     // required. Application code Wavesend
  }
}

deletePreset

POST https://wavesend.ru/json/1.3/deletePreset

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

Тело запроса

Название	Тип	Описание
auth*	string	API access token из Wavesend Control Panel.
preset_code*	string	Код пресета, полученный из Wavesend Control Panel или ответа API /listPresets.

200

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

Пример

{
  "request": {
    "auth": "yxoPUlwqm…………pIyEX4H", // required. API access token из Wavesend Control Panel
    "preset_code": "AAAAA-BBBBB"    // required. Код пресета для удаления
  }
}