Метод: GET

Authorization: Bearer Token

URL: https://tcl.twin24.ai/api/bot/v1/bots?11


Описание параметров метода:

ПараметрТип параметраОбязательность

Значение

по умолчанию

Описание
withoutCountboolнетfalse

true – НЕ выводить поле "count" с количеством сценариев  в ответ 

false – выводить поле "count" с количеством сценариев  в ответ

withoutItemsboolнетfalse

true – НЕ выводить поле "items" со списком сценариев в ответ

false – выводить поле "items" со списком сценариев в ответ

limitintнетвсе сценарииОграничение количества данных, которые нужно получить 
offsetintнет0Смещение по позиции полученной информации
pageintнет0Страница выдачи. (Используется, если limit < количества сценариев, чтобы перебирать выдачу постранично, где на каждой странице максимум "limit" элементов)
fieldsstringнет

id,

name,

companyId,

accessType,

language,

nlp,

solver,

critic,

tuner,

problemGenerator,

viewDetails,

createdAt,

updatedAt

Список полей, которые нужно выдать в ответе по каждому сценарию (перечислять через запятую и без пробелов):

id – идентификатор сценария/бота
name – название сценария/бота
companyId – идентификатор компании
accessType – ограничение прав доступа сценария
language – используемый язык распознания
nlp – ссылка на NLU
solver – ссылка на модуль принятия решений
critic –  
tuner –  
problemGenerator – 
viewDetails – 
createdAt – дата создания сценария/бота
updatedAt – дата последнего обновления сценария/бота

sort

stringнет+createdAt,+updatedAtСписок полей для сортировки (перечислять через запятую и без пробелов, использовать знак "+" перед полем для сортировки по возрастанию, "-" – для сортировки по убыванию)


Ответ в формате JSON
{
    "count": 2,
    "items": [
        {
            "id": "890251fb-d1ee-43e4-a68d-72a87c05b10f",
            "name": "Welcome",
            "companyId": 1758,
            "accessType": "PRIVATE",
            "language": "RU",
            "nlp": "Twin\\Support\\Nlu\\RasaNaturalLanguageParser",
            "solver": "Twin\\TwinBot\\Model\\Bot\\Solver\\Graph\\v1\\GraphSolver",
            "critic": null,
            "tuner": null,
            "problemGenerator": null,
            "viewDetails": [],
            "createdAt": "2021-10-20 02:01:54.729507+00",
            "updatedAt": "2021-10-20 02:01:54.729507+00"
        },
        {
            "id": "a524a704-b2a4-4fc8-a89d-0c1a171fda6d",
            "name": "09-06-2021",
            "companyId": 1758,
            "accessType": "PRIVATE",
            "language": "RU",
            "nlp": "Twin\\Support\\Nlu\\RasaNaturalLanguageParser",
            "solver": "Twin\\TwinBot\\Model\\Bot\\Solver\\Graph\\v1\\GraphSolver",
            "critic": null,
            "tuner": null,
            "problemGenerator": null,
            "viewDetails": [],
            "createdAt": "2021-10-20 02:01:54+00",
            "updatedAt": "2021-10-20 02:11:04.136799+00"
        }
    ]
}


Описание полей ответа:


ПолеТипОписание

count

intКоличество найденных сценариев

items

itemsInfo[

]

Массив с информацией по каждому сценарию

id

stringидентификатор сценария/бота

name

stringназвание сценария/бота

companyId

intидентификатор компании

accessType

stringограничение прав доступа сценария

language

stringиспользуемый язык распознания

nlp

stringссылка на NLU

solver

stringссылка на модуль принятия решений

critic

string

tuner

string

problemGenerator

string

viewDetails

viewDetailsInfo[

]


createdAt

stringдата создания сценария/бота

updatedAt

stringдата последнего обновления сценария/бота

авыаыв

  • Нет меток