Добавить пользователя к существующему чату imopenlines.crm.chat.user.add

Scope: imopenlines

Кто может выполнять метод: любой пользователь с доступом к объекту CRM

Метод imopenlines.crm.chat.user.add добавляет пользователя в чат, привязанный к объекту CRM.

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

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

Название `тип`	Описание
CRM_ENTITY_TYPE* `string`	Тип объекта CRM. Возможные значения: `lead` — лид `deal` — сделка `company` — компания `contact` — контакт
CRM_ENTITY* `integer`	Идентификатор объекта CRM. Получить идентификатор можно универсальным методом получения списка элементов CRM
USER_ID* `integer`	Идентификатор пользователя или бота, которого нужно добавить в чат. Получить идентификатор пользователя позволяют методы user.get и user.search
CHAT_ID `integer`	Идентификатор чата. По умолчанию используется последний чат, привязанный к объекту CRM. Получить идентификаторы чатов, привязанных к объекту CRM можно методом imopenlines.crm.chat.get

Примеры кода

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

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"CRM_ENTITY_TYPE":"lead","CRM_ENTITY":1205,"USER_ID":503,"CHAT_ID":1763}' \
          https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/imopenlines.crm.chat.user.add

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"CRM_ENTITY_TYPE":"lead","CRM_ENTITY":1205,"USER_ID":503,"CHAT_ID":1763,"auth":"**put_access_token_here**"}' \
          https://**put_your_bitrix24_address**/rest/imopenlines.crm.chat.user.add

try
        {
            const response = await $b24.callMethod(
                'imopenlines.crm.chat.user.add',
                {
                    CRM_ENTITY_TYPE: 'lead',
                    CRM_ENTITY: 1205,
                    USER_ID: 503,
                    CHAT_ID: 1763
                }
            );
        
            const result = response.getData().result;
            console.log(result);
        }
        catch (error)
        {
            console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'imopenlines.crm.chat.user.add',
                    [
                        'CRM_ENTITY_TYPE' => 'lead',
                        'CRM_ENTITY' => 1205,
                        'USER_ID' => 503,
                        'CHAT_ID' => 1763,
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            print_r($result);
        } catch (Throwable $e) {
            echo $e->getMessage();
        }

BX24.callMethod(
            'imopenlines.crm.chat.user.add',
            {
                CRM_ENTITY_TYPE: 'lead',
                CRM_ENTITY: 1205,
                USER_ID: 503,
                CHAT_ID: 1763
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.log(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'imopenlines.crm.chat.user.add',
            [
                'CRM_ENTITY_TYPE' => 'lead',
                'CRM_ENTITY' => 1205,
                'USER_ID' => 503,
                'CHAT_ID' => 1763,
            ]
        );
        
        print_r($result);

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

HTTP-статус: 200

{
            "result": 1763,
            "time": {
                "start": 1773814042,
                "finish": 1773814043.189039,
                "duration": 1.1890389919281006,
                "processing": 0,
                "date_start": "2026-03-18T09:07:22+03:00",
                "date_finish": "2026-03-18T09:07:23+03:00",
                "operating_reset_at": 1773814643,
                "operating": 0.16756796836853027
            }
        }

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

Название
тип

Описание

result
integer

Идентификатор чата, в который добавлен пользователь.

Если CHAT_ID не передан и чат для объекта CRM не найден или не существует, метод вернет "result":0

time
time

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

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

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

{
            "error": "CHAT_NOT_IN_CRM",
            "error_description": "Chat does not belong to the CRM entity being checked"
        }

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

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

Статус	Код	Описание	Значение
`403`	`ACCESS_DENIED`	Access denied! You don't have access to join user to chat	У пользователя, который выполняет метод, нет прав добавлять пользователей в чат объекта CRM
`403`	`ACCESS_DENIED`	Access denied! This user does not have access to the chat because he does not have access to this CRM entity	У пользователя `USER_ID` нет доступа к объекту CRM
`400`	`ERROR_ARGUMENT`	Argument CRM_ENTITY_TYPE is null or empty	Не передан обязательный параметр `CRM_ENTITY_TYPE`
`400`	`ERROR_ARGUMENT`	Argument CRM_ENTITY is null or empty	Не передан обязательный параметр `CRM_ENTITY`
`400`	`ERROR_ARGUMENT`	The value of an argument `CRM_ENTITY` has an invalid type	Параметр `CRM_ENTITY` передан в неверном формате
`400`	`ERROR_ARGUMENT`	Argument Empty USER_ID is null or empty	Не передан обязательный параметр `USER_ID`
`400`	`IM_NOT_INSTALLED`	Module im is not installed	Модуль `im` не установлен
`400`	`CHAT_NOT_IN_CRM`	Chat does not belong to the CRM entity being checked	Чат `CHAT_ID` не связан с объектом CRM
`400`	`CRM_CHAT_USER_NOT_ACTIVE`	Current user has no access to users list outside open line	У текущего пользователя нет доступа к списку пользователей вне линии

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

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

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

Получить чаты для объекта CRM

Удалить пользователя из чата объекта CRM

Добавить пользователя к существующему чату imopenlines.crm.chat.user.add

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

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

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

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

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

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

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

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