notify.php¶

API модуль уведомлений: управление настройками, рассылка сообщений через различные каналы (Email, SMS, Telegram, Rocket) и интеграция с системами поддержки.

Методы API¶

Метод	Действие	Описание
`get_client_notification_vips`	получение списка VIP-клиентов для уведомлений	Возвращает список Telegram-аккаунтов (VIP) для указанных клиентов и биллинг-параметров.
`get_settings`	получение настроек уведомлений	Возвращает текущие настройки клиента и шаблонные значения.
`save_settings`	сохранение настроек уведомлений	Сохраняет настройки уведомлений для текущего клиента.
`tg_test`	тестовое уведомление в Telegram	Отправляет тестовое сообщение пользователю через бота.

notify/get_client_notification_vips¶

Возвращает список Telegram-аккаунтов (VIP) для указанных клиентов и биллинг-параметров.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `get_client_notification_vips`
token	✅	string	Токен авторизации
clients[]	❌	`array<string>`	Список клиентов в формате email
billing	❌	string	Параметр биллинга для получения настроек уведомлений.
clients	✅	string	Параметр `clients`

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

curl -s "https://invapi.hostkey.ru/notify.php" -X POST \
--data "action=get_client_notification_vips" \
--data "token=HOSTKEY_TOKEN" \
--data "clients[]=user@example.com|123" \
--data "clients[]=user2@example.com|456" \
--data "billing=some_billing_param" \
--data "clients=VALUE"

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

{
"result": "OK",
"vips": [
{
"handle": "@username",
"status": "active"
}
]
}

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

{
"code": -2,
"message": "$module: invalid token"
}

notify/get_settings¶

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

HTTP-метод: POST

Параметры:

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

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

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

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

{
"result": "OK",
"client_settings": {},
"all_settings": {}
}

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

{
"code": -2,
"message": "$module: invalid token"
}

notify/save_settings¶

Сохраняет настройки уведомлений для текущего клиента.

HTTP-метод: POST

Параметры:

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

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

curl -s "https://invapi.hostkey.ru/notify.php" -X POST \
--data "action=save_settings" \
--data "token=HOSTKEY_TOKEN" \
--data "settings[]=val1" \
--data "settings[]=val2"

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

{
"result": "OK"
}

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

{
"code": -1,
"message": "Permission denied"
}

notify/tg_test¶

Отправляет тестовое сообщение пользователю через бота.

HTTP-метод: POST

Параметры:

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

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

curl -s "https://invapi.hostkey.ru/notify.php" -X POST \
--data "action=tg_test" \
--data "token=HOSTKEY_TOKEN"

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

{
"result": "OK"
}

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

{
"code": -1,
"message": "Please check your username and that you've started dialog with our bot"
}