Изменить отправленные сообщения imconnector.update.messages

Scope: imopenlines

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

Метод imconnector.update.messages обновляет данные ранее переданных сообщений внешней системы в открытой линии.

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

В параметрах метода используются значения внешней системы: идентификатор пользователя, идентификатор чата, ссылка на чат и его название в приложении, которое зарегистрировало коннектор.

Для обновления передавайте те же message.id и chat.id, которые использовали при отправке сообщений методом imconnector.send.messages.

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

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

Название
тип

Описание

CONNECTOR*
string

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

LINE*
integer

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

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

MESSAGES*
array

Массив сообщений для обновления. Каждый элемент массива — одно сообщение в формате объекта с тремя обязательными блоками: user, message, chat.

Структура объекта подробно описана ниже

Параметр MESSAGES

Название
тип

Описание

user
object

Данные пользователя внешней системы.

Структура объекта подробно описана ниже

message
object

Данные сообщения внешней системы.

Структура объекта подробно описана ниже

chat
object

Данные чата внешней системы.

Структура объекта подробно описана ниже

Объект user

Название
тип

Описание

id*
string

Идентификатор пользователя во внешней системе

last_name
string

Фамилия пользователя

name
string

Имя пользователя

picture
object

Аватар пользователя в формате объекта с полем url, например {"url":"https://example.ru/u42.png"}

url
string

Ссылка на профиль пользователя во внешней системе

gender
string

Пол пользователя. Поддерживаются значения male и female

email
string

Email пользователя

phone
string

Телефон пользователя

skip_phone_validate
string

Отключает проверку телефона перед сохранением в CRM. Допустимое значение — Y. Если проверка должна выполняться, не передавайте параметр

Объект message

Название
тип

Описание

id
string

Идентификатор сообщения во внешней системе, которое нужно обновить

date
integer

Время сообщения в Unix Timestamp в секундах

text
string

Новый текст сообщения. Передавайте text или files

О допустимом форматировании читайте в статье Форматирование

files
array

Массив файлов. Каждый файл передается как массив вида array('url' => 'Ссылка на файл', 'name' => 'Имя файла')

disable_crm
string

Отключает CRM трекер для сообщения. Допустимое значение — Y

user_id
integer

Идентификатор менеджера в Битрикс24. Если передать user_id, сообщение обновится от имени этого менеджера

Объект chat

Название
тип

Описание

id*
string

Идентификатор чата или канала во внешней системе. Рекомендуется передавать то же значение, что и в DATA.ID метода imconnector.connector.data.set

name
string

Название чата или канала. Рекомендуется использовать значение из DATA.NAME

url
string

Ссылка на чат или канал во внешней системе. Рекомендуется использовать значение из DATA.URL

Примеры кода

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

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{
            "CONNECTOR": "myconnector",
            "LINE": 107,
            "MESSAGES": [
              {
                "user": {
                  "id": "ext-user-42",
                  "last_name": "Иванов",
                  "name": "Иван",
                  "picture": {"url": "https://example.ru/u42.png"},
                  "url": "https://example.ru/users/42",
                  "gender": "male",
                  "email": "ivan@example.ru",
                  "phone": "+79990000000"
                },
                "message": {
                  "id": "ext-msg-1001",
                  "date": 1773266050,
                  "text": "Добрый день, уточнили детали"
                },
                "chat": {
                  "id": "channel-123",
                  "name": "Канал поддержки",
                  "url": "https://example.ru/chats/123"
                }
              }
            ],
            "auth": "**put_access_token_here**"
          }' \
          https://**put_your_bitrix24_address**/rest/imconnector.update.messages
        
const payload = {
            CONNECTOR: 'myconnector',
            LINE: 107,
            MESSAGES: [
                {
                    user: {
                        id: 'ext-user-42',
                        last_name: 'Иванов',
                        name: 'Иван',
                        picture: { url: 'https://example.ru/u42.png' },
                        url: 'https://example.ru/users/42',
                        gender: 'male',
                        email: 'ivan@example.ru',
                        phone: '+79990000000',
                    },
                    message: {
                        id: 'ext-msg-1001',
                        date: 1773266050,
                        text: 'Добрый день, уточнили детали',
                    },
                    chat: {
                        id: 'channel-123',
                        name: 'Канал поддержки',
                        url: 'https://example.ru/chats/123',
                    },
                },
            ],
        };
        
        const response = await $b24.callMethod('imconnector.update.messages', payload);
        console.log(response.getData());
        
$result = $b24Service->core->call(
            'imconnector.update.messages',
            [
                'CONNECTOR' => 'myconnector',
                'LINE' => 107,
                'MESSAGES' => [
                    [
                        'user' => [
                              'id' => 'ext-user-42',
                              'last_name' => 'Иванов',
                              'name' => 'Иван',
                              'picture' => ['url' => 'https://example.ru/u42.png'],
                              'url' => 'https://example.ru/users/42',
                              'gender' => 'male',
                              'email' => 'ivan@example.ru',
                              'phone' => '+79990000000',
                        ],
                        'message' => [
                              'id' => 'ext-msg-1001',
                              'date' => 1773266050,
                              'text' => 'Добрый день, уточнили детали',
                        ],
                        'chat' => [
                              'id' => 'channel-123',
                              'name' => 'Канал поддержки',
                              'url' => 'https://example.ru/chats/123',
                        ],
                    ],
                ],
            ]
        );
        
BX24.callMethod(
            'imconnector.update.messages',
            {
                CONNECTOR: 'myconnector',
                LINE: 107,
                MESSAGES: [
                    {
                        user: {
                            id: 'ext-user-42',
                            last_name: 'Иванов',
                            name: 'Иван',
                            picture: { url: 'https://example.ru/u42.png' },
                            url: 'https://example.ru/users/42',
                            gender: 'male',
                            email: 'ivan@example.ru',
                            phone: '+79990000000',
                        },
                        message: {
                            id: 'ext-msg-1001',
                            date: 1773266050,
                            text: 'Добрый день, уточнили детали',
                        },
                        chat: {
                            id: 'channel-123',
                            name: 'Канал поддержки',
                            url: 'https://example.ru/chats/123',
                        },
                    },
                ],
            },
            function(result) {
                console.log(result.data());
            }
        );
        
$result = CRest::call(
            'imconnector.update.messages',
            [
                'CONNECTOR' => 'myconnector',
                'LINE' => 107,
                'MESSAGES' => [
                    [
                        'user' => [
                            'id' => 'ext-user-42',
                            'last_name' => 'Иванов',
                            'name' => 'Иван',
                            'picture' => ['url' => 'https://example.ru/u42.png'],
                            'url' => 'https://example.ru/users/42',
                            'gender' => 'male',
                            'email' => 'ivan@example.ru',
                            'phone' => '+79990000000',
                        ],
                        'message' => [
                            'id' => 'ext-msg-1001',
                            'date' => 1773266050,
                            'text' => 'Добрый день, уточнили детали',
                        ],
                        'chat' => [
                            'id' => 'channel-123',
                            'name' => 'Канал поддержки',
                            'url' => 'https://example.ru/chats/123',
                        ],
                    ],
                ],
            ]
        );

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

HTTP-статус: 200

{
            "result": {
                "SUCCESS": true,
                "DATA": {
                    "RESULT": [
                        {
                            "user": "585",
                            "message": {
                                "id": "ext-msg-1001",
                                "date": {},
                                "text": "Добрый день, уточнили детали"
                            },
                            "chat": {
                                "id": "channel-123",
                                "name": "Канал поддержки",
                                "description": "Ссылка на исходный пост: https://example.ru/chats/123"
                            },
                            "SUCCESS": true
                        }
                    ]
                }
            },
            "time": {
                "start": 1773322669,
                "finish": 1773322669.300999,
                "duration": 0.3009989261627197,
                "processing": 0,
                "date_start": "2026-03-12T16:37:49+03:00",
                "date_finish": "2026-03-12T16:37:49+03:00",
                "operating_reset_at": 1773323269,
                "operating": 0
            }
        }

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

Название
тип

Описание

SUCCESS
boolean

Возвращает true в случае успешного изменения сообщения

DATA
object

Данные обработки сообщений.

Структура объекта подробно описана ниже

time
time

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

Объект DATA

Название
тип

Описание

RESULT
array

Массив результатов по каждому элементу MESSAGES.

Структура элемента подробно описана ниже

Объект RESULT[]

Название
тип

Описание

user
string

Внутренний идентификатор пользователя Битрикс24

message
object

Данные сообщения после обработки (подробное описание)

chat
object

Данные чата после обработки (подробное описание)

extra
object

Дополнительные флаги обработки сообщения (подробное описание)

SUCCESS
boolean

Признак успешной обработки текущего элемента массива

ERRORS
array

Массив текстов ошибок по текущему элементу, возвращается при SUCCESS = false

Объект message

Название
тип

Описание

id
string

Внешний идентификатор сообщения

date
object

Дата сообщения после обработки

text
string

Текст сообщения

files
array

Массив файлов сообщения

Объект chat

Название
тип

Описание

id
string

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

name
string

Название чата или канала

description
string

Описание чата, например ссылка на исходный пост

Объект extra

Название
тип

Описание

skip_phone_validate
string

Признак отключения проверки телефона, возвращается при значении Y

disable_tracker
string

Признак отключения CRM трекера, возвращается при значении Y

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

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

{
            "error": "ERROR_ARGUMENT",
            "error_description": "Argument 'LINE' is null or empty"
        }

Название
тип

Описание

error
string

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

error_description
error_description

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

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

Статус

Код

Описание

Значение

403

WRONG_AUTH_TYPE

Current authorization type is denied for this method Application context required

Метод вызван не в контексте приложения OAuth

400

ERROR_ARGUMENT

Argument 'CONNECTOR' is null or empty

Не передан CONNECTOR

400

ERROR_ARGUMENT

Argument 'LINE' is null or empty

Не передан LINE

400

ERROR_ARGUMENT

Argument 'MESSAGES' is null or empty

Не передан MESSAGES

400

NOT_ACTIVE_LINE

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

Передан неактивный LINE

400

IMCONNECTOR_NO_CORRECT_PROVIDER

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

Для коннектора не удалось инициализировать провайдер

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

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

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

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

Предыдущая
Отправить сообщения в Битрикс24
Следующая
Удалить отправленные сообщения