gamification.thanks.send
Scope:
gamificationКто может вызывать: Любой авторизованный пользователь. Подробнее: Права доступа
Отправить благодарность другому сотруднику: списать THX у отправителя, начислить BAL получателю, создать запись в ленте.
HTTP: POST
Побочные эффекты: создаётся транзакция THX (списание) и BAL (начисление), создаётся запись в ленте активности, отправляется уведомление.
Параметры метода
| Параметр | Тип | Обяз. | Описание |
|---|---|---|---|
toUserId |
int |
да | ID получателя (псевдонимы: to_user_id, userId, USER_ID) |
categoryId |
int |
да | ID категории благодарности (псевдоним: category_id) |
message |
string |
нет | Текст благодарности (псевдоним: comment) |
amount |
int |
нет | Количество THX (псевдоним: thx_points). По умолчанию — стоимость категории |
siteId |
string |
нет | ID сайта (псевдоним: SITE_ID). По умолчанию s1 |
Возвращаемые данные
result.result — объект созданной благодарности с данными транзакции.
Обработка ошибок
| Код | Описание |
|---|---|
UNAUTHORIZED |
Пользователь не авторизован |
VALIDATION_ERROR |
Не передан toUserId |
SELF_THANKS_FORBIDDEN |
Попытка отправить благодарность самому себе |
INVALID_CATEGORY |
Категория не найдена или недоступна |
INSUFFICIENT_THX_BALANCE |
Недостаточно THX |
USER_NOT_FOUND |
Получатель не найден |
Пример запроса (POST)
curl -X POST "https://{портал}/rest/{user_id}/{webhook_code}/gamification.thanks.send.json" \
-H "Content-Type: application/json" \
-d '{
"toUserId": 42,
"categoryId": 3,
"message": "Отличная работа над проектом!"
}'
Пример ответа:
{
"result": {
"result": {
"ID": "55",
"FROM_USER_ID": "1",
"TO_USER_ID": "42",
"CATEGORY_ID": "3",
"MESSAGE": "Отличная работа над проектом!",
"AMOUNT": "5"
},
"total": null,
"next": null,
"error": null
}
}
Предыдущая
Следующая