imbot.v2.Chat.update
Обновить свойства чата
Описание
Метод imbot.v2.Chat.update обновляет свойства чата. Объединяет обновление заголовка, описания, цвета и аватара в одном вызове.
Параметры
botId
integer
обязательный
ID бота
botToken
string
необязательный
Уникальный токен авторизации бота. Обязателен при авторизации через вебхук, не нужен для OAuth.
Передавайте тот же botToken, который был указан при регистрации чат-бота
dialogId
string
обязательный
ID диалога. Для групповых чатов — chat{chatId}, для личных — {userId}
fields
object
обязательный
Обновляемые свойства чата. Структура объекта описана ниже
Параметр fields
title
string
необязательный
Новое название чата
description
string
необязательный
Новое описание чата
color
string
необязательный
Цвет чата — доступные цвета
avatar
file
необязательный
Новый аватар чата в формате Base64
Доступные цвета
red
необязательный
#df532d
green
необязательный
#64a513
mint
необязательный
#4ba984
lightBlue
необязательный
#4ba5c3
darkBlue
необязательный
#3e99ce
purple
необязательный
#8474c8
aqua
необязательный
#1eb4aa
pink
необязательный
#f76187
lime
необязательный
#58cc47
brown
необязательный
#ab7761
azure
необязательный
#29619b
khaki
необязательный
#728f7a
sand
необязательный
#ba9c7b
marengo
необязательный
#556574
gray
необязательный
#909090
graphite
необязательный
#5e5f5e
Примеры запроса
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"botId":456,"botToken":"my_bot_token","dialogId":"chat5","fields":{"title":"New Title","color":"azure"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/imbot.v2.Chat.update
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"botId":456,"dialogId":"chat5","fields":{"title":"New Title","color":"azure"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/imbot.v2.Chat.update
try {
const response = await $b24.callMethod('imbot.v2.Chat.update', {
botId: 456,
dialogId: 'chat5',
fields: {
title: 'New Title',
color: 'azure',
},
});
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.chat.update(
bot_id=456,
dialog_id="chat5",
fields={
"title": "New Title",
"color": "azure",
},
).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.Chat.update',
[
'botId' => 456,
'dialogId' => 'chat5',
'fields' => [
'title' => 'New Title',
'color' => 'azure',
],
]
);
$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.update',
{
botId: 456,
dialogId: 'chat5',
fields: {
title: 'New Title',
color: 'azure',
},
},
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.update',
[
'botId' => 456,
'dialogId' => 'chat5',
'fields' => [
'title' => 'New Title',
'color' => 'azure',
],
]
);
if (!empty($result['error'])) {
echo 'Error: ' . $result['error_description'];
} else {
echo 'Updated';
}
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "imbot.v2.Chat.update", b24.Params{
"botId": 456,
"botToken": "my_bot_token",
"dialogId": "chat5",
"fields": b24.Params{
"title": "New Title",
"color": "azure",
},
})
if err != nil {
return fmt.Errorf("imbot.v2.Chat.update: %w", err)
}
var item struct {
Result bool `json:"result"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.Result)
Ответ
HTTP-статус: 200
{
"result": {
"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"
}
}
Обработка ошибок
HTTP-статус: 400
{
"error": "ACCESS_DENIED",
"error_description": "Access denied"
}
| Код | Описание | Значение |
|---|---|---|
BOT_TOKEN_NOT_SPECIFIED |
Bot token is not specified | Не указан botToken. Обязателен при авторизации через вебхук |
BOT_ID_REQUIRED |
Bot ID is required | Не указан botId |
BOT_NOT_FOUND |
Bot not found | Бот не найден |
BOT_OWNERSHIP_ERROR |
Bot is registered by another application | Бот зарегистрирован другим приложением |
ACCESS_DENIED |
Access denied | Бот не является участником чата |

