/API
ДОКУМЕНТАЦИЯ ДЛЯ РАЗРАБОТЧИКОВ

Glagol API

Справочник методов для работы с записями в списках, отчётами, трассировками и состояниями карты диалога.

Базовый URL
Загружаем адрес API…
Открыть справочник OpenAPI JSON

Документация открыта — вход не нужен

Загружаем спецификацию
— методовOpenAPI —

Разделы API

Параметры, схемы и примеры запросов
доступны в описании каждого метода.

— методов

Записи в списках

Чтение списков и полей, создание и удаление записей, изменение записи целиком или отдельных полей.

  • Загружаем методы…
Все методы списков
— методов

Отчёты и диалоги

Выборки с фильтрами и без, отдельные карточки, трассировки решений и состояние карты диалога.

  • Загружаем методы…
Все методы отчётов

Как выполнить запрос

  1. 01

    Укажите авторизацию

    Передайте заголовок Authorization: Bearer <API_KEY> с вашим API-ключом или действующим JWT. В поле Bearer интерактивного клиента вставьте только значение токена.

  2. 02

    Заполните параметры

    Откройте метод в справочнике и укажите обязательные поля. Идентификаторы и значения в примерах замените своими. Необязательные фильтры можно не передавать.

  3. 03

    Проверьте ответ

    Отправьте запрос из интерактивного клиента или скопируйте пример кода. Рядом с методом доступны структура ответа, типы полей и правила пагинации.

Изменение пользовательских полей

В PATCH записи переданный custom заменяет объект целиком. Для изменения отдельных полей с сохранением остальных используйте bulk-update. Передача value: null удаляет значение поля; массивы автоматически не дополняются.

Последнее состояние карты

Снимки трассировки содержат последнее записанное состояние параметров и задач конкретного сегмента. Считать его итоговым можно после завершения процесса и обработки событий. Проверьте карточку отчёта и диагностические флаги; завершение одного шага не означает завершения диалога.