База Знаний CleverApp
  • Главная
  • Обзор платформы
    • Краткий обзор платформы CleverApp и создание первого бота
    • Автоподстановка переменных в текст бота
    • Валидация — проверка введенных данных
    • Основная информация контакта
    • Политика обработки персональных данных в боте
    • Работа с датами и временем
    • Арифметические операции в боте
    • Доступ к боту и проекту | Права и роли
    • Пополнение и списание баланса с внутреннего счета контакта
    • Массовое удаление контактов
    • Как удалить аккаунт с платформы CleverApp
  • Часто задаваемые вопросы
  • Тарифы и оплата
  • Партнерская программа платформы CleverApp
  • Создание чат-ботов (блоки платформы CleverApp)
    • Простые блоки
      • Блоки “Простое сообщение” и “Цепочка сообщений”
      • Блок “Назначить тег”
      • Блок “Удалить тег”
      • Блок “Заявка”
      • Блок “Сценарий”
      • Блок “Условие”
      • Блок “Переключатель”
      • Блоки “Этап сделки” и “Ответственный за сделку”
      • Блоки “Запрос номера телефона” и “Запрос Email”
      • Блок “Таймер”
      • Блок “Задержка”
      • Блок “Удалить переменную”
      • Блок “Старт”
    • Уведомления
      • Блок "Заявка"
      • Блок "Уведомление для контакта"
      • Блок "Отправить сообщение"
      • Блок "Отправить быстрое сообщение"
      • Блок "Письмо на Email"
    • Списки и таблицы
      • Блок “Чтение записей из списка”
      • Блок “Чтение записи из списка”
      • Блок “Добавление записи в список”
      • Блок “Проверка существования записи в списке”
      • Блок “Бронирование записи из списка”
      • Блок “Чтение строк из таблицы”
    • Платежи
    • Магазин
      • Блок "Чтение записей из списка"
      • Блок "Чтение записи из списка"
      • Блок “Корзина”
      • Блок “Список заказов”
    • Рассылка
    • Голосования
      • Блок “Регистрация участника голосования”
      • Блок “Голосование за участника”
      • Блок “Лидеры голосования”
    • Интеграции
      • Блок "Заказ на GetCourse"
      • Блок “Запись в Google Таблицу”
      • Блок “Проверка существования записи в Google Таблице”
      • Блок “Чтение списка из Клиентской Базы”
      • Блок “Чтение записи из Клиентской Базы”
      • Блок “Отправить контакт в группу JustClick”
      • Блок “Отправить контакт в группу Flowell”
      • Блок “HTTP запрос”
      • Блок “Исходящий Webhook”
    • Специальные
      • Блок “Назначить тег”
      • Блок “Удалить тег”
      • Блок “Сценарий”
      • Блок “Условие”
      • Блок “Переключатель”
      • Блок “Бронирование записи из списка”
      • Блоки “Запрос номера телефона” и “Запрос Email”
      • Блок "Письмо на Email"
      • Блок "Операция над переменной"
      • Блок “Удалить переменную”
      • Блок "A/B-тестирование"
      • Блок “Старт”
      • Блок "Удалить пользователя из бота"
      • Блок “Встроенный бот Телеграм”
      • Блок "Входящий Webhook"
      • Блок “HTTP запрос”
      • Блок “Интерпретатор JavaScript”
      • Блок “Исходящий Webhook”
      • Блок "Распределение по группам"
    • Enterprise блоки
    • Меню слева
      • Сценарий
      • Сообщения
      • Каналы
      • Авторассылки
      • Настройки
      • CRM
      • Списки
      • Бронирование
      • Статистика
  • Кнопки меню со встроенными ссылками
  • Меню в боте Telegram
  • Мессенджеры и соц. сети
    • Telegram
      • Создаем чат-бот и подключаем к каналу Telegram
      • Настройки в BotFather
      • Прямые ссылки на дополнительные сценарии в Телеграм
      • Инлайн-кнопки меню со встроенными ссылками
      • Инлайн-кнопки меню со встроенными ссылками на Web App приложение
      • Как передать права на Telegram-бота в @BotFather?
      • Подмена предыдущего сообщения в чате Telegram-бота
      • Business-аккаунт Telegram
      • Администрация канала или группы
    • Viber
      • Создаем чат-бот и подключаем к каналу Viber
      • Инлайн-кнопки меню со встроенными ссылками
    • WhatsApp
      • Создаем чат-бот и подключаем к каналу Whatsapp
      • Меню для WhatsApp
    • ВКонтакте
      • Создаем чат-бот и подключаем к каналу ВКонтакте
      • Инлайн-кнопки меню со встроенными ссылками
    • ТамТам
      • Создаем чат-бот и подключаем к каналу ТамТам
  • Авторассылки
    • Создание авторассылки
    • Гибкие фильтры авторассылок в CleverApp
    • Отложенная отправка сообщений
  • Магазин в Telegram
    • Импорт товаров в списки
    • Блоки “Чтение записей/записи из списка”
    • Постоплата и адрес доставки в корзине
    • Блок “Встроенный бот Телеграм” – Создание меню для магазина в Telegram
  • Аналитика
    • Встроенная CRM
    • UTM-метки
    • Статистика заявок и посетителей
    • Конверсии связей в сценариях
  • Интеграции
    • CRMCA
    • Клиентская база
    • amoCRM
    • Битрикс24
    • Платежные системы
      • Прием платежей и интеграция с ЮKassa
      • Прием платежей на ЮMoney
      • Прием платежей и интеграция с Robokassa
      • Прием платежей и интеграция с Cloudpayments
      • Прием платежей и интеграция c Prodamus
      • Прием платежей и интеграция с bePaid
      • Прием платежей и интеграция с LiqPay
      • Прием платежей и интеграция с JustClick
      • Прием платежей и интеграция с Flowell
      • Прием платежей и интеграция c Crypto Pay
    • Google Таблицы
    • SMS провайдеры
      • Интеграция с SMS.RU
      • Интеграция с SMS.to
      • Интеграция с SMSala
    • ERESH
    • GetCourse
    • YCLIENTS
    • Make
    • Integromat
    • Postback (постбек)
    • Интеграция CleverApp и ChatGPT
  • Конструктор Мини-лендингов
  • Форма "Захват телефона"
  • Конструктор Виджетов
  • Создание реферальной системы в Telegram
  • Создание бота с ChatGPT
  • JavaScript решения
  • Для разработчиков
    • Документация и работа с API
      • Основы
      • Аккаунт
      • Контакты
        • Счета
        • Счета в криптовалюте
        • Реферальная система
        • Теги
        • Пользовательские переменные
      • Списки
        • Элементы списка
      • Сообщения
      • Рассылка
      • Примеры реализации API интеграций
    • JavaScript API
      • Основы
      • Переменные
      • Функции
        • Пользовательские переменные
          • getContactVariable()
          • setContactVariable()
          • deleteContactVariable()
        • Теги
          • hasContactTag()
          • setContactTag()
          • deleteContactTag()
        • Глобальные переменные
          • getGlobalVariable()
          • setGlobalVariable()
          • deleteGlobalVariable()
        • Общие функции
          • sendMessage()
          • goToBlock()
          • disableContinue()
          • setContactById()
          • setContactByTelegramId()
          • setContactByViberId()
          • setContactByVkId()
          • setContactByWhatsAppPhone()
      • Блок "Входящий Webhook"
      • Блок "HTTP-запрос"
      • Блок "Интерпретатор JavaScript"
  • Полезное
    • Самозанятые
      • Как стать самозанятым?! Инструкция
    • Лайфхаки
      • Для Telegram
        • Гиперссылка в тексте бота
        • Скрытый текст в боте
  • Личный кабинет
  • Обновления платформы
  • Написать в поддержку
Powered by GitBook
On this page
  • Схема списка
  • Получить списки (схемы)
  • Получить список (схему)
  • Создать список (схему)
  • Добавить новое поле в список (схему)
  • Удалить поле списка (схемы)
  • Удалить список (схему)
  1. Для разработчиков
  2. Документация и работа с API

Списки

Данное API позволяет создавать произвольные списки и проводить различные операции над ними, которые возможно привязывать к пользователю или к боту.

PreviousПользовательские переменныеNextЭлементы списка

Last updated 2 years ago

Схема списка

Как правильно сформировать запрос?! Смотрим в

Получить списки (схемы)

GET https://app.cleverapp.pro/api/v1/getListSchemas

Этот метод позволяет получить списки (схемы).

{
  "data": [
    {
      "id": "5dee4800c2cc5a38ec797235",
      "fields": {
        "name": {
          "name": "Название",
          "type": "string",
          "is_required": true,
          "is_hidden": false,
          "is_encryptable": false
        },
        "quantity": {
          "name": "Количество",
          "type": "number",
          "is_required": false,
          "is_hidden": false,
          "is_encryptable": false
        },
        "is_vip": {
          "name": "VIP",
          "type": "bool",
          "is_required": true,
          "is_hidden": false,
          "is_encryptable": false
        },
        "contact": {
          "name": "Контакт",
          "type": "contact",
          "is_required": true,
          "is_hidden": false,
          "is_encryptable": false
        },
        "key": {
          "name": "Ключ",
          "type": "string",
          "is_required": true,
          "is_hidden": true,
          "is_encryptable": true
        }
      },
      "name": "Заказы",
      "is_menu": false,
      "created_at": "2019-12-09T13:11:28+00:00",
      "updated_at": "2019-12-09T13:11:28+00:00"
    }
  ],
  "links": {
    "first": "https:\/\/watbot.ru\/api\/v1\/getListSchemas?page=1",
    "last": "https:\/\/watbot.ru\/api\/v1\/getListSchemas?page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https:\/\/watbot.ru\/api\/v1\/getListSchemas",
    "per_page": 50,
    "to": 1,
    "total": 1
  }
}

Получить список (схему)

GET https://app.cleverapp.pro/api/v1/getListSchemas

Этот метод позволяет получить списки (схемы).

{
  "data": {
    "id": "5dee4800c2cc5a38ec797235",
    "fields": {
      "name": {
        "name": "Название",
        "type": "string",
        "is_required": true,
        "is_hidden": false,
        "is_encryptable": false
      },
      "quantity": {
        "name": "Количество",
        "type": "number",
        "is_required": false,
        "is_hidden": false,
        "is_encryptable": false
      },
      "is_vip": {
        "name": "VIP",
        "type": "bool",
        "is_required": true,
        "is_hidden": false,
        "is_encryptable": false
      },
      "contact": {
        "name": "Контакт",
        "type": "contact",
        "is_required": true,
        "is_hidden": false,
        "is_encryptable": false
      },
      "key": {
        "name": "Ключ",
        "type": "string",
        "is_required": true,
        "is_hidden": true,
        "is_encryptable": true
      }
    },
    "name": "Заказы",
    "is_menu": false,
    "created_at": "2019-12-09T13:11:28+00:00",
    "updated_at": "2019-12-09T13:11:28+00:00"
  }
}

Создать список (схему)

POST https://app.cleverapp.pro/api/v1/createListSchema

Этот метод позволяет создать список.

Request Body

Name
Type
Description

is_menu

boolean

Отображать ссылку на список в меню в интерфейсе CleverApp

name*

string

Название списка.

bot_id

integer

ID бота, если вы хотите привязать список к боту.

fields*

object

name string - название поля slug string - уникальная строка поля type string - тип поля (string, number, boolean, contact, bot) - см. ниже. is_required boolean - обязательность заполнения поля is_hidden boolean - скрыть поле из интерфейса? is_encryptable boolean - шифровать поле для хранения в БД? По таким поля нельзя делать фильтрацию и сортировку.

{
  "data": {
    "id": "5dee51518a7ab32ecf060265",
    "fields": {
      "name": {
        "name": "Название",
        "type": "string",
        "is_required": true,
        "is_hidden": false,
        "is_encryptable": false
      },
      "quantity": {
        "name": "Количество",
        "type": "number",
        "is_required": false,
        "is_hidden": false,
        "is_encryptable": false
      },
      "is_vip": {
        "name": "VIP",
        "type": "bool",
        "is_required": true,
        "is_hidden": false,
        "is_encryptable": false
      },
      "contact": {
        "name": "Контакт",
        "type": "contact",
        "is_required": true,
        "is_hidden": false,
        "is_encryptable": false
      },
      "key": {
        "name": "Ключ",
        "type": "string",
        "is_required": true,
        "is_hidden": true,
        "is_encryptable": true
      }
    },
    "name": "Заказы",
    "is_menu": true,
    "created_at": "2019-12-09T13:51:13+00:00",
    "updated_at": "2019-12-09T13:51:13+00:00"
  }
}
{
  "message": "The given data was invalid.",
  "errors": {
    "name": [
      "Поле Имя обязательно для заполнения."
    ],
    "fields": [
      "Поле fields обязательно для заполнения."
    ]
  }
}

Типы поля fields["type"]

Тип

Значение

string

строка/текст

number

число

boolean

логический тип

contact

id контакта

bot

id бота

Добавить новое поле в список (схему)

POST https://app.cleverapp.pro/api/v1/addListSchemaField

Этот метод позволяет добавить новое поле в список.

Request Body

Name
Type
Description

field*

object

Смотрите метод createListSchema поле fields. Укажите только те поля, которые хотите обновить.

schema_id*

string

ID списка.

{
    // Response
}

Если в списке есть уже элементы, то созданное поле заполнится для них значением null

Удалить поле списка (схемы)

POST https://app.cleverapp.pro/api/v1/deleteListSchemaField

Этот метод позволяет удалить поле списка.

Request Body

Name
Type
Description

slug*

string

Slug поля.

schema_id*

string

ID списка.

{
    // Response
}

Удалить список (схему)

POST https://app.cleverapp.pro/api/v1/deleteListSchema

Этот метод позволяет удалить список.

Request Body

Name
Type
Description

schema_id*

string

ID списка.

{
    // Response
}
основах