Схема списка

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

https://watbot.ru/api/v1/getListSchemas
Этот метод позволяет получить списки (схемы).
Request
Response
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://watbot.ru/api/v1/getListSchema
Этот метод позволяет получить схему.
Request
Response
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://watbot.ru/api/v1/createListSchema
Этот метод позволяет создать список.
Request
Response
Request
Form Data Parameters
is_menu
optional
boolean
Отображать ссылку на список в меню в интерейсе Watbot.
name
required
string
Название списка.
bot_id
optional
integer
ID бота, если вы хотите привязать списк к боту.
fields
required
object
name string - название поля slug string - уникальная строка поля type string - тип поля (string, number, boolean, contact, bot) - см. ниже. is_required boolean - обязательность заполнения поля is_hidden boolean - скрыть поле из интерфейса? is_encryptable boolean - шифровать поле для хранения в БД? По таким поля нельзя делать фильтрацию и сортировку.
Response
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["type"]

Тип

Значение

string

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

number

число

boolean

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

contact

id контакта

bot

id бота

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

https://watbot.ru/api/v1/addListSchemaField
Этот метод позволяет добавить новое поле в список.
Request
Response
Request
Form Data Parameters
field
required
object
Смотрите метод createListSchema поле fields. Укажите только те поля, которые хотите обновить.
schema_id
required
string
ID списка.
Response
201: Created
Запрос успешно обработан.

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

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

https://watbot.ru/api/v1/deleteListSchemaField
Этот метод позволяет удалить поле списка.
Request
Response
Request
Form Data Parameters
slug
required
string
Slug поля.
schema_id
required
string
ID списка.
Response
204: No Content
Запрос успешно обработан.

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

https://watbot.ru/api/v1/deleteListSchema
Этот метод позволяет удалить список.
Request
Response
Request
Form Data Parameters
schema_id
required
string
ID списка.
Response
204: No Content
Запрос успешно обработан.