История документа
09.06.2026
- Раздел 3.2.1 «Создать новую сессию» (/cc/md/session/create):
- параметр запроса message переведен в необязательные;
- обновлено описание метода;
- в параметры ответа добавлен обязательный параметр session_id;
- в параметры ответа добавлен необязательный объект message;
- добавлено описание структуры объекта message;
- актуализированы примеры ответов.
- Раздел 6.1.5 «Получить список активных сессий» (/cc/md/sessions):
- добавлен новый необязательный параметр запроса chat_id;
- дополнено описание метода информацией о фильтрации по chat_id;
- добавлен пример запроса с использованием параметра chat_id.
Также проведена полная проверка ссылок в документации. Добавлены отсутствующие перекрестные ссылки и исправлены неработающие ссылки, включая те, которые не были указаны в замечаниях. Проверена корректность переходов по всем ссылкам документа.
02.06.2026
- Раздел 2.4 «Объекты данных» — актуализированы описания объектов, добавлены новые поля и ссылки на объект Session.
- Раздел 3.1 «Обмен сообщениями в WhatsApp» — метод get_mcw_message_status удалён из основного раздела и перенесён в раздел устаревших методов.
- Раздел 3.3 «API Realtime (вебхуки)» — переработаны описания вебхуков, сокращены таблицы параметров, обновлены примеры JSON в соответствии с новой структурой объектов.
- Раздел 3.3.7 «Новое сообщение в чате» — добавлено поле local_message_id в описание и примеры вебхука.
- Раздел 4 «Коды ошибок» — полностью обновлены подразделы 4.1, 4.2.1, 4.2.2, 4.2.3 и 4.2.4.
- Раздел 5.1 «Прием и обработка обращений Клиента» — обновлены схемы взаимодействия и примеры вебхуков в соответствии с новой моделью данных.
- Раздел 5.2 «Оператор обращается к Клиенту» — обновлены примеры запросов и вебхуков, актуализированы структуры JSON.
- Раздел 5.3 «Перевод обращения на другого оператора» — обновлены примеры запросов и вебхуков, приведены к актуальному формату.
- Раздел 6 «Устаревшие методы API» — создан новый раздел для устаревших методов.
- Раздел 6.2 «Получение статусов отправленных HSM-сообщений» — добавлен метод POST /cc/get_mcw_message_status, перенесённый из основного раздела документации.
- По всей документации — актуализированы примеры вебхуков, удалена устаревшая обёртка vpbx_api_key, sign, json из примеров событий Realtime API, исправлены и приведены к единому формату JSON-примеры.
01.04.2026
- Приведен к единому виду раздел 2.3.7 «Электронная подпись запросов».
- Добавлен раздел 2.4 «Объекты данных» (Widget, Channel, Question, Message, Payload, Button).
- В разделе 3.2.4 убрано дублирование вложенных структур, добавлены ссылки на 2.4
- В разделе 3.2.5 нормализована структура ответа, убраны вложенные описания объектов.
- В разделе 3.3.5 вынесено описание payload в раздел 2.4, упрощена структура метода
- В разделе 3.3.6 вынесены Message/Payload/Button в 2.4, сокращено описание метода.
16.03.2026
- Исправлены блоки кода во всей документации.
- Проверен и актуализирован раздел 4.2 «Возможные коды ошибок API».
- Добавлены отсутствующие коды ошибок: server-error, system-error, subject-error, sender-account-has-been-locked.
- Список ошибок сверен с реестром ошибок текстовых каналов.
- Тексты ошибок унифицированы.
- Раздел приведён к единой структуре.
- Добавлено правило обработки неизвестных ошибок (system-error).
13.03.2026
- Обновлен раздел 3.5.5 «Сообщение оператора не доставлено клиенту».
- Заменен URL вебхука на /events/cc/md/session/chat/on_error_message.
- Актуализированы параметры вебхука и пример события.
- Добавлена информация о кодах ошибок доставки сообщений.
- Коды ошибок оформлены в разделе 4.2 «Возможные коды ошибок API».
- Приведено к единому виду оформление таблиц и блоков примеров по всему документу.
27.02.2026
- Обновлено перечисление типов каналов. Удалён Viber (type = 5). Добавлены новые каналы коммуникации: Авито Работа (type = 14) и MAX
(type = 15).
- В методе 3.4.6 «Загрузка истории чата» удалён параметр productId.
- В методе 3.4.6 уточнено описание поля text – добавлено пояснение для типа buttons.
- В методе 3.4.6 для полей width, height, buttons изменён признак обязательности на «Да, с условием».
27.05.2025
Добавлено описание следующих методов:
- 3.1 Обмен сообщениями в WhatsApp;
- 3.2 Отправление каскада сообщений через WhatsApp и SMS
29.11.2024
Обновлены диаграммы
09.07.2024
Корректировка описания вебхука 3.3.5 HSM-сообщение оператора прочитано клиентом, а также метода 3.2.3 Перевод сессии на другого сотрудника или группу
02.07.2024
Выпущен впервые.
Была ли статья полезна?
Следующая