\" // Уникальный идентификатор запроса или null\n}","options":{"raw":{"language":"json"}}},"url":"https://api.botto.ai/","description":"🟠 Защищенный метод
\nДоступен для ролей admin, accountant, client, manager, support.
\n
\nМетод позволяет получить список транзакций с возможностью фильтрации.
\n
\nПараметры и поля запроса
\n\n\n\n| ПАРАМЕТР | \nТИП ДАННЫХ | \nОПИСАНИЕ | \n
\n\n\n\nuser_id | \nint
optional | \nИдентификатор пользователя, которому принадлежат искомые транзакции.
Необязательные параметры:
user_id
Пример:
\"user_id\": 10 | \n
\n\ntimestamp | \nobject
optional | \nОбъект, представляющий временной период, в который были совершены искомые транзакции. Содержит следующие поля:
- start (int) : Начало периода, формат даты UNIX timestamp.
- end (int) : Конец периода, формат даты UNIX timestamp.
Необязательные параметры:
timestamp
Пример:
смотрите ниже | \n
\n\noffset | \nint
optional | \nКоличество записей, которые нужно пропустить при выборке — отсчет ведется с 1. При передаче значения 0 результат в ответе будет возвращен с первого элемента без пропуска записей.
Необязательные параметры:
offset
Пример:
\"offset\": 25 | \n
\n\nlimit | \nint
optional | \nМаксимальное количество записей, которые нужно вернуть в ответе.
Необязательные параметры:
limit
Пример:
\"limit\": 25 | \n
\n\ntype | \nint
optional | \nИдентификатор типа транзакции.
Необязательные параметры:
type
Пример:
\"type\": 33 | \n
\n\n
\n
Пример передачи значений в параметре timestamp:
\n\"timestamp\": { // object\n \"start\": 0, // int, формат даты UNIX timestamp\n \"end\": 1 // int, формат даты UNIX timestamp\n}\n\n
\n","urlObject":{"host":["https://api.botto.ai/"],"query":[],"variable":[]}},"response":[{"id":"635d4737-c2b7-495b-94ba-ed2a9813ee5c","name":"Successful Response","originalRequest":{"method":"POST","header":[{"key":"Token","value":"your_token_here","description":"Token с вашим персональным ключом доступа","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"jsonrpc\": \"2.0\", // Версия протокола JSON-RPC\n \"method\": \"transactions.list\", // Имя метода\n \"params\": {\n \"user_id\": 10, // ID пользователя\n // \"type\": 33, // Тип транзакции\n \"offset\": 0, // Количество транзакций для пропуска\n \"limit\": 100 // Лимит количества транзакций\n // \"timestamp\": { // Временной период\n // \"start\": 0, // Начало периода, UNIX timestamp\n // \"end\": 1 // Конец периода, UNIX timestamp\n // }\n },\n \"id\": 1 // Уникальный идентификатор запроса или null\n}","options":{"raw":{"language":"json"}}},"url":"https://api.botto.ai/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"result\": {\n \"items\": [ // Массив объектов, представляющих транзакции\n {\n \"comment\": \"Comment on the transaction: any details\", // Комментарий к транзакции\n \"timestamp\": \"YYYY-MM-DD HH:MM:SS\", // Время транзакции\n \"type\": 0, // Тип транзакции\n \"user\": { // Данные о пользователе к которому относится транзакция\n \"second_name\": \"user_second_name\", // Отчество пользователя\n \"avatar\": \"path/to/file\", // Путь к аватару пользователя\n \"email\": \"user@example.com\", // Email пользователя\n \"name\": \"user_name\", // Имя пользователя\n \"surname\": \"user_surname\", // Фамилия пользователя\n \"id\": 10 // ID пользователя\n },\n \"amount\": -1, // Стоимость транзакции\n \"id\": 85 // ID транзакции\n }\n \n // ... \n\n ],\n \"limit\": 100, // Лимит количества записей\n \"total\": 187 // Общее количество найденных записей \n },\n \"jsonrpc\": \"2.0\", // Версия протокола JSON-RPC\n \"id\": 1 // Идентификатор запроса\n}"},{"id":"a77130dd-d171-4833-80cb-aa98fa047051","name":"-32602 — Invalid Params : 'timestamp must be object'","originalRequest":{"method":"POST","header":[{"key":"Token","value":"your_token_here","description":"Token с вашим персональным ключом доступа","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"jsonrpc\": \"2.0\", // Версия протокола JSON-RPC\n \"method\": \"transactions.list\", // Имя метода\n \"params\": {\n \"user_id\": 10, // ID пользователя\n // \"type\": 33, // Тип транзакции\n \"offset\": 0, // Количество транзакций для пропуска\n \"limit\": 100, // Лимит количества транзакций\n \"timestamp\": 1 // Временной период\n },\n \"id\": 1 // Уникальный идентификатор запроса или null\n}","options":{"raw":{"language":"json"}}},"url":"https://api.botto.ai/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"code\": -32602,\n \"message\": \"timestamp must be object\",\n \"data\": {\n \"type\": {\n \"data\": {\n \"start\": \"int\",\n \"end\": \"int\"\n },\n \"type\": \"object\"\n },\n \"field\": \"timestamp\"\n }\n }\n}\n\n// Переданное значение параметра 'timestamp' не соответствует схеме 'object'."},{"id":"26942b91-185b-46e5-9213-62265fdbf4c7","name":"-32000 — Server Error: 'Internal Server Error'","originalRequest":{"method":"POST","header":[{"key":"Token","value":"your_token_here","description":"Token с вашим персональным ключом доступа","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"jsonrpc\": \"2.0\", // Версия протокола JSON-RPC\n \"method\": \"transactions.list\", // Имя метода\n \"params\": {\n \"user_id\": 10, // ID пользователя\n // \"type\": 33, // Тип транзакции\n \"offset\": 0, // Количество транзакций для пропуска\n \"limit\": 100 // Лимит количества транзакций\n // \"timestamp\": { // Временной период\n // \"start\": 0, // Начало периода, UNIX timestamp\n // \"end\": 1 // Конец периода, UNIX timestamp\n // }\n },\n \"id\": 1 // Уникальный идентификатор запроса или null\n}","options":{"raw":{"language":"json"}}},"url":"https://api.botto.ai/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"message\": \"Internal Server Error\",\n \"code\": -32000\n }\n}\n\n// Произошла непредвиденная ошибка на стороне сервера."},{"id":"34d5ed9d-72e1-4466-b743-fdbfe34b464c","name":"-32001 — Server Error: \"Access is denied for the role 'role'\"","originalRequest":{"method":"POST","header":[{"key":"Token","value":"your_token_here","description":"Token с вашим персональным ключом доступа","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"jsonrpc\": \"2.0\", // Версия протокола JSON-RPC\n \"method\": \"transactions.list\", // Имя метода\n \"params\": {\n \"user_id\": 10, // ID пользователя\n // \"type\": 33, // Тип транзакции\n \"offset\": 0, // Количество транзакций для пропуска\n \"limit\": 100 // Лимит количества транзакций\n // \"timestamp\": { // Временной период\n // \"start\": 0, // Начало периода, UNIX timestamp\n // \"end\": 1 // Конец периода, UNIX timestamp\n // }\n },\n \"id\": 1 // Уникальный идентификатор запроса или null\n}","options":{"raw":{"language":"json"}}},"url":"https://api.botto.ai/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"code\": -32001,\n \"data\": {\n \"available\": [\n \"client\",\n \"manager\",\n \"admin\",\n \"accountant\",\n \"support\"\n ]\n },\n \"message\": \"Access is denied for the role 'role'\"\n }\n}\n\n// У пользователя нет прав на выполнение операции."}],"_postman_id":"4a117855-3aba-407f-8ee9-b5311aa0fda1"}],"id":"7f3ea59f-8197-468b-9145-e57876f6351c","_postman_id":"7f3ea59f-8197-468b-9145-e57876f6351c","description":""},{"name":"/upload","id":"17562dd3-7748-4a81-8277-c448e86eca4d","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true,"accept-encoding":true,"connection":true,"user-agent":true,"host":true,"content-length":true,"content-type":true},"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Accept","value":"text/plain;charset=utf-8","type":"text"},{"key":"Token","value":"your_token_here","description":"Your API key
\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","type":"text","description":"Пример: '/path/to/dataset_name.csv;type=text/csv'
\nПри использовании cURL всегда указывайте MIME-тип, добавляя ';type={MIME-type}' к пути файла. Это гарантирует корректное \nраспознавание формата сервером.
\nИспользуйте следующие MIME-типы для поддерживаемых форматов загружаемых файлов:
\n-- '.csv' или '.tsv' → text/csv
\n-- '.txt' → text/plain
\n-- '.xls' → application/vnd.ms-excel
\n-- '.xlsx' или '.xlsb' → application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
\nЕсли вы копируете команду cURL, часть ';type={MIME-type}' может быть пропущена.
\nЕсли в параметре '-F' запроса отсутствует корректная ассоциация типов, сервер отклонит заспрос с ошибкой \"unknown file format\". В таких случаях вручную дополните команду запроса правильным MIME-типом, как показано выше.
\n","value":"/path/to/file","contentType":"{MIME-type}"}]},"url":"https://api.botto.ai/upload","description":"🟠 Защищенный метод
\nДоступен для всех ролей, кроме public
\n
\nЗагружает файлы с датасетами для последующего использования в методах где указывается параметр \"file\": \"/path/to/file\". Возвращает путь к загруженному файлу на сервер, для использования в методах:
\n\n#communications.bases.create
\n#communications.bases.contacts.add
\n#communications.bases.contacts.exclude
\n
\n🟡 Важно. Загружаемые файлы должны быть в кодировке UTF-8, контент в другой кодировке может привести к ошибкам обработки.
\n
\nПоддерживаемые форматы файлов
\n\n\n\n| ФОРМАТ | \nРАСШИРЕНИЕ | \nMIME-тип | \nОПИСАНИЕ | \n
\n\n\n\n| Text | \n.txt | \ntext/plain | \nОбычный текст, где строки разделены символом новой строки '\\n', а в качестве разделителя полей внутри строки могут использоватся кастомные символы. | \n
\n\n| CSV | \n.csv | \ntext/csv | \nТекстовый формат, предназначенный для представления табличных данных. Поля разделяются запятыми ',' или точками с запятой ';' | \n
\n\n| TSV | \n.tsv | \ntext/csv | \nТекстовый формат, предназначенный для представления табличных данных. Поля разделяются символом табуляции '\\t' | \n
\n\n| Excel | \n.xls | \napplication/vnd.ms-excel | \nУстаревший формат таблиц Excel (.xls) | \n
\n\n| Excel | \n.xlsx | \napplication/vnd.openxmlformats-officedocument.spreadsheetml.sheet | \nСовременный формат таблиц Excel Open XML (.xlsx) | \n
\n\n| Excel | \n.xlsb | \napplication/vnd.openxmlformats-officedocument.spreadsheetml.sheet | \nБинарный формат таблиц Excel (.xlsb) | \n
\n\n| Другие форматы | \n-- | \n-- | \nНе поддерживаются | \n
\n\n
\n
🟡 Критически важное требование для cURL:
\nПри использовании метода POST /upload всегда добавляйте ;type={MIME-type} к пути файла в параметрах -F запроса. Пропуск этой части вызовет ошибку 500 unknown file format.
\n
\nПараметры запроса
\n\n\n\n| ПАРАМЕТР | \nТИП ДАННЫХ | \nОПИСАНИЕ | \n
\n\n\n\nfile | \nmultipart/form-data
required | \nУказатель на файл для загрузки. Исходное имя файла сохраняется в ответе в поле \"name\": \"dataset_name.csv\".
Требование к файлу:
-- Соответствие поддерживаемым форматам: .txt, .csv, .tsv, .xls, .xslx, .xlsb.
-- Кодировка UTF-8.
Для корректной загрузки файла нужно передать составное значение параметра file с разделителем точка с запятой ';':
-- /path/to/file
-- type={MIME-type}
Пример:
-F 'file=/path/to/dataset_name.csv;type=text/csv' | \n
\n\n
\n
\nСтруктура ответа
\nВозвращается массив объектов с метаданными загруженного файла:
\n\n\n\n| ПОЛЕ | \nТИП | \nОПИСАНИЕ | \n
\n\n\n\nname | \nstring | \nИсходное имя файла из запроса.
Пример:
\"name\": \"dataset_name.csv\" | \n
\n\ntype | \nstring | \nОпределённое расширение загружаемого файла.
Пример:
\"type\": \"csv\" | \n
\n\npath | \nstring | \nПуть к загруженному файлу на сервере для использования API запросах. Используйте именно это значение в параметрах 'file' других методов.
Пример:
\"path\": \"/upload/00/0/0/0x00xx0.csv\" | \n
\n\n
\n
Пример успешного ответа:
\n[\n {\n \"name\": \"dataset_name.csv\", // Исходное имя файла\n \"type\": \"csv\", // Определённое расширение файла\n \"path\": \"/upload/00/0/0/0x00xx0.csv\" // Путь на сервере для использования \n // в API запросах\n }\n]\n\n
\n","urlObject":{"host":["https://api.botto.ai/upload"],"query":[],"variable":[]}},"response":[{"id":"9b91fc16-779e-4dd6-85d3-f6c239a6edc2","name":"Successful Response","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"text/plain;charset=utf-8","type":"text"},{"key":"Token","value":"your_token_here","description":"Token с вашим персональным ключом доступа","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","type":"text","description":"Пример: '`/path/to/dataset_name.csv;type=text/csv`'\n\n\nПри использовании cURL всегда указывайте MIME-тип, добавляя '`;type={MIME-type}`' к пути файла. Это гарантирует корректное распознавание формата сервером.\n\n\nИспользуйте следующие MIME-типы для поддерживаемых форматов загружаемых файлов:\n\n-- '`.csv`' или '`.tsv`' → `text/csv`\n\n-- '`.txt`' → `text/plain`\n\n-- '`.xls`' → `application/vnd.ms-excel`\n\n-- '`.xlsx`' или '`.xlsb`' → `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet`\n\n\nЕсли вы копируете команду cURL, часть '`;type={MIME-type}`' может быть пропущена.\n\n\nЕсли в параметре '`-F`' запроса отсутствует корректная ассоциация типов, сервер отклонит заспрос с ошибкой `\"unknown file format\"`. В таких случаях вручную дополните команду запроса правильным MIME-типом, как показано выше.","contentType":"{MIME-type}","value":"/path/to/file"}]},"url":"https://api.botto.ai/upload"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain; charset=utf-8","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[{\"path\":\"\\/upload\\/0\\/00\\/0\\/000x0x00.csv\",\"name\":\"dataset_name.csv\",\"type\":\"csv\"}]"},{"id":"e0edc707-75a0-435c-93d2-5af0f3c15c65","name":"Internal Server Error -- Unknown File Format","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"text/plain;charset=utf-8","type":"text"},{"key":"Token","value":"your_token_here","description":"Token с вашим персональным ключом доступа","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","type":"text","description":"Пример: '`/path/to/dataset_name.csv;type=text/csv`'\n\n\nПри использовании cURL всегда указывайте MIME-тип, добавляя '`;type={MIME-type}`' к пути файла. Это гарантирует корректное распознавание формата сервером.\n\n\nИспользуйте следующие MIME-типы для поддерживаемых форматов загружаемых файлов:\n\n-- '`.csv`' или '`.tsv`' → `text/csv`\n\n-- '`.txt`' → `text/plain`\n\n-- '`.xls`' → `application/vnd.ms-excel`\n\n-- '`.xlsx`' или '`.xlsb`' → `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet`\n\n\nЕсли вы копируете команду cURL, часть '`;type={MIME-type}`' может быть пропущена.\n\n\nЕсли в параметре '`-F`' запроса отсутствует корректная ассоциация типов, сервер отклонит заспрос с ошибкой `\"unknown file format\"`. В таких случаях вручную дополните команду запроса правильным MIME-типом, как показано выше.","contentType":"","value":"/path/to/file"}]},"url":"https://api.botto.ai/upload"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain; charset=utf-8","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\"error\":500,\"message\":\"unknown file format\",\"type\":\"application\\/octet-stream\"}\n\n// Ошибка: отсутствует MIME-тип. Всегда указывайте MIME-тип через ';type=' при загрузке через cURL.\n// ПРАВИЛЬНО: '/path/to/file;type='"},{"id":"933189ea-3dcc-4b35-a423-0a21d336ef22","name":"-32001 — Server Error: \"Access is denied for the role 'role'\"","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json;charset=utf-8","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","type":"text","description":"Пример: '`/path/to/dataset_name.csv;type=text/csv`'\n\n\nПри использовании cURL всегда указывайте MIME-тип, добавляя '`;type={MIME-type}`' к пути файла. Это гарантирует корректное распознавание формата сервером.\n\n\nИспользуйте следующие MIME-типы для поддерживаемых форматов загружаемых файлов:\n\n-- '`.csv`' или '`.tsv`' → `text/csv`\n\n-- '`.txt`' → `text/plain`\n\n-- '`.xls`' → `application/vnd.ms-excel`\n\n-- '`.xlsx`' или '`.xlsb`' → `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet`\n\n\nЕсли вы копируете команду cURL, часть '`;type={MIME-type}`' может быть пропущена.\n\n\nЕсли в параметре '`-F`' запроса отсутствует корректная ассоциация типов, сервер отклонит заспрос с ошибкой `\"unknown file format\"`. В таких случаях вручную дополните команду запроса правильным MIME-типом, как показано выше.","value":"/path/to/file","contentType":"{MIME-type}"}]},"url":"https://api.botto.ai/upload"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"message\": \"Access is denied for the role public\",\n \"code\": -32001\n }\n}\n\n// У пользователя нет прав для выполнения данной операции.\n// Запрос завершится ошибкой из-за отсутствия заголовка Token с валидным токеном."}],"_postman_id":"17562dd3-7748-4a81-8277-c448e86eca4d"}],"id":"f60c0f85-8153-49d1-872e-498915ab1ec5","_postman_id":"f60c0f85-8153-49d1-872e-498915ab1ec5","description":""}],"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"0e5357fc-299c-417c-94ca-0f24d55636ef"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"4350ad27-e56a-48a3-ba6b-ecc6296c1998"}}],"variable":[{"key":"BaseURL","value":"https://api.botto.ai/"},{"key":"Token","value":"your_token_here"}]}