Set a New Chat Name imconnector.chat.name.set

Scope: imconnector

Who can execute the method: any user

The method imconnector.chat.name.set sets a new name for the chat.

The method works only in the context of the application.

Method Parameters

Required parameters are marked with *

Name `type`	Description
CONNECTOR* `string`	The string code of the connector specified in the `ID` parameter when calling imconnector.register
LINE* `integer`	Identifier of the Open Channel The identifier can be obtained using the methods imopenlines.config.get and imopenlines.config.list.get
CHAT_ID* `string`	Identifier of the chat in the external system
NAME* `string`	New name for the chat
USER_ID `string`	User identifier. This parameter is mandatory only for connectors without group chats from the external side. For such a connector, the `CHAT_GROUP` parameter in the imconnector.register method must be set to `N`

Code Examples

How to Use Examples in Documentation

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"CONNECTOR":"connector","LINE":105,"CHAT_ID":"47e007b1-ee15-43db-bcba-1c26e5884d3f","NAME":"New Dialog Name","auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/imconnector.chat.name.set

try
        {
            const response = await $b24.callMethod(
                'imconnector.chat.name.set',
                {
                    CONNECTOR: 'connector',
                    LINE: 105,
                    CHAT_ID: '47e007b1-ee15-43db-bcba-1c26e5884d3f',
                    NAME: 'New Dialog Name'
                }
            );
            
            const result = response.getData().result;
            if(result.error())
                alert("Error: " + result.error());
            else
                alert("Success: " + result);
        }
        catch( error )
        {
            console.error('Error:', error);
        }

try {
            $params = [
                'CONNECTOR' => 'connector',
                'LINE'      => 105,
                'CHAT_ID'   => '47e007b1-ee15-43db-bcba-1c26e5884d3f',
                'NAME'      => 'New Dialog Name',
            ];
        
            $response = $b24Service
                ->core
                ->call(
                    'imconnector.chat.name.set',
                    $params
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                echo 'Error: ' . $result->error();
            } else {
                echo 'Success: ' . $result->data();
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error setting chat name: ' . $e->getMessage();
        }

var params = {
            CONNECTOR: 'connector',
            LINE: 105,
            CHAT_ID: '47e007b1-ee15-43db-bcba-1c26e5884d3f',
            NAME: 'New Dialog Name'
        };
        BX24.callMethod(
            'imconnector.chat.name.set',
            params,
            function(result)
            {
                if(result.error())
                    alert("Error: " + result.error());
                else
                    alert("Success: " + result.data());
            }
        );

require_once('crest.php');
        
        $params = [
            'CONNECTOR' => 'connector',
            'LINE' => 105,
            'CHAT_ID' => '47e007b1-ee15-43db-bcba-1c26e5884d3f',
            'NAME' => 'New Dialog Name'
        ];
        
        $result = CRest::call(
            'imconnector.chat.name.set',
            $params
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP Status: 200

{
            "answer": {
                "result": {
                    "SUCCESS": true,
                    "DATA": {
                        "RESULT": {}
                    }
                },
                "time": {
                    "start": 1732110908.525962,
                    "finish": 1732110908.879113,
                    "duration": 0.3531508445739746,
                    "processing": 0.07694888114929199,
                    "date_start": "2024-11-20T15:55:08+02:00",
                    "date_finish": "2024-11-20T15:55:08+02:00"
                }
            },
            "query": {
                "method": "imconnector.chat.name.set",
                "data": {
                    "CONNECTOR": "newcustomconnector",
                    "LINE": "105",
                    "CHAT_ID": "1",
                    "NAME": "name"
                }
            },
            "status": 200
        }

Returned Data

Name `type`	Description
SUCCESS `boolean`	Returns `true` when the new chat name is successfully set
DATA `object`	Contains the `RESULT` object with parameters of the new chat name

Error Handling

HTTP Status: 400

{
            "error": "NOT_ACTIVE_LINE",
            "error_description": "The line with this ID is inactive or does not exist"
        }

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
`400`	`NOT_ACTIVE_LINE`	The line with this ID is inactive or does not exist
`400`	`IMCONNECTOR_NO_CORRECT_PROVIDER`	Unable to find a suitable provider for the connector
`400`	`ERROR_ARGUMENT`	Required parameters `NAME`, `CHAT_ID`, `USER_ID`, `CONNECTOR`, or `LINE` are missing
`400`	`CHAT_RENAMING_FAILED`	Failed to rename the chat

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

Update Delivery Status

Overview of Events

Set a New Chat Name imconnector.chat.name.set

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