Создать групповой чат imbot.v2.Chat.add

Scope: imbot

Кто может выполнять метод: владелец зарегистрированного бота

Метод imbot.v2.Chat.add создает новый групповой чат от имени бота. Если владелец не указан — им становится бот.

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

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

Название
Тип

Описание

botId*
integer

ID бота

botToken
string

Уникальный токен авторизации бота. Обязателен при авторизации через вебхук, не нужен для OAuth.

Передавайте тот же botToken, который был указан при регистрации чат-бота

fields
object

Свойства создаваемого чата. Структура объекта описана ниже

Параметр fields

Название
Тип

Описание

title
string

Название чата

description
string

Описание чата

color
string

Цвет чата — доступные цвета.

Если не указан или некорректен — назначается автоматически

avatar
file

Аватар чата в формате Base64

userIds
integer[]

Массив ID участников

ownerId
integer

ID владельца чата. Если не указан — владельцем становится бот

message
string

Первое сообщение в чате

Доступные цвета

Код

HEX

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","fields":{"title":"Support Chat","color":"mint","userIds":[1,2]}}' \
          https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/imbot.v2.Chat.add
        
curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"botId":456,"fields":{"title":"Support Chat","color":"mint","userIds":[1,2]},"auth":"**put_access_token_here**"}' \
          https://**put_your_bitrix24_address**/rest/imbot.v2.Chat.add
        
try {
          const response = await $b24.callMethod('imbot.v2.Chat.add', {
            botId: 456,
            fields: {
              title: 'Support Chat',
              color: 'mint',
              userIds: [1, 2],
            },
          });
        
          const { result } = response.getData();
          console.log('result:', result);
        } catch (error) {
          console.error('Error:', error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'imbot.v2.Chat.add',
                    [
                        'botId' => 456,
                        'fields' => [
                            'title' => 'Support Chat',
                            'color' => 'mint',
                            'userIds' => [1, 2],
                        ],
                    ]
                );
        
            $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.add',
            {
                botId: 456,
                fields: {
                    title: 'Support Chat',
                    color: 'mint',
                    userIds: [1, 2],
                },
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error().ex);
                } else {
                    console.log('Chat ID:', result.data().chat.id);
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'imbot.v2.Chat.add',
            [
                'botId' => 456,
                'fields' => [
                    'title' => 'Support Chat',
                    'color' => 'mint',
                    'userIds' => [1, 2],
                ],
            ]
        );
        
        if (!empty($result['error'])) {
            echo 'Error: '. $result['error_description'];
        } else {
            echo 'Chat ID: '. $result['result']['chat']['id'];
        }

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

HTTP-код: 200

{
            "result": {
                "chat": {
                    "id": 5,
                    "dialogId": "chat5",
                    "name": "Support Chat",
                    "description": "",
                    "owner": 456,
                    "color": "#4ba984",
                    "avatar": "",
                    "type": "chat",
                    "role": "owner",
                    "dateCreate": "2025-01-15T10:00:00+03:00",
                    "lastMessageId": null,
                    "muteList": [],
                    "managerList": []
                },
                "users": [
                    {
                        "id": 1,
                        "active": true,
                        "name": "John Smith",
                        "type": "employee"
                    },
                    {
                        "id": 2,
                        "active": true,
                        "name": "Anna Davis",
                        "type": "employee"
                    }
                ]
            },
            "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
object

Результат создания чата

result.chat
Chat

Объект созданного чата (подробное описание)

result.users
User[]

Массив участников чата (подробное описание)

time
time

Информация о времени выполнения запроса

Поля объекта Chat

Поле
Тип

Описание

id
integer

Идентификатор чата

dialogId
string

Идентификатор диалога

name
string

Название чата

description
string

Описание чата

owner
integer

Идентификатор владельца чата

color
string

Цвет чата

avatar
string

URL аватара

type
string

Тип чата

role
string

Роль бота в чате

dateCreate
string

Дата создания чата

lastMessageId
integer

Идентификатор последнего сообщения

muteList
array

Список пользователей с отключенными уведомлениями

managerList
array

Список администраторов чата

Поля объекта User

Поле
Тип

Описание

id
integer

Идентификатор пользователя

active
boolean

Пользователь активен

name
string

Имя и фамилия пользователя

type
string

Тип пользователя

Полное описание всех полей объектов — на странице Объекты и поля

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

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

{
            "error": "BOT_NOT_FOUND",
            "error_description": "Bot not found"
        }

Название
тип

Описание

error
string

Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания

error_description
error_description

Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

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

Код

Описание

Значение

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

Бот зарегистрирован другим приложением

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

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

Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

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

Предыдущая
Обзор методов
Следующая
Получить информацию о чате