MailJet (независимый издатель) (предварительная версия)
Полная коллекция всех общедоступных конечных точек и методов для API Mailjet
Этот соединитель доступен в следующих продуктах и регионах:
| Услуга | 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) |
| Контакт | |
|---|---|
| Имя | Клемент OLIVIER |
| URL | https://stuffandtacos.azurewebsites.net/ |
| Адрес электронной почты | clement@carfup.com |
| Метаданные соединителя | |
|---|---|
| Publisher | Клемент Оливье |
| Веб-сайт | https://www.mailjet.com/ |
| Политика конфиденциальности | https://www.mailjet.com/security-privacy/ |
| Категории | Маркетинг; Коммуникация |
Создание подключения
Соединитель поддерживает следующие типы проверки подлинности:
| По умолчанию | Параметры для создания подключения. | Все регионы | Недоступен для совместного использования |
По умолчанию
Применимо: все регионы
Параметры для создания подключения.
Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.
| Имя | Тип | Description | Обязательно |
|---|---|---|---|
| Ключ API и имя входа | securestring | Ключ API или имя входа, выданное MailJet | True |
| Секрет API | securestring | Секрет API/PassWord, выданный MailJet | True |
Ограничения регулирования
| Имя | Вызовы | Период обновления |
|---|---|---|
| Вызовы API для каждого подключения | 100 | 60 секунд |
Действия
| Обновление контакта |
Обновление заданного пользователем имени и состояния исключения конкретного контакта |
| Обновление проекта кампании |
Обновление существующего проекта кампании |
| Обновление списка контактов |
Обновление определенного списка контактов путем изменения его имени и /или состояния удаления |
| Отправка электронной почты версии 3 |
Отправка сообщения электронной почты с помощью API отправки версии 3 |
| Отправка электронной почты версии 3.1 |
Отправка сообщения электронной почты с помощью API отправки версии 3.1 |
| Получение данных контактов |
Получение сведений обо всех контактах и значениях свойств, связанных с ними |
| Получение контакта по идентификатору |
Получение конкретного контакта |
| Получение контактных данных по идентификатору |
Получение всех свойств и соответствующих значений, связанных с определенным контактом |
| Получение контактов |
Получение списка всех контактов. Содержит сведения о состоянии контакта и создании / метках времени действия |
| Получение обзора кампании |
Получение общих сведений и статистики для всех проектов, объектов ТЕСТИРОВАНИЯ AB и /или отправленных кампаний |
| Получение проекта кампании по идентификатору |
Получение определенного проекта кампании и его сведений о конфигурации |
| Получение проекта кампаний |
Получение всех проектов кампании и их конфигурации |
| Получение сведений о сообщениях |
Получение сведений о отправке, размере и спаме обо всех сообщениях |
| Получение сообщений |
Получение списка сообщений с определенной информацией о типе контента, отслеживании, отправке и доставке |
| Получение списка контактов по идентификатору |
Получение сведений для определенного списка контактов — имя, количество подписчиков, метка времени создания, состояние удаления. |
| Получение списков контактов |
Получение сведений обо всех списках контактов : имя, количество подписчиков, метка времени создания, состояние удаления. |
| Получение статистики контактов |
Получение списка общих статистических статистических данных о доставке и взаимодействии, сгруппированных по контакту |
| Создание контакта |
Добавьте новый уникальный контакт в глобальный список контактов и выберите его состояние исключения |
| Создание проекта кампании |
Создайте новый проект кампании. Объекты Бюллетеня и КампанииDraft отличаются значениями EditMode. |
| Создание списка контактов |
Создание списка контактов |
| Удаление списка контактов |
Удаление списка контактов |
Обновление контакта
Обновление заданного пользователем имени и состояния исключения конкретного контакта
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Код контактного лица
|
contact_ID | True | string |
Уникальный числовой идентификатор контакта, который требуется обновить |
|
IsExcludedFromCampaigns
|
IsExcludedFromCampaigns | boolean |
Указывает, добавляется ли контакт в список исключений для кампаний или нет |
|
|
Имя
|
Name | string |
Выбранное пользователем имя для этого контакта |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
Count | integer |
Численность |
|
Данные
|
Data | array of ContactResponse |
Данные |
|
Total
|
Total | integer |
Total |
Обновление проекта кампании
Обновление существующего проекта кампании
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор черновика
|
draft_ID | True | integer |
Уникальный числовой идентификатор проекта кампании, который вы хотите обновить |
|
Тип контента
|
Content-Type | string |
Тип контента |
|
|
Current
|
Current | integer |
Current |
|
|
Режим редактирования
|
EditMode | string |
Режим редактирования для проекта кампании. |
|
|
IsStarred
|
IsStarred | boolean |
В главной роли |
|
|
IsTextPartIncluded
|
IsTextPartIncluded | boolean |
Включена текстовая часть |
|
|
ReplyEmail
|
ReplyEmail | string |
Ответ электронной почты |
|
|
Имя отправителя
|
SenderName | string |
Имя отправителя |
|
|
TemplateID
|
TemplateID | integer |
ИД шаблона |
|
|
Название
|
Title | string |
Название |
|
|
ContactsListID
|
ContactsListID | string |
Идентификатор списка контактов |
|
|
ContactsListAlt
|
ContactsListAlt | string |
Замещающий список контактов |
|
|
Региональные настройки
|
Locale | True | string |
Региональные настройки |
|
Сегментация ИДЕНТИФИКАТОРа
|
SegmentationID | integer |
Идентификатор сегментации |
|
|
СегментацияAlt
|
SegmentationAlt | string |
Alt для сегментации |
|
|
Отправитель
|
Sender | string |
Отправитель |
|
|
SenderEmail
|
SenderEmail | string |
Электронная почта отправителя |
|
|
Тема
|
Subject | True | string |
Тема |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
Count | integer |
Численность |
|
Данные
|
Data | array of CampaignDraftResponse |
Данные |
|
Total
|
Total | integer |
Total |
Обновление списка контактов
Обновление определенного списка контактов путем изменения его имени и /или состояния удаления
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор списка
|
list_ID | True | string |
Уникальный числовые идентификаторы, назначенные этому списку контактов |
|
Имя
|
Name | True | string |
Указанное пользователем имя для этого списка контактов (должно быть уникальным) |
|
IsDeleted
|
IsDeleted | boolean |
Если задано значение true, список контактов будет помечен как удаленный |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
Count | integer |
Численность |
|
Данные
|
Data | array of ContactsListResponse |
Данные |
|
Total
|
Total | integer |
Total |
Отправка электронной почты версии 3
Отправка сообщения электронной почты с помощью API отправки версии 3
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Из электронной почты
|
FromEmail | True | string |
Из электронной почты |
|
Имя
|
FromName | string |
Имя |
|
|
Отправитель
|
Sender | boolean |
Отправитель |
|
|
Рецептантная электронная почта
|
string |
Адрес электронной почты |
||
|
Имя рецепта
|
Name | string |
Имя |
|
|
Сообщение электронной почты
|
To | True | string |
Сообщение электронной почты |
|
Копия электронной почты
|
Cc | string |
Копия электронной почты |
|
|
Электронная почта Bcc
|
Bcc | string |
Электронная почта Bcc |
|
|
Тема
|
Subject | string |
Строка темы электронной почты |
|
|
Текстовая часть
|
Text-part | string |
Текстовая часть |
|
|
Html-часть
|
Html-part | string |
Html-часть |
|
|
Filename
|
Filename | string |
Полное имя файла (включая расширение файла) |
|
|
Тип контента
|
Content-type | string |
Определяет тип содержимого, отправляемого с помощью типа MIME |
|
|
Content
|
Content | string |
Содержимое присоединенного файла в кодировке Base64 |
|
|
Filename
|
Filename | string |
Filename |
|
|
Тип контента
|
Content-type | string |
Тип контента |
|
|
Content
|
Content | string |
Content |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Sent
|
Sent | array of object |
Sent |
|
Адрес электронной почты
|
Sent.Email | string |
Адрес электронной почты |
|
MessageID
|
Sent.MessageID | integer |
Идентификатор сообщения |
|
MessageUUID
|
Sent.MessageUUID | string |
Идентификатор UUID сообщения |
Отправка электронной почты версии 3.1
Отправка сообщения электронной почты с помощью API отправки версии 3.1
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Из электронной почты
|
True | string |
Адрес электронной почты from |
|
|
Имя
|
Name | string |
Имя отправителя |
|
|
Сообщение электронной почты
|
string |
Адрес электронной почты получателя |
||
|
Имя
|
Name | string |
Имя получателя |
|
|
Электронная почта отправителя
|
string |
Адрес электронной почты, используемый для отправки сообщения |
||
|
Имя отправителя
|
Name | string |
Выбранное пользователем имя адреса электронной почты отправителя |
|
|
ReplyTo Email
|
string |
ReplyTo Email |
||
|
Имя replyTo
|
Name | string |
Имя replyTo |
|
|
Копия электронной почты
|
string |
Копия электронной почты |
||
|
Имя cc
|
Name | string |
Имя cc |
|
|
Электронная почта Bcc
|
string |
Электронная почта Bcc |
||
|
Имя Bcc
|
Name | string |
Имя Bcc |
|
|
Тема
|
Subject | string |
Строка темы электронной почты. |
|
|
TextPart
|
TextPart | string |
Предоставляет текстовую часть сообщения |
|
|
HTMLPart
|
HTMLPart | string |
Предоставляет HTML-часть сообщения. |
|
|
TemplateID
|
TemplateID | integer |
Уникальный числовой идентификатор шаблона, который будет использоваться в качестве содержимого электронной почты. |
|
|
Filename
|
Filename | string |
Полное имя файла (включая расширение файла) |
|
|
Тип контента
|
Content-type | string |
Определяет тип содержимого, отправляемого с помощью типа MIME |
|
|
Content
|
Base64Content | string |
Содержимое присоединенного файла в кодировке Base64 |
|
|
SandboxMode
|
SandboxMode | boolean |
Режим песочницы |
|
|
AdvanceErrorHandling
|
AdvanceErrorHandling | boolean |
Предварительная обработка ошибок |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Messages
|
Messages | array of object |
Messages |
|
Состояние
|
Messages.Status | string |
Состояние |
|
Errors
|
Messages.Errors | array of object |
Errors |
|
ErrorIdentifier
|
Messages.Errors.ErrorIdentifier | string |
Идентификатор ошибки |
|
ErrorCode
|
Messages.Errors.ErrorCode | string |
Код ошибки |
|
Код статуса
|
Messages.Errors.StatusCode | integer |
Код состояния |
|
Сообщение об ошибке
|
Messages.Errors.ErrorMessage | string |
Сообщение об ошибке |
|
ErrorRelatedTo
|
Messages.Errors.ErrorRelatedTo | string |
Ошибка, связанная с |
|
CustomID
|
Messages.CustomID | string |
Пользовательский идентификатор |
|
Кому
|
Messages.To | array of object |
Кому |
|
Адрес электронной почты
|
Messages.To.Email | string |
Адрес электронной почты |
|
MessageUUID
|
Messages.To.MessageUUID | string |
Идентификатор UUID сообщения |
|
MessageID
|
Messages.To.MessageID | integer |
Идентификатор сообщения |
|
MessageHref
|
Messages.To.MessageHref | string |
Сообщение Href |
|
Копия (Cc)
|
Messages.Cc | array of object |
Копия (Cc) |
|
Адрес электронной почты
|
Messages.Cc.Email | string |
Адрес электронной почты |
|
MessageUUID
|
Messages.Cc.MessageUUID | string |
Идентификатор UUID сообщения |
|
MessageID
|
Messages.Cc.MessageID | integer |
Идентификатор сообщения |
|
MessageHref
|
Messages.Cc.MessageHref | string |
Сообщение Href |
|
Bcc
|
Messages.Bcc | array of object |
Bcc |
|
Адрес электронной почты
|
Messages.Bcc.Email | string |
Адрес электронной почты |
|
MessageUUID
|
Messages.Bcc.MessageUUID | string |
Идентификатор UUID сообщения |
|
MessageID
|
Messages.Bcc.MessageID | integer |
Идентификатор сообщения |
|
MessageHref
|
Messages.Bcc.MessageHref | string |
Сообщение Href |
Получение данных контактов
Получение сведений обо всех контактах и значениях свойств, связанных с ними
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
кампания
|
Campaign | integer |
Извлекает список значений свойств контакта только для контактов, которые получили сообщения электронной почты из этого идентификатора кампании. |
|
|
Контактный адрес электронной почты
|
ContactEmail | string |
Извлекает список значений свойств контакта только для контакта с этим адресом электронной почты. |
|
|
Идентификатор списка контактов
|
ContactsList | integer |
Извлекает список значений свойств контакта только для контактов, входящих в этот идентификатор списка контактов. |
|
|
Fields
|
Fields | string |
Можно указать несколько свойств, разделив их запятыми |
|
|
Последнее действие в
|
LastActivityAt | string |
Извлекает список значений свойств контакта только для контактов |
|
|
Лимит
|
Limit | integer |
Ограничение ответа на выбор количества возвращаемых объектов |
|
|
Смещение
|
OffSet | integer |
Получение списка объектов, начиная с определенного смещения |
|
|
Только счетчик
|
countOnly | boolean |
Только возвращаемое число. |
|
|
Сортировать
|
Sort | string |
Укажите имя свойства для этого параметра запроса для сортировки объектов в Data |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
Count | integer |
Численность |
|
Данные
|
Data | array of ContactDataResponse |
Данные |
|
Total
|
Total | integer |
Total |
Получение контакта по идентификатору
Получение конкретного контакта
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Код контактного лица
|
contact_ID | True | string |
Уникальный числовой идентификатор контакта, который требуется получить |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
Count | integer |
Численность |
|
Данные
|
Data | array of ContactResponse |
Данные |
|
Total
|
Total | integer |
Total |
Получение контактных данных по идентификатору
Получение всех свойств и соответствующих значений, связанных с определенным контактом
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Код контактного лица
|
contactID | True | integer |
Уникальный числовой идентификатор контакта, свойства которого требуется получить |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
Count | integer |
Численность |
|
Данные
|
Data | array of ContactDataResponse |
Данные |
|
Total
|
Total | integer |
Total |
Получение контактов
Получение списка всех контактов. Содержит сведения о состоянии контакта и создании / метках времени действия
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
кампания
|
Campaign | integer |
Извлекает только контакты, предназначенные для этого идентификатора кампании |
|
|
ContactsList
|
ContactsList | integer |
Извлекает только контакты, которые являются частью этого идентификатора списка контактов |
|
|
IsExcludedFromCampaigns
|
IsExcludedFromCampaigns | boolean |
Извлекает только контакты, добавленные в список исключений для маркетинговых сообщений электронной почты |
|
|
Лимит
|
Limit | integer |
Ограничение ответа на выбор количества возвращаемых объектов |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
Count | integer |
Численность |
|
Данные
|
Data | array of ContactResponse |
Данные |
|
Total
|
Total | integer |
Total |
Получение обзора кампании
Получение общих сведений и статистики для всех проектов, объектов ТЕСТИРОВАНИЯ AB и /или отправленных кампаний
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
Count | integer |
Численность |
|
Данные
|
Data | array of object |
Данные |
|
ClickedCount
|
Data.ClickedCount | integer |
Щелкните "Число" |
|
DeliveredCount
|
Data.DeliveredCount | integer |
Количество доставленных данных |
|
EditMode
|
Data.EditMode | string |
Режим редактирования |
|
EditType
|
Data.EditType | string |
Тип редактирования |
|
Идентификатор
|
Data.ID | integer |
Идентификатор |
|
IDType
|
Data.IDType | string |
Тип идентификатора |
|
Открытое количество
|
Data.OpenedCount | integer |
Открытое число |
|
ProcessedCount
|
Data.ProcessedCount | integer |
Обработанное число |
|
SendTimeStart
|
Data.SendTimeStart | integer |
Время отправки |
|
Усеянный
|
Data.Starred | boolean |
Усеянный |
|
Состояние
|
Data.Status | integer |
Состояние |
|
Тема
|
Data.Subject | string |
Тема |
|
Название
|
Data.Title | string |
Название |
|
Total
|
Total | integer |
Total |
Получение проекта кампании по идентификатору
Получение определенного проекта кампании и его сведений о конфигурации
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор черновика
|
draft_ID | True | integer |
Уникальный числовой идентификатор проекта кампании, который требуется получить. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
Count | integer |
Численность |
|
Данные
|
Data | array of CampaignDraftResponse |
Данные |
|
Total
|
Total | integer |
Total |
Получение проекта кампаний
Получение всех проектов кампании и их конфигурации
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
Count | integer |
Численность |
|
Данные
|
Data | array of CampaignDraftResponse |
Данные |
|
Total
|
Total | integer |
Total |
Получение сведений о сообщениях
Получение сведений о отправке, размере и спаме обо всех сообщениях
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор кампании
|
CampaignID | integer |
Извлекает сведения только о сообщениях, входящих в эту кампанию. |
|
|
ContactsList
|
ContactsList | integer |
Извлекает сведения только о сообщениях, отправленных в этот список контактов |
|
|
CustomCampaign
|
CustomCampaign | integer |
Извлекает сведения только о сообщениях, входящих в кампанию с указанным пользовательским идентификатором |
|
|
От
|
From | string |
Извлекает сведения только о сообщениях, отправленных с указанного адреса электронной почты отправителя |
|
|
FromDomain
|
FromDomain | string |
Извлекает сведения только о сообщениях, отправленных из указанного домена отправителя |
|
|
FromID
|
FromID | integer |
Извлекает сведения только о сообщениях, отправленных с указанного идентификатора отправителя |
|
|
FromTS
|
FromTS | date-time |
Извлекает только сообщения, отправленные после указанной метки времени |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
Count | integer |
Численность |
|
Данные
|
Data | array of MessageInformationResponse |
Данные |
|
Total
|
Total | integer |
Total |
Получение сообщений
Получение списка сообщений с определенной информацией о типе контента, отслеживании, отправке и доставке
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Контакт
|
Contact | integer |
Извлекает только сообщения, отправленные на указанный идентификатор контакта |
|
|
CustomID
|
CustomID | integer |
Извлекает только сообщения, помеченные указанным CustomID |
|
|
Место назначения
|
Destination | integer |
Извлекает только сообщения, отправленные в указанный идентификатор назначения |
|
|
FromTS
|
FromTS | date-time |
Извлекает только сообщения, отправленные после указанной метки времени |
|
|
Лимит
|
Limit | integer |
Ограничение ответа на выбор количества возвращаемых объектов |
|
|
FromType
|
FromType | integer |
|
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
Count | integer |
Численность |
|
Данные
|
Data | array of MessageResponse |
Данные |
|
Total
|
Total | integer |
Total |
Получение списка контактов по идентификатору
Получение сведений для определенного списка контактов — имя, количество подписчиков, метка времени создания, состояние удаления.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Уникальный числовой идентификатор
|
list_ID | True | string |
Уникальный числовой идентификатор, назначенный этому списку контактов. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
Count | integer |
Численность |
|
Данные
|
Data | array of ContactsListResponse |
Данные |
|
Total
|
Total | integer |
Total |
Получение списков контактов
Получение сведений обо всех списках контактов : имя, количество подписчиков, метка времени создания, состояние удаления.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Address
|
Address | string |
Извлекает только список контактов с указанным уникальным адресом, созданным Mailjet. |
|
|
Идентификатор исключения
|
ExcludeID | integer |
Исключает список контактов с указанным идентификатором из ответа. |
|
|
Удалено?
|
IsDeleted | boolean |
Если значение true, извлекает только удаленные списки. Если значение false, извлекает списки, которые не удаляются. |
|
|
Имя
|
Name | string |
Извлекает только список с указанным именем, выбранным пользователем. |
|
|
Лимит
|
Limit | integer |
Ограничьте ответ на выбор количества возвращаемых объектов. |
|
|
Смещение
|
OffSet | integer |
Получение списка объектов, начиная с определенного смещения. |
|
|
Только счетчик
|
countOnly | boolean |
Возвращает только строки счетчика. |
|
|
Сортировать
|
Sort | string |
Укажите имя свойства для этого параметра запроса для сортировки объектов в Data. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
Count | integer |
Численность |
|
Данные
|
Data | array of ContactsListResponse |
Данные |
|
Total
|
Total | integer |
Total |
Получение статистики контактов
Получение списка общих статистических статистических данных о доставке и взаимодействии, сгруппированных по контакту
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
Count | integer |
Численность |
|
Данные
|
Data | array of object |
Данные |
|
Заблокированная учетная запись
|
Data.BlockedCount | integer |
Заблокированное число |
|
BouncedCount
|
Data.BouncedCount | integer |
Отскочило число |
|
ClickedCount
|
Data.ClickedCount | integer |
Щелкните "Число" |
|
ContactID
|
Data.ContactID | integer |
Код контактного лица |
|
Отложенная учетная запись
|
Data.DeferredCount | integer |
Отложенное число |
|
DeliveredCount
|
Data.DeliveredCount | integer |
Количество доставленных данных |
|
HardbouncedCount
|
Data.HardbouncedCount | integer |
Жесткое число |
|
LastActivityAt
|
Data.LastActivityAt | date-time |
Последнее действие в |
|
MarketingContacts
|
Data.MarketingContacts | integer |
Маркетинговые контакты |
|
Открытое количество
|
Data.OpenedCount | integer |
Открытое число |
|
ProcessedCount
|
Data.ProcessedCount | integer |
Обработанное число |
|
QueuedCount
|
Data.QueuedCount | integer |
Количество очередей |
|
SoftbouncedCount
|
Data.SoftbouncedCount | integer |
Обратимое число отскочило |
|
SpamComplaintCount
|
Data.SpamComplaintCount | integer |
Количество жалоб на спам |
|
Отмена подпискиCount
|
Data.UnsubscribedCount | integer |
Неподписанный счетчик |
|
UserMarketingContacts
|
Data.UserMarketingContacts | integer |
Контакты маркетинга пользователей |
|
WorkFlowExitedCount
|
Data.WorkFlowExitedCount | integer |
Число выходов WorkFlow |
|
Total
|
Total | integer |
Total |
Создание контакта
Добавьте новый уникальный контакт в глобальный список контактов и выберите его состояние исключения
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
IsExcludedFromCampaigns
|
IsExcludedFromCampaigns | string |
Указывает, добавляется ли контакт в список исключений для кампаний или нет |
|
|
Имя
|
Name | string |
Выбранное пользователем имя для этого контакта |
|
|
Адрес электронной почты
|
True | string |
Контактный адрес электронной почты |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
Count | integer |
Численность |
|
Данные
|
Data | array of ContactResponse |
Данные |
|
Total
|
Total | integer |
Total |
Создание проекта кампании
Создайте новый проект кампании. Объекты Бюллетеня и КампанииDraft отличаются значениями EditMode.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Current
|
Current | integer |
Current |
|
|
Режим редактирования
|
EditMode | string |
Режим редактирования для проекта кампании. |
|
|
IsStarred
|
IsStarred | boolean |
В главной роли |
|
|
IsTextPartIncluded
|
IsTextPartIncluded | boolean |
Включена текстовая часть |
|
|
ReplyEmail
|
ReplyEmail | string |
Ответ электронной почты |
|
|
Имя отправителя
|
SenderName | string |
Имя отправителя |
|
|
TemplateID
|
TemplateID | integer |
ИД шаблона |
|
|
Название
|
Title | string |
Название |
|
|
ContactsListID
|
ContactsListID | string |
Идентификатор списка контактов |
|
|
ContactsListAlt
|
ContactsListAlt | string |
Замещающий список контактов |
|
|
Региональные настройки
|
Locale | True | string |
Региональные настройки |
|
Сегментация ИДЕНТИФИКАТОРа
|
SegmentationID | integer |
Идентификатор сегментации |
|
|
СегментацияAlt
|
SegmentationAlt | string |
Alt для сегментации |
|
|
Отправитель
|
Sender | string |
Отправитель |
|
|
SenderEmail
|
SenderEmail | string |
Электронная почта отправителя |
|
|
Тема
|
Subject | True | string |
Тема |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
Count | integer |
Численность |
|
Данные
|
Data | array of CampaignDraftResponse |
Данные |
|
Total
|
Total | integer |
Total |
Создание списка контактов
Создание списка контактов
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя
|
Name | True | string |
Указанное пользователем имя для этого списка контактов (должно быть уникальным) |
|
IsDeleted
|
IsDeleted | boolean |
Если задано значение true, список контактов будет помечен как удаленный |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
Count | integer |
Численность |
|
Данные
|
Data | array of ContactsListResponse |
Данные |
|
Total
|
Total | integer |
Total |
Удаление списка контактов
Удаление списка контактов
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор списка
|
list_ID | True | string |
Идентификатор списка |
Определения
MessageResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
ArrivedAt
|
ArrivedAt | string |
Прибыл в |
|
Количество Вложений
|
AttachmentCount | integer |
Количество вложений |
|
AttemptCount
|
AttemptCount | integer |
Количество попыток |
|
Идентификатор кампании
|
CampaignID | integer |
Идентификатор кампании |
|
ContactAlt
|
ContactAlt | string |
Контакт ALT |
|
ContactID
|
ContactID | integer |
Код контактного лица |
|
Delay
|
Delay | number |
Delay |
|
Целевой идентификатор
|
DestinationID | integer |
Идентификатор назначения |
|
FilterTime
|
FilterTime | integer |
Время фильтрации |
|
Идентификатор
|
ID | integer |
Идентификатор |
|
IsClickTracked
|
IsClickTracked | boolean |
Щелкните "Отслеживаемый" |
|
IsHTMLPartIncluded
|
IsHTMLPartIncluded | boolean |
Включена HTML-часть |
|
IsOpenTracked
|
IsOpenTracked | boolean |
Открыт для отслеживания |
|
IsTextPartIncluded
|
IsTextPartIncluded | boolean |
Включена текстовая часть |
|
IsUnsubTracked
|
IsUnsubTracked | boolean |
Отслеживается отмена подписки |
|
MessageSize
|
MessageSize | integer |
Размер сообщения |
|
SenderID
|
SenderID | integer |
Идентификатор отправителя |
|
SpamassassinScore
|
SpamassassinScore | number |
Оценка спамассассина |
|
SpamassRules
|
SpamassRules | string |
Правила спама |
|
StateID
|
StateID | integer |
Идентификатор состояния |
|
StatePermanent
|
StatePermanent | boolean |
Постоянное состояние |
|
Состояние
|
Status | string |
Состояние |
|
Тема
|
Subject | string |
Тема |
|
UUID (Универсальный уникальный идентификатор)
|
UUID | string |
UUID (Универсальный уникальный идентификатор) |
MessageInformationResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор кампании
|
CampaignID | integer |
Идентификатор кампании |
|
ClickTrackedCount
|
ClickTrackedCount | integer |
Щелкните "Отслеживаемое число" |
|
ContactID
|
ContactID | integer |
Код контактного лица |
|
CreatedAt
|
CreatedAt | date-time |
Создано в |
|
Идентификатор
|
ID | integer |
Идентификатор |
|
MessageSize
|
MessageSize | integer |
Размер сообщения |
|
OpenTrackedCount
|
OpenTrackedCount | integer |
Открытие отслеживаемого количества |
|
QueuedCount
|
QueuedCount | integer |
Количество очередей |
|
SendEndAt
|
SendEndAt | string |
Конец отправки в |
|
SentCount
|
SentCount | integer |
Число отправленных данных |
|
SpamAssassinScore
|
SpamAssassinScore | number |
Оценка спам-убийцы |
ContactResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
IsExcludedFromCampaigns
|
IsExcludedFromCampaigns | boolean |
Исключен изCampaigns |
|
Имя
|
Name | string |
Имя |
|
CreatedAt
|
CreatedAt | date-time |
Создано в |
|
DeliveredCount
|
DeliveredCount | integer |
Количество доставленных данных |
|
Адрес электронной почты
|
string |
Адрес электронной почты |
|
|
ExclusionFromCampaignsUpdatedAt
|
ExclusionFromCampaignsUpdatedAt | string |
Исключение из кампаний, обновленных по адресу |
|
Идентификатор
|
ID | integer |
Идентификатор |
|
IsOptInPending
|
IsOptInPending | boolean |
Ожидается оптин |
|
IsSpamComplaining
|
IsSpamComplaining | boolean |
Жаловаться на спам |
|
LastActivityAt
|
LastActivityAt | date-time |
Последнее действие в |
|
LastUpdateAt
|
LastUpdateAt | date-time |
Последнее обновление по адресу |
ContactsListResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Имя
|
Name | string |
Имя |
|
Address
|
Address | string |
Address |
|
CreatedAt
|
CreatedAt | date-time |
Создано в |
|
Идентификатор
|
ID | integer |
Идентификатор |
|
Подписчик
|
SubscriberCount | integer |
Число подписчиков |
CampaignDraftResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
AXFraction
|
AXFraction | integer |
Доля AX |
|
AXFractionName
|
AXFractionName | string |
Имя дроби AX |
|
AXTesting
|
AXTesting | string |
Тестирование AX |
|
Current
|
Current | integer |
Current |
|
EditMode
|
EditMode | string |
Режим редактирования |
|
IsStarred
|
IsStarred | boolean |
В главной роли |
|
IsTextPartIncluded
|
IsTextPartIncluded | boolean |
Включается textPart |
|
ReplyEmail
|
ReplyEmail | string |
Ответ электронной почты |
|
Имя отправителя
|
SenderName | string |
Имя отправителя |
|
TemplateID
|
TemplateID | integer |
ИД шаблона |
|
Название
|
Title | string |
Название |
|
Идентификатор кампании
|
CampaignID | integer |
Идентификатор кампании |
|
ContactsListID
|
ContactsListID | integer |
Идентификатор списка контактов |
|
CreatedAt
|
CreatedAt | date-time |
Создано в |
|
DeliveredAt
|
DeliveredAt | date-time |
Доставлено по адресу |
|
Идентификатор
|
ID | integer |
Идентификатор |
|
Региональные настройки
|
Locale | string |
Региональные настройки |
|
ModifiedAt
|
ModifiedAt | date-time |
Изменено в |
|
Предустановка
|
Preset | string |
Предустановка |
|
Сегментация ИДЕНТИФИКАТОРа
|
SegmentationID | integer |
Идентификатор сегментации |
|
Отправитель
|
Sender | string |
Отправитель |
|
SenderEmail
|
SenderEmail | string |
Электронная почта отправителя |
|
Состояние
|
Status | integer |
Состояние |
|
Тема
|
Subject | string |
Тема |
|
URL-адрес
|
Url | string |
URL-адрес |
|
Б/у
|
Used | boolean |
Б/у |
ContactDataResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
ContactID
|
ContactID | integer |
Уникальный числовой идентификатор для этого контакта |
|
Данные
|
Data | array of |
Массив JSON, содержащий свойства контакта и их значения |
|
Идентификатор
|
ID | integer |
Уникальный числовые идентификаторы для объекта Data этого контакта |
|
MethodCollection
|
MethodCollection | string |
MethodCollection |