notify.php¶

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

notify/get_client_notification_vips¶

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

HTTP-метод: POST

Параметры:

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

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

{
"result": "OK",
"vips": [
"@username1",
"@username2"
]
}

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

{
"code": -2,
"message": "$module: authorization required"
}

notify/get_settings¶

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

HTTP-метод: POST|GET

Параметры:

Параметр	Обязательный	Тип	Описание
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": {
"email_enabled": true,
"sms_enabled": false,
"telegram_vips": [
"@user1",
"@user2"
]
},
"all_settings": {
"template_version": "1.0",
"available_channels": [
"mail",
"sms",
"rocket"
]
}
}

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

{
"code": -2,
"message": "$module: authorization required"
}

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 (PERMISSION_DENIED)"
}

notify/tg_test¶

Отправляет тестовое сообщение пользователю в Telegram. Сообщение адаптируется под локацию клиента (RU или другие).

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"
}