\" // Уникальный идентификатор запроса или null\n}","options":{"raw":{"language":"json"}}},"url":"https://api.botto.ai/","description":"🟠 Защищенный метод \nДоступен для ролей admin, client.
\nМетод для скачивания файла с данными сегмента (аудитории) по его уникальному идентификатору. Можно выбрать формат файла для скачивания: .csv или .xlsx(Excel).
\nПример структуры формируемого csv-файла для скачивания:
\nвремя создания,телефон,email,wa,tg,viber,тип,страна,регион,оператор,имя,фамилия,отчество,день рождения,пол,скорбалл телефон,активность телефона,валидность email,валидность wa,валидность tg,валидность fb,валидность ig,теги телефона,часовой пояс,код страны,тип линии,время скоринга,время нормализации\nYYYY-MM-DD HH:MM:SS,00000000001,user0@example.com,,@user0,,scoring,,,,,,,,,,,,inactive,unknown,unknown,,{},UTC+0,xx,mobile,YYYY-MM-DD HH:MM:SS,\nYYYY-MM-DD HH:MM:SS,00000000002,,,@user1,,scoring,,,,,,,,,,,,active,unknown,unknown,,{},UTC+0,xx,mobile,YYYY-MM-DD HH:MM:SS,\nYYYY-MM-DD HH:MM:SS,00000000003,,,,,scoring,,,,,,,,,,,,active,unknown,unknown,,{},UTC+0,xx,mobile,YYYY-MM-DD HH:MM:SS,\n...\n\nПараметры и поля запроса \n\n\nПАРАМЕТР ТИП ДАННЫХ ОПИСАНИЕ \n \n\n\nproject_idint required Идентификатор проекта, которому принадлежит сегмент (аудитория). Обязательные параметры : project_id Пример : \"project_id\": 8 \n \n\nidint required Идентификатор сегмента (аудитории), для скачивания. Обязательные параметры : id Пример : \"id\": 84 \n \n\nexport_formatenum optional [ csv, excel ]Тип формата файла для скачивания данных сегмента (аудитории). Возможные значения: csv — скачивание csv-файла. excel — скачивание Excel-файла. export_format — по-умолчанию будет сформирован xlsx-файл. Необязательные параметры : export_format Пример : \"export_format\": \"csv\" \n \n \n
\n
Token с вашим персональным ключом доступа
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"jsonrpc\": \"\", // Версия протокола JSON-RPC\n \"method\": \"communications.bases.contacts.export\", // Имя метода\n \"params\": {\n \"id\": \"\", // ID сегмента (аудитории)\n \"project_id\": \"\", // ID проекта\n \"filter\": \"\", // Параметры фильтрации\n \"only_system_fields\": \"\", // Флаг использования только системных полей для экспорта\n \"export_format\": \"\" // Тип формата файла для экпорта данных сегмента (аудитории)\n },\n \"id\": \"\" // Уникальный идентификатор запроса или null\n}","options":{"raw":{"language":"json"}}},"url":"https://api.botto.ai/","description":"🟠 Защищенный метод \nДоступен для ролей admin, client
\nМетод для экспорта в файл данных сегмента (аудитории) по его уникальному идентификатору с различными параметрами фильтрации. Можно выбрать формат файла для экспорта: .csv или .xlsx (Excel).
\nУспешный ответ: code 301 'HTTP/1.1 301 Moved Permanently' с 'Location: { URL }'.
\nПри выполнении запроса через curl необходимо добавить флаг -i для просмотра HTTP заголовков ответа. Без флага -i вы не увидите заголовок Location со ссылкой на файл.
\nПараметры и поля запроса \n\n\nПАРАМЕТР ТИП ДАННЫХ ОПИСАНИЕ \n \n\n\nproject_idint required ID проекта которому принадлежит сегмент (аудитория). Обязательные параметры : project_id Пример : \"project_id\": 123 \n \n\nidint required ID сегмента (аудитории) для экспорта. Обязательные параметры : id Пример : \"id\": 851 \n \n\nfilterobject optional Объект с параметрами фильтров. Содержит поля: context (string ): поиск по контексту уникальных значений из кастомных и системных полей. updated (object ): период обновления данных: start (int ) — начало периода, UNIX timestamp end (int )— конец периода, UNIX timestamp type (enum[] ): список типов контактов сегмента (аудитории): initial — исходный, 'raw data' до обработки (скоринга) segmented — сегментированный (создание нового сегмента (аудитории) по какому-либо признаку) custom — пользовательский target — цель delivered — доставлено not_delivered — не доставлено blacklist — черный список unique — уникальные amd — автоответчики scoring — прошел скоринг normalized — нормализованный dm_pixel — не используется operator (string ): наименование оператора связи. region (string ): наименование региона. phone_activity (enum ): активность контактов по номеру телефона: active — активный inactive — неактивный unknown — неизвестный messengers_validity (enum ): значение валидности контакта в мессенджерах, если контакт валиден хотя бы в одном из мессенджеров, то он считается 'active': active — активный inactive — неактивный email_activity (enum ): значение активности email: active — активный inactive — неактивный unknown — неизвестный line_type (string ): тип линии (мобильный, фиксированная связь, голосовая почта и т.д.), возможные значения: shared_cost — номер с разделённой стоимостью voip — интернет-телефония (VoIP) personal_number — персональный номер fixed_line — городской (стационарный) mobile — мобильный unknown — неизвестный тип fixed_line_or_mobile — городской или мобильный voicemail — голосовая почта toll_free — бесплатный номер uan — универсальный номер доступа (UAN) premium_rate — премиум-номер (платные услуги) pager — пейджер messengers (enum[] ): cписок по типам мессенджера, работает в связке с 'messengers_validity' и работает от значения активности (если \"messengers_validity\": \"inactive\" то фильтр по 'messengers' вернет контакты у которых нет выбранного мессенджера): telegram — TG whatsapp — WA viber — Viber, не используется facebook — FB, instagram — IG. country (string ): наименование страны. country_iso_code (string ): двухбуквенный Alpha-2-код по ISO 3166-1. phone_connectability (object ): диапазон для выборки по контактности номера полученное после скоринга, при передаче значений вне диапазона вернет либо значения соответствующие min-max, либо пустоту если значение переданное значение находится за пределами диапазона данных скоринга: max (int ) — максимальное значение min (int )— минимальное значение connectability_types (enum[] ): список типов для оценки контактности телефонного номера: sms — SMS-сообщения voice— голосовые рассылки messengers — мессенджеры tags (string[] ): фильтр по наименованию тегов связанных с контактами сегмента (аудитории). email_info (object ): фильтр по метаданным email адресов сегмента (аудитории), прошедших скоринг с типом \"type\": \"email_validation\": last_seen (object ): дата и время последней активности пользователя: start (int ) — начало периода, Unix timestamp, end (int )— конец периода, Unix timestamp. smtp_provider (string ): название SMTP-провайдера. smtp_status_code (int ): код статуса SMTP-сервера. country (string ): наименование страны. domain (string ): доменная часть адреса электронной почты. mx_record (string ): MX-запись домена. Необязательные параметры : filter Пример : \n \n\nonly_system_fieldsboolean optional Флаг использования только системных полей для экспорта. Необязательные параметры : only_system_fields Пример : \"only_system_fields\": true \n \n\nexport_formatenum optional [ csv, excel ]Тип формата файла для экпорта данных сегмента (аудитории). Возможные значения: csv — экспорт в csv-файл excel — экспот в Excel-файл . export_format — по-умолчанию будет сформирован xlsx-файл. Необязательные параметры : export_format Пример : \"export_format\": \"csv\" \n \n \n
\n
Пример передачи значений в параметре filter:
\n\"filter\": {\n \"context\": \"context_name\", // string\n \"updated\": { // object\n \"start\": 0, // int\n \"end\": 1 // int\n },\n \"type\": [ // enum[]\n \"target\", // string\n \"segmented\" // string\n ],\n \"operator\": \"carrier_name\", // string\n \"region\": \"region_name\", // string\n \"phone_activity\": \"active\", // enum\n \"messengers_validity\": \"active\", // enum\n \"email_activity\": \"active\", // enum\n \"line_type\": \"mobile\", // string\n \"messengers\": [ // enum[]\n \"telegram\" // string\n ],\n \"country\": \"country_name\", // string\n \"country_iso_code\": \"xx\", // string\n \"phone_connectability\": { // object\n \"min\": 0, // int\n \"max\": 1 // int\n },\n \"connectability_types\": [ // enum[]\n \"voice\", // string\n \"messengers\" // string\n ],\n \"tags\": [ // string[]\n \"tag_name1\", // string\n \"tag_name2\" // string\n ],\n \"email_info\": { // object\n \"last_seen\": { // object\n \"start\": 0, // int\n \"end\": 1 // int\n },\n \"smtp_provider\": \"smtp_provider_name\", // string\n \"smtp_status_code\": 000, // int\n \"country\": \"country_name\", // string\n \"domain\": \"domain.com\", // string\n \"mx_record\": \"mx.smtp_provider.com\" // string\n }\n}\n\nToken с вашим персональным ключом доступа
\n","type":"text"},{"key":"Accept","value":"text/plain; charset=utf-8","type":"text"}],"body":{"mode":"raw","raw":"{\n \"jsonrpc\": \"\", // Версия протокола JSON-RPC\n \"method\": \"communications.bases.contacts.export_stream\", // Имя метода\n \"params\": {\n \"id\": \"\", // ID сегмента (аудитории)\n \"project_id\": \"\", // ID проекта\n \"filter\": \"\", // Параметры фильтрации\n \"only_system_fields\": \"\" // Флаг использования только системных полей для экспорта\n },\n \"id\": \"\" // Уникальный идентификатор запроса или null\n}","options":{"raw":{"language":"json"}}},"url":"https://api.botto.ai/","description":"🟠 Защищенный метод \nДоступен для ролей admin, client
\nЭкспорт данных сегмента с различными параметрами фильтрации. В ответе возвращается text/plain в структуре .csv: кодировка UTF-8, разделитель полей точка с запятой.
\nПример структуры csv-файла в ответе:
\nвремя создания;телефон;email;wa;tg;viber;тип;страна;регион;оператор;имя;фамилия;отчество;день рождения;пол;скорбалл телефон;активность телефона;валидность email;валидность wa;валидность tg;валидность fb;часовой пояс;код страны;тип линии;время скоринга;время нормализации\n\nПараметры и поля запроса \n\n\nПАРАМЕТР ТИП ДАННЫХ ОПИСАНИЕ \n \n\n\nproject_idint required ID проекта которому принадлежит сегмент (аудитория). Обязательные параметры : project_id Пример : \"project_id\": 123 \n \n\nidint required ID сегмента (аудитории) для экспорта. Обязательные параметры : id Пример : \"id\": 851 \n \n\nfilterobject optional Объект с параметрами фильтров. Содержит поля: timezone (string ): часовой пояс, значение указывается в формате UTC. context (string ): поиск по контексту уникальных значений из кастомных и системных полей. updated (object ): период обновления данных: start (int ) — начало периода, UNIX timestamp end (int )— конец периода, UNIX timestamp type (enum[] ): список типов контактов сегмента (аудитории): initial — исходный, 'raw data' до обработки (скоринга) segmented — сегментированный (создание нового сегмента (аудитории) по какому-либо признаку) custom — пользовательский target — цель delivered — доставлено not_delivered — не доставлено blacklist — черный список unique — уникальные amd — автоответчики scoring — прошел скоринг normalized — нормализованный dm_pixel — не используется operator (string ): наименование оператора связи. region (string ): наименование региона. phone_activity (enum ): активность контактов по номеру телефона: active — активный inactive — неактивный unknown — неизвестный messengers_validity (enum ): значение валидности контакта в мессенджерах, если контакт валиден хотя бы в одном из мессенджеров, то он считается 'active': active — активный inactive — неактивный email_activity (enum ): значение активности email: active — активный inactive — неактивный line_type (string ): тип линии (мобильный, фиксированная связь, голосовая почта и т.д.), возможные значения: shared_cost — номер с разделённой стоимостью voip — интернет-телефония (VoIP) personal_number — персональный номер fixed_line — городской (стационарный) mobile — мобильный unknown — неизвестный тип fixed_line_or_mobile — городской или мобильный voicemail — голосовая почта toll_free — бесплатный номер uan — универсальный номер доступа (UAN) premium_rate — премиум-номер (платные услуги) pager — пейджер messengers (enum[] ): cписок по типам мессенджера, работает в связке с 'messengers_validity' и работает от значения активности (если \"messengers_validity\": \"inactive\" то фильтр по 'messengers' вернет контакты у которых нет выбранного мессенджера): telegram — TG whatsapp — WA viber — Viber, не используется instagram — IG. country (string ): наименование страны. country_iso_code (string ): двухбуквенный Alpha-2-код по ISO 3166-1. phone_connectability (object ): диапазон для выборки по контактности номера полученное после скоринга, при передаче значений вне диапазона вернет либо значения соответствующие min-max, либо пустоту если переданное значение находится за пределами диапазона данных скоринга: max (int ) — максимальное значение min (int )— минимальное значение email_connectability (object ): Не используется. Диапазон для выборки по контактности email, не используется: max (int ) — максимальное значение min (int )— минимальное значение Необязательные параметры : filter Пример : \n \n\nonly_system_fieldsboolean optional Флаг использования только системных полей для экспорта. Необязательные параметры : only_system_fields Пример : \"only_system_fields\": true \n \n \n
\n
Пример передачи значений в параметре filter:
\n\"filter\": {\n \"timezone\": \"UTC-0\", // string\n \"context\": \"context_name\", // string\n \"updated\": { // object\n \"start\": 0, // int\n \"end\": 1 // int\n },\n \"type\": [ // enum[]\n \"target\", // string\n \"segmented\" // string\n ],\n \"operator\": \"carrier_name\", // string\n \"region\": \"region_name\", // string\n \"phone_activity\": \"active\", // enum\n \"messengers_validity\": \"active\", // enum\n \"email_activity\": \"active\", // enum\n \"line_type\": \"mobile\", // string\n \"messengers\": [ // enum[]\n \"telegram\" // string\n ], \n \"country\": \"country_name\", // string\n \"country_iso_code\": \"xx\", // string\n \"phone_connectability\": { // object\n \"min\": 0, // int\n \"max\": 1 // int\n },\n \"email_connectability\": { // object\n \"min\": 0, // int\n \"max\": 1 // int\n },\n}\n\nToken с вашим персональным ключом доступа
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"jsonrpc\": \"\", // Версия протокола JSON-RPC\n \"method\": \"communications.bases.create\", // Имя метода\n \"params\": {\n \"project_id\": \"\", // ID проекта\n \"name\": \"\", // Название создаваемого сегмента (аудитории)\n \"email_column\": \"\", // Индекс столбца с email-адресами\n \"file\": \"\", // Путь к загружаемому файлу\n \"wa_column\": \"\", // Индекс столбца с WA аккаунтами\n \"viber_column\": \"\", // Индекс столбца с Viber аккаунтами, не используется\n \"region_column\": \"\", // Индекс столбца с наименованиями регионов\n \"operator_column\": \"\", // Индекс столбца с наименованиями операторов связи\n \"phone_column\": \"\", // Индекс столбца с телефонными номерами\n \"matching\": \"\", // Сопоставление полей\n \"sep\": \"\", // Указание на разделитель полей загружаемого файла\n \"contacts\": \"\", // Передача списка номеров телефонов\n \"country_column\": \"\", // Индекс столбца с наименованиями стран\n \"contacts_exclude\": \"\", // Передача списка номеров телефонов для исключения (минусации)\n \"file_exclude\": \"\", // Путь к загружаемому файлу для исключения (минусации)\n \"tg_column\": \"\", // Индекс столбца с TG аккаунтами\n \"geo_iso_code\": \"\", // Указание гео к которому относятся контакты абонентов в сегменте, \n // принимает двухбуквенный код alpha-2 ISO 3166\n \"remove_duplicates\": \"\" // Флаг с отметкой для возможности удаления дубликатов контактов\n // после нормализации. Удаление дубликатов осуществляется\n // по телефонным номерам и email.\n },\n \"id\": \"\" // Уникальный идентификатор запроса или null\n}","options":{"raw":{"language":"json"}}},"url":"https://api.botto.ai/","description":"🟠 Защищенный метод \nДоступен для роли client.
\nМетод позволяет создать сегмент (аудиторию) из базы контактов. Доступна загрузка через файл или списком.
\nПример загружаемого csv-файла
\nphone;email;tg\n+00000000000; user0@example.com ;@user0\n+00000000000;user0@example .com;\n00000000000;user0@example.com;@user0\n+0 (000) 000-0000;user0@example.com;\n+00000000001;user1@example.com;@user1\n00000000002;;@user2\n+0 000 000-00-03;user3@example.com;\n\nПараметры и поля запроса \n\n\nПАРАМЕТР ТИП ДАННЫХ ОПИСАНИЕ \n \n\n\nproject_idint required ID проекта, к которому будет прикреплена создаваемая база контактов (сегмент). Обязательные параметры : project_id Пример : \"project_id\": 123 \n \n\nnamestring required Название создаваемого сегмента (аудитории). Обязательные параметры : name Пример : \"name\": \"any_name\" \n \n\nemail_columnint[] optional Индекс столбца с email адресами. Необязательные параметры : email_column Пример : \"email_column\": [2] \n \n\nfilestring optional Поле для указания пути к загруженному файлу, значение должно быть получено в результате выполнения загрузки файла POST /upload Необязательные параметры : file Пример : \"file\": \"/upload/0/0/0/000x0xx0.csv\" \n \n\nwa_columnint optional Индекс столбца с WA аккаунтами. Необязательные параметры : wa_column Пример : \"wa_column\": 4 \n \n\nviber_columnint optional Индекс столбца с Viber аккаунтами. Не используется. Необязательные параметры : viber_column Пример : \"viber_column\": 5 \n \n\nregion_columnint optional Индекс столбца с наименованиями регионов. Необязательные параметры : region_column Пример : \"region_column\": 6 \n \n\noperator_columnint optional Индекс столбца с наименованиями операторов связи. Необязательные параметры : operator_column Пример : \"operator_column\": 7 \n \n\nphone_columnint[] optional Индекс столбца с телефонными номерами. Необязательные параметры : phone_column Пример : \"phone_column\": [1] \n \n\nmatchingobject[] optional Сопоставление полей, может быть пустым массивом. Необязательные параметры : matching Пример : \"matching\": [] \n \n\nsepstring optional Указание на разделитель полей загружаемого файла. \"sep\": \"semicolon\" — \"точка с запятой\" \"sep\": \"common\" — \"запятая\" \"sep\": \"whitespace\" — \"пробел\" и знак \"табуляция\" \"sep\": \"-\" — свой вариант с указанием его в качестве значения, в данном примере используется символ \"дефис\". Необязательные параметры : sep Пример : \"sep\": \"-\" \n \n\ncontactsstring optional Строка для передачи списка номеров телефонов, при передаче нескольких значений в качестве разделителя используется \\n. Формат телефонных номеров E.164 без ведущего плюса. Необязательные параметры : contacts Пример : \"contacts\": \"00000000001\\n00000000002\" \n \n\ncountry_columnint optional Индекс столбца с наименованиями стран. Необязательные параметры : country_column Пример : \"country_column\": 8 \n \n\ntg_columnint optional Индекс столбца с TG аккаунтами. Необязательные параметры : tg_column Пример : \"tg_column\": 3 \n \n\ncontacts_excludestring optional Строка для передачи списка номеров телефонов для исключения (минусации), при передаче нескольких значений в качестве разделителя используется \\n. Формат телефонных номеров E.164 без ведущего плюса. Необязательные параметры : contacts_exclude Пример : \"contacts_exclude\": \"00000000001\\n00000000002\" \n \n\nfile_excludestring optional Поле для указания пути к загруженному файлу для исключения (минусации), значение должно быть получено в результате выполнения загрузки файла POST /upload Необязательные параметры : file_exclude Пример : \"file_exclude\": \"/upload/0/0/0/0x0xxxx0.csv\" \n \n\ngeo_iso_codestring optional Указание гео к которому относятся контакты абонентов в сегменте, принимает двухбуквенный код alpha-2 ISO 3166. Необязательные параметры : geo_iso_code Пример : \"geo_iso_code\": \"XX\" \n \n\nremove_duplicatesboolean optional Флаг с отметкой для возможности удаления дубликатов контактов после нормализации. Удаление дубликатов осуществляется по телефонным номерам и email. Необязательные параметры : remove_duplicates Пример : \"remove_duplicates\": true \n \n \n
\n
Пример передачи значений в параметре matching:
\n\"matching\": [ // object[]\n {\n \"column\": 1, // int\n \"field_id\": 2 // int\n }\n]\n\nToken с вашим персональным ключом доступа
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"jsonrpc\": \"\", // Версия протокола JSON-RPC\n \"method\": \"communications.bases.get\", // Имя метода\n \"params\": {\n \"id\": \"\", // ID сегмента (аудитории)\n \"project_id\": \"\" // ID проекта\n },\n \"id\": \"\" // Уникальный идентификатор запроса или null\n}","options":{"raw":{"language":"json"}}},"url":"https://api.botto.ai/","description":"🟠 Защищенный метод \nДоступен для ролей admin, client.
\nМетод позволяет получить данные сегмента (аудитории) по его уникальному идентификатору.
\nПараметры и поля запроса \n\n\nПАРАМЕТР ТИП ДАННЫХ ОПИСАНИЕ \n \n\n\nproject_idint required ID проекта к которому принадлежит сегмент (аудитория). Обязательные параметры : project_id Пример : \"project_id\": 123 \n \n\nidint required ID сегмента (аудитории) по которому нужно получить данные. Обязательные параметры : id Пример : \"id\": 851 \n \n \n
\n
Token с вашим персональным ключом доступа
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"jsonrpc\": \"\", // Версия протокола JSON-RPC\n \"method\": \"communications.bases.list\", // Имя метода\n \"params\": {\n \"project_id\": \"\", // ID проекта\n \"sort\": \"\", // Параметры сортировки\n \"filter\": \"\", // Параметры фильтрации\n \"offset\": \"\", // Количество записей для пропуска\n \"limit\": \"\", // Лимит количества записей\n \"status\": \"\" // Фильтр по статусу сегмента (аудитории)\n },\n \"id\": \"\" // Уникальный идентификатор запроса или null\n}","options":{"raw":{"language":"json"}}},"url":"https://api.botto.ai/","description":"🟠 Защищенный метод \nДоступен для ролей admin, client.
\nМетод позволяет по идентификатору проекта получить список сегментов (аудиторий) с фильтрацией по названию, типу, дате создания и прочим параметрам.
\nПараметры и поля запроса \n\n\nПАРАМЕТР ТИП ДАННЫХ ОПИСАНИЕ \n \n\n\nproject_idint required ID проекта к которому принадлежит сегмент (аудитория). Обязательные параметры : project_id Пример : \"field_name\": value \n \n\nsortobject optional Объект с параметрами сортировки. Содержит поля: name (enum ) : наименование поля, по которому производится сортировка: id — идентификатор, created — дата создания, name — название, updated — дата обновления. direction (enum ) : направление сортировки: ASC — по возрастанию, DESC — по убыванию. Необязательные параметры : sort Пример : \n \n\nfilterobject optional Объект с параметрами фильтров. Содержит поля: create (object ): период по дате создания: start (int ) — начало периода, UNIX timestamp end (int )— конец периода, UNIX timestamp context (string ): поиск по контексту уникальных значений из кастомных и системных полей type (string[] ): список типов контактов сегмента: initial — исходный, 'raw data' до обработки (скоринга) segmented — сегментированный (создание нового сегмента (аудитории) по какому-либо признаку) target — цель delivered — доставлено not_delivered — не доставлено blacklist — черный список unique — уникальные amd — автоответчики scoring — прошел скоринг normalized — нормализованный dm_pixel — не используется execute (string[] ): не используется trigger (string[] ): не используется update (object ): период по дате обновления: start (int ) — начало периода, UNIX timestamp end (int ) — конец периода, UNIX timestamp Необязательные параметры : filter Пример : \n \n\noffsetint optional Количество записей, которые нужно пропустить при выборке — отсчет ведется с '1'. При передаче значения '0' результат в ответе будет возвращен с первого элемента без пропуска записей. Необязательные параметры : offset Пример : \"offset\": 0 \n \n\nlimitint optional Максимальное количество записей, которые нужно вернуть в ответе. Необязательные параметры : limit Пример : \"limit\": 25 \n \n\nstatusenum optional [ active, archived ]Фильтр по статусу сегмента (аудитории). Возможные значения: active : активный. archived : архивированный. Необязательные параметры : status Пример : \"status\": \"active\" \n \n \n
\n
Пример передачи значений в параметре sort:
\n\"sort\": {\n \"name\": \"created\", // enum\n \"direction\": \"DESC\" // enum\n }\n\nПример передачи значений в параметре filter:
\n\"filter\": {\n \"create\": { // object\n \"start\": 0, // int, UNIX timestamp\n \"end\": 1 // int, UNIX timestamp\n },\n \"context\": \"email\", // string\n \"type\": [ // string[]\n \"initial\", // string\n \"segmented\", // string\n \"target\" // string\n ], \n \"update\": { // object\n \"start\": 0, // int, UNIX timestamp\n \"end\": 1 // int, UNIX timestamp\n }\n}\n\nToken с вашим персональным ключом доступа
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"jsonrpc\": \"\", // Версия протокола JSON-RPC\n \"method\": \"communications.bases.update\", // Имя метода\n \"params\": {\n \"id\": \"\", // ID сегмента\n \"project_id\": \"\", // ID проекта\n \"name\": \"\", // ID сегмента\n \"status\": \"\" // ID проекта\n },\n \"id\": \"\" // Уникальный идентификатор запроса или null\n}","options":{"raw":{"language":"json"}}},"url":"https://api.botto.ai/","description":"🟠 Защищенный метод \nДоступен для роли client.
\nМетод позволяет обновить название ранее созданного сегмента или изменить его статус на активный или архив.
\nПараметры и поля запроса \n\n\nПАРАМЕТР ТИП ДАННЫХ ОПИСАНИЕ \n \n\n\nidint required ID сегмента для обновления. Обязательные параметры : id Пример : \"id\": 851 \n \n\nproject_idint required ID проекта которому принадлежит сегмент. Обязательные параметры : project_id Пример : \"project_id\": 123 \n \n\nnamestring optional Новое наименование сегмента. Необязательные параметры : name Пример : \"name\": \"any_name_updated\" \n \n\nstatusenum optional [ active, archived ]Новый статус сегмента. Возможные значения: active : активный. archived : архивированный. Необязательные параметры : status Пример : \"status\": \"active\" \n \n \n
\n
Token с вашим персональным ключом доступа
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"jsonrpc\": \"\", // Версия протокола JSON-RPC\n \"method\": \"communications.bases.copy\", // Имя метода\n \"params\": {\n \"project_id\": \"\", // ID проекта\n \"base_id\": \"\" // ID сегмента для копирования\n },\n \"id\": \"\" // Уникальный идентификатор запроса или null\n}","options":{"raw":{"language":"json"}}},"url":"https://api.botto.ai/","description":"🟠 Защищенный метод \nДоступен для роли client.
\nМетод позволяет создать копию существующего сегмента. Копия получит новый идентификатор и имя исходного сегмента с добавлением суффикса ' копия(1)'.
\nПараметры и поля запроса \n\n\nПАРАМЕТР ТИП ДАННЫХ ОПИСАНИЕ \n \n\n\nproject_idint required ID проекта к которому принадлежит сегмент (аудитория). Обязательные параметры : project_id Пример : \"project_id\": 82 \n \n\nbase_idint required ID сегмента (аудитории) который необходимо копировать. Обязательные параметры : id Пример : \"id\": 84 \n \n \n
\n
Token с вашим персональным ключом доступа
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"jsonrpc\": \"\", // Версия протокола JSON-RPC\n \"method\": \"communications.bases.segmentation\", // Имя метода \n \"params\": {\n \"base_id\": \"\", // Список ID сегментов для сегментации\n \"name\": \"\", // Наименование нового создаваемого сегмента \n // после операции сегментации \n \"project_id\": \"\", // ID проекта\n \"contacts\": \"\", // Список SID контактов для сегментирования\n \"filter\": \"\" // Параметры фильтрации\n },\n \"id\": \"\" // Уникальный идентификатор запроса или null\n}","options":{"raw":{"language":"json"}}},"url":"https://api.botto.ai/","description":"🟠 Защищенный метод \nДоступен для роли client.
\nМетод позволяет создать новый сегмент (аудиторию) путем разделения существующего, либо объединения нескольких сегментов:
\n\nПараметры и поля запроса \n\n\nПАРАМЕТР ТИП ДАННЫХ ОПИСАНИЕ \n \n\n\nbase_idint[] required Список ID сегментов (аудиторий) для преобразования в новый сегмент. Обязательные параметры : base_id Пример : \"base_id\": [851] \n \n\nproject_idint required ID проекта которому принадлежит(ат) выбранный(ые) сегмент(ы). Обязательные параметры : project_id Пример : \"project_id\": 123 \n \n\nnamestring required Наименование нового создаваемого сегмента после операции преобразования. Необязательные параметры : name Пример : \"name\": \"any_name_segmented\" \n \n\ncontactsstring[] optional Список SID контактов (уникальные идентификаторы контактов внутри сегмента) для выборки в новый формируемый сегмент. При передаче нескольких значений в качестве разделителя используется запятая ','. communications.bases.contacts.list ' Необязательные параметры : contacts Пример : \"contacts\": [\"123\", \"456\"] \n \n\nfilterobject optional Объект с параметрами фильтров. Содержит поля: context (string ): поиск по контексту уникальных значений из кастомных и системных полей. updated (object ): выбор периода обновления данных: start (int ) — начало периода, Unix timestamp end (int )— конец периода, Unix timestamp type (enum[] ): выборка типов контактов сегмента из списка: initial — исходный, 'raw data' до обработки (скоринга) segmented — сегментированный (создание нового сегмента по какому-либо признаку) custom — пользовательский target — цель delivered — доставлено not_delivered — не доставлено blacklist — черный список unique — уникальные amd — автоответчики scoring — прошел скоринг normalized — нормализованный dm_pixel — не используется operator (string ): выборка по наименованию оператора связи. region (string ): выборка по наименованию региона. phone_activity (enum ): выборка активности контактов по номеру телефона: active — активный inactive — неактивный unknown — неизвестный messengers_validity (enum ): выборка по значению валидности контакта в мессенджерах, если контакт валиден хотя бы в одном из мессенджеров, то он считается 'active': active — активный inactive — неактивный email_activity (enum ): выборка по значению активности email: active — активный inactive — неактивный line_type (string ): выборка по типу линии (мобильный, фиксированная связь, голосовая почта и т.д.), возможные значения: shared_cost — номер с разделённой стоимостью voip — интернет-телефония (VoIP) personal_number — персональный номер fixed_line — городской (стационарный) mobile — мобильный unknown — неизвестный тип fixed_line_or_mobile — городской или мобильный voicemail — голосовая почта toll_free — бесплатный номер uan — универсальный номер доступа (UAN) premium_rate — премиум-номер (платные услуги) pager — пейджер messengers (enum[] ): выборка по типам мессенджеров, работает в связке с 'messengers_validity' и работает от значения активности (если \"messengers_validity\": \"inactive\" то фильтр по 'messengers' вернет контакты у которых нет выбранного мессенджера): telegram — TG whatsapp — WA viber — Viber, не используется facebook — FB instagram — IG country (string ): выборка по наименованию страны. country_iso_code (string ): выборка по двухбуквенному Alpha-2-коду по ISO 3166-1. phone_connectability (object ): указание диапазона для выборки по контактности номера полученное после скоринга, при передаче значений вернет либо значения соответствующие min-max, либо пустоту если переданное значение находится за пределами диапазона данных полученных после операции скоринга: max (int ) — максимальное значение min (int )— минимальное значение email_connectability (object ): указание диапазона для выборки по контактности email, не используется: max (int ) — максимальное значение min (int )— минимальное значение connectability_types (enum[] ): фильтр для выборки по полученной ранее оценке типа контактности телефонного номера, возможные значения: sms (string ) — контактность телефонного номера для отправки SMS-сообщений voice (string ) — контактность телефонного номера для голосового трафика messengers (string ) —контактность телефонного номера в мессенджерах Необязательные параметры : filter Пример : \n \n \n
\n
Пример передачи значений в параметре filter:
\n\"filter\": { // object\n \"phone_connectability\": { // object\n \"min\": 0, // int\n \"max\": 10 // int\n },\n \"messengers_validity\": \"active\", // enum\n \"phone_activity\": \"active\", // enum\n \"email_activity\": \"active\", // enum\n \"line_type\": \"mobile\", // enum\n \"messengers\": [ // enum[]\n \"telegram\" // string\n ],\n \"connectability_types\": [ // enum[]\n \"sms\", // string\n \"messengers\" // string\n ]\n}\n\nToken с вашим персональным ключом доступа
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"jsonrpc\": \"\", // Версия протокола JSON-RPC\n \"method\": \"communications.bases.scoring\", // Имя метода\n \"params\": {\n \"base_id\": \"\", // Список ID сегментов\n \"project_id\": \"\", // ID проекта\n \"type\": \"\", // Тип скоринга\n // \"webhook_url\": \"\", // Не используется\n \"update_system_fields\": \"\", // Перезаписать значения в полях\n // мессенджеров значениями результатов скоринга\n \"name\": \"\", // Название для нового сегмента\n // формируемого из результатов скоринга\n \"contacts\": \"\", // Cписок SID телефонов для скоринга\n \"geo_iso_codes\": \"\" // Cписок с гео контактов\n },\n \"id\": \"\" // Уникальный идентификатор запроса или null\n}","options":{"raw":{"language":"json"}}},"url":"https://api.botto.ai/","description":"🟠 Защищенный метод \nДоступен для ролей admin, client.
\nМетод позволяет сделать скоринг (оценку) контактной базы на активность по различным параметрам. В ответе возвращается ID сегмента прошедшего скоринг.
\nПараметры и поля запроса \n\n\nПАРАМЕТР ТИП ДАННЫХ ОПИСАНИЕ \n \n\n\nproject_idint required ID проекта которому принадлежит выбранный сегмент. Обязательные параметры : project_id Пример : \"project_id\": 123 \n \n\nbase_idint[] required Список ID сегментов для скоринга. Обязательные параметры : field_name Пример : \"base_id\": [851] \n \n\ntypeenum[] required [ phone_validation, phone_validation_mnp, wa_score, tg_score, facebook_score, ig_score, tags_phone_score, tags_email_score, phone_connectability, phone_connectability_voice, phone_connectability_sms, phone_connectability_ehlr, email_connectability, email_validation ]Тип скоринга, выбор нескольких значений. Примечание : phone_validation' phone_validation_mnp' phone_connectability' phone_connectability_voice' phone_connectability_sms' 'phone_connectability_ehlr' \"type\". phone_validation : валидация телефона, возвращает : код страны (country_iso_code), страна (country), регион (region), тип линии (line_type), часовой пояс (timezone). phone_validation_mnp : валидация телефона + , возвращает: код страны (country_iso_code), страна (country), регион (region) , оператор (operator), тип линии (line_type), часовой пояс (timezone). wa_score : валидация телефона на наличие WA-аккаунта. tg_score : валидация телефона на наличие TG-аккаунта. facebook_score : валидация телефона на наличие FB-аккаунта. ig_score : валидация телефона на наличие IG-аккаунта. tags_phone_score : проверка телефона на списко свзанных с ним тегов. tags_email_score : проверка email на список свзанных с ним тегов. phone_connectability : Оценка контактности - общая. Скоринг-балл контактности телефона, возвращает значение от '0' до '10' баллов активности номера на основании данных внутренней BigData. Если получено значение '-100': контактность номера не известна. Если получено значение '-200': для оценки передан невалидный номер. На основании полученного скоринг-балла формируется значение 'phone_score': При значении >= 3 'active', если < 3 то 'inactive'. При значении == -100: контактность номера неизвестна 'unknown'. phone_connectability_voice : Оценка контактности телефонного номера для голосового трафика. Возвращает значение от '0' до '10'. phone_connectability_sms : Оценка контактности телефонного номера для отправки SMS-сообщений. Возвращает значение от '0' до '10'. phone_connectability_ehlr : Оценка активности телефонного номера. Возвращает значение: \"phone_score\": \"active\" (номер активен), \"phone_score\": \"inactive\" (номер неактивен), \"phone_score\": \"unknown\" (не удалось определить статус). email_connectability : контактность e-mail, не используется. email_validation : Валидация e-mail, возвращает: \"active\" (активный), \"inactive\" (неактивный). Обязательные параметры : type Пример : \n \n\nwebhook_urlstring optional URL для отправки вебхука. Не используется. Необязательные параметры : webhook_url Пример : \"webhook_url\": \"https://example.com/webhook\" \n \n\nupdate_system_fieldsboolean optional В значении 'true' параметр перезаписывает значение полей мессенджеров значениями полученными в результате скоринга. Необязательные параметры : update_system_fields Пример : \"update_system_fields\": true \n \n\nnamestring optional Наименование для сегмента, при сохранении результатов скоринга в новый сегмент. Необязательные параметры : name Пример : \"name\": \"any_name_scoring_result\" \n \n\ncontactsstring[] optional Список SID (уникальные идентификаторы контактов внутри сегмента) контактов для скоринга, при передаче нескольких значений в качестве разделителя используется запятая ','. communications.bases.contacts.list' Необязательные параметры : field_name Пример : \"contacts\": [\"123\", \"456\"] \n \n\ngeo_iso_codesstring[] optional Список с гео контактов - используется для указания гео к которому относятся контакты абонентов в сегменте. В качестве значения принимает двухбуквенный код alpha-2 ISO 3166 Необязательные параметры : geo_iso_codes Пример : \"geo_iso_codes\": [\"xx\", \"YY\"] \n \n \n
\n
Пример передачи значений в параметре type:
\n\"type\": [ // enum[]\n \"phone_validation_mnp\",\n \"tg_score\",\n \"ig_score\",\n \"tags_phone_score\",\n \"phone_connectability\",\n \"email_validation\"\n]\n\nToken с вашим персональным ключом доступа
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"jsonrpc\": \"\", // Версия протокола JSON-RPC\n \"method\": \"communications.tags.phone\", // Имя метода\n \"params\": {\n \"phones\": \"\", // Телефонные номера для скоринга (оценки)\n \"phone\": \"\", // Телефонный номер для скоринга (оценки)\n \"geo_iso_code\": \"\" // Указание гео для передаваемых контактов\n },\n \"id\": \"\" // Уникальный идентификатор запроса или null\n}","options":{"raw":{"language":"json"}}},"url":"https://api.botto.ai/","description":"🟠 Защищенный метод \nДоступен для ролей admin, client.
\nЭтот метод проверяет телефонные номера и возвращает список связанных тегов.
\nПараметры и поля запроса \n\n\nПАРАМЕТР ТИП ДАННЫХ ОПИСАНИЕ \n \n\n\nphonesstring[] optional Номера телефонов по которым необходимо сделать провекру. Формат E.164 без ведущего плюса. В одном запросе можно передать до 10000 контактов. Необязательные параметры : phones Пример : \"phones\": [\"00000000001\"] \n \n\nphonestring optional Номер телефона по которому необходимо сделать провекру. Формат E.164 без ведущего плюса. Необязательные параметры : phone Пример : \"phone\": \"00000000001\" \n \n\ngeo_iso_codestring optional Гео контакта - используется для указания гео к которому относятся оцениваемые контакты, передаваемые в запросе. В качестве значения принимает двухбуквенный код alpha-2 ISO 3166. Необязательные параметры : geo_iso_code Пример : \"geo_iso_code\": \"XX\" \n \n \n
\n
Token с вашим персональным ключом доступа
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"jsonrpc\": \"\", // Версия протокола JSON-RPC\n \"method\": \"communications.tags.email\", // Имя метода\n \"params\": {\n \"emails\": \"\", // Массив Email для проверки\n \"email\": \"\" // Email для проверки\n },\n \"id\": \"\" // Уникальный идентификатор запроса или null\n}","options":{"raw":{"language":"json"}}},"url":"https://api.botto.ai/","description":"🟠 Защищенный метод \nДоступен для ролей admin, client.
\nЭтот метод проверяет адреса электронной почты и возвращает список связанных тегов.
\nПараметры и поля запроса \n\n\nПАРАМЕТР ТИП ДАННЫХ ОПИСАНИЕ \n \n\n\nemailsstring[] optional Адреса электронной почты emails передаваемые в запросе. В одном запросе можно передать до 10000 контактов. Необязательные параметры : emails Пример : \"emails\": [\"user1@example.com\"] \n \n\nemailstring optional Адрес электронной почты email передаваемый в запросе. Необязательные параметры : email Пример : \"email\": \"user1@example.com\" \n \n \n
\n
Token с вашим персональным ключом доступа
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"jsonrpc\": \"\", // Версия протокола JSON-RPC\n \"method\": \"communications.utils.phone_connectability\", // Имя метода\n \"params\": {\n \"phones\": \"\", // Телефонные номера для скоринга (оценки)\n \"phone\": \"\", // Телефонный номер для скоринга (оценки)\n \"geo_iso_code\": \"\" // Указание для гео контактов\n },\n \"id\": \"\" // Уникальный идентификатор запроса или null\n}","options":{"raw":{"language":"json"}}},"url":"https://api.botto.ai/","description":"🟠 Защищенный метод \nДоступен для ролей admin, client.
\nМетод позволяет сделать \"общий\" скоринг (оценку) контактности телефонных номеров.
\nПараметры и поля запроса \n\n\nПАРАМЕТР ТИП ДАННЫХ ОПИСАНИЕ \n \n\n\nphonesstring[] optional Номера телефонов по которым необходимо сделать скоринг (оценку). Формат E.164 без ведущего плюса. В одном запросе можно передать до 10000 контактов. Необязательные параметры : phones Пример : \"phones\": [\"00000000001\"] \n \n\nphonestring optional Номер телефона по которыму необходимо сделать скоринг (оценку). Формат E.164 без ведущего плюса. Необязательные параметры : phone Пример : \"phone\": \"00000000001\" \n \n\ngeo_iso_codestring optional Гео контакта - используется для указания гео к которому относится оцениваемый контакт, передаваемый в запросе. В качестве значения принимает двухбуквенный код alpha-2 ISO 3166. Необязательные параметры : geo_iso_code Пример : \"geo_iso_code\": \"XX\" \n \n \n
\n
Token с вашим персональным ключом доступа
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"jsonrpc\": \"\", // Версия протокола JSON-RPC\n \"method\": \"communications.utils.phone_validation_mnp\", // Имя метода\n \"params\": {\n \"phones\": \"\", // Телефонные номера для валидации\n \"phone\": \"\", // Телефонный номер для валидации\n \"geo_iso_code\": \"\" // Указание для гео контактов\n },\n \"id\": \"\" // Уникальный идентификатор запроса или null\n}","options":{"raw":{"language":"json"}}},"url":"https://api.botto.ai/","description":"🟠 Защищенный метод \nДоступен для ролей admin, client.
\nМетод позволяет сделать \"Валидацию +\" телефонных номеров для получения данных о типе линии, гео переданного контакта, часовом поясе, операторе связи.
\nПараметры и поля запроса \n\n\nПАРАМЕТР ТИП ДАННЫХ ОПИСАНИЕ \n \n\n\nphonesstring[] optional Номера телефонов по которым необходимо сделать валидацию. Формат E.164 без ведущего плюса. В одном запросе можно передать до 10000 контактов. Необязательные параметры : phones Пример : \"phones\": [\"00000000001\"] \n \n\nphonestring optional Номер телефона по которому необходимо сделать валидацию. Формат E.164 без ведущего плюса. Необязательные параметры : phone Пример : \"phone\": \"00000000001\" \n \n\ngeo_iso_codestring optional Гео контакта - используется для указания гео к которому относится оцениваемый контакт, передаваемый в запросе. В качестве значения принимает двухбуквенный код alpha-2 ISO 3166. Необязательные параметры : geo_iso_code Пример : \"geo_iso_code\": \"XX\" \n \n \n
\n
Token с вашим персональным ключом доступа
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"jsonrpc\": \"\", // Версия протокола JSON-RPC\n \"method\": \"communications.utils.phone_validation\", // Имя метода\n \"params\": {\n \"phones\": \"\", // Телефонные номера для валидации\n \"phone\": \"\", // Телефонный номер для валидации\n \"geo_iso_code\": \"\" // Указание для гео контактов\n },\n \"id\": \"\" // Уникальный идентификатор запроса или null\n}","options":{"raw":{"language":"json"}}},"url":"https://api.botto.ai/","description":"🟠 Защищенный метод \nДоступен для ролей admin, client.
\nМетод позволяет сделать \"Валидацию\" телефонных номеров для получения данных о типе линии, гео переданных контактов, часовом поясе.
\nПараметры и поля запроса \n\n\nПАРАМЕТР ТИП ДАННЫХ ОПИСАНИЕ \n \n\n\nphonesstring[] optional Номера телефонов по которым необходимо сделать валидацию. Формат E.164 без ведущего плюса. В одном запросе можно передать до 10000 контактов. Необязательные параметры : phones Пример : \"phones\": [\"00000000001\"] \n \n\nphonestring optional Номер телефона по которому необходимо сделать валидацию. Формат E.164 без ведущего плюса. Необязательные параметры : phone Пример : \"phone\": \"00000000001\" \n \n\ngeo_iso_codestring optional Гео контакта - используется для указания гео к которому относится оцениваемый контакт, передаваемый в запросе. В качестве значения принимает двухбуквенный код alpha-2 ISO 3166. Необязательные параметры : geo_iso_code Пример : \"geo_iso_code\": \"XX\" \n \n \n
\n
Token с вашим персональным ключом доступа
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"jsonrpc\": \"\", // Версия протокола JSON-RPC\n \"method\": \"communications.utils.scoring\", // Имя метода\n \"params\": {\n \"phones\": \"\", // Телефонные номера для скоринга (оценки)\n \"phone\": \"\", // Телефонный номер для скоринга (оценки)\n \"type\": \"\", // Тип скоринга\n \"geo_iso_code\": \"\", // Указание для гео контакта\n \"normalization\": \"\" // Флаг для отметки нормализации, \n // передаваемого контакта\n },\n \"id\": \"\" // Уникальный идентификатор запроса или null\n}","options":{"raw":{"language":"json"}}},"url":"https://api.botto.ai/","description":"🟠 Защищенный метод \nДоступен для роли client.
\nМетод позволяет сделать скоринг (оценку) телефонных номеров на активность по различным параметрам.
\nПараметры и поля запроса \n\n\nПАРАМЕТР ТИП ДАННЫХ ОПИСАНИЕ \n \n\n\ntypeenum[] required [ phone_validation_mnp, phone_validation, phone_connectability, wa_score, tg_score, facebook_score, ig_score ]Тип скоринга, выбор нескольких значений. phone_validation' и 'phone_validation_mnp', все остальные значения могут быть в списке. phone_validation_mnp : валидация телефона + , возвращает: country_iso_code), country), region) , operator), line_type), timezone). phone_validation : валидация телефона , возвращает: country_iso_code), country), region), line_type), timezone). phone_connectability : скоринг-балл контактности телефона , возвращает значение от '0' до '10' баллов активности номера на основе внутренних данных BigData. wa_score : валидация телефона на наличие WA-аккаунта . tg_score : валидация телефона на наличие TG-аккаунта. facebook_score : валидация телефона на наличие FB-аккаунта. ig_score : валидация телефона на наличие IG-аккаунта. Обязательные параметры : type Пример : \n \n\nphonesstring[] optional Номера телефонов по которым необходимо сделать скоринг (оценку). Формат E.164 без ведущего плюса. phone: \"+00000000001\" или phone: \"+0 (000) 000-0001\", то для выполнения запроса телефонный номер будет нормализован до значения \\d+ содержащее только цифры. сырое значение переданного номера телефона : phone: \"+0 (000) 000-0001\" нормализованное значение телефонного номера : \"normalized_phone\": \"00000000001\" Необязательные параметры : phones Пример : \"phones\": [\"00000000001\"] \n \n\nphonestring optional Номер телефона по которому необходимо сделать скоринг (оценку). Формат E.164 без ведущего плюса. phone: \"+00000000001\" или phone: \"+0 (000) 000-0001\", то для выполнения запроса телефонный номер будет нормализован до значения \\d+ содержащее только цифры. сырое значение переданного номера телефона : phone: \"+0 (000) 000-0001\" нормализованное значение телефонного номера : \"normalized_phone\": \"00000000001\" Необязательные параметры : phone Пример : \"phone\": \"00000000001\" \n \n\ngeo_iso_codestring optional Гео контакта - используется для указания гео к которому относится оцениваемый контакт, передаваемый в запросе. В качестве значения принимает двухбуквенный код alpha-2 ISO 3166. Необязательные параметры : geo_iso_code Пример : \"geo_iso_code\": \"XX\" \n \n\nnormalizationboolean optional Флаг для отметки нужна ли нормализация телефонного номера, передаваемого в запросе. Необязательные параметры : normalization Пример : \"normalization\": true \n \n \n
\n
Пример передачи значений в параметре type:
\n\"type\": [ // enum[], Тип скоринга\n // \"phone_validation_mnp\", // Валидация телефона +\n \"phone_validation\", // Валидация телефона\n \"phone_connectability\", // Скоринг-балл контактности телефона\n \"wa_score\", // Валидация телефона на наличие WA-аккаунта\n \"tg_score\", // Валидация телефона на наличие TG-аккаунта\n \"facebook_score\", // Валидация телефона на наличие FB-аккаунта\n \"ig_score\" // Валидация телефона на наличие IG-аккаунта\n ]\n\nМетод communications.utils.scoring возвращает значение \"connectability\": -100 для неизвестных номеров.
\nПример запроса в котором для оценки передается неизвестный номер:
\n{\n \"jsonrpc\": \"2.0\", // Версия протокола JSON-RPC\n \"method\": \"communications.utils.scoring\", // Имя метода\n \"params\": {\n \"phones\": [\"00000000001\"], // Телефонные номера для скоринга (оценки)\n \"type\": [ // Тип скоринга\n \"phone_connectability\" // Скоринг-балл контактности телефона\n ]\n },\n \"id\": 1 // Уникальный идентификатор запроса или null\n}\n\nОтвет :
\n{\n \"result\": [\n {\n \"phone_connectability\": -100 // Значение контактности телефонного номера \n // полученное после скоринга - для оценки передан неизвестный номер телефона\n },\n \"phone\": \"00000000001\", // Неизвестный телефонный номер для скоринга (оценки)\n \"normalized_phone\": \"00000000001\" // Нормализованное значение телефонного номера\n }\n ],\n \"jsonrpc\": \"2.0\", // Версия протокола JSON-RPC\n \"id\": 1 // Идентификатор запроса\n}\n\nToken с вашим персональным ключом доступа
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"jsonrpc\": \"\", // Версия протокола JSON-RPC\n \"method\": \"communications.utils.facebook_score\", // Имя метода\n \"params\": {\n \"phones\": \"\", // Телефонные номера для валидации\n \"phone\": \"\", // Телефонный номер для валидации\n \"geo_iso_code\": \"\" // Указание для гео контактов\n },\n \"id\": \"\" // Уникальный идентификатор запроса или null\n}","options":{"raw":{"language":"json"}}},"url":"https://api.botto.ai/","description":"🟠 Защищенный метод \nДоступен для ролей admin, client.
\nМетод позволяет сделать валидацию телефонных номеров на наличие FB-аккаунта.
\nПараметры и поля запроса \n\n\nПАРАМЕТР ТИП ДАННЫХ ОПИСАНИЕ \n \n\n\nphonesstring[] optional \nНомера телефонов по которым необходимо сделать валидацию. Формат E.164 без ведущего плюса. В одном запросе можно передать до 10000 контактов. Необязательные параметры : phones Пример : \"phones\": [\"00000000001\"] \n \n\nphonesstring optional Номер телефона по которомунеобходимо сделать валидацию. Формат E.164 без ведущего плюса. Необязательные параметры : phone Пример : \"phone\": \"00000000001\" \n \n\ngeo_iso_codestring optional Гео контакта - используется для указания гео к которому относится оцениваемый контакт, передаваемый в запросе. В качестве значения принимает двухбуквенный код alpha-2 ISO 3166. Необязательные параметры : geo_iso_code Пример : \"geo_iso_code\": \"XX\" \n \n \n
\n
Token с вашим персональным ключом доступа
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"jsonrpc\": \"\", // Версия протокола JSON-RPC\n \"method\": \"communications.utils.ig_score\", // Имя метода\n \"params\": {\n \"phones\": \"\", // Телефонные номера для валидации\n \"phone\": \"\", // Телефонный номер для валидации\n \"geo_iso_code\": \"\" // Указание для гео контактов\n },\n \"id\": \"\" // Уникальный идентификатор запроса или null\n}","options":{"raw":{"language":"json"}}},"url":"https://api.botto.ai/","description":"🟠 Защищенный метод \nДоступен для ролей admin, client.
\nМетод позволяет сделать валидацию телефонных номеров на наличие IG-аккаунта.
\nПараметры и поля запроса \n\n\nПАРАМЕТР ТИП ДАННЫХ ОПИСАНИЕ \n \n\n\nphonesstring[] optional \nНомера телефонов по которым необходимо сделать валидацию. Формат E.164 без ведущего плюса. В одном запросе можно передать до 10000 контактов. Необязательные параметры : phones Пример : \"phones\": [\"00000000001\"] \n \n\nphonesstring optional Номер телефона по которомунеобходимо сделать валидацию. Формат E.164 без ведущего плюса. Необязательные параметры : phone Пример : \"phone\": \"00000000001\" \n \n\ngeo_iso_codestring optional Гео контакта - используется для указания гео к которому относится оцениваемый контакт, передаваемый в запросе. В качестве значения принимает двухбуквенный код alpha-2 ISO 3166. Необязательные параметры : geo_iso_code Пример : \"geo_iso_code\": \"XX\" \n \n \n
\n
Token с вашим персональным ключом доступа
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"jsonrpc\": \"\", // Версия протокола JSON-RPC\n \"method\": \"communications.utils.tg_score\", // Имя метода\n \"params\": {\n \"phones\": \"\", // Телефонные номера для валидации\n \"phone\": \"\", // Телефонный номер для валидации\n \"geo_iso_code\": \"\" // Указание для гео контактов\n },\n \"id\": \"\" // Уникальный идентификатор запроса или null\n}","options":{"raw":{"language":"json"}}},"url":"https://api.botto.ai/","description":"🟠 Защищенный метод \nДоступен для ролей admin, client.
\nМетод позволяет сделать валидацию телефонных номеров на наличие TG-аккаунта.
\nПараметры и поля запроса \n\n\nПАРАМЕТР ТИП ДАННЫХ ОПИСАНИЕ \n \n\n\nphonesstring[] optional \nНомера телефонов по которым необходимо сделать валидацию. Формат E.164 без ведущего плюса. В одном запросе можно передать до 10000 контактов. Необязательные параметры : phones Пример : \"phones\": [\"00000000001\"] \n \n\nphonesstring optional Номер телефона по которомунеобходимо сделать валидацию. Формат E.164 без ведущего плюса. Необязательные параметры : phone Пример : \"phone\": \"00000000001\" \n \n\ngeo_iso_codestring optional Гео контакта - используется для указания гео к которому относится оцениваемый контакт, передаваемый в запросе. В качестве значения принимает двухбуквенный код alpha-2 ISO 3166. Необязательные параметры : geo_iso_code Пример : \"geo_iso_code\": \"XX\" \n \n \n
\n
Token с вашим персональным ключом доступа
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"jsonrpc\": \"\", // Версия протокола JSON-RPC\n \"method\": \"communications.utils.wa_score\", // Имя метода\n \"params\": {\n \"phones\": \"\", // Телефонные номера для валидации\n \"phone\": \"\", // Телефонный номер для валидации\n \"geo_iso_code\": \"\" // Указание для гео контактов\n },\n \"id\": \"\" // Уникальный идентификатор запроса или null\n}","options":{"raw":{"language":"json"}}},"url":"https://api.botto.ai/","description":"🟠 Защищенный метод \nДоступен для ролей admin, client.
\nМетод позволяет сделать валидацию телефонных номеров на наличие WA-аккаунта.
\nПараметры и поля запроса \n\n\nПАРАМЕТР ТИП ДАННЫХ ОПИСАНИЕ \n \n\n\nphonesstring[] optional \nНомера телефонов по которым необходимо сделать валидацию. Формат E.164 без ведущего плюса. В одном запросе можно передать до 10000 контактов. Необязательные параметры : phones Пример : \"phones\": [\"00000000001\"] \n \n\nphonesstring optional Номер телефона по которомунеобходимо сделать валидацию. Формат E.164 без ведущего плюса. Необязательные параметры : phone Пример : \"phone\": \"00000000001\" \n \n\ngeo_iso_codestring optional Гео контакта - используется для указания гео к которому относится оцениваемый контакт, передаваемый в запросе. В качестве значения принимает двухбуквенный код alpha-2 ISO 3166. Необязательные параметры : geo_iso_code Пример : \"geo_iso_code\": \"XX\" \n \n \n
\n
Token с вашим персональным ключом доступа
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"jsonrpc\": \"\", // Версия протокола JSON-RPC\n \"method\": \"communications.utils.email_score\", // Имя метода\n \"params\": {\n \"emails\": \"\", // Массив Email для скоринга (оценки)\n \"email\": \"\" // Email для скоринга (оценки)\n },\n \"id\": \"\" // Уникальный идентификатор запроса или null\n}","options":{"raw":{"language":"json"}}},"url":"https://api.botto.ai/","description":"🟠 Защищенный метод \nДоступен для ролей admin, client.
\nМетод позволяет сделать скоринг (оценку) адресов электронной почты emails на активность с дополнительным получением метаданных.
\nПараметры и поля запроса \n\n\nПАРАМЕТР ТИП ДАННЫХ ОПИСАНИЕ \n \n\n\nemailsstring[] optional Адреса электронной почты emails в запросе. В одном запросе можно передать до 10000 контактов. Необязательные параметры : emails Пример : \"emails\": [\"user_name@gmail.com\"] \n \n\nemailstring optional Адрес электронной почты email в запросе. Необязательные параметры : email Пример : \"email\": \"user_name@gmail.com\" \n \n \n
\n
Token с вашим персональным ключом доступа
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"jsonrpc\": \"\", // Версия протокола JSON-RPC\n \"method\": \"communications.connectability.general\", // Имя метода\n \"params\": {\n \"phones\": \"\", // Телефонные номера для скоринга (оценки)\n \"phone\": \"\", // Телефонный номер для скоринга (оценки)\n \"geo_iso_code\": \"\" // Указание для гео контакта\n },\n \"id\": \"\" // Уникальный идентификатор запроса или null\n}","options":{"raw":{"language":"json"}}},"url":"https://api.botto.ai/","description":"🟠 Защищенный метод \nДоступен для ролей admin, client.
\nМетод позволяет сделать скоринг (оценку) телефонных номеров. В ответе возвращается общий скоринг-балл контактности: значение от '0' до '10' баллов активности переданного контакта.
\nПараметры и поля запроса \n\n\nПАРАМЕТР ТИП ДАННЫХ ОПИСАНИЕ \n \n\n\nphonesstring[] optional Номера телефонов по которым необходимо сделать скоринг (оценку). Формат E.164 без ведущего плюса. В одном запросе можно передать до 10000 контактов. phone: \"+00000000001\" или phone: \"+0 (000) 000-0001\", то для выполнения запроса телефонный номер будет нормализован до значения \\d+ содержащее только цифры. нормализованное значение телефонного номера : \"phone\": \"00000000001\" общий скоринг-балл контактности телефона : значение от '0' до '10' баллов активности номера. Если получено значение '-100': контактность номера не известна. Если получено значение '-200': для оценки передан невалидный номер. Необязательные параметры : phones Пример : \"phones\": [\"+00000000001\"] \n \n\nphonestring optional Номер телефона по которому необходимо сделать скоринг (оценку). Формат E.164 без ведущего плюса. phone: \"+00000000001\" или phone: \"+0 (000) 000-0001\", то для выполнения запроса телефонный номер будет нормализован до значения \\d+ содержащее только цифры. нормализованное значение телефонного номера : \"phone\": \"00000000001\" общий скоринг-балл контактности телефона : значение от '0' до '10' баллов активности номера. Если получено значение '-100': контактность номера не известна. Если получено значение '-200': для оценки передан невалидный номер. Необязательные параметры : phone Пример : \"phones\": \"+00000000001\" \n \n\ngeo_iso_codestring optional Гео контакта - используется для указания гео к которому относится оцениваемый контакт, передаваемый в запросе. В качестве значения принимает двухбуквенный код alpha-2 ISO 3166. Необязательные параметры : geo_iso_code Пример : \"geo_iso_code\": \"XX\" \n \n \n
\n
Token с вашим персональным ключом доступа
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"jsonrpc\": \"\", // Версия протокола JSON-RPC\n \"method\": \"communications.connectability.sms\", // Имя метода\n \"params\": {\n \"phones\": \"\", // Телефонные номера для скоринга (оценки)\n \"phone\": \"\", // Телефонный номер для скоринга (оценки)\n \"geo_iso_code\": \"\" // Указание для гео контакта\n },\n \"id\": \"\" // Уникальный идентификатор запроса или null\n}","options":{"raw":{"language":"json"}}},"url":"https://api.botto.ai/","description":"🟠 Защищенный метод \nДоступен для ролей admin, client.
\nМетод позволяет сделать скоринг (оценку) телефонных номеров. В ответе возвращается скоринг-балл контактности для отправки SMS-сообщений: значение от '0' до '10' баллов активности переданного контакта.
\nПараметры и поля запроса \n\n\nПАРАМЕТР ТИП ДАННЫХ ОПИСАНИЕ \n \n\n\nphonesstring[] optional Номера телефонов по которым необходимо сделать скоринг (оценку). Формат E.164 без ведущего плюса. В одном запросе можно передать до 10000 контактов. phone: \"+00000000001\" или phone: \"+0 (000) 000-0001\", то для выполнения запроса телефонный номер будет нормализован до значения \\d+ содержащее только цифры. нормализованное значение телефонного номера : \"phone\": \"00000000001\" общий скоринг-балл контактности телефона : значение от '0' до '10' баллов активности номера. Если получено значение '-100': контактность номера не известна. Если получено значение '-200': для оценки передан невалидный номер. Необязательные параметры : phones Пример : \"phones\": [\"+00000000001\"] \n \n\nphonestring optional Номер телефона по которому необходимо сделать скоринг (оценку). Формат E.164 без ведущего плюса. phone: \"+00000000001\" или phone: \"+0 (000) 000-0001\", то для выполнения запроса телефонный номер будет нормализован до значения \\d+ содержащее только цифры. нормализованное значение телефонного номера : \"phone\": \"00000000001\" общий скоринг-балл контактности телефона : значение от '0' до '10' баллов активности номера. Если получено значение '-100': контактность номера не известна. Если получено значение '-200': для оценки передан невалидный номер. Необязательные параметры : phone Пример : \"phone\": \"+00000000001\" \n \n\ngeo_iso_codestring optional Гео контакта - используется для указания гео к которому относится оцениваемый контакт, передаваемый в запросе. В качестве значения принимает двухбуквенный код alpha-2 ISO 3166. Необязательные параметры : geo_iso_code Пример : \"geo_iso_code\": \"XX\" \n \n \n
\n
Token с вашим персональным ключом доступа
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"jsonrpc\": \"\", // Версия протокола JSON-RPC\n \"method\": \"communications.connectability.voice\", // Имя метода\n \"params\": {\n \"phones\": \"\", // Телефонные номера для скоринга (оценки)\n \"phone\": \"\", // Телефонный номер для скоринга (оценки)\n \"geo_iso_code\": \"\" // Указание для гео контакта\n },\n \"id\": \"\" // Уникальный идентификатор запроса или null\n}","options":{"raw":{"language":"json"}}},"url":"https://api.botto.ai/","description":"🟠 Защищенный метод \nДоступен для ролей admin, client.
\nМетод позволяет сделать скоринг (оценку) телефонных номеров. В ответе возвращается скоринг-балл контактности для голосового трафика: значение от '0' до '10' баллов активности переданного контакта.
\nПараметры и поля запроса \n\n\nПАРАМЕТР ТИП ДАННЫХ ОПИСАНИЕ \n \n\n\nphonesstring[] optional Номера телефонов по которым необходимо сделать скоринг (оценку). Формат E.164 без ведущего плюса. В одном запросе можно передать до 10000 контактов. phone: \"+00000000001\" или phone: \"+0 (000) 000-0001\", то для выполнения запроса телефонный номер будет нормализован до значения \\d+ содержащее только цифры. нормализованное значение телефонного номера : \"phone\": \"00000000001\" общий скоринг-балл контактности телефона : значение от '0' до '10' баллов активности номера. Если получено значение '-100': контактность номера не известна. Если получено значение '-200': для оценки передан невалидный номер. Необязательные параметры : phones Пример : \"phones\": [\"+00000000001\"] \n \n\nphonestring optional Номер телефона по которому необходимо сделать скоринг (оценку). Формат E.164 без ведущего плюса. phone: \"+00000000001\" или phone: \"+0 (000) 000-0001\", то для выполнения запроса телефонный номер будет нормализован до значения \\d+ содержащее только цифры. нормализованное значение телефонного номера : \"phone\": \"00000000001\" общий скоринг-балл контактности телефона : значение от '0' до '10' баллов активности номера. Если получено значение '-100': контактность номера не известна. Если получено значение '-200': для оценки передан невалидный номер. Необязательные параметры : phone Пример : \"phone\": \"+00000000001\" \n \n\ngeo_iso_codestring optional Гео контакта - используется для указания гео к которому относится оцениваемый контакт, передаваемый в запросе. В качестве значения принимает двухбуквенный код alpha-2 ISO 3166. Необязательные параметры : geo_iso_code Пример : \"geo_iso_code\": \"XX\" \n \n \n
\n
Token с вашим персональным ключом доступа
\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"jsonrpc\": \"\", // Версия протокола JSON-RPC\n \"method\": \"communications.connectability.ehlr\", // Имя метода\n \"params\": {\n \"phones\": \"\", // Телефонные номера для скоринга (оценки)\n \"phone\": \"\", // Телефонный номер для скоринга (оценки)\n \"geo_iso_code\": \"\", // Указание для гео контакта\n \"file_path\": \"\", // Путь к файлу\n \"webhook_url\": \"\" // URL для получения результатов асинхронной обработки\n },\n \"id\": \"\" // Уникальный идентификатор запроса или null\n}","options":{"raw":{"language":"json"}}},"url":"https://api.botto.ai/","description":"🟠 Защищенный метод \nДоступен для ролей admin, client.
\nМетод выполняет оценку контактности (скоринг) телефонных номеров. Поддерживает два режима работы:
\n\nСинхронный — для проверки номера или небольшого списка в реальном времени.
\nАсинхронный — для массовой обработки датасетов, загруженных через POST /upload.
\n \nРежимы работы \n1. Синхронный режим \nАктивируется, если в запросе передан параметр phone.
\n\n2. Асинхронный режим (массовая обработка) \nАктивируется, если передан параметр file_path.Важно: Режим считается асинхронным только если также передан webhook_url. Если webhook_url отсутствует, метод выполнится синхронно.
\n\nПараметры и поля запроса \n\n\nПАРАМЕТР ТИП ДАННЫХ ОПИСАНИЕ \n \n\n\nphonesstring[] optional Массив номерова телефонов по которым необходимо сделать скоринг (оценку). Формат E.164, например: \"+00000000001\". phones: [\"+00000000001\"], то для выполнения запроса телефонный номер будет нормализован до значения \\d+ содержащее только цифры. нормализованное значение телефонного номера : \"phone\": \"00000000001\" \"phone_connectability\", Возможные значения: valid, invalid, unknown. Необязательные параметры : phones Пример : \"phones\": [\"+00000000001\"] \n \n\nphonestring optional Номер телефона по которому необходимо сделать скоринг (оценку). Формат E.164, например: \"+00000000001\". phone: \"+00000000001\", то для выполнения запроса телефонный номер будет нормализован до значения \\d+ содержащее только цифры. нормализованное значение телефонного номера : \"phone\": \"00000000001\" \"phone_connectability\", Возможные значения: valid, invalid, unknown. Необязательные параметры : phone Пример : \"phone\": \"+00000000001\" \n \n\ngeo_iso_codestring optional Гео контакта - используется для указания гео к которому относится оцениваемый контакт, передаваемый в запросе. В качестве значения принимает двухбуквенный код alpha-2 ISO 3166. Необязательные параметры : geo_iso_code Пример : \"geo_iso_code\": \"XX\" \n \n\nfile_pathstring optional Путь к файлу с номерами для массовой проверки. POST /upload Требование к номерам внутри датасета : 00000000001 \\n 00000000001 00000000002 00000000003 Необязательные параметры : file_path Пример : \"file_path\": \"/upload/0/0/0/000x0xx0.csv \n \n\nwebhook_urlstring optional URL для получения результатов асинхронной обработки: file_path — режим асинхронный. Необязательные параметры : webhook_url Пример : \"webhook_url\": \"https://example.com/webhook\" \n \n \n
\n
Форматы ответов \nПример ответа при синхронном запросе (phones) \n{\n \"result\": [\n {\n \"phone\": \"00000000001\", // Телефонный номер по которому произведен скоринг (оценка) статуса.\n \"phone_connectability\": \"valid\" // Статус контактности телефонного номера, возиможные занчения:\n // \"valid\" - номер валиден\n // \"invalid\" - номер невалиден\n // \"unknown\" - не удалось определить статус\n }\n ],\n \"jsonrpc\": \"2.0\", // Версия протокола JSON-RPC\n \"id\": 1 // Идентификатор запроса\n}\n\nПример ответа на стороне клиента по вебхуку при асинхронном запросе (file_path + webhook_url) \nРезультат приходит массивом объектов.
\n[\n {\n \"phone\": \"00000000001\",\n \"connectability\": \"valid\"\n },\n {\n \"phone\": \"00000000002\",\n \"connectability\": \"invalid\"\n },\n {\n \"phone\": \"00000000003\",\n \"connectability\": \"unknown\"\n }\n // ...\n]\n\nToken с вашим персональным ключом доступа
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"jsonrpc\": \"\", // Версия протокола JSON-RPC\n \"method\": \"users.me\", // Имя метода\n \"params\": \"\", // Пустой объект, параметры отсутствуют для соответствия формату JSON-RPC\n \"id\": \"\" // Уникальный идентификатор запроса или null\n}","options":{"raw":{"language":"json"}}},"url":"https://api.botto.ai/","description":"🟠 Защищенный метод \nДоступен для ролей admin, manager, support, moderator, client, accountant.
\nМетод предоставляет информацию о текущем авторизованном пользователе.
\nПараметры и поля запроса \n\n\nПАРАМЕТР ТИП ДАННЫХ ОПИСАНИЕ \n \n\n\nparamsobject optional {} array optional []Параметры отсутствуют. {} или массивом [] для соответствия формату JSON-RPC. params Необязательные параметры : Пример : \"params\": {} \n \n \n
\n
Token с вашим персональным ключом доступа
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"jsonrpc\": \"\", // Версия протокола JSON-RPC\n \"method\": \"transactions.list\", // Имя метода\n \"params\": {\n \"user_id\": \"\", // ID пользователя\n \"type\": \"\", // Тип транзакции\n \"offset\": \"\", // Количество транзакций для пропуска\n \"limit\": \"\", // Лимит количества транзакций\n \"timestamp\": \"\" // Временной период\n },\n \"id\": \"\" // Уникальный идентификатор запроса или 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\nuser_idint optional Идентификатор пользователя, которому принадлежат искомые транзакции. Необязательные параметры : user_id Пример : \"user_id\": 10 \n \n\ntimestampobject optional Объект, представляющий временной период, в который были совершены искомые транзакции. Содержит следующие поля: start (int ) : Начало периода, формат даты UNIX timestamp. end (int ) : Конец периода, формат даты UNIX timestamp. Необязательные параметры : timestamp Пример : \n \n\noffsetint optional Количество записей, которые нужно пропустить при выборке — отсчет ведется с 1. При передаче значения 0 результат в ответе будет возвращен с первого элемента без пропуска записей. Необязательные параметры : offset Пример : \"offset\": 25 \n \n\nlimitint optional Максимальное количество записей, которые нужно вернуть в ответе. Необязательные параметры : limit Пример : \"limit\": 25 \n \n\ntypeint optional Идентификатор типа транзакции. Необязательные параметры : 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\nYour 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Загружает файлы с датасетами для последующего использования в методах где указывается параметр \"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ФОРМАТ РАСШИРЕНИЕ MIME-тип ОПИСАНИЕ \n \n\n\nText \n.txttext/plainОбычный текст, где строки разделены символом новой строки '\\n', а в качестве разделителя полей внутри строки могут использоватся кастомные символы. \n \n\nCSV \n.csvtext/csvТекстовый формат, предназначенный для представления табличных данных. Поля разделяются запятыми ',' или точками с запятой ';' \n \n\nTSV \n.tsvtext/csvТекстовый формат, предназначенный для представления табличных данных. Поля разделяются символом табуляции '\\t' \n \n\nExcel \n.xlsapplication/vnd.ms-excelУстаревший формат таблиц Excel (.xls) \n \n\nExcel \n.xlsxapplication/vnd.openxmlformats-officedocument.spreadsheetml.sheetСовременный формат таблиц Excel Open XML (.xlsx) \n \n\nExcel \n.xlsbapplication/vnd.openxmlformats-officedocument.spreadsheetml.sheetБинарный формат таблиц 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\nfilemultipart/form-data required Указатель на файл для загрузки. Исходное имя файла сохраняется в ответе в поле \"name\": \"dataset_name.csv\". Требование к файлу : .txt, .csv, .tsv, .xls, .xslx, .xlsb. Для корректной загрузки файла нужно передать составное значение параметра 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\nnamestringИсходное имя файла из запроса. Пример : \"name\": \"dataset_name.csv\" \n \n\ntypestringОпределённое расширение загружаемого файла. Пример : \"type\": \"csv\" \n \n\npathstringПуть к загруженному файлу на сервере для использования 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' при загрузке через cURL.\n// ПРАВИЛЬНО: '/path/to/file;type='"},{"id":"d2880e54-d3d6-495a-85cc-a5b7eec47b2e","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":"fd93c781-b637-4a66-aba0-2b87f4356293"}],"id":"bc9f0519-2092-4d35-b075-05c37cd5dba5","_postman_id":"bc9f0519-2092-4d35-b075-05c37cd5dba5","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"}]}