triggered_mailings.php¶

В этой статье

Методы API

triggered_mailings/create

triggered_mailings/delete

triggered_mailings/get_settings

triggered_mailings/list

triggered_mailings/read

triggered_mailings/save_settings

triggered_mailings/update

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

Методы API¶

Метод	Действие	Описание
`create`	создание шаблона	Создает новый шаблон триггерного письма с указанием темы и текста на двух языках.
`delete`	удаление шаблона	Удаляет существующий шаблон по его ID.
`get_settings`	получение настроек	Возвращает текущие настройки рассылок (список email).
`list`	получение списка шаблонов	Возвращает список всех доступных шаблонов рассылок.
`read`	чтение шаблона	Возвращает детальную информацию о конкретном шаблоне по его ID.
`save_settings`	сохранение настроек	Обновляет список email-адресов для рассылок.
`update`	обновление шаблона	Обновляет данные существующего шаблона.

triggered_mailings/create¶

Создает новый шаблон триггерного письма с указанием темы и текста на двух языках.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: create
token	✅	string	Токен авторизации
name	✅	string	Название шаблона письма
code	✅	string	Уникальный код (slug) шаблона
subject_en	✅	string	Тема письма на английском языке
subject_ru	✅	string	Тема письма на русском языке
body_en	✅	string	Текст письма на английском языке
body_ru	✅	string	Текст письма на русском языке
active	❌	boolean	Статус активности создаваемого шаблона рассылки.
test_group_only	❌	boolean	Флаг отправки сообщений только тестовой группе пользователей.

Пример запроса

curl -s "https://invapi.hostkey.ru/triggered_mailings.php" -X POST \
--data "action=create" \
--data "token=HOSTKEY_TOKEN" \
--data "name=VALUE" \
--data "code=VALUE" \
--data "subject_en=VALUE" \
--data "subject_ru=VALUE" \
--data "body_en=VALUE" \
--data "body_ru=VALUE" \
--data "active=true" \
--data "test_group_only=false"

Пример успешного ответа

{
"result": "OK",
"action": "create",
"template_id": 123
}

Примеры ошибок

{
"code": -1,
"message": "Parameter required"
}

triggered_mailings/delete¶

Удаляет существующий шаблон по его ID.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `delete`
token	✅	string	Токен авторизации
template_id	✅	integer	Уникальный идентификатор шаблона для удаления.

Пример запроса

curl -s "https://invapi.hostkey.ru/triggered_mailings.php" -X POST \
--data "action=delete" \
--data "token=HOSTKEY_TOKEN" \
--data "template_id=VALUE"

Пример успешного ответа

{
"result": "OK",
"action": "delete"
}

Примеры ошибок

{
"code": -1,
"message": "Template not found"
}

triggered_mailings/get_settings¶

Возвращает текущие настройки рассылок (список email).

HTTP-метод: GET

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `get_settings`
token	✅	string	Токен авторизации

Пример запроса

curl -s "https://invapi.hostkey.ru/triggered_mailings.php" -X GET \
--data "action=get_settings" \
--data "token=HOSTKEY_TOKEN"

Пример успешного ответа

{
"result": "OK",
"action": "get_settings",
"data": [
"admin@example.com",
"test@domain.tld"
]
}

Примеры ошибок

{
"code": -1,
"message": "Error fetching settings"
}

triggered_mailings/list¶

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

HTTP-метод: GET

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `list`
token	✅	string	Токен авторизации

Пример запроса

curl -s "https://invapi.hostkey.ru/triggered_mailings.php" -X GET \
--data "action=list" \
--data "token=HOSTKEY_TOKEN"

Пример успешного ответа

{
"result": "OK",
"action": "list",
"templates": [
{
"id": 1,
"code": "welcome_email",
"name": "Welcome Template",
"subject_ru": "Добро пожаловать"
}
]
}

Примеры ошибок

{
"code": -1,
"message": "Error listing templates"
}

triggered_mailings/read¶

Возвращает детальную информацию о конкретном шаблоне по его ID.

HTTP-метод: GET

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `read`
token	✅	string	Токен авторизации
template_id	✅	integer	Уникальный идентификатор шаблона для получения данных о рассылке.

Пример запроса

curl -s "https://invapi.hostkey.ru/triggered_mailings.php" -X GET \
--data "action=read" \
--data "token=HOSTKEY_TOKEN" \
--data "template_id=123"

Пример успешного ответа

{
"result": "OK",
"action": "read",
"template": {
"id": 123,
"code": "promo_code",
"name": "Promo Template",
"subject_ru": "Ваш промокод",
"body_ru": "<p>Hello!</p>"
}
}

Примеры ошибок

{
"code": -1,
"message": "Template not found"
}

triggered_mailings/save_settings¶

Обновляет список email-адресов для рассылок.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `save_settings`
token	✅	string	Токен авторизации
emails	✅	`array<string>`	Список email-адресов для рассылок.

Пример запроса

curl -s "https://invapi.hostkey.ru/triggered_mailings.php" -X POST \
--data "action=save_settings" \
--data "token=HOSTKEY_TOKEN" \
--data "emails[]=user1@example.com" \
--data "emails[]=user2@example.com"

Пример успешного ответа

{
"result": "OK",
"action": "save_settings",
"data": true
}

Примеры ошибок

{
"code": -1,
"message": "Absent required parameters"
}

triggered_mailings/update¶

Обновляет данные существующего шаблона.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: update
token	✅	string	Токен авторизации
template_id	✅	integer	Идентификатор шаблона для обновления
name	✅	string	Название шаблона
code	✅	string	Уникальный код шаблона
subject_en	✅	string	Тема письма на английском языке
subject_ru	✅	string	Тема письма на русском языке
body_ru	❌	string	Текст тела письма на русском языке.
body_en	❌	string	Текст тела письма на английском языке.
active	❌	boolean	Статус активности шаблона рассылки.
test_group_only	❌	boolean	Флаг отправки писем только тестовой группе пользователей.

Пример запроса

curl -s "https://invapi.hostkey.ru/triggered_mailings.php" -X POST \
--data "action=update" \
--data "token=HOSTKEY_TOKEN" \
--data "template_id=123" \
--data "name=My Template" \
--data "code=TMPL_001" \
--data "subject_en=Hello English" \
--data "subject_ru=Привет Русский"

Пример успешного ответа

{
"result": "OK",
"action": "update"
}

Примеры ошибок

{
"code": -1,
"message": "Parameter required"
}