# Справочник по методам API

import { Badge } from '@astrojs/starlight/components';

Pushwoosh предоставляет обширную библиотеку из более чем 100 методов API, разделенных по категориям для различных функций, таких как отправка уведомлений, управление пользователями и отслеживание аналитики.




## Messaging API v2

Унифицированный API, который заменяет все семейство методов `/create*Message` (push, email, SMS, Kakao). См. [обзор](/ru/developer/api-reference/messaging-api-v2/) и [руководство по миграции](/ru/developer/api-reference/messaging-api-v2/migration-from-v1/).

|    <div style="width:250px"></div>                                                            |                                                                                                     |
|-------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------|
| [`Notify`](/ru/developer/api-reference/messaging-api-v2/notify/)             | Создает и отправляет одно сообщение по любому каналу. Заменяет `/createMessage`, `/createTargetedMessage`, `/createEmailMessage`, `/createSMSMessage`, `/createKakaoMessage`. |
| [`Cancel`](/ru/developer/api-reference/messaging-api-v2/cancel/)             | Отменяет ранее созданное сообщение до его доставки. Используйте с `message_code` из [`Notify`](/ru/developer/api-reference/messaging-api-v2/notify/). |
| [`Update`](/ru/developer/api-reference/messaging-api-v2/update/)             | Заменяет еще не отправленное запланированное сообщение новым определением (полная замена). Используйте с `message_code` из [`Notify`](/ru/developer/api-reference/messaging-api-v2/notify/). |

## SMTP-шлюз

Отправляйте транзакционные email через стандартный SMTP вместо прямого вызова API. Шлюз аутентифицируется с помощью кода вашего приложения и токена API, а затем пересылает каждое сообщение в [`Notify`](/ru/developer/api-reference/messaging-api-v2/notify/). См. [справочник по SMTP-шлюзу](/ru/developer/api-reference/smtp-gateway/).

## Messages API


|    <div style="width:250px"></div>                                                            |                                                                                                     |
|-------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------|
| [`createMessage`](/ru/developer/api-reference/messages-api#createmessage) <Badge text="Устарел" variant="caution" size="small" />   | Создает новое push-уведомление. Вместо него используйте [`Notify`](/ru/developer/api-reference/messaging-api-v2/notify/). |
| [`deleteMessage`](/ru/developer/api-reference/messages-api#deletemessage)   | Отменяет запланированное сообщение и удаляет его из истории сообщений.                                                |
| [`getMessageDetails`](/ru/developer/api-reference/messages-api#getmessagedetails) | Получает детали сообщения.                                                                             |
| [`createTargetedMessage`](/ru/developer/api-reference/messages-api#createtargetedmessage) <Badge text="Устарел" variant="caution" size="small" /> | Создает новое таргетированное push-уведомление. Вместо него используйте [`Notify`](/ru/developer/api-reference/messaging-api-v2/notify/) с типом `transactional`. |
| [`getPushHistory`](/ru/developer/api-reference/messages-api#getpushhistory) <Badge text="Устарел" variant="caution" size="small" /> | Используйте [`/messages:list`](/ru/developer/api-reference/statistics-api/message-statistics-api/#messageslist) для получения истории сообщений с подробными данными. |
| [`cancelMessage`](/ru/developer/api-reference/messages-api#cancelmessage)   | Отменяет запланированное сообщение, сохраняя его в истории сообщений.                                                    |


## Presets API

|                 <div style="width:250px"></div>                                              |                                                                                     |
|------------------------------------------------------------------------|------------------------------------------------------------------------------------------------|
| [`createPreset`](/ru/developer/api-reference/presets-api#createpreset)      | Создает новый пресет.                                                                          |
| [`getPreset`](/ru/developer/api-reference/presets-api#getpreset)            | Получает параметры указанного push-пресета.                                            |
| [`listPresets`](/ru/developer/api-reference/presets-api/#listpresets)       | Получает список пресетов, созданных для приложения.                                              |
| [`deletePreset`](/ru/developer/api-reference/presets-api#deletepreset)      | Удаляет пресет из вашего аккаунта.                                                           |


## Device API

|                <div style="width:250px"></div>                                               |                                                                                                    |
|-------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------|
| [`registerDevice`](/ru/developer/api-reference/device-api#registerdevice)   | Регистрирует устройство для приложения.                                                                         |
| [`unregisterDevice`](/ru/developer/api-reference/device-api#unregisterdevice) | Удаляет push-токен устройства.                                                                               |
| [`deleteDevice`](/ru/developer/api-reference/device-api#deletedevice) | Удаляет устройство и все связанные с ним данные в указанном приложении.                                           |
| [`setTags`](/ru/developer/api-reference/device-api#settags)                 | Устанавливает значения тегов для устройства.                                                                                |
| [`getTags`](/ru/developer/api-reference/device-api#gettags)                 | Получает теги с их соответствующими значениями для определенного устройства.                                           |
| [`setBadge`](/ru/developer/api-reference/device-api#setbadge)               | Отправляет текущее значение бейджа для устройства в Pushwoosh.                                                        |
| [`applicationOpen`](/ru/developer/api-reference/device-api#applicationopen)  | Регистрирует событие открытия приложения.                                                                                    |
| [`pushStat`](/ru/developer/api-reference/device-api#pushstat)               | Регистрирует событие открытия push-уведомления.                                                                                    |
| [`messageDeliveryEvent`](/ru/developer/api-reference/device-api#messagedeliveryevent) | Регистрирует событие доставки push-уведомления для устройства.                                                      |

## Audience API


|    <div style="width:250px"></div>                                                            |                                                                                                     |
|-------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------|
| [`bulkSetTags`](/ru/developer/api-reference/audience-api/#bulksettags) |         Устанавливает значения тегов для нескольких устройств.                                                               |
| [`bulkSetTags Status`](/ru/developer/api-reference/audience-api/#bulksettags-status) | Возвращает статус операции bulkSetTags.  |
| [`bulkRegisterDevice`](/ru/developer/api-reference/audience-api/#bulkregisterdevice)   |     Регистрирует несколько устройств в одном запросе, включая необязательные значения тегов для каждого устройства. |
| [`bulkRegisterDevice Status`](/ru/developer/api-reference/audience-api/#bulkregisterdevice-status)   |     Получает статус и результаты запроса на массовую регистрацию устройств по ID запроса. |
| [`bulkUnregisterDevice`](/ru/developer/api-reference/audience-api/#bulkunregisterdevice)   |     Отменяет регистрацию нескольких устройств в одном запросе.  |
| [`bulkUnregisterDevice Status`](/ru/developer/api-reference/audience-api/#bulkunregisterdevice-status)   |     Получает статус и результаты запроса на массовую отмену регистрации устройств по ID запроса.  |




## Tags API

|                       <div style="width:250px"></div>                                         |                                                                                 |
|----------------------------------------------------------------------|----------------------------------------------------------------------------------------------|
| [`addTag`](/ru/developer/api-reference/tags#addtag)                      | Создает тег в вашем аккаунте.                                                              |
| [`deleteTag`](/ru/developer/api-reference/tags#deletetag)                | Удаляет тег со всей связанной информацией.                                              |
| [`listTags`](/ru/developer/api-reference/tags#listtags)                  | Получает список тегов в аккаунте.                                                    |                                      |



## Segmentation (Filters) API

|                         <div style="width:250px"></div>                                       |                                                                                              |
|-------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------|
| [`createFilter`](/ru/developer/api-reference/segmentation-filters-api#createfilter) | Создает новый сегмент.                                                                     |
| [`listFilters`](/ru/developer/api-reference/segmentation-filters-api/#listfilters)  | Возвращает список доступных сегментов с их условиями.                             |
| [`deleteFilter`](/ru/developer/api-reference/segmentation-filters-api#deletefilter) | Удаляет существующий сегмент.                                                             |
| [`exportSegment`](/ru/developer/api-reference/segmentation-filters-api#exportsegment) | Планирует запрос на экспорт подписчиков, соответствующих условиям сегмента.                  |
| [`exportSegment Results`](/ru/developer/api-reference/segmentation-filters-api#exportsegment-results) | Получает CSV-ссылку на результаты exportSegment.                           |



## User-centric API

|                       <div style="width:250px"></div>                                           |                                                     |
|--------------------------------------------------------------------|----------------------------------------------------------------|
| [`registerUser`](/ru/developer/api-reference/user-centric-api#registeruser) | Связывает внешний User ID с указанным устройством.           |
| [`deleteUser`](/ru/developer/api-reference/user-centric-api#deleteuser) | Удаляет пользователя и все устройства, связанные с указанным User ID. |
| [`postEvent`](/ru/developer/api-reference/user-centric-api#postevent)  | Вызывает событие в приложении.                                |



## Events API

|                        <div style="width:250px"></div>                                   |                          |
|------------------------------------------------------------------|--------------------------------------|
| [`createEvent`](/ru/developer/api-reference/events#createevent)       | Создает событие для приложения.        |



## Applications API

|                           <div style="width:250px"></div>                                               |                                                    |
|---------------------------------------------------------------------------|-----------------------------------------------------------------|
| [`createApplication`](/ru/developer/api-reference/applications#createapplication) | Создает новое приложение в аккаунте.                      |
| [`updateApplication`](/ru/developer/api-reference/applications#updateapplication) | Обновляет настройки приложения.                              |
| [`deleteApplication`](/ru/developer/api-reference/applications#deleteapplication) | Удаляет приложение из аккаунта.                              |
| [`getApplication`](/ru/developer/api-reference/applications#getapplication)   | Получает подробную информацию о приложении.                                    |
| [`getApplications`](/ru/developer/api-reference/applications#getapplications) | Получает список приложений в аккаунте.              |
| [`getApplicationFile`](/ru/developer/api-reference/applications#getapplicationfile) | Получает файлы конфигурации, связанные с приложением.         |
| [`setApplicationPlatformStatus`](/ru/developer/api-reference/applications#setapplicationplatformstatus) | Изменяет статус платформы приложения. |


## Campaigns API

|                            <div style="width:250px"></div>                                        |                           |
|-------------------------------------------------------------------|------------------------------------------|
| [`createCampaign`](/ru/developer/api-reference/campaigns#createcampaign) | Создает новую push-кампанию.            |
| [`deleteCampaign`](/ru/developer/api-reference/campaigns#deletecampaign) | Удаляет определенную кампанию.          |
| [`getCampaigns`](/ru/developer/api-reference/campaigns#getcampaigns)   | Получает список кампаний для приложения. |



## App configuration API

|    <div style="width:250px"></div>                      |                                                                                              |
|----------------------------------------------|-------------------------------------------------------------------------------------------------------------------|
| [`configureApplication for iOS`](/ru/developer/api-reference/app-configuration#configureapplication-for-ios)         | Настраивает платформу iOS для приложения.                                                                         |
| [`configureApplication for Android`](/ru/developer/api-reference/app-configuration#configureapplication-for-android) | Настраивает платформу Android для приложения.                                                                     |
| [`configureApplication for Mac OS X`](/ru/developer/api-reference/app-configuration#configureapplication-for-mac-os-x) | Настраивает платформу macOS для приложения.                                                                       |
| [`configureApplication for Windows`](/ru/developer/api-reference/app-configuration#configureapplication-for-windows) | Настраивает платформу Windows для приложения.                                                                     |
| [`configureApplication for Amazon`](/ru/developer/api-reference/app-configuration#configureapplication-for-amazon)   | Настраивает платформу Amazon для приложения.                                                                      |
| [`configureApplication for Chrome`](/ru/developer/api-reference/app-configuration#configureapplication-for-chrome)   | Настраивает платформу Chrome для приложения.                                                                      |
| [`configureApplication for Safari`](/ru/developer/api-reference/app-configuration#configureapplication-for-safari)   | Настраивает платформу Safari для приложения.                                                                      |
| [`configureApplication for Firefox`](/ru/developer/api-reference/app-configuration#configureapplication-for-firefox) | Настраивает платформу Firefox для приложения.                                                                     |
| [`configureApplication for Email`](/ru/developer/api-reference/app-configuration#configureapplication-for-email)     | Настраивает платформу Email для приложения.                                                                       |



## Email API

|                  <div style="width:250px"></div>                      |                                                                                                |
|----------------------------------------------|-------------------------------------------------------------------------------------------------------------------|
| [`createEmailMessage`](/ru/developer/api-reference/email-api#createemailmessage) <Badge text="Устарел" variant="caution" size="small" /> | Создает email-сообщение. Вместо него используйте [`Notify`](/ru/developer/api-reference/messaging-api-v2/notify/) с `platforms: ["EMAIL"]` и [`email_payload`](/ru/developer/api-reference/messaging-api-v2/email-payload-reference/). |
| [`registerEmail`](/ru/developer/api-reference/email-api#registeremail)           | Регистрирует email-адрес для приложения.                                                                          |
| [`deleteEmail`](/ru/developer/api-reference/email-api#deleteemail)               | Удаляет email-адрес из вашей базы данных.                                                                     |
| [`setEmailTags`](/ru/developer/api-reference/email-api#setemailtags)             | Устанавливает значения тегов для указанного email-адреса.                                                                 |
| [`registerEmailUser`](/ru/developer/api-reference/email-api#registeremailuser)   | Связывает внешний User ID с указанным email-адресом.                                                   |



## Test devices API

|                <div style="width:250px"></div>                       |                                                                                                |
|----------------------------------------------|-------------------------------------------------------------------------------------------------------------------|
| [`createTestDevice`](/ru/developer/api-reference/test-devices#createtestdevice)  | Регистрирует тестовое устройство для приложения.                                                                     |
| [`listTestDevices`](/ru/developer/api-reference/test-devices#listtestdevices)    | Получает все тестовые устройства, зарегистрированные для приложения.                                                       |



## Message inbox API

|                <div style="width:250px"></div>                       |                                                                                                 |
|------------------------------------------------|-------------------------------------------------------------------------------------------------------------------|
| [`getInboxMessages`](/ru/developer/api-reference/message-inbox/#getinboxmessages) | Получает список сообщений из папки "Входящие" для указанного HWID.                                                       |
| [`inboxStatus`](/ru/developer/api-reference/message-inbox#inboxstatus)             | Обновляет статус определенного сообщения из папки "Входящие".                                                                  |



## Statistics API
### Статистика сообщений
|     <div style="width:250px"></div>  |  |
|----------------------------------------------|--------------------------------------------------------------------------------------------------|
| [`messages:list`](/ru/developer/api-reference/statistics-api/message-statistics-api/#messageslist) | Получает список отправленных сообщений. |
| [`totalsByIntervals`](/ru/developer/api-reference/statistics-api/message-statistics-api/#totalsbyintervals) | Предоставляет метрики и данные о конверсиях, агрегированные по часам. |
| [`getMessageLog`](/ru/developer/api-reference/statistics-api/message-statistics-api/#getmessagelog) | Получает подробную информацию об отправленных сообщениях. |
| [`linksInteractions`](/ru/developer/api-reference/statistics-api/message-statistics-api/#emailslinksinteractions) | Предоставляет статистику по кликам на ссылки в email. |
| [`linksInteractionsDevices`](/ru/developer/api-reference/statistics-api/message-statistics-api/#emailslinksinteractionsdevices) | Перечисляет пользователей, которые кликнули на ссылки в email. |
| [`bouncedEmails`](/ru/developer/api-reference/statistics-api/message-statistics-api/#bouncedemails) | Предоставляет информацию о возвратах email, жалобах и причинах возвратов. |

### Статистика приложений и подписчиков
|      <div style="width:250px"></div>  |  |
|----------------------------------------------|--------------------------------------------------------------------------------------------------|
| [`getApplicationSubscribersStats`](/ru/developer/api-reference/statistics-api/application-subscriber-statistics/#getapplicationsubscribersstats) | Получает статистику подписчиков приложения, сгруппированную по типу устройства. |
| [`getAppStats`](/ru/developer/api-reference/statistics-api/application-subscriber-statistics/#getappstats) | Получает статистику приложения за определенный период времени. |
| [`getSubscribersStatistics`](/ru/developer/api-reference/statistics-api/application-subscriber-statistics/#getsubscribersstatistics) | Получает статистику подписчиков за определенный период времени. |

### Статистика кампаний
|     <div style="width:250px"></div>   |  |
|----------------------------------------------|--------------------------------------------------------------------------------------------------|
| [`getCampaignStats`](/ru/developer/api-reference/statistics-api/campaign-statistics/) | Получает статистику кампании за определенный период времени. |

### Статистика событий и тегов
|     <div style="width:250px"></div>   |  |
|----------------------------------------------|--------------------------------------------------------------------------------------------------|
| [`getEventStatistics`](/ru/developer/api-reference/statistics-api/events-and-tags-statistics/#geteventstatistics) | Получает количество срабатываний события за определенный период. |
| [`getTagStats`](/ru/developer/api-reference/statistics-api/events-and-tags-statistics/#gettagstats) | Получает статистику по определенному тегу. |


## iOS Live Activities API

|                <div style="width:250px"></div>                 |                                                                                             |
|------------------------------------------------|-------------------------------------------------------------------------------------------------------------------|
| [`startLiveActivity`](/ru/developer/api-reference/ios-live-activities-api#startliveactivity) | Создает новое iOS Live Activity.                                                                                 |
| [`updateLiveActivity`](/ru/developer/api-reference/ios-live-activities-api#updateliveactivity) | Обновляет существующее iOS Live Activity.                                                                           |


## Apple Wallet PassKit API

|                <div style="width:250px"></div>                 |                                                                                             |
|------------------------------------------------|-------------------------------------------------------------------------------------------------------------------|
| [`Apple Wallet PassKit API`](/ru/developer/api-reference/apple-wallet-passkit-api/) | Справочник по управлению картами Apple Wallet и соответствующей конфигурации в Pushwoosh. |


## Google Wallet API

|                <div style="width:250px"></div>                 |                                                                                             |
|------------------------------------------------|-------------------------------------------------------------------------------------------------------------------|
| [`Create a pass`](/ru/developer/api-reference/google-wallet-api/#create-a-pass) | Создает карту в Google Wallet и возвращает ссылку для сохранения. |
| [`Validate a pass`](/ru/developer/api-reference/google-wallet-api/#validate-a-pass) | Проверяет конфигурацию карты без ее создания. |
| [`Update a pass`](/ru/developer/api-reference/google-wallet-api/#update-a-pass) | Обновляет существующую карту. Google доставляет изменения на сохраненные устройства. |
| [`Get a save link`](/ru/developer/api-reference/google-wallet-api/#get-a-save-link) | Возвращает ссылку "Добавить в Google Wallet" для сохранения существующей карты. |
| [`Get a pass`](/ru/developer/api-reference/google-wallet-api/#get-a-pass) | Возвращает одну сохраненную карту. |
| [`List passes`](/ru/developer/api-reference/google-wallet-api/#list-passes) | Возвращает постраничный список карт для приложения. |
| [`Set pass state`](/ru/developer/api-reference/google-wallet-api/#set-pass-state) | Активирует или делает недействительной карту. |
| [`Delete a pass`](/ru/developer/api-reference/google-wallet-api/#delete-a-pass) | Делает карту недействительной в Google и удаляет ее запись в Pushwoosh. |
| [`Get configuration`](/ru/developer/api-reference/google-wallet-api/#get-configuration) | Возвращает состояние конфигурации Google Wallet для приложения. |
| [`Templates`](/ru/developer/api-reference/google-wallet-api/#templates) | Перечисляет шаблоны карт или извлекает один из них в качестве отправной точки. |


## Customer Journey API

|                          <div style="width:250px"></div>                                                             |                                    |
|------------------------------------------------------------------------------------------|--------------------------------------------------|
| [`Lifecycle`](/ru/developer/api-reference/customer-journey-api/lifecycle/) | Запускает, приостанавливает, завершает, переводит в черновик или архивирует journey по его UUID. |
| [`Create and update`](/ru/developer/api-reference/customer-journey-api/create-update/) | Создает новое определение journey или заменяет существующее. |
| [`Start by API`](/ru/developer/api-reference/customer-journey-api/start-by-api/) | Вводит пользователей в точку входа API запущенного journey. |
| [`Get Journey stats`](/ru/developer/api-reference/customer-journey-api/statistics/) | Получает статистику для определенного journey по его ID. |
| [`Remove users from journeys`](/ru/developer/api-reference/customer-journey-api/drop-users/) | Удаляет одного или нескольких пользователей из всех или выбранных активных journeys. |


## Scheduled requests API

|                        <div style="width:250px"></div>                                |                                     |
|--------------------------------------------------------------|--------------------------------------------------|
| [`getResults`](/ru/developer/api-reference/scheduled-requests#getresults) | Получает результат запланированного запроса.    |



## SMS API

|                      <div style="width:250px"></div>                                        |                  |
|-------------------------------------------------------------------|-------------------------------|
| [`createSMSMessage`](/ru/developer/api-reference/sms#createsmsmessage) <Badge text="Устарел" variant="caution" size="small" /> | Создает новое SMS-сообщение. Вместо него используйте [`Notify`](/ru/developer/api-reference/messaging-api-v2/notify/) с `platforms: ["SMS"]`. |



## WhatsApp API

|                 <div style="width:250px"></div>                      |                                                                                              |
|----------------------------------------------|-------------------------------------------------------------------------------------------------------------------|
| [`createWhatsAppMessage`](/ru/developer/api-reference/whatsapp#createwhatsappmessage) <Badge text="Устарел" variant="caution" size="small" /> | Создает новое сообщение WhatsApp. Вместо него используйте [`Notify`](/ru/developer/api-reference/messaging-api-v2/notify/) с `platforms: ["WHATS_APP"]`. |

## LINE API

|                 <div style="width:250px"></div>                      |                                                                                              |
|----------------------------------------------|-------------------------------------------------------------------------------------------------------------------|
| [`createLineMessage`](/ru/developer/api-reference/line-api/) <Badge text="Устарел" variant="caution" size="small" /> | Создает новое сообщение LINE. Вместо него используйте [`Notify`](/ru/developer/api-reference/messaging-api-v2/notify/) с `platforms: ["LINE"]`. |

## Kakao API

|                 <div style="width:250px"></div>                      |                                                                                              |
|----------------------------------------------|-------------------------------------------------------------------------------------------------------------------|
| [`createKakaoMessage`](/ru/developer/api-reference/kakao/#createkakaomessage) <Badge text="Устарел" variant="caution" size="small" /> | Отправляет сообщение Kakao, используя утвержденный шаблон. Вместо него используйте [`Notify`](/ru/developer/api-reference/messaging-api-v2/notify/) с `platforms: ["KAKAO"]`. |

## Geozones API

|  <div style="width:250px"></div>           |  |
|-------------------------|-------------|
| [`getNearestZone`](/ru/developer/api-reference/geozones#getnearestzone) | Получает параметры ближайшей геозоны и расстояние до нее. Также записывает местоположение устройства для гео-push-уведомлений. |
| [`addGeoZone`](/ru/developer/api-reference/geozones#addgeozone) | Добавляет геозону к определенному приложению. |
| [`updateGeoZone`](/ru/developer/api-reference/geozones#updategeozone) | Обновляет свойства геозоны, такие как имя, статус, контент и радиус действия. |
| [`deleteGeoZone`](/ru/developer/api-reference/geozones#deletegeozone) | Удаляет геозоны из приложения. |
| [`addGeoZoneCluster`](/ru/developer/api-reference/geozones#addgeozonecluster) | Добавляет кластер геозон в приложение. |
| [`deleteGeoZoneCluster`](/ru/developer/api-reference/geozones#deletegeozonecluster) | Удаляет кластер геозон из приложения. |
| [`listGeoZones`](/ru/developer/api-reference/geozones#listgeozones) | Получает список геозон для приложения. |
| [`listGeoZoneClusters`](/ru/developer/api-reference/geozones#listgeozoneclusters) | Получает список кластеров геозон для приложения. |