Установить новое имя чата imconnector.chat.name.set
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
imopenlinesКто может выполнять метод: любой пользователь
Метод imconnector.chat.name.set переименовывает в Битрикс24 чат открытой линии, который соответствует диалогу внешней системы с указанным CHAT_ID. Во внешней системе название диалога остается прежним.
Битрикс24 ищет открытую сессию по сочетанию CONNECTOR, LINE и CHAT_ID. Если такой сессии нет, метод возвращает ошибку CHAT_RENAMING_FAILED.
У коннекторов с CHAT_GROUP: false в поиске участвует еще и USER_ID, но ведет он себя иначе: если собеседник с таким идентификатором не найден, метод отвечает SUCCESS: true и чат не переименовывает.
Метод работает только в контексте приложения.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
CONNECTOR* |
Строковый код коннектора, который задали в параметре |
|
LINE* |
Идентификатор открытой линии. Идентификатор можно получить методами imopenlines.config.get и imopenlines.config.list.get |
|
CHAT_ID* |
Идентификатор чата во внешней системе — то же значение, что передают в |
|
NAME* |
Новое имя чата |
|
USER_ID |
Идентификатор собеседника во внешней системе — то же значение, что передают в Параметр обязателен для коннекторов, у которых при регистрации методом imconnector.register параметр |
Примеры кода
Как использовать примеры в документации
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 |
Результат установки имени чата (подробное описание) |
|
time |
Информация о времени выполнения запроса |
Объект result
|
Название |
Описание |
|
SUCCESS |
Возвращает Значение |
|
DATA |
Служебный объект. Поле |
Обработка ошибок
HTTP-статус: 400, 403
{
"error": "NOT_ACTIVE_LINE",
"error_description": "Линия c таким ID неактивна или не существует"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только |
|
error_description |
Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки |
Возможные коды ошибок
|
Статус |
Код |
Описание |
Значение |
|
|
|
Current authorization type is denied for this method Application context required |
Метод вызван не в контексте приложения OAuth |
|
|
|
Argument 'NAME' is null or empty |
Не передан или пуст один из параметров: |
|
|
|
Линия c таким ID неактивна или не существует |
Коннектор не включен на этой линии или линии с таким |
|
|
|
Не удалось найти подходящий провайдер для коннектора |
Коннектор с таким кодом не зарегистрирован в Битрикс24 |
|
|
|
Chat renaming failed |
По переданному сочетанию параметров нет открытой сессии или переименовать чат не удалось |
Не все отказы приходят ошибкой: если по USER_ID не удалось определить собеседника во внешней системе, метод отвечает SUCCESS: true, но чат не переименовывается.
Статусы и коды системных ошибок
HTTP-статус: 4xx, 5xx
Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит |
|
|
|
В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука |
|
|
|
Методы вызываются только по протоколу HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — |
|
|
|
Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом |
|
|
|
Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа |
|
|
|
Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на |
|
|
|
Срок действия access-токена истек |
|
|
|
Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Зарегистрировать коннектор imconnector.register
- Активировать коннектор imconnector.activate
- Получить статус коннектора imconnector.status
- Установить настройки коннектора imconnector.connector.data.set
- Получить список коннекторов imconnector.list
- Отменить регистрацию коннектора imconnector.unregister
- Отправить сообщения в Битрикс24 imconnector.send.messages
- Изменить отправленные сообщения imconnector.update.messages
- Удалить отправленные сообщения imconnector.delete.messages
- Обновить статус «доставлено» imconnector.send.status.delivery
- Как создать коннектор открытых линий для чата на сайте