Сравнение версий

Ключ

  • Эта строка добавлена.
  • Эта строка удалена.
  • Изменено форматирование.

...

  • В ответ на подключение будет получено следующее сообщение:
Блок кода
languagejson
linenumberstrue
{
    "id": 1, // Порядковый номер сообщения
    "connect": { // Подробная информация о подключении
        "client": "bce7d22e-dde6-4427-b391-ebbdfda44de6", // Идентификатор клиента
        "version": "6.2.1 OSS", // Системная информация. Не имеет роли для интеграции
        "subs": { // Список доступных подписок
            "widget:bce7d22e-dde6-4427-b391-ebbdfda44de6": { // Имя канала подписки
                "recoverable": true, // Системная информация. Не имеет роли для интеграции
                "epoch": "1769579399", // Системная информация. Не имеет роли для интеграции
                "positioned": true // Системная информация. Не имеет роли для интеграции
            }
        },
        "ping": 25, // Частота пинга
        "pong": true // Флаг наличия понга
    }
}

...

  • showTypingIndicator – уведомление о наборе сообщения ботом или оператором
    Блок кода
    languagejson
    titlePayload события
    linenumberstrue
    {
        "authorType": "BOT" // Автор события: BOT | OPERATOR
    }
  • chatMessageCreated – сообщение от бота или оператора
    Блок кода
    languagejson
    titlePayload события
    linenumberstrue
    {
        "id": "bce7d22e-dde6-4427-b391-ebbdfda44de6", // REQUIRED. Уникальный идентификатор сообщения
        "authorType": "BOT", // REQUIRED. ENUM: 'BOT' | 'OPERATOR'. Тип автора сообщения
        "body": "Тестовое сообщение", // REQUIRED. Текст сообщения (может быть пустым)
        "answers": [ // REQUIRED. Массив предустановленных вариантов ответов для пользователя
            "Вариант ответа 1",
            "Вариант ответа 2",
            "Вариант ответа 3"
        ],
        "keyboard": { // OPTIONAL. Объект клавиатуры с кнопками быстрых ответов
            "buttonsInRow": 2, // Количество кнопок в одном ряду
            "buttons": [ // Массив кнопок для отображения
                {
                    "type": "text", // Тип кнопки. Всегда text. 
                    "text": "Кнопка 1" // Текст на кнопке
                },
                {
                    "type": "text",
                    "text": "Кнопка 2"
                }
            ]
        },
        "createdAt": "2026-01-28T12:00:00+00:00", // REQUIRED. Дата и время создания сообщения в формате ISO 8601
        "sessionId": "bce7d22e-dde6-4427-b391-ebbdfda44de6", // REQUIRED. Идентификатор сессии чата 
        "attachments": [ // REQUIRED. Массив прикрепленных файлов (может быть пустым)
            {
                "id": "bce7d22e-dde6-4427-b391-ebbdfda44de6", // REQUIRED. Идентификатор вложения
                "contentType": "image/png", // REQUIRED. MIME-тип файла (например: 'image/png', 'application/pdf')
                "size": 1024000, // REQUIRED. Размер файла в байтах
                "downloadLink": "https://example.com/file.png", // REQUIRED. Ссылка для скачивания файла
                "name": "test-file.png", // REQUIRED. Имя файла
                "url": "https://example.com/file.png" // OPTIONAL. Альтернативная ссылка на файл
            }
        ],
        "actions": [ // REQUIRED. Массив действий/кнопок для интерактивности (ожетможет быть пустым)
            {
                "type": "button", // REQUIRED. Тип действия
                "event": "click_action", // OPTIONAL. Событие, которое триггерится при клике
                "label": "Нажми меня", // OPTIONAL. Текст на кнопке действия
                "data": "{\"key\": \"value\"}" // OPTIONAL. Дополнительные данные в формате строки
            }
        ],
        "avatar": "https://example.com/avatar.png", // OPTIONAL. URL аватара автора
        "authorId": "bce7d22e-dde6-4427-b391-ebbdfda44de6", // OPTIONAL. Идентификатор автора
        "authorName": "Тестовый Автор", // OPTIONAL. Имя автора сообщения
        "type": "REGULAR", // OPTIONAL. ENUM: 'REGULAR' | 'TERMINAL'. Тип сообщения
        "replyId": "bce7d22e-dde6-4427-b391-ebbdfda44de6", // OPTIONAL. Идентификатор сообщения, на которое это сообщение является ответом
        "replyToMessage": { // OPTIONAL. Объект с информацией о сообщении, на которое отвечают
            "id": "bce7d22e-dde6-4427-b391-ebbdfda44de6", // REQUIRED. Идентификатор исходного сообщения
            "authorType": "CLIENT", // REQUIRED. ENUM: 'BOT' | 'OPERATOR' | 'CLIENT'. Тип автора исходного сообщения
            "body": "Исходное сообщение", // OPTIONAL. Текст исходного сообщения
            "authorName": "Имя клиента" // OPTIONAL. Имя автора исходного сообщения
        }
    }
  • operatorChanged – событие переключение диалога с бота или оператора на другого оператора или бота
    Блок кода
    languagejson
    titlePayload события
    linenumberstrue
    {
        "operatorId": "bce7d22e-dde6-4427-b391-ebbdfda44de6", // REQUIRED. Идентификатор нового оператора 
        "operatorName": "Тестовый Оператор", // REQUIRED. Имя нового оператора
        "avatar": "https://example.com/avatar.png", // REQUIRED. URL аватара нового оператора
        "previousOperatorId": "bce7d22e-dde6-4427-b391-ebbdfda44de6", // REQUIRED. Идентификатор предыдущего оператора
        "previousOperatorName": "Предыдущий Оператор", // REQUIRED. Имя предыдущего оператора
        "previousOperatorAvatar": null // REQUIRED. URL аватара предыдущего оператора
    }
  • chatMessageRead – уведомление о прочтении сообщения оператором
    Блок кода
    languagejson
    titlePayload события
    linenumberstrue
    {
        "messageId": "bce7d22e-dde6-4427-b391-ebbdfda44de6" // REQUIRED. Идентификатор сообщения
    }
  • sessionClosed – уведомление о закрытии сессии оператором
    Блок кода
    languagejson
    titlePayload события
    linenumberstrue
    {
        "sessionId": "bce7d22e-dde6-4427-b391-ebbdfda44de6", // REQUIRED. Идентификатор закрываемой сессии 
        "chatId": "bce7d22e-dde6-4427-b391-ebbdfda44de6", // REQUIRED. Идентификатор чата
        "sessionRatingRequired": true // REQUIRED. Флаг, требуется ли оценка сессии от пользователя 
    }

...