Установить новое имя чата imconnector.chat.name.set

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: imconnector

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

Метод imconnector.chat.name.set устанавливает новое имя чата.

Метод работает только в контексте приложения.

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

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

Название
тип

Описание

CONNECTOR*
string

Строковый код коннектора, который задали в параметре ID при вызове imconnector.register

LINE*
integer

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

Идентификатор можно получить методами imopenlines.config.get и imopenlines.config.list.get

CHAT_ID*
string

Идентификатор чата во внешней системе

NAME*
string

Новое имя чата

USER_ID
string

Идентификатор пользователя. Параметр является обязательным только для коннекторов без групповых чатов с внешней стороны. У такого коннектора в методе imconnector.register параметр CHAT_GROUP должен быть равен false

Примеры кода

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

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":"Новое имя диалога","auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/imconnector.chat.name.set
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

// Shape of the payload returned in result (match the "response handling" section of the page)
type ChatNameSetResult = {
  SUCCESS: boolean
  DATA: {
    RESULT: Record<string, unknown>
  }
}

try {
  const response = await $b24.actions.v2.call.make<ChatNameSetResult>({
    method: 'imconnector.chat.name.set',
    params: {
      CONNECTOR: 'connector',
      LINE: 105,
      CHAT_ID: '47e007b1-ee15-43db-bcba-1c26e5884d3f',
      NAME: 'New dialog name',
    },
    requestId: Text.getUuidRfc4122()
  })

  // The payload is available only on a successful response
  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    console.info('SUCCESS:', result.SUCCESS, 'DATA:', result.DATA)
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
  async function setChatName() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'imconnector.chat.name.set',
        params: {
          CONNECTOR: 'connector',
          LINE: 105,
          CHAT_ID: '47e007b1-ee15-43db-bcba-1c26e5884d3f',
          NAME: 'New dialog name',
        },
        requestId: B24Js.Text.getUuidRfc4122()
      })

      // The payload is available only on a successful response
      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      const result = response.getData().result
      console.info('SUCCESS:', result.SUCCESS, 'DATA:', result.DATA)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', setChatName)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.imconnector.chat.name.set(
        connector="connector",
        line=105,
        chat_id="47e007b1-ee15-43db-bcba-1c26e5884d3f",
        name="New dialog name",
    ).response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {error}")
try {
    $params = [
        'CONNECTOR' => 'connector',
        'LINE'      => 105,
        'CHAT_ID'   => '47e007b1-ee15-43db-bcba-1c26e5884d3f',
        'NAME'      => 'Новое имя диалога',
    ];

    $response = $b24Service
        ->core
        ->call(
            'imconnector.chat.name.set',
            $params
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    if ($result->error()) {
        echo 'Error: ' . $result->error();
    } else {
        echo 'Успешно: ' . $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: 'Новое имя диалога'
};
BX24.callMethod(
    'imconnector.chat.name.set',
    params,
    function(result)
    {
        if(result.error())
            alert("Error: " + result.error());
        else
            alert("Успешно: " + result.data());
    }
);
require_once('crest.php');

$params = [
    'CONNECTOR' => 'connector',
    'LINE' => 105,
    'CHAT_ID' => '47e007b1-ee15-43db-bcba-1c26e5884d3f',
    'NAME' => 'Новое имя диалога'
];

$result = CRest::call(
    'imconnector.chat.name.set',
    $params
);

echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "imconnector.chat.name.set", b24.Params{
	"CONNECTOR": "connector",
	"LINE":      105,
	"CHAT_ID":   "47e007b1-ee15-43db-bcba-1c26e5884d3f",
	"NAME":      "Новое имя диалога",
})
if err != nil {
	return fmt.Errorf("imconnector.chat.name.set: %w", err)
}

// Ответ приходит как json.RawMessage — разберите его
// в структуру под форму ответа, показанную ниже на этой странице.
fmt.Printf("%s\n", res.Result)

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

HTTP-статус: 200

{
    "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"
    }
}

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

Название
тип

Описание

result
object

Результат установки имени чата (подробное описание)

time
time

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

Объект result

Название
тип

Описание

SUCCESS
boolean

Возвращает true при успешной установке нового имени чата

DATA
object

Содержит объект RESULT c параметрами нового имени чата

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

HTTP-статус: 400

{
    "error": "NOT_ACTIVE_LINE",
    "error_description": "Линия c таким ID неактивна или не существует"
}

Название
тип

Описание

error
string

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

error_description
error_description

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

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

Статус

Код

Описание

400

NOT_ACTIVE_LINE

Линия c таким ID неактивна или не существует

400

IMCONNECTOR_NO_CORRECT_PROVIDER

Не удалось найти подходящий провайдер для коннектора

400

ERROR_ARGUMENT

Не указаны обязательные параметры NAME, CHAT_ID, USER_ID, CONNECTOR или LINE

400

CHAT_RENAMING_FAILED

Не удалось переименовать чат

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

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

Превышен лимит на интенсивность запросов

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут

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

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

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