Add User to Existing Chat imopenlines.crm.chat.user.add

Scope: imopenlines

Who can execute the method: any user with access to the CRM entity

The method imopenlines.crm.chat.user.add adds a user to a chat associated with a CRM entity.

Method Parameters

Required parameters are marked with *

Name `type`	Description
CRM_ENTITY_TYPE* `string`	Type of the CRM entity. Possible values: `lead` — lead `deal` — deal `company` — company `contact` — contact
CRM_ENTITY* `integer`	Identifier of the CRM entity. You can obtain the identifier using the universal method get CRM item list
USER_ID* `integer`	Identifier of the user or bot to be added to the chat. You can obtain the user identifier using the user.get and user.search methods
CHAT_ID `integer`	Identifier of the chat. By default, the last chat associated with the CRM entity is used. You can obtain the identifiers of chats associated with the CRM entity using the imopenlines.crm.chat.get method

Code Examples

How to Use Examples in Documentation

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);

Response Handling

HTTP Status: 200

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

Returned Data

Name
type

Description

result
integer

Identifier of the chat to which the user has been added.

If CHAT_ID is not provided and no chat is found for the CRM entity, the method will return "result":0

time
time

Information about the request execution time

Error Handling

HTTP Status: 400, 403

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

Name `type`	Description
error `string`	String error code. It may consist of digits, Latin letters, and underscores
error_description `error_description`	Textual description of the error. The description is not intended to be shown to the end user in its raw form

Possible Error Codes

Status	Code	Description	Value
`403`	`ACCESS_DENIED`	Access denied! You don't have access to join user to chat	The user executing the method does not have permission to add users to the CRM entity chat
`403`	`ACCESS_DENIED`	Access denied! This user does not have access to the chat because he does not have access to this CRM entity	The user `USER_ID` does not have access to the CRM entity
`400`	`ERROR_ARGUMENT`	Argument CRM_ENTITY_TYPE is null or empty	Required parameter `CRM_ENTITY_TYPE` is not provided
`400`	`ERROR_ARGUMENT`	Argument CRM_ENTITY is null or empty	Required parameter `CRM_ENTITY` is not provided
`400`	`ERROR_ARGUMENT`	The value of an argument `CRM_ENTITY` has an invalid type	The `CRM_ENTITY` parameter is provided in an incorrect format
`400`	`ERROR_ARGUMENT`	Argument Empty USER_ID is null or empty	Required parameter `USER_ID` is not provided
`400`	`IM_NOT_INSTALLED`	Module im is not installed	The `im` module is not installed
`400`	`CHAT_NOT_IN_CRM`	Chat does not belong to the CRM entity being checked	The chat `CHAT_ID` is not associated with the CRM entity
`400`	`CRM_CHAT_USER_NOT_ACTIVE`	Current user has no access to users list outside open line	The current user does not have access to the user list outside the open line

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	The current method is not allowed to be called using batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	The maximum length of parameters passed to the batch method has been exceeded
`401`	`NO_AUTH_FOUND` Wrong authorization data	Invalid access token or webhook code
`400`	`INVALID_REQUEST` Https required	The methods must be called using the HTTPS protocol
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is available only on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user whose access token or webhook was used to call the method lacks permissions
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	The manifest is not available
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires higher privileges than those provided by the webhook token
`401`	`expired_token` The access token provided has expired	The provided access token has expired
`403`	`user_access_error` The user does not have access to the application	The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users
`500`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Retrieve Chats for the CRM Object

Remove a User from the CRM Object Chat

Add User to Existing Chat imopenlines.crm.chat.user.add

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning