Поделиться через

Moosend (независимый издатель) (предварительная версия)

Конечная платформа маркетингового программного обеспечения и маркетинговой автоматизации электронной почты, которая не разорвит ваш банк. С сотнями up-to-date шаблоны для выбора, ваши маркетинговые кампании электронной почты будут одеты для успеха.

Этот соединитель доступен в следующих продуктах и регионах:

Услуга Class Регионы
Copilot Studio Премия Все регионы Power Automate , кроме следующих:
     - Правительство США (GCC)
     - Правительство США (GCC High)
     — Облако Китая, управляемое 21Vianet
     - Министерство обороны США (DoD)
Логические приложения Стандарт Все регионы Logic Apps , кроме следующих:
     — Регионы Azure для государственных организаций
     — Регионы Azure Для Китая
     - Министерство обороны США (DoD)
Power Apps Премия Все регионы Power Apps , кроме следующих:
     - Правительство США (GCC)
     - Правительство США (GCC High)
     — Облако Китая, управляемое 21Vianet
     - Министерство обороны США (DoD)
Power Automate Премия Все регионы Power Automate , кроме следующих:
     - Правительство США (GCC)
     - Правительство США (GCC High)
     — Облако Китая, управляемое 21Vianet
     - Министерство обороны США (DoD)
Контакт
Имя Трой Тейлор
URL https://www.hitachisolutions.com
Адрес электронной почты ttaylor@hitachisolutions.com
Метаданные соединителя
Publisher Трой Тейлор
Веб-сайт https://moosend.com/
Политика конфиденциальности https://www.sitecore.com/trust/privacy-policy
Категории Маркетинг

Создание подключения

Соединитель поддерживает следующие типы проверки подлинности:
По умолчанию Параметры для создания подключения. Все регионы Недоступен для совместного использования

По умолчанию

Применимо: все регионы

Параметры для создания подключения.

Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.

Имя Тип Description Обязательно
Ключ API securestring Ключ API для этого API True

Ограничения регулирования

Имя Вызовы Период обновления
Вызовы API для каждого подключения 100 60 секунд

Действия

Добавление нескольких подписчиков

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

Добавляет нового подписчика в указанный список рассылки.
Клонирование существующей кампании

Создает точную копию существующей кампании. Новая кампания создается в виде черновика.
Обновление настраиваемого поля

Обновляет свойства существующего настраиваемого поля в указанном списке рассылки.
Обновление подписчика

Обновляет подписчик в указанном списке рассылки.
Обновление проекта кампании

Обновляет свойства существующей кампании AB в вашей учетной записи. Не удается обновить некритовые кампании. Пропустить (AB Split Campaign Option) если вы хотите создать обычную кампанию.
Обновление списка рассылки

Обновляет свойства существующего списка рассылки.
Отмена подписки подписчика из списка рассылки

Отменяет подписку подписчика из указанного списка рассылки.
Отмена подписки подписчика из учетной записи

Отменяет подписку подписчика из учетной записи.
Отмена расписания кампании

Удаляет ранее определяемую ранее дату и время из кампании, чтобы она была доставлена немедленно, если она уже в очереди или при отправке.
Отправка кампании

Отправляет существующую проектную кампанию всем получателям, указанным в списке рассылки. Кампания отправляется немедленно.
Планирование кампании

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

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

Возвращает подробный отчет о том, что ваша кампания открывается (уникальная и общая) по странам.
Получение действия ссылки

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

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

Извлекает список активных отправителей в вашей учетной записи.
Получение подписчика по адресу электронной почты

Ищет подписчика с указанным адресом электронной почты в указанном списке рассылки.
Получение подписчика по идентификатору

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

Извлекает список всех подписчиков в указанном списке рассылки.
Получение сведений о кампании

Возвращает полный набор свойств, описывающих запрошенную кампанию подробно.
Получение сведений о списке рассылки

Получение сведений для заданного списка рассылки.
Получение сведений об отправителе

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

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

Предоставляет базовую сводку результатов для отправленной тестовой кампании AB отдельно для каждой версии (A и B), например количество получателей, открывается, щелкает, откажет, отменяет подписки, пересылает и т. д. на сегодняшний день.
Получение статистики кампании

Извлекает подробный список статистики для данной кампании на основе таких действий, как отправленные сообщения электронной почты, открытые, отскочили, щелкнули ссылку и т. д.
Создание настраиваемого поля

Создает новое настраиваемое поле в указанном списке рассылки.
Создание проекта кампании

Создает новую проектную кампанию в вашей учетной записи.
Создание списка рассылки

Создает пустой список рассылки в вашей учетной записи.
Тестирование кампании

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

Удаляет кампанию из учетной записи, черновика или даже отправленную.
Удаление настраиваемого поля

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

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

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

Удаляет список рассылки из учетной записи.

Добавление нескольких подписчиков

Идентификатор операции:
SubscriberAddBulk

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

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор списка рассылки
 MailingListId True string

Идентификатор списка рассылки.
Имеет внешний двойной вход
 HasExternalDoubleOptIn boolean

Имеет ли внешний двойной отказ.
Имя
 Name string

Имя.
Адрес электронной почты
 Email string

Адрес электронной почты.
Настраиваемые поля
 CustomFields array of string

Настраиваемые поля.

Возвращаемое значение

Имя Путь Тип Описание
Code
 Code integer

Код.
Ошибка
 Error string

Ошибка.
Контекст
 Context array of object
Идентификатор
 Context.ID string

Идентификатор.
Имя
 Context.Name string

Имя.
Адрес электронной почты
 Context.Email string

Адрес электронной почты.
Создано
 Context.CreatedOn string

При создании.
Обновлено
 Context.UpdatedOn string

При обновлении.
Отмена подписки на
 Context.UnsubscribedOn string

При отмене подписки.
Отмена подписки на идентификатор
 Context.UnsubscribedFromID string

Отмена подписки на идентификатор.
Тип подписки
 Context.SubscribeType integer

Тип подписки.
Метод подписки
 Context.SubscribeMethod integer

Метод подписки.
Настраиваемые поля
 Context.CustomFields array of object
Идентификатор настраиваемого поля
 Context.CustomFields.CustomFieldID string

Идентификатор настраиваемого поля.
Имя
 Context.CustomFields.Name string

Имя.
Ценность
 Context.CustomFields.Value string

Значение.
Удалено
 Context.RemovedOn string

Удалено.

Добавление подписчика

Идентификатор операции:
SubscriberAdd

Добавляет нового подписчика в указанный список рассылки.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор списка рассылки
 MailingListId True string

Идентификатор списка рассылки.
Имя
 Name string

Имя.
Адрес электронной почты
 Email string

Адрес электронной почты.
Имеет внешний двойной вход
 HasExternalDoubleOptIn boolean

Имеет ли внешний двойной отказ.
Настраиваемые поля
 CustomFields array of string

Настраиваемые поля.

Возвращаемое значение

Имя Путь Тип Описание
Code
 Code integer

Код.
Ошибка
 Error string

Ошибка.
Идентификатор
 Context.ID string

Идентификатор.
Имя
 Context.Name string

Имя.
Адрес электронной почты
 Context.Email string

Адрес электронной почты.
Создано
 Context.CreatedOn string

При создании.
Обновлено
 Context.UpdatedOn string

При обновлении.
Отмена подписки на
 Context.UnsubscribedOn string

При отмене подписки.
Отмена подписки на идентификатор
 Context.UnsubscribedFromID string

Отмена подписки на идентификатор.
Тип подписки
 Context.SubscribeType integer

Тип подписки.
Метод подписки
 Context.SubscribeMethod integer

Метод подписки.
Настраиваемые поля
 Context.CustomFields array of object
Идентификатор настраиваемого поля
 Context.CustomFields.CustomFieldID string

Идентификатор настраиваемого поля.
Имя
 Context.CustomFields.Name string

Имя.
Ценность
 Context.CustomFields.Value string

Значение.
Удалено
 Context.RemovedOn string

При удалении.

Клонирование существующей кампании

Идентификатор операции:
CampaignClone

Создает точную копию существующей кампании. Новая кампания создается в виде черновика.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор кампании
 CampaignId True string

Идентификатор кампании.

Возвращаемое значение

Имя Путь Тип Описание
Code
 Code integer

Код.
Ошибка
 Error string

Ошибка.
Идентификатор
 Context.ID string

Идентификатор.
Имя
 Context.Name string

Имя.
Тема
 Context.Subject string

Тема.
Веб-расположение
 Context.WebLocation string

Веб-расположение.
HTML-содержимое
 Context.HTMLContent string

HTML-содержимое.
Простое содержимое
 Context.PlainContent string

Простое содержимое.
Идентификатор
 Context.Sender.ID string

Идентификатор.
Имя
 Context.Sender.Name string

Имя.
Адрес электронной почты
 Context.Sender.Email string

Адрес электронной почты.
Создано
 Context.Sender.CreatedOn string

При создании.
Включен
 Context.Sender.IsEnabled boolean

Включена ли функция.
Проверено SPF
 Context.Sender.SpfVerified boolean

Проверяется ли SPF.
Проверено DKIM
 Context.Sender.DkimVerified boolean

Проверяется ли DKIM.
Общедоступный DKIM
 Context.Sender.DkimPublic string

Общедоступный DKIM.
Доставлено
 Context.DeliveredOn string

При доставке.
Идентификатор
 Context.ReplyToEmail.ID string

Идентификатор.
Имя
 Context.ReplyToEmail.Name string

Имя.
Адрес электронной почты
 Context.ReplyToEmail.Email string

Адрес электронной почты.
Создано
 Context.ReplyToEmail.CreatedOn string

При создании.
Включен
 Context.ReplyToEmail.IsEnabled boolean

Включена ли функция.
Проверено SPF
 Context.ReplyToEmail.SpfVerified boolean

Проверяется ли SPF.
Проверено DKIM
 Context.ReplyToEmail.DkimVerified boolean

Проверяется ли DKIM.
Общедоступный DKIM
 Context.ReplyToEmail.DkimPublic string

Общедоступный DKIM.
Создано
 Context.CreatedOn string

При создании.
Обновлено
 Context.UpdatedOn string

При обновлении.
Запланированное для
 Context.ScheduledFor string

При планировании.
Timezone
 Context.Timezone string

Часовой пояс.
Тип формата
 Context.FormatType integer

Тип формата.
Идентификатор
 Context.ABCampaignData.ID integer

Идентификатор.
Тема B
 Context.ABCampaignData.SubjectB string

Тема B.
Простое содержимое B
 Context.ABCampaignData.PlainContentB string

Обычное содержимое B.
Html-содержимое B
 Context.ABCampaignData.HTMLContentB string

Html-содержимое B.
Веб-расположение B
 Context.ABCampaignData.WebLocationB string

Веб-расположение B.
Отправитель B
 Context.ABCampaignData.SenderB string

Отправитель B.
Часы тестирования
 Context.ABCampaignData.HoursToTest integer

Часы тестирования.
Процент списка
 Context.ABCampaignData.ListPercentage integer

Процент списка.
Тип кампании AB
 Context.ABCampaignData.ABCampaignType integer

Тип кампании AB.
Тип выбора победителя AB
 Context.ABCampaignData.ABWinnerSelectionType integer

Тип выбора победителя AB.
Доставленный
 Context.ABCampaignData.DeliveredOnA string

A доставлено.
B доставлено
 Context.ABCampaignData.DeliveredOnB string

B доставлено.
Списки рассылки
 Context.MailingLists array of object
Идентификатор списка рассылки
 Context.MailingLists.MailingListID string

Идентификатор списка рассылки.
Идентификатор сегмента
 Context.MailingLists.SegmentID integer

Идентификатор сегмента.
Подтверждение
 Context.ConfirmationTo string

Подтверждение.
Состояние
 Context.Status integer

Состояние.
Транзакция
 Context.IsTransactional boolean

Указывает, является ли транзакция.

Обновление настраиваемого поля

Идентификатор операции:
FieldUpdate

Обновляет свойства существующего настраиваемого поля в указанном списке рассылки.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор списка рассылки
 MailingListId True string

Идентификатор списка рассылки.
Идентификатор настраиваемого поля
 CustomFieldId True string

Идентификатор настраиваемого поля.
Имя
 Name string

Имя.
Настраиваемый тип поля
 CustomFieldType string

Тип настраиваемого поля.
Options
 Options string

Параметры.

Возвращаемое значение

Имя Путь Тип Описание
Code
 Code integer

Код.
Ошибка
 Error string

Ошибка.
Контекст
 Context string

Контекст.

Обновление подписчика

Идентификатор операции:
SubscriberUpdate

Обновляет подписчик в указанном списке рассылки.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор списка рассылки
 MailingListId True string

Идентификатор списка рассылки.
Идентификатор подписчика
 SubscriberId True string

Идентификатор подписчика.
Имя
 Name string

Имя.
Имеет внешний двойной вход
 HasExternalDoubleOptIn boolean

Имеет ли внешний двойной отказ.
Адрес электронной почты
 Email string

Адрес электронной почты.
Настраиваемые поля
 CustomFields array of string

Возвращаемое значение

Имя Путь Тип Описание
Code
 Code integer

Код.
Ошибка
 Error string

Ошибка.
Идентификатор
 Context.ID string

Идентификатор.
Имя
 Context.Name string

Имя.
Адрес электронной почты
 Context.Email string

Адрес электронной почты.
Создано
 Context.CreatedOn string

При создании.
Обновлено
 Context.UpdatedOn string

При обновлении.
Отмена подписки на
 Context.UnsubscribedOn string

При отмене подписки.
Отмена подписки на идентификатор
 Context.UnsubscribedFromID string

Отмена подписки на идентификатор.
Тип подписки
 Context.SubscribeType integer

Тип подписки.
Метод подписки
 Context.SubscribeMethod integer

Метод подписки.
Настраиваемые поля
 Context.CustomFields array of object
Идентификатор настраиваемого поля
 Context.CustomFields.CustomFieldID string

Идентификатор настраиваемого поля.
Имя
 Context.CustomFields.Name string

Имя.
Ценность
 Context.CustomFields.Value string

Значение.
Удалено
 Context.RemovedOn string

При удалении.

Обновление проекта кампании

Идентификатор операции:
CampaignUpdate

Обновляет свойства существующей кампании AB в вашей учетной записи. Не удается обновить некритовые кампании. Пропустить (AB Split Campaign Option) если вы хотите создать обычную кампанию.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор кампании
 CampaignId True string

Идентификатор кампании.
Имя
 Name string

Имя.
Тема
 Subject string

Тема.
Электронная почта отправителя
 SenderEmail string

Адрес электронной почты отправителя.
Ответ на сообщение электронной почты
 ReplyToEmail string

Ответ на адрес электронной почты.
Подтверждение электронной почты
 ConfirmationToEmail string

Подтверждение адреса электронной почты.
Веб-расположение
 WebLocation string

Веб-расположение.
Идентификатор списка рассылки
 MailingListID string

Идентификатор списка рассылки.
Идентификатор сегмента
 SegmentID string

Идентификатор сегмента.
Is AB
 IsAB string

Это AB.
Тип кампании AB
 ABCampaignType string

Тип кампании AB.
Веб-расположение B
 WebLocationB string

Веб-расположение B.
Часы тестирования
 HoursToTest string

Часы тестирования.
Процент списка
 ListPercentage string

Процент списка.
Тип выбора победителя AB
 ABWinnerSelectionType string

Тип выбора победителя AB.

Возвращаемое значение

Имя Путь Тип Описание
Code
 Code integer

Код.
Ошибка
 Error string

Ошибка.
Контекст
 Context string

Контекст.

Обновление списка рассылки

Идентификатор операции:
ListUpdate

Обновляет свойства существующего списка рассылки.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор списка рассылки
 MailingListId True string

Идентификатор списка рассылки.
Имя
 Name string

Имя.
Страница подтверждения
 ConfirmationPage string

Страница подтверждения.
Перенаправление после отмены подписки
 RedirectAfterUnsubscribePage string

Перенаправление после отмены подписки.

Возвращаемое значение

Имя Путь Тип Описание
Code
 Code integer

Код.
Ошибка
 Error string

Ошибка.
Контекст
 Context string

Контекст.

Отмена подписки подписчика из списка рассылки

Идентификатор операции:
UnsubscribeList

Отменяет подписку подписчика из указанного списка рассылки.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор списка рассылки
 MailingListId True string

Идентификатор списка рассылки.
Адрес электронной почты
 Email True string

Адрес электронной почты.

Возвращаемое значение

Имя Путь Тип Описание
Code
 Code integer

Код.
Ошибка
 Error string

Ошибка.
Контекст
 Context string

Контекст.

Отмена подписки подписчика из учетной записи

Идентификатор операции:
UnsubscribeAccount

Отменяет подписку подписчика из учетной записи.

Параметры

Имя Ключ Обязательно Тип Описание
Адрес электронной почты
 Email True string

Адрес электронной почты.

Возвращаемое значение

Имя Путь Тип Описание
Code
 Code integer

Код.
Ошибка
 Error string

Ошибка.
Контекст
 Context string

Контекст.

Отмена расписания кампании

Идентификатор операции:
CampaignUnschedule

Удаляет ранее определяемую ранее дату и время из кампании, чтобы она была доставлена немедленно, если она уже в очереди или при отправке.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор кампании
 CampaignId True string

Идентификатор кампании.

Возвращаемое значение

Имя Путь Тип Описание
Code
 Code integer

Код.
Ошибка
 Error string

Ошибка.
Контекст
 Context string

Контекст.

Отправка кампании

Идентификатор операции:
CampaignSend

Отправляет существующую проектную кампанию всем получателям, указанным в списке рассылки. Кампания отправляется немедленно.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор кампании
 CampaignId True string

Идентификатор кампании.

Возвращаемое значение

Имя Путь Тип Описание
Code
 Code integer

Код.
Ошибка
 Error string

Ошибка.
Контекст
 Context string

Контекст.

Планирование кампании

Идентификатор операции:
CampaignSchedule

Назначает запланированную дату и время доставки кампании.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор кампании
 CampaignId True string

Идентификатор кампании.
Дата Время
 DateTime True string

Дата и время.
Timezone
 Timezone string

Часовой пояс.

Возвращаемое значение

Имя Путь Тип Описание
Code
 Code integer

Код.
Ошибка
 Error string

Ошибка.
Контекст
 Context string

Контекст.

Получение всех активных списков рассылки

Идентификатор операции:
ListActive

Извлекает список активных списков рассылки в вашей учетной записи.

Параметры

Имя Ключ Обязательно Тип Описание
Страница
 Page True integer

Страница.
Размер страницы
 PageSize True integer

Размер страницы.
Сортировка по
 SortBy string

Сортировка по.
Метод сортировки
 SortMethod string

Метод сортировки.

Возвращаемое значение

Имя Путь Тип Описание
Code
 Code integer

Код.
Ошибка
 Error string

Ошибка.
Размер страницы
 Context.Paging.PageSize integer

Размер страницы.
Текущая страница
 Context.Paging.CurrentPage integer

Текущая страница.
Всего результатов
 Context.Paging.TotalResults integer

Общий результат.
Общее число страниц
 Context.Paging.TotalPageCount integer

Общее число страниц.
Выражение сортировки
 Context.Paging.SortExpression string

Выражение сортировки.
Сортировка возрастает
 Context.Paging.SortIsAscending boolean

Указывает, является ли сортировка возрастающей.
Списки рассылки
 Context.MailingLists array of object
Идентификатор
 Context.MailingLists.ID string

Идентификатор.
Имя
 Context.MailingLists.Name string

Имя.
Число активных элементов
 Context.MailingLists.ActiveMemberCount integer

Число активных элементов.
Число отскочих элементов
 Context.MailingLists.BouncedMemberCount integer

Число отскочих элементов.
Число удаленных элементов
 Context.MailingLists.RemovedMemberCount integer

Число удаленных элементов.
Число неподписанных элементов
 Context.MailingLists.UnsubscribedMemberCount integer

Число неподписанных элементов.
Состояние
 Context.MailingLists.Status integer

Состояние.
Определение настраиваемых полей
 Context.MailingLists.CustomFieldsDefinition array of object
Идентификатор
 Context.MailingLists.CustomFieldsDefinition.ID string

Идентификатор.
Имя
 Context.MailingLists.CustomFieldsDefinition.Name string

Имя.
Контекст
 Context.MailingLists.CustomFieldsDefinition.Context string

Контекст.
Требуется
 Context.MailingLists.CustomFieldsDefinition.IsRequired boolean

Требуется ли это.
Тип
 Context.MailingLists.CustomFieldsDefinition.Type integer

Тип.
Создано автором
 Context.MailingLists.CreatedBy string

Созданное.
Создано
 Context.MailingLists.CreatedOn string

При создании.
Обновлено по
 Context.MailingLists.UpdatedBy string

Обновлено.
Обновлено
 Context.MailingLists.UpdatedOn string

Обновлено.
Идентификатор
 Context.MailingLists.ImportOperation.ID integer

Идентификатор.
Хэш данных
 Context.MailingLists.ImportOperation.DataHash string

Хэш данных.
Сопоставления
 Context.MailingLists.ImportOperation.Mappings string

Сопоставления.
Уведомление по электронной почте
 Context.MailingLists.ImportOperation.EmailNotify string

Сообщение электронной почты с уведомлением.
Создано
 Context.MailingLists.ImportOperation.CreatedOn string

При создании.
Начало работы
 Context.MailingLists.ImportOperation.StartedOn string

При запуске.
Завершено
 Context.MailingLists.ImportOperation.CompletedOn string

После завершения работы.
Всего вставленных данных
 Context.MailingLists.ImportOperation.TotalInserted integer

Общий объем вставленных данных.
Всего обновлено
 Context.MailingLists.ImportOperation.TotalUpdated integer

Общее обновление.
Всего отмены подписки
 Context.MailingLists.ImportOperation.TotalUnsubscribed integer

Общая отмена подписки.
Общее недопустимое значение
 Context.MailingLists.ImportOperation.TotalInvalid integer

Общее недопустимое значение.
Всего дубликата
 Context.MailingLists.ImportOperation.TotalDuplicate integer

Общий дубликат.
Всего членов
 Context.MailingLists.ImportOperation.TotalMembers integer

Общее число членов.
Message
 Context.MailingLists.ImportOperation.Message string

Сообщение.
Success
 Context.MailingLists.ImportOperation.Success boolean

Является ли успешным.

Получение действия по расположению

Идентификатор операции:
CampaignActivityLocation

Возвращает подробный отчет о том, что ваша кампания открывается (уникальная и общая) по странам.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор кампании
 CampaignId True string

Идентификатор кампании.

Возвращаемое значение

Имя Путь Тип Описание
Code
 Code integer

Код.
Ошибка
 Error string

Ошибка.
Размер страницы
 Context.Paging.PageSize integer

Размер страницы.
Текущая страница
 Context.Paging.CurrentPage integer

Текущая страница.
Всего результатов
 Context.Paging.TotalResults integer

Общий результат.
Общее число страниц
 Context.Paging.TotalPageCount integer

Общее число страниц.
Выражение сортировки
 Context.Paging.SortExpression string

Выражение сортировки.
Сортировка возрастает
 Context.Paging.SortIsAscending boolean

Указывает, является ли сортировка возрастающей.
Аналитика
 Context.Analytics array of object
Контекст
 Context.Analytics.Context string

Контекст.
Имя контекста
 Context.Analytics.ContextName string

Имя контекста.
Общее число
 Context.Analytics.TotalCount integer

Общее число.
Уникальное число
 Context.Analytics.UniqueCount integer

Уникальное число.
Описание контекста
 Context.Analytics.ContextDescription string

Описание контекста.

Получение действия ссылки

Идентификатор операции:
CampaignActivityLink

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

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор кампании
 CampaignId True string

Идентификатор кампании.

Возвращаемое значение

Имя Путь Тип Описание
Code
 Code integer

Код.
Ошибка
 Error string

Ошибка.
Размер страницы
 Context.Paging.PageSize integer

Размер страницы.
Текущая страница
 Context.Paging.CurrentPage integer

Текущая страница.
Всего результатов
 Context.Paging.TotalResults integer

Общий результат.
Общее число страниц
 Context.Paging.TotalPageCount integer

Общее число страниц.
Выражение сортировки
 Context.Paging.SortExpression string

Выражение сортировки.
Сортировка возрастает
 Context.Paging.SortIsAscending boolean

Указывает, является ли сортировка возрастающей.
Аналитика
 Context.Analytics array of object
Контекст
 Context.Analytics.Context string

Контекст.
Имя контекста
 Context.Analytics.ContextName string

Имя контекста.
Общее число
 Context.Analytics.TotalCount integer

Общее число.
Уникальное число
 Context.Analytics.UniqueCount integer

Уникальное число.
Описание контекста
 Context.Analytics.ContextDescription string

Описание контекста.

Получение кампаний

Идентификатор операции:
CampaignGet

Возвращает список всех кампаний в вашей учетной записи с подробными сведениями.

Параметры

Имя Ключ Обязательно Тип Описание
Страница
 Page True string

Страница.
Размер страницы
 PageSize True string

Размер страницы.
Сортировка по
 SortBy string

Сортировка по.
Метод сортировки
 SortMethod string

Метод сортировки.

Возвращаемое значение

Имя Путь Тип Описание
Code
 Code integer

Код.
Ошибка
 Error string

Ошибка.
Размер страницы
 Context.Paging.PageSize integer

Размер страницы.
Текущая страница
 Context.Paging.CurrentPage integer

Текущая страница.
Всего результатов
 Context.Paging.TotalResults integer

Общий результат.
Общее число страниц
 Context.Paging.TotalPageCount integer

Общее число страниц.
Выражение сортировки
 Context.Paging.SortExpression string

Выражение сортировки.
Сортировка возрастает
 Context.Paging.SortIsAscending boolean

Указывает, является ли сортировка возрастающей.
Кампании
 Context.Campaigns array of object
Идентификатор
 Context.Campaigns.ID string

Идентификатор.
Имя
 Context.Campaigns.Name string

Имя.
Тема
 Context.Campaigns.Subject string

Тема.
Имя сайта
 Context.Campaigns.SiteName string

Имя сайта.
Подтверждение
 Context.Campaigns.ConfirmationTo string

Подтверждение.
Создано
 Context.Campaigns.CreatedOn string

При создании.
Часы AB для тестирования
 Context.Campaigns.ABHoursToTest string

Тестируемые часы AB.
Тип кампании AB
 Context.Campaigns.ABCampaignType string

Тип кампании AB.
Победитель A/B
 Context.Campaigns.ABWinner string

Победитель AB.
Тип выбора победителя AB
 Context.Campaigns.ABWinnerSelectionType string

Тип выбора победителя AB.
Состояние
 Context.Campaigns.Status integer

Состояние.
Доставлено
 Context.Campaigns.DeliveredOn string

При доставке.
Запланированное для
 Context.Campaigns.ScheduledFor string

При планировании.
Расписание для часового пояса
 Context.Campaigns.ScheduledForTimezone string

Расписание часового пояса.
Списки рассылки
 Context.Campaigns.MailingLists array of object
кампания
 Context.Campaigns.MailingLists.Campaign string

Кампания.
Идентификатор
 Context.Campaigns.MailingLists.MailingList.ID string

Идентификатор.
Имя
 Context.Campaigns.MailingLists.MailingList.Name string

Имя.
Число активных элементов
 Context.Campaigns.MailingLists.MailingList.ActiveMemberCount integer

Число активных элементов.
Число отскочих элементов
 Context.Campaigns.MailingLists.MailingList.BouncedMemberCount integer

Число отскочих элементов.
Число удаленных элементов
 Context.Campaigns.MailingLists.MailingList.RemovedMemberCount integer

Число удаленных элементов.
Число неподписанных элементов
 Context.Campaigns.MailingLists.MailingList.UnsubscribedMemberCount integer

Число неподписанных элементов.
Состояние
 Context.Campaigns.MailingLists.MailingList.Status integer

Состояние.
Определение настраиваемых полей
 Context.Campaigns.MailingLists.MailingList.CustomFieldsDefinition array of

Определение настраиваемых полей.
Создано автором
 Context.Campaigns.MailingLists.MailingList.CreatedBy string

Созданное.
Создано
 Context.Campaigns.MailingLists.MailingList.CreatedOn string

При создании.
Обновлено по
 Context.Campaigns.MailingLists.MailingList.UpdatedBy string

Обновлено.
Обновлено
 Context.Campaigns.MailingLists.MailingList.UpdatedOn string

При обновлении.
Операция импорта
 Context.Campaigns.MailingLists.MailingList.ImportOperation string

Операция импорта.
Сегмент
 Context.Campaigns.MailingLists.Segment string

Сегмент.
Всего отправленных
 Context.Campaigns.TotalSent integer

Общий объем отправленных.
Всего открывается
 Context.Campaigns.TotalOpens integer

Откроется итог.
Уникальные открытия
 Context.Campaigns.UniqueOpens integer

Откроется уникальное окно.
Всего отказов
 Context.Campaigns.TotalBounces integer

Итог отскочил.
Общее количество перенаправлений
 Context.Campaigns.TotalForwards integer

Общее число переадресов.
Уникальные перенаправления
 Context.Campaigns.UniqueForwards integer

Уникальные перенаправления.
Всего щелчков по ссылке
 Context.Campaigns.TotalLinkClicks integer

Всего щелкает ссылка.
Уникальные щелчки ссылки
 Context.Campaigns.UniqueLinkClicks integer

Щелкните уникальную ссылку.
Число получателей
 Context.Campaigns.RecipientsCount integer

Число получателей.
Транзакция
 Context.Campaigns.IsTransactional boolean

Указывает, является ли транзакция.
Всего жалоб
 Context.Campaigns.TotalComplaints integer

Общий объем жалоб.
Всего отмены подписки
 Context.Campaigns.TotalUnsubscribes integer

Общий объем отмены подписки.

Получение отправителей

Идентификатор операции:
SenderGet

Извлекает список активных отправителей в вашей учетной записи.

Возвращаемое значение

Имя Путь Тип Описание
Code
 Code integer

Код.
Ошибка
 Error string

Ошибка.
Контекст
 Context array of object
Идентификатор
 Context.ID string

Идентификатор.
Имя
 Context.Name string

Имя.
Адрес электронной почты
 Context.Email string

Адрес электронной почты.
Создано
 Context.CreatedOn string

При создании.
Включен
 Context.IsEnabled boolean

Включена ли функция.
Проверено SPF
 Context.SpfVerified boolean

Проверяется ли SPF.
Проверено DKIM
 Context.DkimVerified boolean

Проверяется ли DKIM.
Общедоступный DKIM
 Context.DkimPublic string

Общедоступный DKIM.

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

Идентификатор операции:
SubscriberGetEmail

Ищет подписчика с указанным адресом электронной почты в указанном списке рассылки.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор списка рассылки
 MailingListId True string

Идентификатор списка рассылки.
Адрес электронной почты
 Email True string

Адрес электронной почты.

Возвращаемое значение

Имя Путь Тип Описание
Code
 Code integer

Код.
Ошибка
 Error string

Ошибка.
Идентификатор
 Context.ID string

Идентификатор.
Имя
 Context.Name string

Имя.
Адрес электронной почты
 Context.Email string

Адрес электронной почты.
Создано
 Context.CreatedOn string

При создании.
Обновлено
 Context.UpdatedOn string

При обновлении.
Отмена подписки на
 Context.UnsubscribedOn string

При отмене подписки.
Отмена подписки на идентификатор
 Context.UnsubscribedFromID string

Отмена подписки на идентификатор.
Тип подписки
 Context.SubscribeType integer

Тип подписки.
Метод подписки
 Context.SubscribeMethod integer

Метод подписки.
Настраиваемые поля
 Context.CustomFields array of object
Идентификатор настраиваемого поля
 Context.CustomFields.CustomFieldID string

Идентификатор настраиваемого поля.
Имя
 Context.CustomFields.Name string

Имя.
Ценность
 Context.CustomFields.Value string

Значение.
Удалено
 Context.RemovedOn string

При удалении.

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

Идентификатор операции:
SubscriberGetID

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

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор списка рассылки
 MailingListId True string

Идентификатор списка рассылки.
Идентификатор подписчика
 SubscriberId True string

Идентификатор подписчика.

Возвращаемое значение

Имя Путь Тип Описание
Code
 Code integer

Код.
Ошибка
 Error string

Ошибка.
Идентификатор
 Context.ID string

Идентификатор.
Имя
 Context.Name string

Имя.
Адрес электронной почты
 Context.Email string

Адрес электронной почты.
Создано
 Context.CreatedOn string

При создании.
Обновлено
 Context.UpdatedOn string

При обновлении.
Отмена подписки на
 Context.UnsubscribedOn string

При отмене подписки.
Отмена подписки на идентификатор
 Context.UnsubscribedFromID string

Отмена подписки на идентификатор.
Тип подписки
 Context.SubscribeType integer

Тип подписки.
Метод подписки
 Context.SubscribeMethod integer

Метод подписки.
Настраиваемые поля
 Context.CustomFields array of

Настраиваемые поля.
Удалено
 Context.RemovedOn string

При удалении.

Получение подписчиков

Идентификатор операции:
SubscriberList

Извлекает список всех подписчиков в указанном списке рассылки.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор списка рассылки
 MailingListId True string

Идентификатор списка рассылки.
Страница
 Page integer

Страница.
Размер страницы
 PageSize integer

Размер страницы.

Возвращаемое значение

Имя Путь Тип Описание
Code
 Code integer

Код.
Ошибка
 Error string

Ошибка.
Размер страницы
 Context.Paging.PageSize integer

Размер страницы.
Текущая страница
 Context.Paging.CurrentPage integer

Текущая страница.
Всего результатов
 Context.Paging.TotalResults integer

Общий результат.
Общее число страниц
 Context.Paging.TotalPageCount integer

Общее число страниц.
Выражение сортировки
 Context.Paging.SortExpression string

Выражение сортировки.
Сортировка возрастает
 Context.Paging.SortIsAscending boolean

Указывает, является ли сортировка возрастающей.
Подписчики
 Context.Subscribers array of object
Идентификатор
 Context.Subscribers.ID string

Идентификатор.
Имя
 Context.Subscribers.Name string

Имя.
Адрес электронной почты
 Context.Subscribers.Email string

Адрес электронной почты.
Создано
 Context.Subscribers.CreatedOn string

При создании.
Обновлено
 Context.Subscribers.UpdatedOn string

Обновлено.
Отмена подписки на
 Context.Subscribers.UnsubscribedOn string

При отмене подписки.
Отмена подписки на идентификатор
 Context.Subscribers.UnsubscribedFromID string

Отмена подписки на идентификатор.
Тип подписки
 Context.Subscribers.SubscribeType integer

Тип подписки.
Метод подписки
 Context.Subscribers.SubscribeMethod integer

Метод подписки.
Настраиваемые поля
 Context.Subscribers.CustomFields array of object
Идентификатор настраиваемого поля
 Context.Subscribers.CustomFields.CustomFieldID string

Идентификатор настраиваемого поля.
Имя
 Context.Subscribers.CustomFields.Name string

Имя.
Ценность
 Context.Subscribers.CustomFields.Value string

Значение.
Удалено
 Context.Subscribers.RemovedOn string

При удалении.

Получение сведений о кампании

Идентификатор операции:
CampaignGetDetails

Возвращает полный набор свойств, описывающих запрошенную кампанию подробно.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор кампании
 CampaignId True string

Идентификатор кампании.

Возвращаемое значение

Имя Путь Тип Описание
Code
 Code integer

Код.
Ошибка
 Error string

Ошибка.
Идентификатор
 Context.ID string

Идентификатор.
Имя
 Context.Name string

Имя.
Тема
 Context.Subject string

Тема.
Веб-расположение
 Context.WebLocation string

Веб-расположение.
HTML-содержимое
 Context.HTMLContent string

HTML-содержимое.
Простое содержимое
 Context.PlainContent string

Простое содержимое.
Идентификатор
 Context.Sender.ID string

Идентификатор.
Имя
 Context.Sender.Name string

Имя.
Адрес электронной почты
 Context.Sender.Email string

Адрес электронной почты.
Создано
 Context.Sender.CreatedOn string

При создании.
Включен
 Context.Sender.IsEnabled boolean

Включена ли функция.
Проверено SPF
 Context.Sender.SpfVerified boolean

Проверяется ли SPF.
Проверено DKIM
 Context.Sender.DkimVerified boolean

Проверяется ли DKIM.
Общедоступный DKIM
 Context.Sender.DkimPublic string

Общедоступный DKIM.
Доставлено
 Context.DeliveredOn string

При доставке.
Идентификатор
 Context.ReplyToEmail.ID string

Идентификатор.
Имя
 Context.ReplyToEmail.Name string

Имя.
Адрес электронной почты
 Context.ReplyToEmail.Email string

Адрес электронной почты.
Создано
 Context.ReplyToEmail.CreatedOn string

При создании.
Включен
 Context.ReplyToEmail.IsEnabled boolean

Включена ли функция.
Проверено SPF
 Context.ReplyToEmail.SpfVerified boolean

Проверяется ли SPF.
Проверено DKIM
 Context.ReplyToEmail.DkimVerified boolean

Проверяется ли DKIM.
Общедоступный DKIM
 Context.ReplyToEmail.DkimPublic string

Общедоступный DKIM.
Создано
 Context.CreatedOn string

При создании.
Обновлено
 Context.UpdatedOn string

При обновлении.
Запланированное для
 Context.ScheduledFor string

При планировании.
Timezone
 Context.Timezone string

Часовой пояс.
Тип формата
 Context.FormatType integer

Тип формата.
Данные кампании AB
 Context.ABCampaignData string

Данные кампании AB.
Списки рассылки
 Context.MailingLists array of object
Идентификатор списка рассылки
 Context.MailingLists.MailingListID string

Идентификатор списка рассылки.
Идентификатор сегмента
 Context.MailingLists.SegmentID integer

Идентификатор сегмента.
Подтверждение
 Context.ConfirmationTo string

Подтверждение.
Состояние
 Context.Status integer

Состояние.
Транзакция
 Context.IsTransactional boolean

Указывает, является ли транзакция.

Получение сведений о списке рассылки

Идентификатор операции:
ListDetails

Получение сведений для заданного списка рассылки.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор списка рассылки
 MailingListId True string

Идентификатор списка рассылки.
С статистикой
 WithStatistics boolean

Независимо от статистики.

Возвращаемое значение

Имя Путь Тип Описание
Code
 Code integer

Код.
Ошибка
 Error string

Ошибка.
Идентификатор
 Context.ID string

Идентификатор.
Имя
 Context.Name string

Имя.
Число активных элементов
 Context.ActiveMemberCount integer

Число активных элементов.
Число отскочих элементов
 Context.BouncedMemberCount integer

Число отскочих элементов.
Число удаленных элементов
 Context.RemovedMemberCount integer

Число удаленных элементов.
Число неподписанных элементов
 Context.UnsubscribedMemberCount integer

Число неподписанных элементов.
Состояние
 Context.Status integer

Состояние.
Определение настраиваемых полей
 Context.CustomFieldsDefinition array of object
Идентификатор
 Context.CustomFieldsDefinition.ID string

Идентификатор.
Имя
 Context.CustomFieldsDefinition.Name string

Имя.
Контекст
 Context.CustomFieldsDefinition.Context string

Контекст.
Требуется
 Context.CustomFieldsDefinition.IsRequired boolean

Требуется ли это.
Тип
 Context.CustomFieldsDefinition.Type integer

Тип.
Создано автором
 Context.CreatedBy string

Созданное.
Создано
 Context.CreatedOn string

При создании.
Обновлено по
 Context.UpdatedBy string

Обновлено.
Обновлено
 Context.UpdatedOn string

При обновлении.
Идентификатор
 Context.ImportOperation.ID integer

Идентификатор.
Хэш данных
 Context.ImportOperation.DataHash string

Хэш данных.
Сопоставления
 Context.ImportOperation.Mappings string

Сопоставления.
Уведомление по электронной почте
 Context.ImportOperation.EmailNotify string

Уведомление электронной почты.
Создано
 Context.ImportOperation.CreatedOn string

При создании.
Начало работы
 Context.ImportOperation.StartedOn string

При запуске.
Завершено
 Context.ImportOperation.CompletedOn string

После завершения работы.
Всего вставленных данных
 Context.ImportOperation.TotalInserted integer

Общий объем вставленных данных.
Всего обновлено
 Context.ImportOperation.TotalUpdated integer

Общее обновление.
Всего отмены подписки
 Context.ImportOperation.TotalUnsubscribed integer

Общая отмена подписки.
Общее недопустимое значение
 Context.ImportOperation.TotalInvalid integer

Общее недопустимое значение.
Всего игнорируется
 Context.ImportOperation.TotalIgnored integer

Общее игнорируемое значение.
Всего дубликата
 Context.ImportOperation.TotalDuplicate integer

Общий дубликат.
Всего членов
 Context.ImportOperation.TotalMembers integer

Общее число членов.
Message
 Context.ImportOperation.Message string

Сообщение.
Success
 Context.ImportOperation.Success boolean

Является ли успешным.
Пропустить новые члены
 Context.ImportOperation.SkipNewMembers boolean

Следует ли пропускать новые члены.

Получение сведений об отправителе

Идентификатор операции:
SenderGetEmail

Возвращает сведения для указанного отправителя, определяемого его адресом электронной почты.

Параметры

Имя Ключ Обязательно Тип Описание
Адрес электронной почты
 Email True string

Адрес электронной почты.

Возвращаемое значение

Имя Путь Тип Описание
Code
 Code integer

Код.
Ошибка
 Error string

Ошибка.
Идентификатор
 Context.ID string

Идентификатор.
Имя
 Context.Name string

Имя.
Адрес электронной почты
 Context.Email string

Адрес электронной почты.
Создано
 Context.CreatedOn string

При создании.
Включен
 Context.IsEnabled boolean

Включена ли функция.
Проверено SPF
 Context.SpfVerified boolean

Проверяется ли SPF.
Проверено DKIM
 Context.DkimVerified boolean

Проверяется ли DKIM.
Общедоступный DKIM
 Context.DkimPublic string

Общедоступный DKIM.

Получение сводки по кампании

Идентификатор операции:
CampaignSummary

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

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор кампании
 CampaignId True string

Идентификатор кампании.

Возвращаемое значение

Имя Путь Тип Описание
Code
 Code integer

Код.
Ошибка
 Error string

Ошибка.
Идентификатор кампании
 Context.CampaignID string

Идентификатор кампании.
Версия AB
 Context.ABVersion string

Версия AB.
Название кампании
 Context.CampaignName string

Имя кампании.
Тема кампании
 Context.CampaignSubject string

Тема кампании.
Списки рассылки
 Context.MailingLists array of object
Идентификатор списка рассылки
 Context.MailingLists.MailingListID string

Идентификатор списка рассылки.
Идентификатор сегмента
 Context.MailingLists.SegmentID integer

Идентификатор сегмента.
Кампания доставлена
 Context.CampaignDeliveredOn string

Когда кампания была доставлена.
Кому
 Context.To string

Адрес для адреса.
От
 Context.From string

Адрес from.
Всего открывается
 Context.TotalOpens integer

Откроется итог.
Уникальные открытия
 Context.UniqueOpens integer

Откроется уникальное окно.
Всего отказов
 Context.TotalBounces integer

Итог отскочил.
Всего жалоб
 Context.TotalComplaints integer

Общий объем жалоб.
Общее количество перенаправлений
 Context.TotalForwards integer

Общее число переадресов.
Уникальные перенаправления
 Context.UniqueForwards integer

Уникальные перенаправления.
Всего отмены подписки
 Context.TotalUnsubscribes integer

Общий объем отмены подписки.
Всего щелчков по ссылке
 Context.TotalLinkClicks integer

Всего щелкает ссылка.
Уникальные щелчки ссылки
 Context.UniqueLinkClicks integer

Щелкните уникальную ссылку.
Sent
 Context.Sent integer

Отправленный номер.
Кампания архивирована
 Context.CampaignIsArchived boolean

Архивируется ли кампания.

Получение сводки тестовой кампании AB

Идентификатор операции:
CampaignABSummary

Предоставляет базовую сводку результатов для отправленной тестовой кампании AB отдельно для каждой версии (A и B), например количество получателей, открывается, щелкает, откажет, отменяет подписки, пересылает и т. д. на сегодняшний день.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор кампании
 CampaignId True string

Идентификатор кампании.

Возвращаемое значение

Имя Путь Тип Описание
Code
 Code integer

Код.
Ошибка
 Error string

Ошибка.
Идентификатор кампании
 Context.CampaignID string

Идентификатор кампании.
Идентификатор кампании
 Context.A.CampaignID string

Идентификатор кампании.
Версия AB
 Context.A.ABVersion integer

Версия AB.
Название кампании
 Context.A.CampaignName string

Имя кампании.
Тема кампании
 Context.A.CampaignSubject string

Тема кампании.
Списки рассылки
 Context.A.MailingLists array of object
кампания
 Context.A.MailingLists.Campaign string

Кампания.
Идентификатор
 Context.A.MailingLists.MailingList.ID string

Идентификатор.
Имя
 Context.A.MailingLists.MailingList.Name string

Имя.
Число активных элементов
 Context.A.MailingLists.MailingList.ActiveMemberCount integer

Число активных элементов.
Число отскочих элементов
 Context.A.MailingLists.MailingList.BouncedMemberCount integer

Число отскочих элементов.
Число удаленных элементов
 Context.A.MailingLists.MailingList.RemovedMemberCount integer

Число удаленных элементов.
Число неподписанных элементов
 Context.A.MailingLists.MailingList.UnsubscribedMemberCount integer

Число неподписанных элементов.
Состояние
 Context.A.MailingLists.MailingList.Status integer

Состояние.
Определение настраиваемых полей
 Context.A.MailingLists.MailingList.CustomFieldsDefinition array of

Определение настраиваемых полей.
Создано автором
 Context.A.MailingLists.MailingList.CreatedBy string

Созданное.
Создано
 Context.A.MailingLists.MailingList.CreatedOn string

При создании.
Обновлено по
 Context.A.MailingLists.MailingList.UpdatedBy string

Обновлено.
Обновлено
 Context.A.MailingLists.MailingList.UpdatedOn string

Обновлено.
Операция импорта
 Context.A.MailingLists.MailingList.ImportOperation string

Операция импорта.
Сегмент
 Context.A.MailingLists.Segment string

Сегмент.
Кампания доставлена
 Context.A.CampaignDeliveredOn string

Кампания была доставлена.
Кому
 Context.A.To string

Адрес для адреса.
От
 Context.A.From string

Адрес from.
Всего открывается
 Context.A.TotalOpens integer

Откроется итог.
Уникальные открытия
 Context.A.UniqueOpens integer

Откроется уникальное окно.
Всего отказов
 Context.A.TotalBounces integer

Итог отскочил.
Всего жалоб
 Context.A.TotalComplaints integer

Общий объем жалоб.
Общее количество перенаправлений
 Context.A.TotalForwards integer

Общее число переадресов.
Уникальные перенаправления
 Context.A.UniqueForwards integer

Уникальные перенаправления.
Всего отмены подписки
 Context.A.TotalUnsubscribes integer

Общий объем отмены подписки.
Всего щелчков по ссылке
 Context.A.TotalLinkClicks integer

Всего щелкает ссылка.
Уникальные щелчки ссылки
 Context.A.UniqueLinkClicks integer

Щелкните уникальную ссылку.
Sent
 Context.A.Sent integer

Отправленный номер.
Кампания архивирована
 Context.A.CampaignIsArchived boolean

Архивируется ли кампания.
Идентификатор кампании
 Context.B.CampaignID string

Идентификатор кампании.
Версия AB
 Context.B.ABVersion integer

Версия AB.
Название кампании
 Context.B.CampaignName string

Имя кампании.
Тема кампании
 Context.B.CampaignSubject string

Тема кампании.
Списки рассылки
 Context.B.MailingLists array of object
кампания
 Context.B.MailingLists.Campaign string

Кампания.
Идентификатор
 Context.B.MailingLists.MailingList.ID string

Идентификатор.
Имя
 Context.B.MailingLists.MailingList.Name string

Имя.
Число активных элементов
 Context.B.MailingLists.MailingList.ActiveMemberCount integer

Число активных элементов.
Число отскочих элементов
 Context.B.MailingLists.MailingList.BouncedMemberCount integer

Число отскочих элементов.
Число удаленных элементов
 Context.B.MailingLists.MailingList.RemovedMemberCount integer

Число удаленных элементов.
Число неподписанных элементов
 Context.B.MailingLists.MailingList.UnsubscribedMemberCount integer

Число неподписанных элементов.
Состояние
 Context.B.MailingLists.MailingList.Status integer

Состояние.
Определение настраиваемых полей
 Context.B.MailingLists.MailingList.CustomFieldsDefinition array of

Определение настраиваемых полей.
Создано автором
 Context.B.MailingLists.MailingList.CreatedBy string

Созданное.
Создано
 Context.B.MailingLists.MailingList.CreatedOn string

При создании.
Обновлено по
 Context.B.MailingLists.MailingList.UpdatedBy string

Обновлено.
Обновлено
 Context.B.MailingLists.MailingList.UpdatedOn string

Обновлено.
Операция импорта
 Context.B.MailingLists.MailingList.ImportOperation string

Операция импорта.
Сегмент
 Context.B.MailingLists.Segment string

Сегмент.
Кампания доставлена
 Context.B.CampaignDeliveredOn string

Кампания была доставлена.
Кому
 Context.B.To string

Адрес для адреса.
От
 Context.B.From string

Адрес from.
Всего открывается
 Context.B.TotalOpens integer

Откроется итог.
Уникальные открытия
 Context.B.UniqueOpens integer

Откроется уникальное окно.
Всего отказов
 Context.B.TotalBounces integer

Итог отскочил.
Всего жалоб
 Context.B.TotalComplaints integer

Общий объем жалоб.
Общее количество перенаправлений
 Context.B.TotalForwards integer

Общее число переадресов.
Уникальные перенаправления
 Context.B.UniqueForwards integer

Уникальные перенаправления.
Всего отмены подписки
 Context.B.TotalUnsubscribes integer

Общий объем отмены подписки.
Всего щелчков по ссылке
 Context.B.TotalLinkClicks integer

Всего щелкает ссылка.
Уникальные щелчки ссылки
 Context.B.UniqueLinkClicks integer

Щелкните уникальную ссылку.
Sent
 Context.B.Sent integer

Отправленный номер.
Кампания архивирована
 Context.B.CampaignIsArchived boolean

Архивируется ли кампания.

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

Идентификатор операции:
CampaignStats

Извлекает подробный список статистики для данной кампании на основе таких действий, как отправленные сообщения электронной почты, открытые, отскочили, щелкнули ссылку и т. д.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор кампании
 CampaignId True string

Идентификатор кампании.
Тип
 Type True string

Тип.
Страница
 Page integer

Страница.
Размер страницы
 PageSize integer

Размер страницы.
От
 From string

Адрес from.
Кому
 To string

Адрес для адреса.

Возвращаемое значение

Имя Путь Тип Описание
Code
 Code integer

Код.
Ошибка
 Error string

Ошибка.
Размер страницы
 Context.Paging.PageSize integer

Размер страницы.
Текущая страница
 Context.Paging.CurrentPage integer

Текущая страница.
Всего результатов
 Context.Paging.TotalResults integer

Общий результат.
Общее число страниц
 Context.Paging.TotalPageCount integer

Общее число страниц.
Выражение сортировки
 Context.Paging.SortExpression string

Выражение сортировки.
Сортировка возрастает
 Context.Paging.SortIsAscending boolean

Указывает, является ли сортировка возрастающей.
Аналитика
 Context.Analytics array of object
Контекст
 Context.Analytics.Context string

Контекст.
Имя контекста
 Context.Analytics.ContextName string

Имя контекста.
Общее число
 Context.Analytics.TotalCount integer

Общее число.
Уникальное число
 Context.Analytics.UniqueCount integer

Уникальное число.
Описание контекста
 Context.Analytics.ContextDescription string

Описание контекста.

Создание настраиваемого поля

Идентификатор операции:
FieldCreate

Создает новое настраиваемое поле в указанном списке рассылки.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор списка рассылки
 MailingListId True string

Идентификатор списка рассылки.
Имя
 Name string

Имя.
Настраиваемый тип поля
 CustomFieldType string

Тип настраиваемого поля.
Options
 Options string

Параметры.

Возвращаемое значение

Имя Путь Тип Описание
Code
 Code integer

Код.
Ошибка
 Error string

Ошибка.
Контекст
 Context string

Контекст.

Создание проекта кампании

Идентификатор операции:
CampaignCreate

Создает новую проектную кампанию в вашей учетной записи.

Параметры

Имя Ключ Обязательно Тип Описание
Имя
 Name string

Имя.
Тема
 Subject string

Тема.
Электронная почта отправителя
 SenderEmail string

Адрес электронной почты отправителя.
Ответ на сообщение электронной почты
 ReplyToEmail string

Ответ на адрес электронной почты.
Подтверждение электронной почты
 ConfirmationToEmail string

Подтверждение адреса электронной почты.
Веб-расположение
 WebLocation string

Веб-расположение.
Идентификатор списка рассылки
 MailingListID string

Идентификатор списка рассылки.
Идентификатор сегмента
 SegmentID string

Идентификатор сегмента.
Is AB
 IsAB string

Это AB.
Тип кампании AB
 ABCampaignType string

Тип кампании AB.
Веб-расположение B
 WebLocationB string

Веб-расположение B.
Часы тестирования
 HoursToTest string

Часы тестирования.
Процент списка
 ListPercentage string

Процент списка.
Тип выбора победителя AB
 ABWinnerSelectionType string

Тип выбора победителя AB.

Возвращаемое значение

Имя Путь Тип Описание
Code
 Code integer

Код.
Ошибка
 Error string

Ошибка.
Контекст
 Context string

Контекст.

Создание списка рассылки

Идентификатор операции:
ListCreate

Создает пустой список рассылки в вашей учетной записи.

Параметры

Имя Ключ Обязательно Тип Описание
Имя
 Name string

Имя.
Страница подтверждения
 ConfirmationPage string

Страница подтверждения.
Перенаправление после отмены подписки
 RedirectAfterUnsubscribePage string

Перенаправление после отмены подписки.

Возвращаемое значение

Имя Путь Тип Описание
Code
 Code integer

Код.
Ошибка
 Error string

Ошибка.
Контекст
 Context string

Контекст.

Тестирование кампании

Идентификатор операции:
CampaignTest

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

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор кампании
 CampaignId True string

Идентификатор кампании.
Тестовые сообщения электронной почты
 TestEmails True array of string

Возвращаемое значение

Имя Путь Тип Описание
Code
 Code integer

Код.
Ошибка
 Error string

Ошибка.
Контекст
 Context string

Контекст.

Удаление кампании

Идентификатор операции:
CampaignDelete

Удаляет кампанию из учетной записи, черновика или даже отправленную.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор кампании
 CampaignId True string

Идентификатор кампании.

Возвращаемое значение

Имя Путь Тип Описание
Code
 Code integer

Код.
Ошибка
 Error string

Ошибка.
Контекст
 Context string

Контекст.

Удаление настраиваемого поля

Идентификатор операции:
FieldDelete

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

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор списка рассылки
 MailingListId True string

Идентификатор списка рассылки.
Идентификатор настраиваемого поля
 CustomFieldId True string

Идентификатор настраиваемого поля.

Возвращаемое значение

Имя Путь Тип Описание
Code
 Code integer

Код.
Ошибка
 Error string

Ошибка.
Контекст
 Context string

Контекст.

Удаление нескольких подписчиков

Идентификатор операции:
UnsubscribeRemoveBulk

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

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор списка рассылки
 MailingListId True string

Идентификатор списка рассылки.
Сообщения электронной почты
 Emails True string

Сообщения электронной почты.

Возвращаемое значение

Имя Путь Тип Описание
Code
 Code integer

Код.
Ошибка
 Error string

Ошибка.
Сообщения электронной почты игнорируются
 Context.EmailsIgnored integer

Сообщения электронной почты игнорируются.
Обработанные сообщения электронной почты
 Context.EmailsProcessed integer

Обработанные сообщения электронной почты.

Удаление подписчика

Идентификатор операции:
UnsubscribeRemove

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

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор списка рассылки
 MailingListId True string

Идентификатор списка рассылки.
Адрес электронной почты
 Email True string

Адрес электронной почты.

Возвращаемое значение

Имя Путь Тип Описание
Code
 Code integer

Код.
Ошибка
 Error string

Ошибка.
Контекст
 Context string

Контекст.

Удаление списка рассылки

Идентификатор операции:
ListDelete

Удаляет список рассылки из учетной записи.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор списка рассылки
 MailingListId True string

Идентификатор списка рассылки.

Возвращаемое значение

Имя Путь Тип Описание
Code
 Code integer

Код.
Ошибка
 Error string

Ошибка.
Контекст
 Context string

Контекст.