{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"9c266592-fd82-4933-8f1f-cb53bc991b76","name":"Botto API","description":"Назначение и функциональность **api.botto.ai**:\n\n- API позволяет формировать запросы для работы с Botto Platform.\n    \n\nBotto Platform предоставляет широкий спектр эффективных решений  \nпо автоматизации коммуникации, привлечению и удержанию клиентов.\n\nПодробнее о возможностях платформы автоматизации маркетинга Botto Platform  \nна сайте проекта [<b>botto.ai</b>](https://botto.ai/)\n\n---\n\n# **Базовый URL, аутентификация, методы**\n\n| **ПАРАМЕТР** | **ОПИСАНИЕ** |\n| --- | --- |\n| **Базовый URL** | API использует протокол передачи данных JSON-RPC.  <br>  <br>**Точка входа для всех запросов**: `https://api.botto.ai/` |\n| **Метод запроса** | Все запросы отправляются HTTP-методом `POST`, протокол передачи данных `JSON-RPC` |\n| **Коды ответа** | Для JSON-RPC методов успешный ответ возвращается с HTTP-кодом `200 OK`.  <br>  <br>**Обратите внимание на коды ответов и заголовки** при использовании того или иного метода — некоторые методы могут возвращать отличные от `200 OK` коды, если это явно указано в описании ответа метода или заголовках метода. |\n| **Авторизация** | Для доступа к защищенным методам API необходимо добавлять HTTP-заголовок `Token` с вашим персональным ключом доступа в каждый запрос. `Token` нужен серверу, чтобы понять, кто вы и какие права доступа у вас есть. Ключ доступа можно получить у вашего персонального менеджера, сопровождающего работу с вашим проектом.  <br>  <br>**Формат заголовка**:  <br>`Token: your_token_here`  <br>  <br>**Пример полного запроса с использованием cURL**:  <br>`curl --location '`[<code>http://api.botto.ai'</code>](http://api.botto.ai') `\\`  <br>`--header 'Token: your_token_here' \\`  <br>`--header 'Content-Type: application/json' \\`  <br>`--header 'Accept: application/json' \\`  <br>`--data '{`  <br>`\"jsonrpc\": \"2.0\",`  <br>`\"method\":` `\"example.method\",`  <br>`\"params\": {},`  <br>`\"id\": 1`  <br>`}'`  <br>  <br>**🟡 Важно**:  <br>\\- Заголовок `Token` требуется для всех защищенных методов. В данном API используется собственный HTTP-заголовок `Token`, а не стандартная схема, как например `Authorization: Bearer`.  <br>\\- Заголовок `Content-Type: application/json` обязателен для JSON-RPC запросов.  <br>\\- Заголовок `Accept: application/json` для JSON-RPC API не является обязательным (сервер обычно возвращает JSON, если не указано иное в списках рекомендуемых заголовков, либо иное значение для кода ответа отличное от `200 OK`). Включение заголовка повышает корректность и надежность запроса, так как явно указывает серверу ожидаемый формат ответа. |\n| **Формат данных** | Большинство JSON-RPC методов возвращают ответ в формате JSON с HTTP-кодом `200 OK`. Однако некоторые методы (например, экспорт данных) могут использовать другие механизмы, такие как редирект (код 301) для получения ссылки на скачивание файлов. В таких случаях тело ответа может быть в другом формате, а сам файл будет доступен по URL из заголовка \\`Location\\`.  <br>  <br>Для получения ответа **запрос по протоколу** **JSON-RPC** требует передачи следующих полей:  <br>\\-- `method` — **Обязательное поле** — Строка с именем вызываемого метода.  <br>\\-- `id` — **Обязательное поле** — Значение любого типа, которое используется для установления соответствия между запросом и ответом.  <br>\\-- `params` — **Опциональное поле** — Объект '`{}`' или массив '`[]`' с параметрами, передаваемыми методу, где формат (объект или массив) определяется сигнатурой конкретного метода API. Может быть опущен, если метод не требует параметров.  <br>\\-- `jsonrpc` — **Опциональное поле** — Указание на версию протокола JSON-RPC.  <br>  <br>**Ответ содержит**:  <br>\\-- `jsonrpc` — Указание версии протокола JSON-RPC.  <br>\\-- `result` или `error` — В корректном ответе всегда присутствует только одно из этих полей:  <br>\\---- `result` — Данные, которые вернул метод.  <br>\\---- `error` — Код ошибки, если произошла ошибка во время выполнения метода.  <br>\\-- `id` — То же значение, что и в запросе, к которому относится данный ответ  <br>  <br>**Уведомления**:  <br>Для ситуаций, когда ответ не требуется, в протоколе JSON-RPC введены уведомления. Уведомление отличается от запроса отсутствием свойства `id`, которое не требуется, так как не будет передан ответ.  <br>  <br>[<b>Спецификация JSON-RPC 2.0</b>](https://www.jsonrpc.org/specification) |\n\n---\n\n# Общие соглашения\n\n| **ПАРАМЕТР** | **ОПИСАНИЕ** |\n| --- | --- |\n| Протокол передачи данных | `JSON-RPC` |\n| Формат данных | `JSON` |\n| Кодировка | `UTF-8`  <br>  <br>🟡 Все текстовые данные должны быть закодированы в `UTF-8`, включая тела запросов и ответов. |\n| Методы | `POST` |\n| Правила именования полей | `snake_case` |\n| Правила именования методов | `dot.notation` |\n\n---\n\n# **Коды ошибок**\n\n| **КОД ОШИБКИ** | **ОПИСАНИЕ** |\n| --- | --- |\n| `-32700` | **Parse error** — Сервер получил неверный JSON. При обработке произошла ошибка сервера. |\n| `-32600` | **Invalid request** — Отправленный JSON не является допустимым объектом запроса. |\n| `-32601` | **Method not found** — Метод не существует или недоступен. |\n| `-32602` | **Invalid params** — Некорректный параметр метода. После кода ошибки может идти пояснение, например:  <br>\\- `'status must be enum'` — поле `status` передано с недопустимым значением (к примеру, должно быть одним из `['active', 'archived']`, согласно реализации схемы перечисления определенной на стороне бэкенда).  <br>\\- `'base_id is required'` — не указано обязательное поле '`base_id`'.  <br>\\- `'phone must be phone'` — телефон должен быть в формате E.164 без `+` (например, `79×××××××22`). |\n| `-32603` | **Internal error** — Внутренняя ошибка сервиса. |\n| `-32000` → `-32099` | **Server error** — Ошибки сервера, определяемые реализацией.  <br>  <br>Например, `-32004 — Server Error: \"Low balance\"` — Низкий баланс, пополните баланс аккаунта. |","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"53737309","team":14758037,"collectionId":"9c266592-fd82-4933-8f1f-cb53bc991b76","publishedId":"2sBXionAbt","public":true,"publicUrl":"https://docs.botto.ai","privateUrl":"https://go.postman.co/documentation/53737309-9c266592-fd82-4933-8f1f-cb53bc991b76","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"24ADED"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":"API позволяет формировать запросы для работы с Botto Platform"},{"name":"title","value":""}],"appearance":{"default":"dark","themes":[{"name":"dark","logo":"https://content.pstmn.io/eb700f92-5016-42d9-91db-7d118b29799b/ZGFya192ZXJzaW9uX2JHOW5ieUF5TG5CdVp3PT0ucG5n","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"24ADED"}},{"name":"light","logo":"https://content.pstmn.io/8b912131-f314-41bf-b7de-37395efdb750/bGlnaHRfdmVyc2lvbl9iRzluYnlBeExuQnVadz09LnBuZw==","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"24ADED"}}]}},"version":"8.11.4","publishDate":"2026-04-06T16:25:52.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":"API позволяет формировать запросы для работы с Botto Platform"},"logos":{"logoLight":"https://content.pstmn.io/8b912131-f314-41bf-b7de-37395efdb750/bGlnaHRfdmVyc2lvbl9iRzluYnlBeExuQnVadz09LnBuZw==","logoDark":"https://content.pstmn.io/eb700f92-5016-42d9-91db-7d118b29799b/ZGFya192ZXJzaW9uX2JHOW5ieUF5TG5CdVp3PT0ucG5n"}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/d74b1047e254814afef295c2b430cb7a65af71a4cf7a3e81652779f2acc11b07","favicon":"https://botto.ai/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://docs.botto.ai/view/metadata/2sBXionAbt"}