imbot.v2.Bot.get
Получить информацию о боте
Описание
Метод imbot.v2.Bot.get возвращает информацию о боте. Используется для проверки установки бота.
Для приложения-владельца возвращает расширенный формат включая moduleId, eventMode и счетчики. Для других приложений — краткий формат.
Параметры
botId
integer
необязательный
ID бота. Обязателен, если не указан code
code
string
необязательный
Код бота. Обязателен, если не указан botId
botToken
string
необязательный
Уникальный токен авторизации бота. Обязателен при авторизации через вебхук, не нужен для OAuth.
Передавайте тот же botToken, который был указан при регистрации чат-бота
Примеры запроса
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"botToken":"my_bot_token","code":"support_bot"}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/imbot.v2.Bot.get
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"code":"support_bot","auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/imbot.v2.Bot.get
try {
const response = await $b24.callMethod('imbot.v2.Bot.get', {
code: 'support_bot',
});
const { result } = response.getData();
console.log('result:', result);
} catch (error) {
console.error('Error:', error);
}
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.imbot.v2.bot.get(
code="support_bot",
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
try {
$response = $b24Service
->core
->call(
'imbot.v2.Bot.get',
[
'code' => 'support_bot',
]
);
$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.Bot.get',
{
code: 'support_bot',
},
function(result) {
if (result.error()) {
console.error(result.error().ex);
} else {
console.log(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'imbot.v2.Bot.get',
['code' => 'support_bot']
);
if (!empty($result['error'])) {
echo 'Error: '. $result['error_description'];
} else {
echo 'Bot ID: '. $result['result']['bot']['id'];
}
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "imbot.v2.Bot.get", b24.Params{
"botToken": "my_bot_token",
"code": "support_bot",
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("imbot.v2.Bot.get: %w", err)
}
// Форма ответа показана ниже на этой странице.
fmt.Printf("%s\n", res.Result)
Ответ
HTTP-статус: 200
{
"result": {
"bot": {
"id": 456,
"code": "support_bot",
"type": "bot",
"isHidden": false,
"isSupportOpenline": false,
"isReactionsEnabled": true,
"backgroundId": null,
"language": "ru",
"moduleId": "rest",
"eventMode": "fetch",
"countMessage": 150,
"countCommand": 3,
"countChat": 12,
"countUser": 45
},
"users": [
{
"id": 456,
"active": true,
"name": "Support Bot",
"bot": true,
"type": "bot"
}
]
},
"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"
}
}
Обработка ошибок
HTTP-статус: 400
{
"error": "BOT_NOT_FOUND",
"error_description": "Bot not found"
}
| Код | Описание | Значение |
|---|---|---|
BOT_TOKEN_NOT_SPECIFIED |
Bot token is not specified | Не указан botToken. Обязателен при авторизации через вебхук |
PARAMS_REQUIRED |
Required parameters are missing | Не передан ни botId, ни code |
BOT_NOT_FOUND |
Bot not found | Бот не найден |

