notify.php¶

В этой статье

Методы API

notify/call

notify/get_client_notification_vips

notify/get_settings

notify/jira

notify/kayako

notify/kayko_note

notify/mail

notify/rocket

notify/save_settings

notify/send_bug_report

notify/send_client_notification_rocket

notify/sms

notify/tg_test

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

Методы API¶

Метод	Действие	Описание
`call`	голосовой вызов	Инициирует голосовой вызов на указанный номер телефона с проигрыванием заданного кода.
`get_client_notification_vips`	получение списка VIP-клиентов для уведомлений	Возвращает список Telegram-аккаунтов (VIP) для указанных клиентов и биллинг-параметров.
`get_settings`	получение настроек уведомлений	Возвращает текущие настройки клиента и шаблонные значения.
`jira`	создание тикета в Jira	Создает новый тикет в системе Jira через соответствующую очередь.
`kayako`	создание тикета Kayako	Создает тикет в системе поддержки Kayako.
`kayko_note`	добавление заметки в Kayako	Добавляет внутреннюю заметку к существующему тикету Kayako.
`mail`	отправка email	Отправляет электронное письмо через SMTP (Yandex или Google).
`rocket`	уведомление в Rocket.Chat	Отправляет сообщение в канал Rocket.Chat.
`save_settings`	сохранение настроек уведомлений	Сохраняет настройки уведомлений для текущего клиента.
`send_bug_report`	отправка отчета об ошибке	Формирует и отправляет отчет об ошибке в Rocket.Chat с указанием автора.
`send_client_notification_rocket`	рассылка уведомлений в Rocket по тикетам Jira	Отправляет массовое уведомление через Rocket клиентам, привязанным к списку указанных Jira-тикетов. Также оповещает VIP-клиентов в Telegram.
`sms`	отправка SMS сообщения	Отправляет текстовое сообщение на указанный номер телефона через доступный шлюз.
`tg_test`	тестовое уведомление в Telegram	Отправляет тестовое сообщение пользователю через бота.

notify/call¶

Инициирует голосовой вызов на указанный номер телефона с проигрыванием заданного кода.

HTTP-метод: POST

Параметры:

action	✅	string	Идентификатор метода: `call`
token	✅	string	Токен авторизации
code	✅	integer	Код для проигрывания в звонке. Должен быть числовым.
lang	❌	string	Язык голосового сообщения
to	❌	string	Номер телефона или идентификатор получателя для совершения голосового вызова.

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

curl -s "https://invapi.hostkey.ru/notify.php" -X POST \
--data "action=call" \
--data "token=HOSTKEY_TOKEN" \
--data "code=1234" \
--data "to=+79991234567"

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

{
"result": "OK",
"action": "call",
"data": {
"status": "success",
"callback": "7bc29eb23b1b879b21fce509597f07c"
}
}

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

{
"code": -2,
"message": "$module/$action: code is required"
}

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/jira¶

Создает новый тикет в системе Jira через соответствующую очередь.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `jira`
token	✅	string	Токен авторизации
subject	❌	string	Тема создаваемого тикета в Jira
message	❌	string	Текст сообщения или описание для тикета
from	❌	string	Email отправителя. Если не указан, используется sales@hostkey.com
department	❌	integer	Идентификатор департамента для обработки запроса в Jira.

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

curl -s "https://invapi.hostkey.ru/notify.php" -X POST \
--data "action=jira" \
--data "token=YOUR_TOKEN" \
--data "subject=Test Subject" \
--data "message=Test Message" \
--data "from=user@example.com" \
--data "department=1"

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

{
"result": "OK",
"message": "ISSUE-12345"
}

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

{
"code": -1,
"message": "Invalid department"
}

notify/kayako¶

Создает тикет в системе поддержки Kayako.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `kayako`
token	✅	string	Токен авторизации
subject	✅	string	Тема создаваемого тикета
message	✅	string	Текст сообщения тикета
to	❌	string	Получатель или идентификатор для разрешения адресата
user	❌	string	Идентификатор пользователя для разрешения целевого адреса в системе Kayako.

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

curl -s "https://invapi.hostkey.ru/notify.php" -X POST \
--data "action=kayako" \
--data "token=VALUE" \
--data "subject=VALUE" \
--data "message=VALUE"

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

{
"result": "OK",
"message": "Ticket ID 56789"
}

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

null

notify/kayko_note¶

Добавляет внутреннюю заметку к существующему тикету Kayako.

HTTP-метод: POST

Параметры:

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

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

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

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

{
"result": "OK",
"message": "Note added successfully"
}

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

{
"code": -1,
"message": "$module/$action: invalid request, no ticket data while $message"
}

notify/mail¶

Отправляет электронное письмо через SMTP (Yandex или Google).

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: mail
provider	❌	string	SMTP провайдер для отправки письма. Допустимые значения: yandex, google.
to	✅	string	Email получателя сообщения.
subject	✅	string	Тема электронного письма.
message	✅	string	Текст или HTML-содержимое сообщения.
is_html	❌	boolean	Флаг использования HTML-формата письма.
is_tm	❌	boolean	Флаг включения шаблонов для триггерных рассылок.
token	❌	string	Уникальный токен авторизации или проверки подлинности запроса.

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

curl -s "https://invapi.hostkey.ru/notify.php" -X POST \
--data "action=mail" \
--data "to=example@test.com" \
--data "subject=Hello World" \
--data "message=This is a test message"

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

{
"result": "OK"
}

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

{
"code": -1,
"message": "SMTP Error details"
}

notify/rocket¶

Отправляет сообщение в канал Rocket.Chat.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `rocket`
token	✅	string	Токен авторизации
message	✅	string	Текст сообщения для отправки в Rocket.Chat
to	✅	string	Идентификатор получателя или канала

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

curl -s "https://invapi.hostkey.ru/notify.php" -X POST \
--data "action=rocket" \
--data "token=VALUE" \
--data "message=VALUE" \
--data "to=VALUE"

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

{
"result": "OK"
}

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

{
"code": -1,
"message": "Rocket.Chat error message"
}

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/send_bug_report¶

Формирует и отправляет отчет об ошибке в Rocket.Chat с указанием автора.

HTTP-метод: POST

Параметры:

action	✅	string	Идентификатор метода: `send_bug_report`
token	✅	string	Токен авторизации
report	✅	string	Текст сообщения с описанием ошибки для отправки в Rocket.Chat

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

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

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

{
"result": "OK"
}

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

{
"code": -1,
"message": "Rocket.Chat error message"
}

notify/send_client_notification_rocket¶

Отправляет массовое уведомление через Rocket клиентам, привязанным к списку указанных Jira-тикетов. Также оповещает VIP-клиентов в Telegram.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `send_client_notification_rocket`
token	✅	string	Токен авторизации
tickets[]	✅	`array<string>`	Список полных ссылок на Jira тикеты. Формат: https://my.hostkey.ru/browse/CS-XXXXXX.
vips[]	❌	`array<string>`	Список Telegram-хендлов VIP клиентов в формате @username.
tickets	✅	`array`	Параметр `tickets`
vips	✅	`array`	Параметр `vips`

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

curl -s "https://invapi.hostkey.ru/notify.php" -X POST \
--data "action=send_client_notification_rocket" \
--data "token=HOSTKEY_TOKEN" \
--data "tickets[]=https://my.hostkey.ru/browse/CS-123456" \
--data "tickets[]=https://my.hostkey.ru/browse/CS-789012" \
--data "vips[]=@user1" \
--data "vips[]=@user2"

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

{
"result": "OK"
}

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

{
"code": -1,
"message": "$module/$action: tickets list is required"
}

notify/sms¶

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

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: sms
token	✅	string	Токен авторизации
to	✅	string	Номер телефона получателя сообщения
message	✅	string	Текст SMS-сообщения
method	❌	string	Метод отправки (шлюз). Допустимые значения: TW, BH.

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

curl -s "https://invapi.hostkey.ru/notify.php" -X POST \
--data "action=sms" \
--data "token=VALUE" \
--data "to=VALUE" \
--data "message=VALUE"

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

{
"result": "OK",
"action": "sms",
"status": "sent"
}

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

{
"code": -1,
"message": "Not serviced <number>"
}

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