Доступные ресурсы eSputnik Public API Available resources eSputnik public API

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
dateFrom	Обязательный параметр. Дата и время, с которого учитывать активность контактов. Required parameter. Initial date and time of the period you want to get the contact activity for.
dateTo	Обязательный параметр. Дата и время, до которого учитывать активность контактов. Required parameter. Final date and time of the period you want to get the contact activity for.
email	Email. Email address.
sms	Номер телефона контакта. Contact's phone number.
webPushToken	Web-push токен. Web-push token.
mobPushToken	Mobile Push токен. Mobile Push token.
messageTag	Метка сообщения. Message tag.
activityStatus	Активность контакта (DELIVERED, UNDELIVERED, READ, UNSUBSCRIBED, CLICKED, SPAM). Activity status (DELIVERED, UNDELIVERED, READ, UNSUBSCRIBED, CLICKED, SPAM)
offset	Смещение последней найденной активности из результатов предыдущего поиска для продолжения вычитки. См ContactActivity#offset Last found contact activity offset in previous search results. It is used to continue search. See ContactActivity#offset
maxrows	Максимальное количество возвращаемых событий активности. Max number of activity entries in response.	25000

/v2/contacts/messages

История сообщений для контакта. Поддерживаемые медиа типы: Email, SMS, Viber, Mobile Push, Web Push, App Inbox, Telegram.

Get contact's message history.
The method returns the contact's message history. Supported media types: Email, SMS, Viber, Mobile Push, Web Push, App Inbox, Telegram.

Тип метода:

Type of method:

GET.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
dateFrom	Обязательный параметр. Дата или дата со временем, с которого вычитывать историю контакта. Значения даты/времени передаются в формате ISO_8061 Формат для даты: YYYY-MM-DD Формат для даты со временем: YYYY-MM-DDTHH:mm Required parameter. The initial date or date and time of the history period. The date/time values are passed in the ISO_8061 format. Date format: YYYY-MM-DD Date with time format: YYYY-MM-DDTHH:mm
dateTo	Обязательный параметр. Дата или дата со временем, до которого вычитывать историю контакта. Значения даты/времени передаются в формате ISO_8061 Формат для даты: YYYY-MM-DD Формат для даты со временем: YYYY-MM-DDTHH:mm Required parameter. The final date or date and time of the history period. The date/time values are passed in the ISO_8061 format. Date format: YYYY-MM-DD Date with time format: YYYY-MM-DDTHH:mm
email	Email (только один из contactId, email, phone должен быть указан). Email (only one of contactId, email, phone must be specified).
phone	Номер телефона контакта (только один из contactId, email, phone должен быть указан). Contact's phone number (only one of contactId, email, phone must be specified).
sms	Устаревшее. Синоним для phone. Deprecated. Synonym for phone.
contactId	Идентификатор контакта (только один из contactId, email, phone должен быть указан). Contact ID (only one of contactId, email, phone must be specified).
offset	Смещение относительно первой записи. Для пагинации. Дефолтное значение - 0 Offset from the first item. For pagination purposes. The default value is 0	0
maxrows	Максимальное количество возвращаемых записей. Дефолтное значение - 10. Масимальное значение - 100 Max amount of items in the response. The default value is 10. The maximum value is 100	10

/v2/contacts/recoms/{dataSourceId}

Рекомендации для контакта, основанные на веб-трекинге.

Contact recommendations based on web tracking.
The method returns recommendations for a contact based on the web tracking.

Тип метода:

Type of method:

GET.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
dataSourceId	Обязательный параметр. Идентификатор источника данных. Можно увидеть в Вашем аккаунте > Настройки > Источники данных Required parameter. Data Source ID. Сan be found in your account> Settings> Data Sources
contactId	Идентификатор контакта. Хотя бы один из contactId, email, phone, externalCustomerId, webId должен быть указан Contact ID. At least one of contactId, email, phone, externalCustomerId, webId must be specified
email	Email контакта. Хотя бы один из contactId, email, phone, externalCustomerId, webId должен быть указан Contact's email address. At least one of contactId, email, phone, externalCustomerId, webId must be specified
phone	Номер телефона контакта. Хотя бы один из contactId, email, phone, externalCustomerId, webId должен быть указан Contact's phone number. At least one of contactId, email, phone, externalCustomerId, webId must be specified
externalCustomerId	Внешний идентификатор контакта. Хотя бы один из contactId, email, phone, externalCustomerId, webId должен быть указан External Customer ID. At least one of contactId, email, phone, externalCustomerId, webId must be specified
webId	Веб идентификатор контакта. Хотя бы один из contactId, email, phone, externalCustomerId, webId должен быть указан Web ID. At least one of contactId, email, phone, externalCustomerId, webId must be specified
sms	Устаревшее. Синоним для phone Deprecated. Synonym for phone
products	Список идентификаторов продуктов. Обязательное поле для product-based алгоритмов Array of product IDs. Required for the product-based algorithms
category	Идентификатор категории. Обязательное поле для category-based алгоритмов Сategory ID. Required for the category-based algorithms

/v2/event

Сгенерировать событие.
Метод используется для генерации событий в аккаунте, которые могут быть использованы для запуска сценария или учитываться при сегментации.
Максимальный размер контента для событий, отправляемых в теле запроса, составляет 20 кБ.
Управление заказами через события.
Внимание: Методы API версии 2 не требуют экранирования вложенного JSON.

Generate event.
The method is used for generating events in the account to be used for starting a workflow or being taken into account for segmentation.
Max. size of content for events sent in the request body is 20 kB.
To learn more, read Order Transfer Using the Generate event API Method.
NOTE: Version 2 API methods do not require escaping in nested JSON.

Тип метода:

Type of method:

POST.

/v2/past_events

Сгенерировать события за прошедшее время.
Сценарии по данным событиям запущены не будут. В одном запросе может быть до 500 событий. Подробнее. Внимание: Методы API версии 2 не требуют экранирования вложенного JSON.

Generate past events.
The method is used for transferring the available event data from your CRM or other data store to our system. Workflows are not launched for these events. You can send up to 500 events per a request. Learn more.
NOTE: Version 2 API methods do not require escaping in nested JSON.

Тип метода:

Type of method:

POST.

/v2/version

Получить версию протокола.

Get protocol version.

Тип метода:

Type of method:

GET.

/v1/account/info

Получить информацию об аккаунте.

Get account info.

Тип метода:

Type of method:

GET.

/v1/addressbooks

Получить список каталогов.
Каталог содержит списки дополнительных полей для контактов, которые доступны в вашей организации.

Get catalog list.
The catalog contains the list of additional fields for contacts that are available in your organisation.

Тип метода:

Type of method:

GET.

/v1/apps/{app_uuid}/tokens

Добавление токенов приложения.
Метод используется для добавления токенов приложения.

Add application tokens.
The method is used to add application tokens.

Тип метода:

Type of method:

POST.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
app_uuid	Идентификатор приложения Application ID

/v1/auth/token

Сгенерировать API token(Bearer Authentication).
Используйте токен только если вам по определенным причинам не подходит Basic-авторизация по логину и паролю.
Методы, для которых доступна авторизация по токену:
POST /v1/event
POST /v1/past_events
DELETE /v1/past_events

Generate API token(Bearer Authentication).
Use token only if Basic authentication is not appropriate for you.
Available methods for token authorization:
POST /v1/event
POST /v1/past_events
DELETE /v1/past_events

Тип метода:

Type of method:

POST.

/v1/balance

Получить баланс организации.

Get organisation balance.

Тип метода:

Type of method:

GET.

/v1/balance/history

Получить историю биллинга организации.

Get organisation billing history.

Тип метода:

Type of method:

GET.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
dateFrom
dateTo

/v1/broadcast

Создать рассылку. Метод используется для создания рассылок через каналы Email, SMS, Mobile Push, Web Push, Viber, Telegram.

Create broadcast. The method is used for creating broadcasts for Email, SMS, Mobile Push, Web Push, Viber, Telegram channels.

Тип метода:

Type of method:

POST.

/v1/broadcast/{broadcast_id}

Получить информацию о рассылке.

Get broadcast info.

Тип метода:

Type of method:

GET.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
broadcast_id	Идентификатор рассылки Broadcast id

/v1/broadcast/{broadcast_id}

Отменить запланированную рассылку.

Cancel scheduled broadcast.

Тип метода:

Type of method:

DELETE.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
broadcast_id	Идентификатор рассылки Broadcast id

/v1/broadcasts

Получить список рассылок.

Get broadcasts.

Тип метода:

Type of method:

GET.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
startindex	Номер первой возвращаемой рассылки. Нумерация начинается с 1. Number of the first returned broadcast. Numbering starts from 1.	1
maxrows	Максимальное количество возвращаемых рассылок (не более 500). Max amount of broadcasts in the response (max 500).	10

/v1/contact

Добавить или обновить контакт.
Метод используется для добавления нового контакта или обновления существующего.
Поле ID будет проигнорировано.
Чтобы узнать больше об импорте или обновлении контактов и их дополнительных полей, прочтите Importing Historical Data.

Add/update a contact.
The method is used to add a new or update an existing contact.
The ID field is ignored.
To learn more about importing or updating contacts and their additional fields, read Importing Historical Data.

Тип метода:

Type of method:

POST.

/v1/contact

Удалить контакт по externalCustomerId.
Метод используется для удаления контакта, идентифицированного по externalCustomerId.

Delete contact by externalCustomerId.
The method is used for deleting a contact identified by externalCustomerId.

Тип метода:

Type of method:

DELETE.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
externalCustomerId	Внешний идентификатор контакта External contact ID. Contact ID
erase	Безвозвратное удаление всех контактных данных: атрибутов контактного профиля, контактной активности, веб- и мобильного трекинга. Восстановить удаленные данные невозможно. Permanent deletion of all contact data: contact profile attributes, contact activity, web- and mobile tracking. It is not possible to recover deleted data.	false

/v1/contact/{id}

Получить контакт.
Метод возвращает имеющуюся информацию о контакте по его ID.

Get contact.
The method returns the available information about the contact identified by the contact ID.

Тип метода:

Type of method:

GET.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
id	Id контакта. Contact ID.

/v1/contact/{id}

Обновить контакт.
Метод используется для обновления данных контакта, за исключением поля ID контакта.
При обновлении контакта который был удален, этот контакт будет восстановлен.

Update contact.
The method is used to update the contact's data, except for the contact ID field.
In case of updating a deleted contact, this contact is restored.

Тип метода:

Type of method:

PUT.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
id	Идентификатор контакта Contact ID

/v1/contact/{id}

Удалить контакт.
Метод используется для удаления контакта, идентифицированного по contactID.

Delete contact.
The method is used for deleting a contact identified by contactID.

Тип метода:

Type of method:

DELETE.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
id	Идентификатор контакта Contact ID Contact ID
erase	Безвозвратное удаление всех данных контакта: атрибуты профиля контакта, активность контакта, веб- и мобильный трекинг. Восстановить удаленные данные невозможно. Permanent deletion of all contact's data: contact profile attributes, contact activity, web- and mobile tracking. It is not possible to recover the deleted data.	false

/v1/contact/{id}/subscriptions

Получение категорий, на которые подписан контакт.

Returns subscriptions which a contact is subscribed to.

Тип метода:

Type of method:

GET.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
id	Идентификтор контакта Contact ID

/v1/contact/{id}/subscriptions

Изменение категорий, на которые подписан контакт.

Change contact subscription categories.

Тип метода:

Type of method:

PUT.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
id	Идентификтор контакта Contact ID

/v1/contact/subscribe

Подписать контакт.
Используется для интеграции форм подписки.
Если контакт не существует, он будет создан с неподтверждённым email.
Если контакт существует, поля контакта будут обновлены (за исключением существующих медиа-каналов).
Новые контакты создаются со статусом Неподтвержденный.

Subscribe a contact.
Used for the integration of subscription forms.
If a contact does not exist, it is created with the non-confirmed email.
If a contact exists, the contact fields are updated (except existing media channels).
New contacts are created with the Not confirmed status.

Тип метода:

Type of method:

POST.

/v1/contact/token/{app_uuid}/{token_id}/contactId

Получение ID контакта по токену.
Метод используется для получения ID контакта используя ID токен.

Get contact ID by token.
The method is used for getting the ID of a contact using the token ID.

Тип метода:

Type of method:

GET.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
app_uuid	Идентификатор приложения Application ID
token_id	Токен Token ID

/v1/contact/token/activated/{app_uuid}/{token_id}

Изменение активности токена

Change token activity

Тип метода:

Type of method:

PUT.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
token_id	Токен Token id
app_uuid	Идентификатор приложения Application id

/v1/contact/token/activated/{app_uuid}/{token_id}

Получение активности токена

Get token activity

Тип метода:

Type of method:

GET.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
token_id	Токен Token id
app_uuid	Идентификатор приложения Application id

/v1/contacts

Поиск контактов.
Метод возвращает не более 500 результатов.
В заголовке TotalCount указано общее число контактов.

Search for contacts.
The method returns max 500 results.
The total amount of contacts is in the TotalCount header.

Тип метода:

Type of method:

GET.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
externalCustomerId	Внешний идентификатор контакта. External contact ID.
email	Email. Email.
sms	Номер телефона контакта. Contact phone number.
firstname	Имя контакта. Contact name.
lastname	Фамилия контакта. Contact last name.
startindex	Номер первого возвращаемого контакта из результатов поиска. Нумерация начинается с 1. The number of the first contact returned in the search results. Numbering begins at 1.	1
maxrows	Максимальное количество возвращаемых контактов (не более 500). Maximum number of returned contacts (max 500).	500
sortBy	Возможное значение - 'contactId'. Актуально для поисков без условий. По умолчанию, поиск осуществляется по дате обновления контакта. При использовании данного параметра, сортировка производится по contactId. Использование этого параметра позволяет ускорить выгрузку всех контактов. Possible value is 'contactId'. Only actual for searches without conditions. By default, the date of contact update is used for the search. If this parameter is used, sorting is done by contactId. Using this parameter allows you to upload contacts faster.

/v1/contacts

Добавить/обновить контакты.
Существующие контакты будут обновлены, новые - добавлены.

Add/update contacts.
The method adds new contacts and updates existing contacts.

Тип метода:

Type of method:

POST.

/v1/contacts/email

Получить email по идентификатору контакта.
Метод используется для получения адресов электронной почты контактов по их contactID.

Get email by contact id.
The method is used for getting the email addresses of contacts by their contactID.

Тип метода:

Type of method:

GET.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
ids	Идентификаторы контактов, для которых будут получены email-ы, разделённые запятыми. Comma separated list of contact IDs to get emails for.

/v1/contacts/upload

Добавить/обновить контакты из внешнего файла.
Существующие контакты будут обновлены, новые - добавлены.

Add/update contacts from external file.
Existing contacts will be updated, new contacts will be created.

Тип метода:

Type of method:

POST.

/v1/emails/unsubscribed/add

Добавить email адреса в список отписавшихся (отписать email-ы).

Add emails to unsubscribed list (unsubscribe emails).

Тип метода:

Type of method:

POST.

/v1/emails/unsubscribed/delete

Удалить email адреса из списка отписавшихся.

Remove emails from unsubscribed list.

Тип метода:

Type of method:

POST.

/v1/event OLD

Этот метод устарел и вскоре будет удалён.

This method is deprecated and will be deleted soon.

Сгенерировать событие. Метод устарел, используйте v2/event вместо него.
Метод используется для генерации событий в аккаунте, которые могут быть использованы для запуска сценария или учитываться при сегментации.
Максимальный размер контента для событий, отправляемых в теле запроса, составляет 20 кБ.
Управление заказами через события.
Управление заказами через события.

Generate event. Method is deprecated, use v2/event instead.
The method is used for generating events in the account to be used for starting a workflow or being taken into account for segmentation.
Max. size of content for events sent in the request body is 20 kB.
To learn more, read Order Transfer Using the Generate event API Method.
Order management via events.

Тип метода:

Type of method:

POST.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
source

/v1/group/{id}/contacts

Поиск всех контактов в группе.

Get contacts from segment.

Тип метода:

Type of method:

GET.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
id	Идентификатор группы. Segment ID
startindex	Номер первого возвращаемого контакта из результатов поиска. Нумерация начинается с 1. Number of the first returned contact from search results. Numbering starts from 1.	1
maxrows	Максимальное количество возвращаемых контактов (не более 500). Max amount of contacts in the response (max 500).	500
orderByTs		false
asc		true

/v1/group/{id}/contacts/attach

Добавление контактов по id или внешнему id в статическую группу.

Attach contacts to static segment.

Тип метода:

Type of method:

POST.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
id	Идентификатор группы. Segment ID

/v1/group/{id}/contacts/detach

Удалить контакты по id или внешнему id из статической группы.

Delete all contacts from static segment.

Тип метода:

Type of method:

POST.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
id	Идентификатор группы. Segment ID

/v1/groups

Поиск групп.

Get segments.

Тип метода:

Type of method:

GET.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
name	Название группы. Segment name.
startindex	Номер первой возвращаемой группы из результатов поиска. Нумерация начинается с 1. Number of the first returned segment from search results. Numbering starts from 1.	1
maxrows	Максимальное количество возвращаемых групп (не более 500). Max amount of segments in the response (max 500).	500

/v1/importstatus/{sessionId}

Получение статуса сессии импорта контактов по асинхронному идентификатору сессии.

Get contact import session status by asynchronous session ID.

Тип метода:

Type of method:

GET.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
sessionId	Асинхронный идентификатор сессии Asynchronous session identifier

/v1/interactions/{interaction_id}/status

Обновить статус отправки

Update interaction status

Тип метода:

Type of method:

PUT.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
interaction_id	Идентификатор отправки Interaction id

/v1/interfaces/email

Получить email-интерфейсы (имена отправителей).

Get email interfaces

Тип метода:

Type of method:

GET.

/v1/interfaces/sms

Получить sms-интерфейсы (имена отправителей).

Get SMS interfaces (alpha names)

Тип метода:

Type of method:

GET.

/v1/message/{id}/send OLD

Этот метод устарел и вскоре будет удалён.

This method is deprecated and will be deleted soon.

Отправка рассылки по заранее созданному сообщению. Сообщение может дополнительно параметризироваться.
Метод устарел. Рекомендуется использовать вместо него метод /v1/message/{id}/smartsend.

Dispatch start of the created message. Message can be parametrized additionally.
Method is deprecated. It is recommended to use method /v1/message/{id}/smartsend instead.

Тип метода:

Type of method:

POST.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
id	ID сообщения. Поддерживаются email, SMS и Viber сообщения. Message ID. Currently email, SMS and Viber messages are supported.

/v1/message/{id}/smartsend

Метод используется для отправки подготовленных сообщений одному или многим контактам. Вы можете создавать рассылки для каналов Email, SMS, Mobile Push, Web Push, Viber, Telegram Bot. Сообщение может параметризироваться для каждого контакта отдельно.

The method is used for sending a prepared message to one or many contacts. You can create broadcasts for Email, SMS, Mobile Push, Web Push, Viber, Telegram Bot channels. The message can be parametrized for each contact separately.

Тип метода:

Type of method:

POST.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
id	ID сообщения. Поддерживаются Email, SMS, Mobile Push, Web Push, Viber, Telegram Bot сообщения. Message ID. Currently Email, SMS, Mobile Push, Web Push, Viber, Telegram Bot messages are supported.

/v1/message/email

Отправить email-сообщение. Если контакта с таким адресом нет, он будет создан.

Send email message. If contact with such email address is not exist it will be created.

Тип метода:

Type of method:

POST.

/v1/message/email/status OLD

Этот метод устарел и вскоре будет удалён.

This method is deprecated and will be deleted soon.

Получить статус одиночного email сообщения.
Meтод устарел. Рекомендуется использовать вместо него метод /v1/message/status.

Get status of a single email message.
Method is deprecated. It is recommended to use method /v1/message/status instead.

Тип метода:

Type of method:

GET.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
ids	Идентификаторы одиночных сообщений, для которых будут получены статусы, разделённые запятыми. Comma separated list of IDs of single messages.

/v1/message/sms

Отправить sms-сообщение. Если контакта с таким номером телефона нет, он будет создан.

Send SMS message. If contact with such phone number is not exist it will be created.

Тип метода:

Type of method:

POST.

/v1/message/sms/status OLD

Этот метод устарел и вскоре будет удалён.

This method is deprecated and will be deleted soon.

Получить статус одиночного sms сообщения.
Meтод устарел. Рекомендуется использовать вместо него метод /v1/message/status.

Get status of the single SMS message.
Method is deprecated. It is recommended to use method /v1/message/status instead.

Тип метода:

Type of method:

GET.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
ids	Идентификаторы одиночных сообщений, для которых будут получены статусы, разделённые запятыми. Comma separated list of IDs of single messages.

/v1/message/status

Получить статус одиночного сообщения.

Get status of a single message.

Тип метода:

Type of method:

GET.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
ids	Идентификаторы одиночных сообщений, для которых будут получены статусы, разделённые запятыми. Comma separated list of IDs of single messages.

/v1/message/viber

Отправить Viber сообщение. Если контакта с таким номером телефона нет, он будет создан.

Send Viber message. If contact with such phone number is not exist it will be created.

Тип метода:

Type of method:

POST.

/v1/message/viber/status OLD

Этот метод устарел и вскоре будет удалён.

This method is deprecated and will be deleted soon.

Получить статус одиночного Viber сообщения.
Meтод устарел. Рекомендуется использовать вместо него метод /v1/message/status.

Get status of the single Viber message.
Method is deprecated. It is recommended to use method /v1/message/status instead.

Тип метода:

Type of method:

GET.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
ids	Идентификаторы одиночных сообщений, для которых будут получены статусы, разделённые запятыми. Comma separated list of IDs of single messages.

/v1/messages/appinbox

Поиск app inbox сообщений по части названия или метки.
Метод возвращает не более 500 сообщений.
В заголовке TotalCount указано количество сообщений, которое вернул запрос.

Search for app inbox messages by part of name or tag.
Method returns maximum of 500 messages.
TotalCount header contains number of messages returned by query.

Тип метода:

Type of method:

GET.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
search	Условие поиска (часть названия сообщения или метки). Search condition (part of message name or tag).
startindex	Индекс первого возвращаемого сообщения из результатов поиска. Нумерация начинается с 1. Index of first message to return from search result. Numbering starts from 1.	1
maxrows	Максимальное количество возвращаемых сообщений (не более 500). Maximum number of messages to return (not more than 500).	500

/v1/messages/appinbox

Добавить базовое app inbox сообщение.

Add base app inbox message

Тип метода:

Type of method:

POST.

/v1/messages/appinbox/{id}

Обновить базовое app inbox сообщение.

Update base app inbox message.

Тип метода:

Type of method:

PUT.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
id	Идентификатор app inbox сообщения. App inbox message ID.

/v1/messages/appinbox/{id}

Получить app inbox сообщение.

Get the app inbox message.

Тип метода:

Type of method:

GET.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
id	Идентификатор app inbox сообщения. App inbox message id.

/v1/messages/appinbox/{id}

Удалить базовое app inbox сообщение.

Delete base app inbox message.

Тип метода:

Type of method:

DELETE.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
id	Идентификатор app inbox сообщения. App inbox message id.

/v1/messages/appinbox/{id}/{language}

Обновить языковую версию app inbox сообщения.

Update language version of app inbox message.

Тип метода:

Type of method:

PUT.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
id	Идентификатор app inbox сообщения. App inbox message id.
language	Код языка app inbox сообщения. App inbox message language code.

/v1/messages/appinbox/{id}/{language}

Удалить языковую версию app inbox сообщения.

Delete language version for app inbox message.

Тип метода:

Type of method:

DELETE.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
id	Идентификатор app inbox сообщения. App inbox message id.
language	Код языка app inbox сообщения. App inbox message language code.

/v1/messages/email

Добавить базовое email-сообщение.

Add base email message.

Тип метода:

Type of method:

POST.

/v1/messages/email

Поиск email-сообщений по части названия или метки.
Метод возвращает не более 500 сообщений.
В заголовке TotalCount указано количество сообщений, которое вернул запрос.

Search email messages by part of name or tag.
Method returns maximum of 500 messages. TotalCount header contains number of messages returned by query.

Тип метода:

Type of method:

GET.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
search	Условие поиска (часть названия сообщения или метки). Search condition (part of message name or tag).
startindex	Индекс первого возвращаемого сообщения из результатов поиска. Нумерация начинается с 1. Index of first message to return from search result. Numbering starts from 1.	1
maxrows	Максимальное количество возвращаемых сообщений (не более 500). Maximum number of messages to return (not more than 500).	500

/v1/messages/email/{id}

Получить email-сообщение.

Get email message.

Тип метода:

Type of method:

GET.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
id	Идентификатор email-сообщения. Email message id.

/v1/messages/email/{id}

Удалить базовое email-сообщение.

Delete base email message.

Тип метода:

Type of method:

DELETE.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
id	Идентификатор email-сообщения. Email message id.

/v1/messages/email/{id}

Обновить базовое email-сообщение.

Update base email message.

Тип метода:

Type of method:

PUT.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
id	Идентификатор email-сообщения. Email message id.

/v1/messages/email/{id}/{language}

Удалить дочернее email-сообщение.

Delete translated email message.

Тип метода:

Type of method:

DELETE.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
id	Идентификатор email-сообщения. Email message id.
language	Код языка email-сообщения Согласно ISO_639-1 Email message language code According to ISO_639-1

/v1/messages/email/{id}/{language}

Обновить дочернее email-сообщение

Update translated email message.

Тип метода:

Type of method:

PUT.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
id	Идентификатор email-сообщения. Email message id.
language	Код языка email-сообщения Согласно ISO_639-1 Email message language code According to ISO_639-1

/v1/messages/email/{id}/viewLink

Получить ссылку для просмотра email сообщения.

Get email message view link.

Тип метода:

Type of method:

GET.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
id	Идентификатор сообщения Message id

/v1/messages/mobilepush

Поиск mobile push сообщений по части названия или метки.
Метод возвращает не более 500 сообщений.
В заголовке TotalCount указано количество сообщений, которое вернул запрос.

Search for mobile push messages by part of the name or tag.
Method returns maximum of 500 messages.
TotalCount header contains number of messages returned by query.

Тип метода:

Type of method:

GET.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
search	Условие поиска (часть названия сообщения или метки). Search condition (part of message name or tag).
startindex	Индекс первого возвращаемого сообщения из результатов поиска. Нумерация начинается с 1. Index of first message to return from search result. Numbering starts at 1.	1
maxrows	Максимальное количество возвращаемых сообщений (не более 500). Maximum number of messages to return (not more than 500).	500

/v1/messages/mobilepush

Добавить базовое mobile push сообщение.

Add base mobile push message.

Тип метода:

Type of method:

POST.

/v1/messages/mobilepush/{id}

Обновить базовое mobile push сообщение

Update base mobile push message

Тип метода:

Type of method:

PUT.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
id	Идентификатор сообщения Mobile push message id

/v1/messages/mobilepush/{id}

Получить mobile push сообщение.

Get a mobile push message.

Тип метода:

Type of method:

GET.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
id	Идентификатор mobile push сообщения. Mobile push message id.

/v1/messages/mobilepush/{id}

Удалить базовое mobile push сообщение.

Delete base mobile push message.

Тип метода:

Type of method:

DELETE.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
id	Идентификатор mobile push сообщения. Mobile push message id.

/v1/messages/mobilepush/{id}/{language}

Обновить переведенное mobile push сообщение

Update translated mobile push message

Тип метода:

Type of method:

PUT.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
id	Идентификатор mobile push сообщения Mobile push message ID
language	Код языка Language code

/v1/messages/mobilepush/{id}/{language}

Удалить языковую версию mobile push сообщения.

Delete language version of mobile push message.

Тип метода:

Type of method:

DELETE.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
id	Идентификатор mobile push сообщения. Mobile push message id.
language	Код языка. Language code.

/v1/messages/sms

Поиск sms-сообщений по части названия или метки.
Метод возвращает не более 500 сообщений.
В заголовке TotalCount указано количество сообщений, которое вернул запрос.

Search sms messages by part of name or tag.
Method returns maximum of 500 messages.
TotalCount header contains number of messages returned by query.

Тип метода:

Type of method:

GET.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
search	Условие поиска (часть названия сообщения или метки). Search condition (part of message name or tag).
startindex	Индекс первого возвращаемого сообщения из результатов поиска. Нумерация начинается с 1. Index of first message to return from search result. Numbering starts from 1.	1
maxrows	Максимальное количество возвращаемых сообщений (не более 500). Maximum number of messages to return (not more than 500).	500

/v1/messages/sms/{id}

Получить SMS-сообщение.

Get SMS message.

Тип метода:

Type of method:

GET.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
id	Идентификатор SMS-сообщения. SMS message id.

/v1/messages/telegram

Добавить базовое telegram bot сообщение.

Add base telegram bot message

Тип метода:

Type of method:

POST.

/v1/messages/telegram

Поиск telegram bot сообщений по части названия или метки.
Метод возвращает не более 500 сообщений.
В заголовке TotalCount указано количество сообщений, которое вернул запрос.

Search for telegram bot messages by part of the name or tag.
Method returns maximum of 500 messages.
TotalCount header contains number of messages returned by query.

Тип метода:

Type of method:

GET.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
search	Условие поиска (часть названия сообщения или метки). Search condition (part of message name or tag).
startindex	Индекс первого возвращаемого сообщения из результатов поиска. Нумерация начинается с 1. Index of first message to return from search result. Numbering starts at 1.	1
maxrows	Максимальное количество возвращаемых сообщений (не более 500). Maximum number of messages to return (not more than 500).	500

/v1/messages/telegram/{id}

Удалить базовое telegram bot сообщение.

Delete base telegram bot message.

Тип метода:

Type of method:

DELETE.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
id	Идентификатор telegram bot сообщения. Telegram bot id.

/v1/messages/telegram/{id}

Получить telegram bot сообщение.

Get the telegram bot message.

Тип метода:

Type of method:

GET.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
id	Идентификатор telegram bot сообщения. Telegram bot message id.

/v1/messages/telegram/{id}

Обновить базовое telegram bot сообщение

Update base telegram bot message

Тип метода:

Type of method:

PUT.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
id	Идентификатор сообщения Telegram bot message id

/v1/messages/telegram/{id}/{language}

Удалить языковую версию telegram bot сообщения.

Delete language version for telegram bot message.

Тип метода:

Type of method:

DELETE.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
id	Идентификатор telegram bot сообщения. Telegram bot message id.
language	Код языка telegram bot сообщения. Telegram bot message language code.

/v1/messages/telegram/{id}/{language}

Обновить переведенное telegram bot сообщение

Update translated telegram bot message

Тип метода:

Type of method:

PUT.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
id	Идентификатор telegram bot сообщения Telegram bot message ID
language	Код языка Language code

/v1/orders

Добавить набор заказов.
Управление заказами через события.

Add orders.
Order management via events.

Тип метода:

Type of method:

POST.

/v1/past_events OLD

Этот метод устарел и вскоре будет удалён.

This method is deprecated and will be deleted soon.

Сгенерировать события за прошедшее время. Метод устарел, используйте v2/past_events вместо него.
Сценарии по данным событиям запущены не будут. В одном запросе может быть до 500 событий. Подробнее.

Generate past events. Method is deprecated, use v2/past_events instead.
Workflows will no be launched for these events. You can send up to 500 events per request. Learn more.

Тип метода:

Type of method:

POST.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
source

/v1/past_events

Удалить события за выбранный период.

Remove events for selected period.

Тип метода:

Type of method:

DELETE.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
source

/v1/preprocessor/file/{id}

Обновить файл для препроцессора.

Update file for preprocessor.

Тип метода:

Type of method:

POST.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
id	Идентификатор файла FIle identifier

/v1/preprocessor/file/{id}/status

Получение статуса сессии загрузки файла для препроцессора по асинхронному идентификатору сессии.

Retrieving file uploading session status for pre-processor by asynchronous session identifier.

Тип метода:

Type of method:

GET.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
id	Асинхронный идентификатор сессии Asynchronous session identifier

/v1/preprocessor/file/upload

Загрузить файл для препроцессора из внешнего репозитория.

Upload file for preprocessor from external repository.

Тип метода:

Type of method:

POST.

/v1/products/config

Тип метода:

Type of method:

POST.

/v1/products/config

Тип метода:

Type of method:

GET.

/v1/promocodes

Загрузить промокоды из csv файла. Существующие промокоды обновляются.

Upload promotional codes from a CSV file. Existing promotional codes will be updated.

Тип метода:

Type of method:

POST.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
expirationDate	Дата завершения действия промокода. Term of promo code validity.
discount	Скидка. Discount.
type	Тип промокода. Type of promo code.
inUse	Флаг, использованный промокод или нет. Tag used/unused promo code.	false

/v1/promocodes

Загрузить промокоды из JSON. Существующие промокоды обновляются.

Upload promotional codes in JSON format. Existing promotional codes will be updated.

Тип метода:

Type of method:

POST.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
expirationDate	Дата завершения действия промокода. Term of promo code validity.
discount	Скидка. Discount.
type	Тип промокода. Type of promo code.
inUse	Флаг, использованный промокод или нет. Tag used/unused promo code.	false

/v1/promocodes

Получить промокоды. В этом методе возвращается список всех доступных промокодов.

Get promotional codes. The method returns a list of all available promotional codes.

Тип метода:

Type of method:

GET.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
type	Тип промокода. Type of promo code.
inUse	Был ли промокод уже использован. Tag used/unused promo code.
activeDueDays	Количество дней для подсчёта доступных промокодов (activeDueDays=7 означает: промокод будет доступен в течение следующих 7 дней, не считая сегодня). Number of days to calculate available promo codes (activeDueDays=7 means that promo code will be available for next 7 days).
discount	Скидка по промокоду. Discount.

/v1/promocodes/count

Получить количество доступных промокодов.

Get the amount of available promotional codes.

Тип метода:

Type of method:

GET.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
type	Тип промокода. Type of promo code.
activeDueDays	Количество дней для подсчёта доступных промокодов (activeDueDays=7 означает: промокод будет доступен в течение следующих 7 дней, не считая сегодня). Number of days to calculate available promo codes (activeDueDays=7 means that promo code will be available for next 7 days).
discount	Скидка по промокоду. Discount.

/v1/site/domains

Добавление домена
Метод регистрирует домен, отправленный в параметрах тела, для использования в веб-трекинге или виджетах.
Только один домен может быть зарегистрирован на организацию.

Add domain
The method registers the domain sent in the body params for use in web tracking or widgets.
Only one domain can be registered per organization.

Тип метода:

Type of method:

POST.

/v1/site/domains

Получение домена.
Метод возвращает домен вашей организации. Ответ будет пустым, если домен не найден.

Get domain
The method returns your organization's domain. The response is empty if no domain is found.

Тип метода:

Type of method:

GET.

/v1/site/script

Получить скрипт
Метод возвращает скрипт для вашего аккаунта.
Домен должен существовать в организации перед получением скрипта.
Он может быть использован для плагинов, которые автоматически устанавливают скрипт на сайт и требуют конечную точку API для получения скрипта.

Get script
The method returns the script for your account.
The domain must exist for an organization before getting a script.
It can be used for plugins that automatically install the script on the site and require the API endpoint for getting the script.

Тип метода:

Type of method:

GET.

/v1/subscriptions

Получение категорий подписок организации

Returns organization subscriptions

Тип метода:

Type of method:

GET.

/v1/version

Получить версию протокола.

Get protocol version.

Тип метода:

Type of method:

GET.