Схема списка

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

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

https://app.botvsem.ru/api/v1/getListSchemas

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

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

Request
Response

200: OK

Запрос успешно обработан.

{
"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.botvsem.ru/api/v1/getListSchemas

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

Request
Response

200: OK

Запрос успешно обработан.

{
"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.botvsem.ru/api/v1/createListSchema

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

Request
Response

Form Data Parameters

is_menu

OPTIONAL

boolean

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

name

REQUIRED

string

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

bot_id

OPTIONAL

integer

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

200: OK

Запрос успешно обработан

{
"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"
}
}

422: Unprocessable Entity

Переданы некорректные данные.

{
"message": "The given data was invalid.",
"errors": {
"name": [
"Поле Имя обязательно для заполнения."
],
"fields": [
"Поле fields обязательно для заполнения."
]}
}

fields

REQUIRED

object

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

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

Тип

Значение

string

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

number

число

boolean

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

contact

id контакта

bot

id бота

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

https://app.botvsem.ru/api/v1/addListSchemaField

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

Request
Response

Form Data Parameters

field

REQUIRED

object

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

schema_id

REQUIRED

string

ID списка.

201: Created

Запрос успешно обработан.

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

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

https://app.botvsem.ru/api/v1/deleteListSchemaField

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

Request
Response

Form Data Parameters

slug

REQUIRED

string

Slug поля.

schema_id

REQUIRED

string

ID списка.

204: No Content

Запрос успешно обработан.

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

https://app.botvsem.ru/api/v1/deleteListSchema

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

Request
Response

Form Data Parameters

schema_id

REQUIRED

string

ID списка.

204: No Content

Запрос успешно обработан.

База знаний BotVsem ⤵

Схема списка

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

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

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

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

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

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

Документы

Платформа