# API для пресетов
## createPreset
`POST` `https://api.pushwoosh.com/json/1.3/createPreset`
Создает новый пресет.
#### Тело запроса
| Имя | Тип | Описание |
| -------------------------------------------------------- | ------- |----------------------------------------------------------------------------------------------------------------------------------------------------|
| auth\* | string | [Токен доступа к API](/ru/developer/api-reference/api-identifiers/#api-access-token) из Панели управления Pushwoosh. |
| name\* | string | Название пресета. |
| applicationCode\* | string | [Код приложения Pushwoosh](/ru/developer/api-reference/api-identifiers/#application-code) |
| campaignCode | string | [Код кампании](/ru/developer/api-reference/api-identifiers/#campaign-code), к которой вы хотите привязать этот пресет. |
| 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 | [Имя сегмента (фильтра)](/ru/developer/api-reference/api-identifiers/#segment--filter-name) |
| segmentation.platforms\* | array | Массив целых чисел. Список ID платформ. 1 - iOS, 3 - Android, 7 - Mac OS X, 8 - Windows, 9 - Amazon, 10 - Safari, 11 - Chrome, 12 - Firefox. |
```json
{
"status_code": 200,
"status_message": "OK"
}
```
```json title="Пример"
{
"request": {
"auth": "yxoPUlwqm…………pIyEX4H", // обязательно. Токен доступа к API из Панели управления Pushwoosh.
"name": "PRESET_NAME", // обязательно.
"applicationCode": "XXXXX-XXXXX", // обязательно. Код приложения Pushwoosh.
"applicationGroupCode": "AAAAA-BBBBB", // необязательно. Может использоваться вместо "applicationCode".
"campaignCode": "CCCCC-DDDDD", // необязательно. Код кампании.
"content": { // обязательно. Содержит данные сообщения.
"message": { // обязательно. Строка или объект. Содержимое сообщения. Если это
"en": "Английское сообщение", // строка, будет использован язык по умолчанию.
"fr": "Французское сообщение" // Содержимое сообщения, локализованное для разных языков.
}, // Для кодов языков используется только ISO 639-1:2002.
"title": { // необязательно. Строка или объект. Для многоязычности установите заголовок
"en": "Английский заголовок", // для каждого языка в объекте. Игнорируется, если
"fr": "Французский заголовок" // указаны заголовки для конкретных платформ (например,
}, // 'ios_title', 'android_header' и т.д.; см. примеры
// параметров для конкретных платформ в API /createMessage).
"subtitle": { // необязательно. Строка или объект. Для многоязычности установите подзаголовок
"en": "Английский подзаголовок", // для каждого языка в объекте. Игнорируется, если
"fr": "Французский подзаголовок" // указаны подзаголовки для конкретных платформ (например,
}, // '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 диплинка.
"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 push-уведомлений в секунду.
},
"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-уведомлений.
#### Тело запроса
| Имя | Тип | Описание |
| ---------------------------------------------- | ------ | ---------------------------------------------- |
| auth\* | string | [Токен доступа к API](/ru/developer/api-reference/api-identifiers/#api-access-token) из Панели управления Pushwoosh. |
| preset\_code\* | string | [Код пресета](/ru/developer/api-reference/api-identifiers/#preset-code) push-уведомлений, для которого нужно получить информацию. |
```json
{
"status_code": 200,
"status_message": "OK",
"response": {
"preset": {
"code": "XXXXX-XXXXX",
"name": "Полный пресет",
"page_id": 26,
"url": null,
"content": {
"en": "Какое-то сообщение",
"de": "Сообщение на немецком"
},
"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": "Заголовок",
"bodytext": "супер текст"
},
"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_code": "1"
},
"platforms": [1, 3, 7, 10, 11]
}
}
}
```
```json title="Пример"
{
"request":{
"auth": "yxoPUlwqm…………pIyEX4H", // обязательно. Токен доступа к API из Панели управления Pushwoosh
"preset_code": "AAAAA-BBBBB" // обязательно. Код пресета, для которого нужно получить информацию
}
}
```
## listPresets
`POST` `https://api.pushwoosh.com/json/1.3/listPresets`
Получает список пресетов, созданных для приложения.
#### Тело запроса
| Имя | Тип | Описание |
| --------------------------------------------- | ------ | ---------------------------------------------- |
| auth\* | string | [Токен доступа к API](/ru/developer/api-reference/api-identifiers/#api-access-token) из Панели управления Pushwoosh. |
| application\* | string | [Код приложения Pushwoosh](/ru/developer/api-reference/api-identifiers/#application-code) |
```json
{
"status_code": 200,
"status_message": "OK",
"response": {
"presets": []
}
}
```
```json
{
"status_code": 200,
"status_message": "OK",
"response": {
"presets": [{
"name": "тест",
"code": "AAAAA-BBBBB"
}]
}
}
```
```json
{
"request": {
"auth": "yxoPUlwqm…………pIyEX4H", // обязательно. Токен доступа к API из Панели управления Pushwoosh
"application": "XXXXX-XXXXX" // обязательно. Код приложения Pushwoosh
}
}
```
## deletePreset
`POST` `https://api.pushwoosh.com/json/1.3/deletePreset`
Удаляет пресет из вашего аккаунта.
#### Тело запроса
| Имя | Тип | Описание |
| ---------------------------------------------- | ------ | -------------------------------------------------------------------------------- |
| auth\* | string | [Токен доступа к API](/ru/developer/api-reference/api-identifiers/#api-access-token) из Панели управления Pushwoosh. |
| preset\_code\* | string | [Код пресета](/ru/developer/api-reference/api-identifiers/#preset-code), полученный из Панели управления Pushwoosh или из ответа API `/listPresets`. |
```json
{
"status_code": 200,
"status_message": "OK",
"response": null
}
```
```json title="Пример"
{
"request": {
"auth": "yxoPUlwqm…………pIyEX4H", // обязательно. Токен доступа к API из Панели управления Pushwoosh
"preset_code": "AAAAA-BBBBB" // обязательно. Код пресета для удаления
}
}
```