Изменить цвет чата imbot.chat.updateColor

Scope: imbot

Кто может выполнять метод: авторизованный пользователь приложения, которое зарегистрировало чат-бота

DEPRECATED

Развитие метода остановлено. Используйте imbot.v2.Chat.update.

Метод imbot.chat.updateColor обновляет цвет чата для мобильного приложения.

Параметры метода

Обязательные параметры отмечены *

Название `тип`	Описание
CHAT_ID* `integer`	Идентификатор чата. Идентификатор можно получить с помощью метода imbot.chat.get
COLOR* `string`	Цвет чата для мобильного приложения. Возможные значения: `RED` — красный `GREEN` — зеленый `MINT` — мятный `LIGHT_BLUE` — светло-синий `DARK_BLUE` — темно-синий `PURPLE` — фиолетовый `AQUA` — аквамариновый `PINK` — розовый `LIME` — лаймовый `BROWN` — коричневый `AZURE` — лазурный `KHAKI` — хаки `SAND` — песочный `MARENGO` — маренго `GRAY` — серый `GRAPHITE` — графитовый
BOT_ID `integer`	Идентификатор чат-бота. Получить идентификатор бота можно с помощью метода imbot.bot.list. Если параметр не передан, метод ищет первого бота, который зарегистрирован текущим приложением
CLIENT_ID `string`	Параметр обязателен только для вебхуков. Передавайте тот же CLIENT_ID, который был указан при регистрации чат-бота

Примеры кода

Как использовать примеры в документации

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST /
        -H "Content-Type: application/json" /
        -H "Accept: application/json" /
        -d '{"CHAT_ID":2725,"COLOR":"PINK","CLIENT_ID":"**put_your_client_id_here**"}' /
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/imbot.chat.updateColor

curl -X POST /
        -H "Content-Type: application/json" /
        -H "Accept: application/json" /
        -d '{"CHAT_ID":2725,"COLOR":"PINK","auth":"**put_access_token_here**"}' /
        https://**put_your_bitrix24_address**/rest/imbot.chat.updateColor

try
        {
            const response = await $b24.callMethod(
                'imbot.chat.updateColor',
                {
                    CHAT_ID: 2725,
                    COLOR: 'PINK'
                }
            );
            
            const result = response.getData().result;
            console.log('Updated chat color:', result);
            processResult(result);
        }
        catch( error )
        {
            console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'imbot.chat.updateColor',
                    [
                        'CHAT_ID' => 2725,
                        'COLOR' => 'PINK'
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error updating chat color: ' . $e->getMessage();
        }

BX24.callMethod(
            'imbot.chat.updateColor',
            {
                CHAT_ID: 2725,
                COLOR: 'PINK',
            },
            function (result)
            {
                if (result.error())
                    console.error(result.error());
                else
                    console.dir(result.data());
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'imbot.chat.updateColor',
            [
                'CHAT_ID' => 2725,
                'COLOR' => 'PINK'
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Обработка ответа

HTTP-статус: 200

{
            "result": true,
            "time": {
                "start": 1771935255,
                "finish": 1771935255.192065,
                "duration": 0.19206500053405762,
                "processing": 0,
                "date_start": "2026-02-24T15:14:15+03:00",
                "date_finish": "2026-02-24T15:14:15+03:00",
                "operating_reset_at": 1771935855,
                "operating": 0
            }
        }

Возвращаемые данные

Название `тип`	Описание
result `boolean`	`true`, если цвет чата обновлен
time `time`	Информация о времени выполнения запроса

Обработка ошибок

HTTP-статус: 400, 403

{
            "error": "WRONG_COLOR",
            "error_description": "This color currently unavailable"
        }

Название `тип`	Описание
error `string`	Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания
error_description `error_description`	Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

Возможные коды ошибок

Код	Описание	Значение
`CHAT_ID_EMPTY`	Chat ID can't be empty	Не передан `CHAT_ID`
`ACCESS_ERROR`	Action unavailable	Операция недоступна для этого чата
`WRONG_COLOR`	This color currently unavailable	Передан недопустимый цвет
`WRONG_REQUEST`	This color currently set or chat isn't exists	Цвет уже установлен или чат не существует
`BOT_ID_ERROR`	Bot not found	Чат-бот не найден
`APP_ID_ERROR`	Bot was installed by another rest application	Чат-бот установлен другим приложением

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус	Код Текст ошибки	Описание
`500`	`INTERNAL_SERVER_ERROR` Internal server error	Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	Превышен лимит на интенсивность запросов
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	Текущий метод не разрешен для вызова с помощью batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	Превышена максимальная длина параметров, переданных в метод batch
`401`	`NO_AUTH_FOUND` Wrong authorization data	Неверный access-токен или код вебхука
`400`	`INVALID_REQUEST` Https required	Для вызовов методов требуется использовать протокол HTTPS
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	REST API доступен только на коммерческих планах
`403`	`INVALID_CREDENTIALS` Invalid request credentials	У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	Манифест недоступен
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	Запрос требует более высоких привилегий, чем предоставляет токен вебхука
`401`	`expired_token` The access token provided has expired	Предоставленный access-токен доступа истек
`403`	`user_access_error` The user does not have access to the application	Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям
`500`	`PORTAL_DELETED` Portal was deleted	Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Изменить аватар чата

Получить идентификатор чата

Изменить цвет чата imbot.chat.updateColor

Параметры методаПараметры метода

Примеры кодаПримеры кода

Обработка ответаОбработка ответа

Возвращаемые данныеВозвращаемые данные

Обработка ошибокОбработка ошибок

Возможные коды ошибокВозможные коды ошибок

Статусы и коды системных ошибокСтатусы и коды системных ошибок

Продолжите изучениеПродолжите изучение