Добавить реакцию на сообщение imbot.v2.Chat.Message.Reaction.add
Scope:
imbotКто может выполнять метод: владелец зарегистрированного бота
Метод imbot.v2.Chat.Message.Reaction.add добавляет реакцию бота на сообщение.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
botId* |
ID бота |
|
botToken |
Уникальный токен авторизации бота. Обязателен при авторизации через вебхук, не нужен для OAuth. Передавайте тот же botToken, который был указан при регистрации чат-бота |
|
messageId* |
ID сообщения |
|
reaction* |
Код реакции. Список доступных кодов описан ниже |
Доступные коды реакций
|
Код |
Описание |
|
|
Нравится |
|
|
Не нравится |
|
|
До слез |
|
|
Сердечко |
|
|
Равнодушен |
|
|
Огонь! |
|
|
Жаль |
|
|
Улыбаюсь |
|
|
Подмигиваю |
|
|
Смеюсь |
|
|
Восхищаюсь |
|
|
Шок |
|
|
Грущу |
|
|
Плачу |
|
|
Язык |
|
|
Дразнюсь |
|
|
Круто |
|
|
Ну не знаю |
|
|
Смущаюсь |
|
|
Сомневаюсь |
|
|
Злюсь |
|
|
Злорадно |
|
|
Болею |
|
|
Без комментариев |
|
|
Фу |
|
|
Мощно |
|
|
Великолепно |
|
|
Дай пять |
|
|
Красота |
|
|
Обожаю |
|
|
Умоляю |
|
|
Дзен |
|
|
Спасибо |
|
|
ОК |
|
|
Рок! |
|
|
Всё круто |
|
|
Клоун |
|
|
Поздравляю |
|
|
Вопрос |
|
|
Внимание |
|
|
Идея |
|
|
Бомба |
|
|
Засыпаю |
|
|
Отмена |
|
|
Готово |
|
|
Глаза |
|
|
Договорились |
|
|
Поддерживаю |
Список реакций может расширяться и сокращаться без предварительного уведомления.
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"botId":456,"botToken":"my_bot_token","messageId":789,"reaction":"like"}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/imbot.v2.Chat.Message.Reaction.add
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"botId":456,"messageId":789,"reaction":"like","auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/imbot.v2.Chat.Message.Reaction.add
try {
const response = await $b24.callMethod('imbot.v2.Chat.Message.Reaction.add', {
botId: 456,
messageId: 789,
reaction: 'like',
});
const { result } = response.getData();
console.log('result:', result);
} catch (error) {
console.error('Error:', error);
}
try {
$response = $b24Service
->core
->call(
'imbot.v2.Chat.Message.Reaction.add',
[
'botId' => 456,
'messageId' => 789,
'reaction' => 'like',
]
);
$result = $response
->getResponseData()
->getResult();
echo 'result: ' . print_r($result, true);
} catch (Throwable $exception) {
error_log($exception->getMessage());
echo 'Error: ' . $exception->getMessage();
}
BX24.callMethod(
'imbot.v2.Chat.Message.Reaction.add',
{
botId: 456,
messageId: 789,
reaction: 'like',
},
function(result) {
if (result.error()) {
console.error(result.error().ex);
} else {
console.log(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'imbot.v2.Chat.Message.Reaction.add',
[
'botId' => 456,
'messageId' => 789,
'reaction' => 'like',
]
);
if (!empty($result['error'])) {
echo 'Error: ' . $result['error_description'];
} else {
echo 'Reaction added';
}
Обработка ответа
HTTP-код: 200
{
"result": true,
"time": {
"start": 1728626400.123,
"finish": 1728626400.234,
"duration": 0.111,
"processing": 0.045,
"date_start": "2024-10-11T10:00:00+03:00",
"date_finish": "2024-10-11T10:00:00+03:00"
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
|
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400, 403
{
"error": "REACTION_NOT_FOUND",
"error_description": "Reaction not found"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Описание |
Значение |
|
|
Bot token is not specified |
Не указан |
|
|
Bot ID is required |
Не указан |
|
|
Bot not found |
Бот не найден |
|
|
Bot is registered by another application |
Бот зарегистрирован другим приложением |
|
|
Access denied |
Бот не является участником чата с этим сообщением |
|
|
Reaction not found |
Указан несуществующий код реакции |
|
|
Reaction already set |
Эта реакция уже установлена ботом на данное сообщение |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Удалить реакцию с сообщения imbot.v2.Chat.Message.Reaction.delete
- Отправить сообщение imbot.v2.Chat.Message.send