curl --request POST 'https://forum.arzguard.com/api/alerts/' \
--header "XF-Api-Key: $FORUM_API_KEY" \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'to_user_id=42' \
--data-urlencode 'alert=Пример уведомления'
{
"success": true
}
Уведомления
Отправить уведомление
Создаёт уведомление для выбранного пользователя через Super key.
POST
/
api
/
alerts
/
curl --request POST 'https://forum.arzguard.com/api/alerts/' \
--header "XF-Api-Key: $FORUM_API_KEY" \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'to_user_id=42' \
--data-urlencode 'alert=Пример уведомления'
{
"success": true
}
Создаёт уведомление для выбранного пользователя через Super key.
Тело запроса:
Ошибки возвращаются в общей структуре
Примеры сокращены и содержат только условные значения. Состав полей объектов зависит от прав, контекста и установленных дополнений.
Доступ
ПередавайтеXF-Api-Key в заголовке каждого запроса. Типы ключей и выбор пользователя.
Требуемые scopes: alert:write. Все перечисленные разрешения нужны одновременно.
Метод доступен только с Super key.
Параметры
string
required
Секретный API-ключ. В примерах ключ берётся из серверной переменной
$FORUM_API_KEY.application/x-www-form-urlencoded. Вложенные значения передавайте в форме с квадратными скобками в имени поля.
integer
required
ID получателя уведомления.
string
required
Текст уведомления. Маркер
{link} заменяется ссылкой из link_url.integer
ID отправителя. По умолчанию используется текущий API-пользователь;
0 означает анонимного отправителя.string
Адрес перехода из уведомления.
string
Подпись ссылки. Если в тексте нет
{link}, ссылка добавляется в конец уведомления.Ответ
HTTP200, JSON. Схемы объектов и условные поля.
true
Результат выполнения операции.
errors. Обрабатывайте поле code; текст message может меняться или переводиться. Формат ошибок.
curl --request POST 'https://forum.arzguard.com/api/alerts/' \
--header "XF-Api-Key: $FORUM_API_KEY" \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'to_user_id=42' \
--data-urlencode 'alert=Пример уведомления'
{
"success": true
}