{"info":{"_postman_id":"8e06274d-eb50-432c-85cb-c2c28a906c4e","name":"- Botto API -","description":"

Назначение и функциональность api.botto.ru:

API позволяет формировать запросы для работы с Botto Platform.

Botto Platform предоставляет широкий спектр эффективных решений
по автоматизации коммуникации, привлечению и удержанию клиентов.

Подробнее о возможностях платформы автоматизации маркетинга Botto Platform
на сайте проекта botto.ru

Базовый URL, аутентификация, методы

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

ПАРАМЕТР	ОПИСАНИЕ
Базовый URL	API использует протокол передачи данных JSON-RPC. Точка входа для всех запросов: `https://api.botto.ru/`
Метод запроса	Все запросы отправляются HTTP-методом `POST`, протокол передачи данных `JSON-RPC`
Коды ответа	Для JSON-RPC методов успешный ответ возвращается с HTTP-кодом `200 OK`. Обратите внимание на коды ответов и заголовки при использовании того или иного метода — некоторые методы могут возвращать отличные от `200 OK` коды, если это явно указано в описании ответа метода или заголовках метода.
Авторизация	Для доступа к защищенным методам API необходимо добавлять HTTP-заголовок `Token` с вашим персональным ключом доступа в каждый запрос. `Token` нужен серверу, чтобы понять, кто вы и какие права доступа у вас есть. Ключ доступа можно получить у вашего персонального менеджера, сопровождающего работу с вашим проектом. Формат заголовка: `Token: your_token_here` Пример полного запроса с использованием cURL: `curl --location 'http://api.botto.ru' \\` `--header 'Token: your_token_here' \\` `--header 'Content-Type: application/json' \\` `--header 'Accept: application/json' \\` `--data '{` `\"jsonrpc\": \"2.0\",` `\"method\":` `\"example.method\",` `\"params\": {},` `\"id\": 1` `}'` 🟡 Важно: - Заголовок `Token` требуется для всех защищенных методов. В данном API используется собственный HTTP-заголовок `Token`, а не стандартная схема, как например `Authorization: Bearer`. - Заголовок `Content-Type: application/json` обязателен для JSON-RPC запросов. - Заголовок `Accept: application/json` для JSON-RPC API не является обязательным (сервер обычно возвращает JSON, если не указано иное в списках рекомендуемых заголовков, либо иное значение для кода ответа отличное от `200 OK`). Включение заголовка повышает корректность и надежность запроса, так как явно указывает серверу ожидаемый формат ответа.
Формат данных	Большинство JSON-RPC методов возвращают ответ в формате JSON с HTTP-кодом `200 OK`. Однако некоторые методы (например, экспорт данных) могут использовать другие механизмы, такие как редирект (код 301) для получения ссылки на скачивание файлов. В таких случаях тело ответа может быть в другом формате, а сам файл будет доступен по URL из заголовка `Location`. Для получения ответа запрос по протоколу JSON-RPC требует передачи следующих полей: -- `method` — Обязательное поле — Строка с именем вызываемого метода. -- `id` — Обязательное поле — Значение любого типа, которое используется для установления соответствия между запросом и ответом. -- `params` — Опциональное поле — Объект '`{}`' или массив '`[]`' с параметрами, передаваемыми методу, где формат (объект или массив) определяется сигнатурой конкретного метода API. Может быть опущен, если метод не требует параметров. -- `jsonrpc` — Опциональное поле — Указание на версию протокола JSON-RPC. Ответ содержит: -- `jsonrpc` — Указание версии протокола JSON-RPC. -- `result` или `error` — В корректном ответе всегда присутствует только одно из этих полей: ---- `result` — Данные, которые вернул метод. ---- `error` — Код ошибки, если произошла ошибка во время выполнения метода. -- `id` — То же значение, что и в запросе, к которому относится данный ответ Уведомления: Для ситуаций, когда ответ не требуется, в протоколе JSON-RPC введены уведомления. Уведомление отличается от запроса отсутствием свойства `id`, которое не требуется, так как не будет передан ответ. Спецификация JSON-RPC 2.0

Общие соглашения

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

ПАРАМЕТР	ОПИСАНИЕ
Протокол передачи данных	`JSON-RPC`
Формат данных	`JSON`
Кодировка	`UTF-8` 🟡 Все текстовые данные должны быть закодированы в `UTF-8`, включая тела запросов и ответов.
Методы	`POST`
Правила именования полей	`snake_case`
Правила именования методов	`dot.notation`

Коды ошибок

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

КОД ОШИБКИ	ОПИСАНИЕ
`-32700`	Parse error — Сервер получил неверный JSON. При обработке произошла ошибка сервера.
`-32600`	Invalid request — Отправленный JSON не является допустимым объектом запроса.
`-32601`	Method not found — Метод не существует или недоступен.
`-32602`	Invalid params — Некорректный параметр метода. После кода ошибки может идти пояснение, например: - `'status must be enum'` — поле `status` передано с недопустимым значением (к примеру, должно быть одним из `['active', 'archived']`, согласно реализации схемы перечисления определенной на стороне бэкенда). - `'base_id is required'` — не указано обязательное поле '`base_id`'. - `'phone must be phone'` — телефон должен быть в формате E.164 без `+` (например, `79×××××××22`).
`-32603`	Internal error — Внутренняя ошибка сервиса.
`-32000` → `-32099`	Server error — Ошибки сервера, определяемые реализацией. Например, `-32004 — Server Error: \"Low balance\"` — Низкий баланс, пополните баланс аккаунта.

","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Базовый URL, аутентификация, методы","slug":"bazovyj-url-autentifikaciya-metody"},{"content":"Общие соглашения","slug":"obshie-soglasheniya"},{"content":"Коды ошибок","slug":"kody-oshibok"}],"owner":"53737309","collectionId":"8e06274d-eb50-432c-85cb-c2c28a906c4e","publishedId":"2sBYB4Jkdh","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"24ADED"},"publishDate":"2026-09-25T09:11:23.000Z"},"item":[{"name":"Cases","item":[{"name":"Работа с проектами","item":[],"id":"04ba89c9-70af-4336-af51-02aea7b5c56b","description":"

Проект — базовая сущность, к которой привязываются сегменты, черные списки, материалы, IVR и рассылки.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

МЕТОД	ОПИСАНИЕ
`#projects.create`	Метод позволяет создать новый проект.
`#projects.my`	Метод позволяет получить список проектов, принадлежащих текущему пользователю, с возможностью фильтрации.
`#projects.update`	Метод позволяет обновить данные выбранного проекта.

","_postman_id":"04ba89c9-70af-4336-af51-02aea7b5c56b"},{"name":"Работа с сегментами","item":[],"id":"34cfe407-b602-4a7e-9d18-b29846198f93","description":"

Сегменты (аудитории) — списки контактов для обзвона, рассылок, скоринга и сегментации.

Последовательность

Проект:
#projects.create → #projects.my
\n
Создание сегмента:
#communications.bases.create
Загрузка контактов файлом через POST /upload или списком через contacts.
В result возвращается ID сегмента.
\n
Добавление контактов:
#communications.bases.contacts.add
\n
Исключение контактов:
#communications.bases.contacts.exclude
\n
Просмотр:
#communications.bases.get → #communications.bases.list → #communications.bases.contacts.list
\n
Преобразование:
#communications.bases.copy — копия сегмента.
#communications.bases.segmentation — разделение или объединение сегментов.
\n
Обновление:
#communications.bases.update — изменение имени и статуса active / archived.
\n
Экспорт данных сегмента:
#communications.bases.contacts.export или #communications.bases.contacts.download
\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

МЕТОД	ОПИСАНИЕ
`#communications.bases.create`	Метод позволяет создать сегмент (аудиторию) из базы контактов. Доступна загрузка через файл или списком.
`#communications.bases.contacts.add`	Метод для добавления контактов к ранее созданному сегменту (аудитории).
`#communications.bases.contacts.exclude`	Метод для исключения (минусации) контактов из ранее созданного сегмента (аудитории).
`#communications.bases.get`	Метод позволяет получить данные сегмента (аудитории) по его уникальному идентификатору.
`#communications.bases.list`	Метод позволяет по идентификатору проекта получить список входящих в него сегментов (аудиторий) с фильтрацией по названию, типу, дате создания и прочим параметрам.
`#communications.bases.contacts.list`	Метод позволяет получить список контактов сегмента (аудитории) с различными параметрами фильтрации.
`#communications.bases.contacts.tags`	Метод позволяет получить список уникальных тегов к контактам сегмента (аудитории).
`#communications.bases.contacts.emails_info`	Метод позволяет получить список уникальных метаданных из списка email адресов сегмента (аудитории) прошедших скоринг с типом `\"type\": \"email_validation\"`. Список метатегов включает: -- MX-записи доменов -- Названия SMTP-провайдеров -- Коды статуса SMTP-сервера -- Названия стран -- Название доменов Если сегмент не проходил скоринг или не найдено результатов для email адресов, то метод вернет `\"result\": null`
`#communications.bases.update`	Метод позволяет обновить название ранее созданного сегмента или изменить его статус на активный или архив.
`#communications.bases.copy`	Метод позволяет создать копию существующего сегмента. Копия получит новый идентификатор и имя исходного сегмента с добавлением суффикса ' `копия(1)`'.
`#communications.bases.segmentation`	Метод позволяет создать новый сегмент (аудиторию) путем разделения существующего, либо объединения нескольких сегментов: -- Разделение существующего сегмента путем выборки контактов с различными параметрами фильтрации. -- Объединение нескольких сегментов в один.
`#communications.bases.contacts.download`	Метод для скачивания файла с данными сегмента (аудитории) по его уникальному идентификатору. Можно выбрать формат файла для скачивания: `.csv` или `.xlsx`(Excel).
`#communications.bases.contacts.export`	Метод для экспорта в файл данных сегмента (аудитории) по его уникальному идентификатору с различными параметрами фильтрации. Можно выбрать формат файла для экспорта: `.csv` или `.xlsx` (Excel).
`#communications.bases.contacts.export_stream`	Экспорт данных сегмента с различными параметрами фильтрации. В ответе возвращается `text/csv`: кодировка `UTF-8`, разделитель полей `точка с запятой`.
`#communications.bases.scoring`	Метод позволяет сделать скоринг (оценку) контактной базы на активность по различным параметрам. В ответе возвращается список ID сегментов прошедших скоринг, количество ID в ответе определяется набором параметров `\"type\"` указанными в запросе.
`POST /upload`	Загружает файлы с датасетами для последующего использования в методах где указывается параметр `\"file\": \"/path/to/file\"`. Возвращает путь к загруженному файлу на сервер.

","_postman_id":"34cfe407-b602-4a7e-9d18-b29846198f93"},{"name":"Работа с черными списками","item":[],"id":"f5ace2f3-3c86-4041-b19c-9d0d88202d5c","description":"

Черные списки используются для исключения контактов из обзвона и накопления номеров, которые не должны получать коммуникации.

Последовательность

Проект:
#projects.create → #projects.my
\n
Создание черного списка:
#communications.blacklists.create
Контакты можно передать файлом через POST /upload или списком через contacts.
Черный список может быть создан пустым.
В result возвращается ID черного списка.
\n
Добавление контактов:
#communications.blacklists.contacts.add
\n
Исключение контактов:
#communications.blacklists.contacts.exclude
\n
Просмотр:
#communications.blacklists.get → #communications.blacklists.list → #communications.blacklists.suggest → #communications.blacklists.contacts.list
\n
Обновление:
#communications.blacklists.update
Изменение имени и статуса active / archived.
\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

МЕТОД	ОПИСАНИЕ
`#communications.blacklists.create`	Метод позволяет создать сегмент с новым черным списком контактов для указанного проекта.
`#communications.blacklists.get`	Метод позволяет получить информацию о выбранном черном списке контактов.
`#communications.blacklists.list`	Метод позволяет получить список черных списков для указанного проекта.
`#communications.blacklists.suggest`	Метод позволяет получить список черных списков контактов для указанного проекта с возможностью фильтрации по поисковому запросу и статусу.
`#communications.blacklists.update`	Метод позволяет обновить данные выбранного черного списка контактов.
`#communications.blacklists.contacts.add`	Метод позволяет добавить контакты в выбранный черный список.
`#communications.blacklists.contacts.exclude`	Метод позволяет исключить контакты из выбранного черного списка.
`#communications.blacklists.contacts.list`	Метод позволяет получить список контактов из выбранного черного списка.
`POST /upload`	Загружает файлы с датасетами для последующего использования в методах где указывается параметр `\"file\": \"/path/to/file\"`. Возвращает путь к загруженному файлу на сервер.

","_postman_id":"f5ace2f3-3c86-4041-b19c-9d0d88202d5c"},{"name":"Скоринг (оценка) контактов","item":[{"name":"Скоринг (оценка) сегмента","item":[],"id":"141c4886-69ad-4a6e-acda-1a56da234e83","description":"

Осуществляется путем последовательного выполнения методов:

Для создания сегмента в новом проекте:
#projects.create → #communications.bases.create → #communications.bases.scoring → #communications.bases.get
\n
Для создания сегмента в уже существующем проекте:
#projects.my → #communications.bases.create → #communications.bases.scoring → #communications.bases.get
\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

МЕТОД	ОПИСАНИЕ
`#projects.create`	Создание нового проекта. Опциональный шаг. В ответе метода '`#projects.create`' в поле '`result`' получаем идентификатор созданного проекта. Идентификатор проекта нужен для привязки создаваемых сегментов к конкретному проекту, если уже есть ранее созданные проекты, то можно использовать их идентификаторы для работы с системой. Пример: `\"result\": 15`
`#projects.my`	Получение списка существующих проектов пользователя. Опциональный шаг. В ответе метода '`#projects.my`' в поле '`items`' получаем список проектов пользователя. Внутри каждого '`items`' указаны идентификаторы проектов в поле '`id`'. Пример: `\"items\": { [` `...` `\"id\": 14` `...` `],` `}`
`#communications.bases.create`	Создание сегмента. При создании сегмента необходимо указать идентификатор нового созданного проекта, либо использовать идентификатор существующего в системе проекта. Посмотреть список проектов пользователя можно с помощью метода '`#projects.my`' . В ответе метода '`#communications.bases.create`' в поле '`result`' получаем идентификатор созданного сегмента. Пример: `\"result\": 851`
`#communications.bases.scoring`	Скоринг сегмента. В ответе метода в поле '`result`' получаем список идентификаторов сегментов прошедших скоринг исходного сегмента полученного на прошлом этапе `#communications.bases.create` . Количество полученных идентификаторов в ответе определяется набором значений параметра '`type`' указанных в запросе. Пример: `\"result\": [852, 853]`
`#communications.bases.get`	Проверка завершения процесса скоринга по идентификатору сегмента полученного на прошлом этапе `#communications.bases.scoring`. В ответе метода в массиве '`result`' с данными сегмента в поле '`status`' проверяем статус сегмента. Примеры: `\"status\": \"pending\"` — Статус сегмента \"в ожидании\" — Скоринг не завершен. `\"status\": \"active\"` — Статус сегмента \"активный\" — Скоринг завершен.

Для получения результатов скоринга используются методы:

#communications.bases.contacts.list — получение списка контактов сегмента (аудитории) с возможностью фильтрации по различным параметрам.
\n
#communications.bases.contacts.download — скачивание в файл всех данных сегмента, можно указать формат файла для скачивания: .csv или .xlsx.
\n
#communications.bases.contacts.export — экспорт данных сегмента с различными параметрами фильтрации, можно указать формат экспортируемых данных: .csv или .xlsx.
\n
#communications.bases.contacts.export_stream — экспорт данных сегмента с различными параметрами фильтрации. В ответе возвращается text/plain в структуре .csv: кодировка UTF-8, разделитель полей точка с запятой.
\n

\n","_postman_id":"141c4886-69ad-4a6e-acda-1a56da234e83"},{"name":"Скоринг (оценка) контакта (телефон или email)","item":[],"id":"539ffed8-2a83-4c7a-9701-6fa99377743b","description":"

Для получения данных по одному переданному контакту можно использовать:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

МЕТОД	ОПИСАНИЕ
`#communications.utils.phone_connectability`	Метод позволяет сделать \"общий\" скоринг (оценку) контактности телефонных номеров.
`#communications.utils.phone_validation_mnp`	Метод позволяет сделать \"Валидацию +\" телефонных номеров для получения данных о типе линии, гео переданного контакта, часовом поясе, операторе связи.
`#communications.utils.phone_validation`	Метод позволяет сделать \"Валидацию\" телефонных номеров для получения данных о типе линии, гео переданных контактов, часовом поясе.
`#communications.utils.scoring`	Метод позволяет сделать скоринг (оценку) телефонных номеров на активность по различным параметрам.
`#communications.utils.facebook_score`	Метод позволяет сделать валидацию телефонных номеров на наличие FB-аккаунта.
`#communications.utils.ig_score`	Метод позволяет сделать валидацию телефонных номеров на наличие IG-аккаунта.
`#communications.utils.tg_score`	Метод позволяет сделать валидацию телефонных номеров на наличие TG-аккаунта.
`#communications.utils.wa_score`	Метод позволяет сделать валидацию телефонных номеров на наличие WA-аккаунта.
`#communications.utils.max_score`	Метод позволяет сделать валидацию телефонных номеров на наличие MAX-аккаунта.
`#communications.utils.email_score`	Метод позволяет сделать скоринг (оценку) адресов электронной почты `emails` на активность с дополнительным получением метаданных.
`#communications.connectability.general`	Метод позволяет сделать скоринг (оценку) телефонных номеров. В ответе возвращается общий скоринг-балл контактности: значение от '0' до '10' баллов активности переданного контакта.
`#communications.connectability.sms`	Метод позволяет сделать скоринг (оценку) телефонных номеров. В ответе возвращается скоринг-балл контактности для отправки SMS-сообщений: значение от '0' до '10' баллов активности переданного контакта.
`#communications.connectability.voice`	Метод позволяет сделать скоринг (оценку) телефонных номеров. В ответе возвращается скоринг-балл контактности для голосового трафика: значение от '0' до '10' баллов активности переданного контакта.
`#communications.connectability.ehlr`	Метод выполняет оценку контактности (скоринг) телефонных номеров. Поддерживает два режима работы: -- Синхронный — для проверки одного номера или небольшого списка в реальном времени. -- Асинхронный — для массовой обработки датасетов, загруженных через `POST /upload`. В ответе возвращается статус контактности для переданного в запросе контакта/ов. Возможные значения: `valid`, `invalid`, `unknown`.

","_postman_id":"539ffed8-2a83-4c7a-9701-6fa99377743b"}],"id":"c6acc2ca-df53-483e-a93f-1183a63cf904","_postman_id":"c6acc2ca-df53-483e-a93f-1183a63cf904","description":""},{"name":"DMP","item":[],"id":"7e145106-8ed0-4c47-9352-36bded514422","description":"

Для работы с DMP доступно 4 типа DMP-записей:

phones : Телефонные номера
\n
domains : Домены
\n
alpha_names : Альфа-имена SMS
\n
code : Код пискселя DMP
\n

Чтобы начать работу с DMP необходимо:

Выбрать существующий проект projects.my или создать новыйprojects.create.
\n
Создать целевой сегмент communications.bases.createдля сбора результатов работы DMP.
\n
В зависимости от типа создаваемой DMP записи создать материал методом communications.materials.create. Также доступно создание DMP списком или через загрузку файлом для типов: phones, domains, alpha_names. DMP с типом code имеет отличный сценарий создания.
\n
Создать DMP запись методом communications.dmp.create — примеры создания DMP-записей в зависимости от типа DMP и материла показаны на примерах саксесс запросов. Все записи создаются в статусе paused или pending в зависимости от ипользуемого типа.
\n
Опционально для фильтрации собираемых значений от DMP можно использовать черные списки communications.blacklists.create — в черном списке можно указать списки исключающих значений (телефонные номера, домены, альфа-мена SMS) которые не нужно собирать в целевой сегмент.
\n
Для старта сбора данных для созданной DMP-записи необходимо перевести статус её в \"status\": \"active\" с помощью метода communications.dmp.update
\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

МЕТОД	ОПИСАНИЕ
`#communications.dmp.create`	Метод позволяет создать новую DMP запись, с указанием типа и опицональных параметров.
`#communications.dmp.get`	Метод позволяет получить информацию о DMP записи по ее идентификатору.
`#communications.dmp.list`	Метод позволяет получить список DMP записей с фильтрацией по статусу, типу и прочим параметрам.
`#communications.dmp.update`	Метод позволяет обновить существующую DMP запись.
`#communications.dmp.archive`	Метод позволяет архивировать DMP запись по ее идентификатору.
`#communications.dmp.generate_pixel_code`	Метод позволяет сгенерировать HTML-код DMP записи по идентификатору проекта и домену.

","_postman_id":"7e145106-8ed0-4c47-9352-36bded514422"},{"name":"Триггеры","item":[],"id":"a167c7bd-be09-4960-9559-d60d2cb6f792","description":"

Триггеры — автоматизированные правила, которые выполняют заданные действия (скоринг, сегментацию, запуск рассылок) при наступлении определённых условий: по расписанию, при достижении лимита или по повторяющемуся событию.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

МЕТОД	ОПИСАНИЕ
`communications.triggers.rules.create`	Метод позволяет создать новый триггер с параметризацей дейстивий и условий выполнения.
`communications.triggers.rules.get`	Метод позволяет получить данные триггера по его идентификатору.
`communications.triggers.rules.list`	Метод позволяет получить список триггеров.
`communications.triggers.rules.update`	Метод позволяет обновить параметры существующего триггера.
`communications.triggers.action_definitions.list`	Метод позволяет получить список доступных действий для триггеров с их идентификаторами для использования в параметре `\"actions\":{}`метода `communications.triggers.rules.create`

Последовательность вызова методов при типовом сценарии:

Получить список доступных действий → communications.triggers.action_definitions.list узнать какие action_definition_id можно использовать
\n
Создать триггер → communications.triggers.rules.create указать типы, действия, конфигурацию
\n
Проверить результат
→ communications.triggers.rules.get по id
→ communications.triggers.rules.list список/фильтры
\n
Изменить существующий триггер → communications.triggers.rules.update
\n

тип триггера → ожидаемый `config`

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

TYPES	ОЖИДАЕМЫЕ ПОЛЯ `config`
`[\"scheduled\"]`	`scheduled_time` или `interval_delta`
`[\"scheduled\", \"limits\"]`	`scheduled_time` или `interval_delta`, плюс `limit_target_count`
`[\"iterations\"]`	`days_of_week + at_time` или `cron_expression`
`[\"iterations\", \"limits\"]`	`days_of_week + at_time` или `cron_expression`, плюс `limit_target_count` (и при необходимости `limit_step`)
`[\"limits\"]`	`limit_target_count`

Подготовка действия перед созданием триггера

Задача: узнать, какие действия доступны для использования в триггере.

Метод: communications.triggers.action_definitions.list

{\n  \"jsonrpc\": \"2.0\",\n  \"method\": \"communications.triggers.action_definitions.list\",\n  \"params\": {\n    \"offset\": 0,\n    \"limit\": 25\n  },\n  \"id\": 1\n}\n\n

Результат: список действий вида { \"id\": 1, \"name\": \"method.name\" }. Значение id далее используется как action_definition_id при создании триггера.

Примеры `types`/`config` при работе с различными триггерами

Однократный запуск действия по времени (`scheduled`)

Задача: запустить скоринг сегмента в конкретную дату и время.

Тип триггера: [\"scheduled\"]

\"types\": [\"scheduled\"],\n\"config\": {\n  \"scheduled_time\": \"2027-09-01 12:00:00\",\n  \"timezone\": \"Europe/Moscow\"\n}\n\n

Альтернатива — запуск через интервал в секундах (например, через 1 час):

\"config\": {\n  \"interval_delta\": \"3600\"\n}\n\n

\n
-- scheduled_time и interval_delta взаимоисключающие — передавать нужно только одно из них.
-- При использовании scheduled_time обязательно передать timezone в формате IANA (например, \"Europe/Moscow\").
-- При использовании interval_delta параметр timezone не передаётся (интервал относительный).
\n

Запуск действия при достижении лимита (`limits`)

Задача: выполнить сегментацию, когда счётчик контактов достигнет порога.

Тип триггера: [\"limits\"]

\"types\": [\"limits\"],\n\"config\": {\n  \"limit_target_count\": 500\n}\n\n

\n
-- Для типа limits обязательно передать limit_target_count.
-- Параметр timezone для типа [\"limits\"] не передаётся.
\n

Повторяющийся запуск (`iterations`)

Задача: запускать действие регулярно — по дням недели или по cron.

Тип триггера: [\"iterations\"]

Вариант А — по дням недели и времени (пн, ср, пт в 10:30):

\"types\": [\"iterations\"],\n\"config\": {\n  \"days_of_week\": [1, 3, 5],\n  \"at_time\": \"10:30\",\n  \"timezone\": \"Europe/Moscow\"\n}\n\n

Вариант Б — по cron-выражению (по будням в 09:00):

\"config\": {\n  \"cron_expression\": \"0 9 * * 1-5\",\n  \"timezone\": \"Europe/Moscow\"\n}\n\n

\n
-- days_of_week + at_time и cron_expression взаимоисключающие — использовать один из вариантов.
-- В обоих вариантах обязательно передать timezone в формате IANA.
\n

Комбинированный запуск: расписание + лимит

Задача: по расписанию проверять достижение лимита.

Тип триггера: [\"scheduled\", \"limits\"] или [\"iterations\", \"limits\"]

Вариант А — [\"scheduled\", \"limits\"]:

\"types\": [\"scheduled\", \"limits\"],\n\"config\": {\n  \"scheduled_time\": \"2027-09-01 12:00:00\",\n  \"timezone\": \"Europe/Moscow\",\n  \"limit_target_count\": 50\n}\n\n

Вариант Б — [\"iterations\", \"limits\"]:

\"types\": [\"iterations\", \"limits\"],\n\"config\": {\n  \"days_of_week\": [1, 2, 3, 4, 5],\n  \"at_time\": \"09:00\",\n  \"timezone\": \"Europe/Moscow\",\n  \"limit_target_count\": 100,\n  \"limit_step\": 10\n}\n\n

\n
-- Для [\"scheduled\", \"limits\"] обязательно передать и расписание (scheduled_time/interval_delta), и limit_target_count.
-- Для [\"iterations\", \"limits\"] дополнительно можно указать limit_step — шаг повторного срабатывания лимита.
-- timezone передаётся при использовании scheduled_time, days_of_week + at_time или cron_expression.
\n

Цепочка из нескольких действий

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

Решение: передать массив actions из нескольких объектов. Последовательность задаётся полем sequence_order, связь между действиями — через parent_id в ответе.

\"actions\": [\n  {\n    \"action_definition_id\": 1,\n    \"action_payload\": {\n      \"method\": \"communications.bases.scoring\",\n      \"params\": { \"...\": \"параметры скоринга\" }\n    }\n  },\n  {\n    \"action_definition_id\": 2,\n    \"action_payload\": {\n      \"method\": \"communications.bases.segmentation\",\n      \"params\": { \"...\": \"параметры сегментации\" }\n    }\n  }\n]\n\n

В ответе действия получат sequence_order: 1 и sequence_order: 2, а второе действие — parent_id, ссылающийся на первое.

Просмотр и фильтрация триггеров

Задача: найти триггеры по проекту, статусу или типу.

Метод: communications.triggers.rules.list

{\n  \"jsonrpc\": \"2.0\",\n  \"method\": \"communications.triggers.rules.list\",\n  \"params\": {\n    \"project_id\": 937,\n    \"limit\": 100,\n    \"offset\": 0,\n    \"filter\": {\n      \"status\": \"active\"\n    }\n  },\n  \"id\": 1\n}\n\n

Метод: communications.triggers.rules.get — для получения одного триггера по id:

{\n  \"jsonrpc\": \"2.0\",\n  \"method\": \"communications.triggers.rules.get\",\n  \"params\": {\n    \"id\": 63\n  },\n  \"id\": 1\n}\n\n

Изменение или архивирование триггера

Задача: обновить расписание, действия, лимиты или перевести триггер в архив.

Метод: communications.triggers.rules.update

Обновление расписания:

{\n  \"jsonrpc\": \"2.0\",\n  \"method\": \"communications.triggers.rules.update\",\n  \"params\": {\n    \"id\": 63,\n    \"types\": [\"iterations\"],\n    \"config\": {\n      \"cron_expression\": \"0 12 * * 1-5\",\n      \"timezone\": \"Europe/Moscow\"\n    }\n  },\n  \"id\": 1\n}\n\n

\n
-- При изменении types необходимо также передать соответствующий новый config.
-- При передаче расписания (scheduled_time, days_of_week + at_time, cron_expression) обязательно указать timezone.
\n

Архивирование триггера:

{\n  \"jsonrpc\": \"2.0\",\n  \"method\": \"communications.triggers.rules.update\",\n  \"params\": {\n    \"id\": 63,\n    \"is_archived\": true\n  },\n  \"id\": 1\n}\n\n

Разархивирование триггера:

{\n  \"jsonrpc\": \"2.0\",\n  \"method\": \"communications.triggers.rules.update\",\n  \"params\": {\n    \"id\": 63,\n    \"is_archived\": false\n  },\n  \"id\": 1\n}\n\n

\n
-- Параметр is_archived можно передавать как отдельно, так и вместе с другими полями обновления.
-- Архивированный триггер не удаляется — он перестаёт обрабатываться системой, но остаётся доступным для просмотра и повторной активации.
\n

Когда передавать `timezone`

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Конфигурация	`timezone` нужен?	Пример
`scheduled_time`	Да, обязательно	`\"timezone\": \"Europe/Moscow\"`
`interval_delta`	Нет, не передаётся	—
`days_of_week` + `at_time`	Да, обязательно	`\"timezone\": \"Europe/Moscow\"`
`cron_expression`	Да, обязательно	`\"timezone\": \"Europe/Moscow\"`
Только `limit_target_count`	Нет, не передаётся	—

\n
-- Формат timezone — строка IANA из справочника таймзон, например: \"Europe/Moscow\", \"America/New_York\", \"Asia/Tokyo\".
-- Недопустимы значения вида: \"UTC+3\", \"MSK\" и т.п.
\n

\n","_postman_id":"a167c7bd-be09-4960-9559-d60d2cb6f792"},{"name":"Материалы","item":[],"id":"7d46c9ef-0918-4191-87de-962988e42274","description":"

Материалы используются в голосовых рассылках, IVR-сценариях и DMP.

Последовательность

Проект:
#projects.create → #projects.my
\n
Создание материала:
#communications.materials.create
Тип материала указывается в параметре type, содержимое — в параметре data.
\n
Проверка статуса модерации:
#communications.materials.get → #communications.materials.list
\n
Обновление материала:
#communications.materials.update
\n
Поиск материала по имени:
#communications.materials.suggest
\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

МЕТОД	ОПИСАНИЕ
`#communications.materials.create`	Метод позволяет создать новый материал для использования его с DMP или голосовыми рассылками.
`#communications.materials.get`	Метод позволяет получить информацию о выбранном материале для указанного проекта.
`#communications.materials.list`	Метод позволяет получить список материалов для указанного проекта.
`#communications.materials.suggest`	Метод позволяет получить список материалов для указанного проекта по текстовому запросу названия материала, в ответе возвращается наименование и ID материала.
`#communications.materials.update`	Метод позволяет обновить данные выбранного материала для указанного проекта.

","_postman_id":"7d46c9ef-0918-4191-87de-962988e42274"},{"name":"Работа с телефонными номерами","item":[],"id":"44b296f0-490e-48d1-9b28-d6ad6be3f2a0","description":"

Для совершения исходящих звонков в голосовых рассылках используются арендованные телефонные номера.

Последовательность

Поиск доступных номеров:
#phones.stock
Фильтрация по оператору, региону, префиксу, типу номера и этикетке.
\n
Аренда номеров:
#phones.rent
\n
Просмотр арендованных номеров:
#phones.my → #phones.get → #phones.suggest
\n
Возврат номеров из аренды:
#phones.release
\n

Использование в рассылках

Арендованные номера передаются в параметр phones методов:

#communications.mailings.create
\n
#communications.mailings.update
\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

МЕТОД	ОПИСАНИЕ
`#phones.get`	Метод позволяет получить информацию об арендованном телефонном номере.
`#phones.my`	Метод позволяет получить список телефонных номеров, которые принадлежат текущему пользователю.
`#phones.release`	Метод позволяет вернуть телефонные номера, ранее взятые в аренду.
`#phones.rent`	Метод позволяет арендовать один или несколько телефонных номеров.
`#phones.stock`	Метод позволяет получить список доступных для аренды телефонных номеров с возможностью фильтрации.
`#phones.suggest`	Метод позволяет клиенту осуществить поиск по арендованным номерам телефонов.

","_postman_id":"44b296f0-490e-48d1-9b28-d6ad6be3f2a0"},{"name":"Работа с пулами номеров (каруселями)","item":[],"id":"0422149e-744d-4078-ba9b-24b578234857","description":"

Пулы номеров (карусели) — это наборы телефонных номеров, которые можно использовать для исходящих вызовов в голосовых рассылках communications.mailings. При использовании карусели система распределяет исходящие вызовы по номерам пула: приоритет отдаётся совпадению оператора абонента и номера; если совпадения нет — выбирается номер с наименьшим количеством ранее сделанных вызовов.

Типы пулов:

user — пользовательский пул, создаётся из арендованных номеров.
\n
global — системный пул номеров, доступный для аренды.
\n
callback — служебный системный пул для повторных вызовов, в аренде отсутствует; используется в настройках recall.use_system_carusel голосовой рассылки.
\n

Последовательность

Проект
#projects.create → #projects.my
\n
Аренда номеров для пользовательской карусели
#phones.stock → #phones.rent
\n
Создание пользовательской карусели
#carousel.create
Указывается type: \"user\" и список арендованных номеров в phones.
В result возвращается ID созданной карусели.
\n
Управление номерами внутри карусели
#carousel.phones.list
#carousel.phones.add
#carousel.phones.remove
\n
Просмотр и обновление
#carousel.get → #carousel.list → #carousel.suggest
#carousel.update — изменение имени и/или статуса active / archived.
\n
Системные карусели type: \"global\"
#carousel.stock → #carousel.rent → #carousel.my → #carousel.release
\n
Использование в голосовой рассылке
В #communications.mailings.create или #communications.mailings.update передать:
\n
- \"use_carousel\": true
  \n
- \"carousel_id\": 0
  \n
\n
Параметр carousel_id взаимоисключающий с phones.
\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

МЕТОД	ОПИСАНИЕ
`#carousel.create`	Метод позволяет создать пользовательский пул номеров (карусель) для совершения исходящих вызовов в голосовых рассылках `communications.mailings`.
`#carousel.get`	Метод позволяет получить информацию о пуле номеров по его идентификатору.
`#carousel.list`	Метод позволяет получить список пулов номеров (каруселей) с различными параметрами фильтрации.
`#carousel.phones.list`	Метод позволяет получить детализированный список номеров по идентификатору пула номеров (карусели) с различными параметрами фильтрации.
`#carousel.phones.add`	Метод позволяет добавить телефонные номера в существующий пул номеров (карусель).
`#carousel.phones.remove`	Метод позволяет исключить телефонные номера из существующего пула номеров (карусели).
`#carousel.update`	Метод позволяет обновить статус и/или наименование пользовательского пула номеров (карусели) по идентификатору.
`#carousel.suggest`	Метод позволяет пользователю осуществить поиск по статусу пулов номеров телефонов (каруселей).
`#carousel.stock`	Метод позволяет получить список системных `\"type\": \"global\"` пулов номеров (каруселей) доступных в аренду.
`#carousel.rent`	Метод позволяет арендовать один или несколько системных `\"type\": \"global\"` пулов телефонных номеров (каруселей).
`#carousel.my`	Метод позволяет получить список системных `\"type\": \"global\"` пулов номеров (каруселей) арендованных пользователем.
`#carousel.release`	Метод позволяет вернуть один или несколько системных `\"type\": \"global\"` пулов телефонных номеров (каруселей), ранее взятых в аренду.

","_postman_id":"0422149e-744d-4078-ba9b-24b578234857"},{"name":"Работа с голосовым меню (IVR)","item":[],"id":"6902bbc2-ad43-4922-8f33-901b29316b13","description":"

IVR-меню — сценарий голосового взаимодействия: воспроизведение материалов, распознавание DTMF и речи, перевод на ветки сценария, сбор лидов, добавление в черные списки и сегменты.

Последовательность

Проект:
#projects.create → #projects.my
\n
Подготовка материалов:
#communications.materials.create
Для воспроизведения используются audio, tts_template; для SMS — short_message_template.
\n
Создание IVR:
#communications.ivr.create
Указываются project_id, name, ivr_type, nodes.
В result возвращается ID IVR-меню.
\n
Просмотр:
#communications.ivr.get → #communications.ivr.list → #communications.ivr.suggest
\n
Обновление:
#communications.ivr.update
\n
Статистика прохождения по шагам:
#communications.ivr.log
\n

Важно

step_id в actions и filters должен последовательно увеличиваться на +1.
\n
Материалы, используемые в узлах, должны быть созданы заранее и иметь статус active.
\n
Для рассылки с incoming_mailing: true обязательно наличие действия add_to_segment.
\n
ID созданного IVR передается в параметр ivr метода #communications.mailings.create.
\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

МЕТОД	ОПИСАНИЕ
`#communications.ivr.create`	Метод позволяет создать новое IVR-меню (интерактивное голосовое меню) для указанного проекта.
`#communications.ivr.get`	Метод позволяет получить информацию о выбранном IVR-меню (интерактивное голосовое меню) для указанного проекта, включая его узлы (шаги), настройки и связанные данные.
`#communications.ivr.list`	Метод позволяет получить список IVR-меню (интерактивных голосовых меню) для указанного проекта.
`#communications.ivr.suggest`	Метод позволяет получить список IVR-меню (интерактивных голосовых меню) с возможностью фильтрации по различным параметрам.
`#communications.ivr.update`	Метод позволяет обновить данные выбранного IVR-меню (интерактивное голосовое меню).
`#communications.ivr.log`	Метод позволяет получить статистику прохождения звонков по шагам (узлам) IVR-меню.

","_postman_id":"6902bbc2-ad43-4922-8f33-901b29316b13"},{"name":"Работа с голосовыми рассылками","item":[],"id":"bfe6aa59-3419-487c-b0e1-94c999135edf","description":"

Голосовые рассылки — автоматизированный обзвон аудитории по сценарию IVR с воспроизведением аудио/TTS-роликов, распознаванием действий абонента (DTMF/голос), сбором лидов и фильтрацией по черным спискам.

Последовательность подготовки голосовой рассылки

Проект:
#projects.create → #projects.my
\n
Аудитория для обзвона:
#communications.bases.create → #communications.bases.contacts.add
\n
Черный список (опциональный шаг):
#communications.blacklists.create → #communications.blacklists.contacts.add
Черный список может быть пустым. В связке с IVR фильтрует номера до обзвона и накапливает контакты, помеченные как ЧС по сценарию IVR.
\n
Материалы:
#communications.materials.create
Типы: audio (аудиоролик), tts_template (TTS-ролик), short_message_template (SMS, если действие настроено в IVR).
Для материалов с модерацией дождаться статуса active.
\n
IVR-сценарий:
#communications.ivr.create
Сценарий содержит узлы с действиями и фильтрами, связывается с материалами.
\n
Номера для обзвона:
#phones.stock → #phones.rent
Арендованные номера передаются в рассылку через параметр phones.
\n
Создание рассылки:
#communications.mailings.create
Указываются сегменты, черные списки, номера, материалы, лимиты, скорость, расписание, оптимизатор и прочие параметры.
\n
Управление и мониторинг:
-- Запуск рассылки:
#communications.mailings.start → #communications.mailings.get (#communications.mailings.list для получения списка и состояния рассылок по идентификатору проекта) → #communications.mailings.stats → #communications.mailings.details
\n
-- Управление ходом выполнения рассылки:
#communications.mailings.start -> #communications.mailings.pause -> #communications.mailings.stop -> #communications.mailings.restart
\n
Экспорт результатов рассылки:
#communications.mailings.export или #communications.mailings.download
\n

Минимальный набор для создания голосовой рассылки

Номера из аренды (#phones.rent)
\n
Материал для воспроизведения (audio или tts_template)
\n
IVR-сценарий (#communications.ivr.create)
\n
Сегмент с номерами для обзвона (#communications.bases.create)
\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

МЕТОД	ОПИСАНИЕ
`#communications.mailings.create`	Метод позволяет создать новую голосовую рассылку с настройками сегментов (аудитории), лимитов, расписания и повторных попыток дозвона, и прочими параметрами.
`#communications.mailings.get`	Метод позволяет получить детальную информацию о выбранной голосовой рассылке, включая статистику, настройки и параметры.
`#communications.mailings.list`	Метод позволяет получить список рассылок в рамках указанного проекта с возможностью фильтрации по различным параметрам.
`#communications.mailings.details`	Метод позволяет получить детальную информацию о звонках в рамках рассылки с возможностью фильтрации по различным параметрам.
`#communications.mailings.start`	Метод позволяет запустить выполнение голосовой рассылки.
`#communications.mailings.pause`	Метод позволяет приостановить ход выполнения выбранной рассылки. После успешного выполнения метода рассылка переходит в состояние \"paused\" (приостановлена).
`#communications.mailings.restart`	Метод позволяет перезапустить ранее остановленную или завершенную рассылку.
`#communications.mailings.stop`	Метод позволяет остановить выполнение выбранной голосовой рассылки.
`#communications.mailings.block`	Метод возвращает список звонков заблокированных по некорректно указанному параметру часового пояса при пользовании в рассылках планировщика звонков.
`#communications.mailings.stats`	Метод позволяет получить статистику по выбранной голосовой рассылке. Статистика включает общее количество звонков, лидов, черных списков, автоответчиков и другие метрики.
`#communications.mailings.export`	Метод позволяет экспортировать данные о звонках в рамках указанной рассылки, Можно выбрать формат экспорта: `.csv` или `.xlsx` (Excel).
`#communications.mailings.download`	Метод позволяет получить ссылку для скачивания файла с детальной информацией о звонках в рамках указанной рассылки в формате `.csv` или `.xlsx` (Excel).
`#communications.mailings.export_stream`	Метод позволяет экспортировать данные о звонках в рамках указанной рассылки в формат `.csv` В ответе возвращается `text/csv`: кодировка `UTF-8`, разделитель полей `точка с запятой`.

","_postman_id":"bfe6aa59-3419-487c-b0e1-94c999135edf"},{"name":"Работа со звонками","item":[],"id":"e48c090f-248b-4967-9faf-c36c20a7c644","description":"

Звонки — это единичные исходящие вызовы, создаваемые через API. В отличие от голосовых рассылок, звонок совершается на один номер и может быть использован для точечных коммуникаций, интеграции с внешними системами через вебхуки и сбора данных по конкретному контакту.

Последовательность работы с звонками

Проект:
#projects.create → #projects.my
(если нет готового проекта)
\n
Подготовка IVR-сценария и материалов (если ещё не созданы):
#communications.ivr.create
#communications.materials.create
\n
Аренда телефонного номера (если ещё не арендован):
#phones.stock → #phones.rent
\n
Создание звонка:
#communications.dialings.create
Указываются:
-- номер абонента (phone);
-- идентификатор IVR-сценария (ivr);
-- номер, с которого будет совершён звонок (from);
-- параметры дозвона и управления вызовом (response_timeout, action_timeout, record, amd и др.).
\n
В ответе возвращается ID созданного звонка.
\n
Просмотр и мониторинг:
\n
- #communications.dialings.get — детальная информация по конкретному звонку;
  \n
- #communications.dialings.list — список звонков с фильтрацией по проекту, статусу, направлению, дате и другим параметрам.
  \n
\n
Статистика:
#communications.dialings.stats — агрегированные данные по звонкам проекта (количество успешных, неуспешных, лидов, автоответчиков и т.д.).
\n
Получение аудиозаписи (если включена):
#communications.dialings.records — возвращает аудиофайл в формате .wav по ID звонка.
\n
Экспорт данных: #communications.dialings.download или #communications.dialings.export
\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

МЕТОД	ОПИСАНИЕ
`#communications.dialings.create`	Метод позволяет создать исходящий звонок с настройками дозвона, вебхуков и кастомизации.
`#communications.dialings.get`	Метод позволяет получить информацию о конкретном звонке по его уникальному идентификатору и ID проекта. Результат включает детали звонка, такие как статус, направление, дата создания, длительность, запись разговора и дополнительные метаданные.
`#communications.dialings.list`	Метод позволяет получить список звонков с фильтрацией по различным параметрам.
`#communications.dialings.stats`	Метод позволяет получить статистику по звонкам внутри проекта с фильтрацией по различным параметрам.
`#communications.dialings.records`	Метод позволяет получить данные аудиозаписи совершенного звонка по его уникальному идентификатору ID.
`#communications.dialings.download`	Метод позволяет получить ссылку для скачивания файла с детальной информацией о звонках по идентификатору проекта c с возможностью указания идентификатора голосовой рассылки. Для скачивания доступны отчеты в формате `.csv` или `.xlsx`
`#communications.dialings.export`	Метод позволяет экспортировать результаты обзвона по идентификатору проекта в файл с возможностью фильтрации: по типу звонков, идентификатору рассылки, списку звонков и прочим параметрам. Для экспорта доступны отчеты в формате `.csv` или `.xlsx`. В ответе возвращается `Content-Type` с `application/octet-stream` или `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet` в зависимости от выбраного формата экспорта.
`#communications.dialings.export_stream`	Экспорт результатов обзвона по индентификатору проекта с различными параметрами фильтрации. В ответе возвращается `text/csv`: кодировка `UTF-8`, разделитель полей `точка с запятой`.

","_postman_id":"e48c090f-248b-4967-9faf-c36c20a7c644"},{"name":"Работа с трекером","item":[],"id":"c5ce8da6-95fb-4bc4-afc5-894710c5590e","description":"

Трекер используется для отслеживания переходов по ссылкам из SMS-сообщений, отправляемых в ходе голосовых рассылок или звонков. Трекер позволяет анализировать эффективность коммуникаций, фиксируя факты переходов по ссылкам и связывая их с конкретными контактами.

Последовательность работы с трекером

Проект:
#projects.create → #projects.my
(если нет готового проекта)
\n
Создание трекера:
#communications.tracker.create – задаётся имя и целевой URL. В ответе возвращается ID трекера.
\n
Подготовка SMS-материала:
#communications.materials.create с типом short_message_template.
В тексте сообщения используется плейсхолдер {{tracker:ID}}, где ID – идентификатор созданного трекера. Пример: \"text\": \"Текст сообщения, подробности по ссылке: {{tracker:89}}\"
\n
Создание IVR-сценария:
#communications.ivr.create – необходимо добавить действие message (отправка SMS) с созданным материалом. В IVR-сценарии это действие нужно выполнить после нажатия абонентом определённой кнопки (DTMF) или после распознавания голоса.
\n
Создание голосовой рассылки или звонка:
\n
- Для рассылки: #communications.mailings.create с указанием созданного IVR.
  \n
- Для звонка: #communications.dialings.create с указанием IVR.
  \n
\n
Запуск рассылки/звонка:
#communications.mailings.start или выполнение звонка.
\n
Отправка SMS:
Когда в ходе IVR-сценария выполняется действие message, система отправляет SMS на номер абонента. В SMS плейсхолдер заменяется на сгенерированную ссылку, которая ведёт на целевой URL с добавленными параметрами отслеживания.
\n
Отслеживание переходов:
При переходе по ссылке фиксируется событие в логах трекера. Для просмотра статистики и логов используются методы:
\n
- #communications.tracker.log.stats – общая статистика по трекеру.
  \n
- #communications.tracker.log.list – список переходов с фильтрацией.
  \n
- #communications.tracker.log.get – детальная информация о конкретном переходе.
  \n
\n
Управление трекером:
\n
- #communications.tracker.get – просмотр настроек трекера.
  \n
- #communications.tracker.list – список трекеров проекта.
  \n
- #communications.tracker.update – обновление настроек трекера.
  \n
\n

Генерация персонализированной ссылки

Метод #communications.tracker.generate позволяет получить персонализированную ссылку для конкретного номера телефона.

Пример использования

Создаем трекер методом #communications.tracker.create → получаем ID трекера, например 89
\n
Создаем материал методом #communications.materials.create с \"type\":\"short_message_template\" + \"data\":{\"text\": \"Текст сообщения, подробности по ссылке: {{tracker:89}}\"} → получаем ID материала 3242.
\n
Создаём IVR-сценарий, в котором на нажатие цифры 1 отправляется SMS (действие message с материалом 3242), в масcиве nodes[] передаем объекты:{\"filters\":[{\"type\":\"dtmf\",\"step_id\":5,\"settings\":{\"digit\":\"1\"}}]} и {\"actions\":[{\"type\":\"message\",\"step_id\":6,\"settings\":{\"materials\":[{\"id\":3242}]}}]
\n
Создаём голосовую рассылку с этим IVR и запускаем её.
\n
При ответе абонента и нажатии 1 ему приходит SMS с трекинговой ссылкой, которая ведёт на целевой URL.
\n
Переходы фиксируются в логах трекера, которые можно просмотреть через #communications.tracker.log.list.
\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

МЕТОД	ОПИСАНИЕ
`#communications.tracker.create`	Метод позволяет создать новый трекер для отслеживания переходов на целевую страницу из SMS-сообщений в рамках указанного проекта.
`#communications.tracker.generate`	Метод генерирует трекинговую ссылку для указанного трекера и номера телефона. Эта ссылка используется для отслеживания переходов пользователей.
`#communications.tracker.get`	Метод позволяет получить информацию о конкретном трекере, включая его настройки и статус.
`#communications.tracker.list`	Метод позволяет получить список трекеров, привязанных к указанному проекту.
`#communications.tracker.update`	Метод позволяет обновить настройки существующего трекера.
`#communications.tracker.log.stats`	Метод позволяет получить общую статистику по записям логов трекеров указанного проекта. Поддерживается фильтрация по ID трекера для вывода статистики по выбранному трекеру.
`#communications.tracker.log.get`	Метод позволяет получить информацию о конкретной записи лога трекера, связанного с указанным проектом.
`#communications.tracker.log.list`	Метод позволяет получить список записей логов трекеров для указанного проекта. Поддерживает фильтрацию по ID трекера, временному периоду, пагинацию и ограничение количества результатов.

","_postman_id":"c5ce8da6-95fb-4bc4-afc5-894710c5590e"},{"name":"Теги","item":[],"id":"87a6d26a-8a85-4b2f-b217-389056cbab0f","description":"

Теги позволяют получить дополнительные признаки контактов по телефонным номерам и email-адресам.

Таблица методов

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

МЕТОД	ОПИСАНИЕ
`#communications.tags.phone`	Проверка телефонных номеров и возврат связанных тегов.
`#communications.tags.email`	Проверка адресов электронной почты и возврат связанных тегов.
`#communications.bases.contacts.tags`	Список уникальных тегов контактов сегмента.

Использование

Для получения тегов по контактам сегмента используйте:

#communications.bases.contacts.tags

Для проверки отдельных контактов:

#communications.tags.phone
\n
#communications.tags.email
\n

\n","_postman_id":"87a6d26a-8a85-4b2f-b217-389056cbab0f"},{"name":"Пользователь","item":[{"name":"Информация о зарегистрированном пользователе","item":[],"id":"5dc0c4c9-eebf-4b75-b946-c2729edb87ed","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

МЕТОД ОПИСАНИЕ

#auth.login Метод позволяет выполнить вход в систему с использованием email и пароля.

#users.me Используется для получения информации о зарегистрированном пользователе.

Ответ включает:
-- Регистрационные данные пользователя,
-- Данные о закрепленном менеджере для сопровождения работы с платформой,
-- Данные о тарификации,
-- Данные о балансе учетной записи,
-- Прочие данные о пользователе в системе.

МЕТОД	ОПИСАНИЕ
`#auth.login`	Метод позволяет выполнить вход в систему с использованием email и пароля.
`#users.me`	Используется для получения информации о зарегистрированном пользователе. Ответ включает: -- Регистрационные данные пользователя, -- Данные о закрепленном менеджере для сопровождения работы с платформой, -- Данные о тарификации, -- Данные о балансе учетной записи, -- Прочие данные о пользователе в системе.

","_postman_id":"5dc0c4c9-eebf-4b75-b946-c2729edb87ed"},{"name":"Информация о транзакциях учетной записи пользователя","item":[],"id":"9a8951de-0e94-4f40-a926-5073b9b3871f","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n

МЕТОД	ОПИСАНИЕ
`#transactions.list`	Используется для получения информации о совершенных транзакциях пользователя. Ответ включает: -- Время совершения транзакций, -- Типы транзакций, -- Суммы транзакций, -- Комментарии к транзакциям.

","_postman_id":"9a8951de-0e94-4f40-a926-5073b9b3871f"}],"id":"887c246a-57d5-456c-b42d-48de04924835","description":"

Раздел содержит методы для получения информации о пользователе, авторизации и операциях по балансу.

\n","_postman_id":"887c246a-57d5-456c-b42d-48de04924835"}],"id":"a1bf3139-a049-419e-a6c2-4ca75cacd55a","description":"

Примеры использования методов API.

\n","_postman_id":"a1bf3139-a049-419e-a6c2-4ca75cacd55a"},{"name":"Methods","item":[{"name":"AUTH","item":[{"name":"#auth.login","id":"7bd82276-33ae-4d13-bcb6-0a6e5de9d690","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"jsonrpc\": \"\", // Версия протокола JSON-RPC\n \"method\": \"auth.login\", // Имя метода\n \"params\": {\n \"email\": \"\", // Email пользователя\n \"password\": \"\" // Пароль пользователя\n },\n \"id\": \"\" // Уникальный идентификатор запроса или null\n}","options":{"raw":{"language":"json"}}},"url":"https://api.botto.ru/","description":"

🟢 Публичный метод

Доступен для всех ролей пользователей.

Метод позволяет выполнить вход в систему с использованием email и пароля.

Параметры и поля запроса

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

ПАРАМЕТР	ТИП ДАННЫХ	ОПИСАНИЕ
`email`	`email` required	Зарегистрированный в системе email. Обязательные параметры: `email` Пример: `\"email\": \"user@example.com\"`
`password`	`string` required	Пароль, связанный с указанным email. Обязательные параметры: `password` Пример: `\"password\": \"xX_x0xX00x\"`

","urlObject":{"host":["https://api.botto.ru/"],"query":[],"variable":[]}},"response":[{"id":"942a8852-8c81-43cf-9953-6d96a16a074c","name":"Successful Response","originalRequest":{"method":"POST","header":[{"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\": \"auth.login\", // Имя метода\n \"params\": {\n \"email\": \"user@example.com\", // Email пользователя\n \"password\": \"x00Xx0x_Xx\" // Пароль пользователя\n },\n \"id\": 1 // Уникальный идентификатор запроса или null\n}","options":{"raw":{"language":"json"}}},"url":"https://api.botto.ru/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"token","value":"your_token_here","description":"","type":"text"},{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"result\": { // Объект с результатами\n \"settings\": { // Настройки пользователя\n \"email_verified\": false, // Флаг верификации email\n \"two_factor\": false, // Двухфакторная аутентификация отключена\n \"tariff_id\": 3, // ID тарифного плана\n \"manager_id\": 14, // Manager ID\n \"phone_verified\": false // Телефон не подтвержден\n },\n \"phone\": \"00000000001\", // Телефонный номер пользователя\n \"surname\": \"User_surname\", // Фамилия пользователя\n \"id\": 17, // Уникальный идентификатор пользователя\n \"email\": \"user@example.com\", // Email пользователя\n \"created\": 0, // Время создания аккаунта, UNIX timestamp\n \"language\": \"en\", // Язык интерфейса пользователя\n \"status\": \"active\", // Статус пользователя\n \"name\": \"User_name\", // Имя пользователя\n \"second_name\": \"User_second_name\", // Отчество пользователя\n \"avatar\": \"\", // Ссылка на аватар \n \"role\": \"client\" // Роль пользователя\n },\n \"jsonrpc\": \"2.0\", // Версия протокола JSON-RPC\n \"id\": 1 // Идентификатор запроса\n}"},{"id":"710d31cb-ab22-4dcc-8413-d40e05554483","name":"-32602 — Invalid Params : 'email is required'","originalRequest":{"method":"POST","header":[{"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\": \"auth.login\", // Имя метода\n \"params\": {\n \"password\": \"x00Xx0x_Xx\" // Пароль пользователя\n },\n \"id\": 1 // Уникальный идентификатор запроса или null\n}","options":{"raw":{"language":"json"}}},"url":"https://api.botto.ru/"},"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 \"data\": {\n \"field\": \"email\",\n \"type\": \"required\"\n },\n \"message\": \"email is required\"\n }\n}\n\n// Обязательный параметр 'email' не был передан."},{"id":"ce87ad49-688f-49a0-9d24-7aed0f913b75","name":"-32602 — Invalid Params : 'password is required'","originalRequest":{"method":"POST","header":[{"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\": \"auth.login\", // Имя метода\n \"params\": {\n \"email\": \"user@example.com\" // Email пользователя\n },\n \"id\": 1 // Уникальный идентификатор запроса или null\n}","options":{"raw":{"language":"json"}}},"url":"https://api.botto.ru/"},"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 \"data\": {\n \"field\": \"password\",\n \"type\": \"required\"\n },\n \"message\": \"password is required\"\n }\n}\n\n// Обязательный параметр 'password' не был передан."},{"id":"eeb0bead-8b69-4edd-bce9-229b6b09b4be","name":"-32602 — Invalid Params : 'password must be string'","originalRequest":{"method":"POST","header":[{"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\": \"auth.login\", // Имя метода\n \"params\": {\n \"email\": \"user@example.com\", // Email пользователя\n \"password\": 12345 // Пароль пользователя\n },\n \"id\": 1 // Уникальный идентификатор запроса или null\n}","options":{"raw":{"language":"json"}}},"url":"https://api.botto.ru/"},"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 \"data\": {\n \"type\": \"string\",\n \"field\": \"password\"\n },\n \"message\": \"password must be string\"\n }\n}\n\n// Значение параметра 'password' должно быть строкой."},{"id":"9b637493-e317-443e-9c76-3e9a45539d93","name":"-32602 — Invalid Params : 'email must be email'","originalRequest":{"method":"POST","header":[{"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\": \"auth.login\", // Имя метода\n \"params\": {\n \"email\": \"user\", // Email пользователя\n \"password\": \"x00Xx0x_Xx\" // Пароль пользователя\n },\n \"id\": 1 // Уникальный идентификатор запроса или null\n}","options":{"raw":{"language":"json"}}},"url":"https://api.botto.ru/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"data\": {\n \"field\": \"email\",\n \"type\": \"email\"\n },\n \"message\": \"email must be email\",\n \"code\": -32602\n }\n}\n\n// Значение параметра 'email' должно быть email."},{"id":"aec58436-921a-4c1b-ac8a-ab98d8529e92","name":"-32000 — Server Error: 'Internal Server Error'","originalRequest":{"method":"POST","header":[{"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\": \"auth.login\", // Имя метода\n \"params\": {\n \"email\": \"user@example.com\", // Email пользователя\n \"password\": \"x00Xx0x_Xx\" // Пароль пользователя\n },\n \"id\": 1 // Уникальный идентификатор запроса или null\n}","options":{"raw":{"language":"json"}}},"url":"https://api.botto.ru/"},"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// Произошла непредвиденная ошибка на стороне сервера."}],"_postman_id":"7bd82276-33ae-4d13-bcb6-0a6e5de9d690"}],"id":"436523fa-eb0a-4c84-aae1-a7a5389aeb67","_postman_id":"436523fa-eb0a-4c84-aae1-a7a5389aeb67","description":""},{"name":"PROJECTS","item":[{"name":"#projects.create","id":"261ceb73-c0f4-4911-90e6-45e020ef6971","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Token","value":"your_token_here","description":"

Token с вашим персональным ключом доступа

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"jsonrpc\": \"\", // Версия протокола JSON-RPC\n \"method\": \"projects.create\", // Имя метода\n \"params\": {\n \"name\": \"\", // Название проекта\n \"description\": \"\", // Описание проекта\n \"applications\": \"enum[]\" // Приложения, связанные с проектом\n },\n \"id\": \"\" // Уникальный идентификатор запроса или null\n}","options":{"raw":{"language":"json"}}},"url":"https://api.botto.ru/","description":"

🟠 Защищенный метод

Доступен для ролей super-admin, client.

Метод позволяет создать новый проект.

Параметры и поля запроса

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

ПАРАМЕТР	ТИП ДАННЫХ	ОПИСАНИЕ
`name`	`string` required	Название создаваемого проекта. Обязательные параметры: `name` Пример: `\"name\": \"anyname\"`
`description`	`string` optional	Описание создаваемого проекта. Необязательные параметры: `description` Пример: `\"description\": \"anydescription\"`
`applications`	`enum[]` optional `[` `communications,` `broker,` `leads` `]`	Массив приложений, которые будут связаны с проектом. Возможные значения: - `communications` : создание голосовых рассылок и работа с аудиториями. - `broker` : не используется. - `leads` : не используется. Необязательные параметры: `applications` Пример: `\"applications\": [\"communications\"]`

","urlObject":{"host":["https://api.botto.ru/"],"query":[],"variable":[]}},"response":[{"id":"9eae5d8e-4c77-4513-937f-0976afed49b5","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\": \"projects.create\", // Имя метода\n \"params\": {\n \"name\": \"anyname\", // Название проекта\n \"description\": \"anydescription\", // Описание проекта\n \"applications\": [ // Приложения, связанные с проектом\n \"communications\"\n ]\n },\n \"id\": 1 // Уникальный идентификатор запроса или null\n}","options":{"raw":{"language":"json"}}},"url":"https://api.botto.ru/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"result\": 15, // ID созданного проекта\n \"jsonrpc\": \"2.0\", // Версия протокола JSON-RPC\n \"id\": 1 // Идентификатор запроса\n}"},{"id":"842cb861-1959-4dc5-9076-914025a52063","name":"-32602 — Invalid Params : 'name is required'","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\": \"projects.create\", // Имя метода\n \"params\": {\n \"description\": \"anydescription\", // Описание проекта\n \"applications\": [ // Приложения, связанные с проектом\n \"communications\"\n ]\n },\n \"id\": 1 // Уникальный идентификатор запроса или null\n}","options":{"raw":{"language":"json"}}},"url":"https://api.botto.ru/"},"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\": \"name is required\",\n \"code\": -32602,\n \"data\": {\n \"field\": \"name\",\n \"type\": \"required\"\n }\n }\n}\n\n// Обязательный параметр 'name' не был передан."},{"id":"37dbd7a3-26bb-4aa1-9123-4551edc2e45e","name":"-32602 — Invalid Params : 'name must be string'","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\": \"projects.create\", // Имя метода\n \"params\": {\n \"name\": 12345, // Название проекта\n \"description\": \"anydescription\", // Описание проекта\n \"applications\": [ // Приложения, связанные с проектом\n \"communications\"\n ]\n },\n \"id\": 1 // Уникальный идентификатор запроса или null\n}","options":{"raw":{"language":"json"}}},"url":"https://api.botto.ru/"},"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\": \"name must be string\",\n \"code\": -32602,\n \"data\": {\n \"field\": \"name\",\n \"type\": \"string\"\n }\n }\n}\n\n// Переданное значение параметра 'name' не является строкой."},{"id":"f3600511-a705-4382-a7b1-89856d584c0e","name":"-32602 — Invalid Params : 'applications must be enum[]'","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\": \"projects.create\", // Имя метода\n \"params\": {\n \"name\": \"anyname\", // Название проекта\n \"description\": \"anydescription\", // Описание проекта\n \"applications\": [ // Приложения, связанные с проектом\n \"other\"\n ]\n },\n \"id\": 1 // Уникальный идентификатор запроса или null\n}","options":{"raw":{"language":"json"}}},"url":"https://api.botto.ru/"},"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\": \"applications must be enum[]\",\n \"code\": -32602,\n \"data\": {\n \"field\": \"applications\",\n \"type\": {\n \"type\": \"enum[]\",\n \"options\": [\n \"communications\",\n \"broker\",\n \"leads\"\n ]\n }\n }\n }\n}\n\n// Переданное значение параметра 'applications' не соответствует схеме 'enum[]'."},{"id":"95c9c3c0-2ea5-4ccf-bc2c-c838ad88fac2","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\": \"projects.create\", // Имя метода\n \"params\": {\n \"name\": \"anyname\", // Название проекта\n \"description\": \"anydescription\", // Описание проекта\n \"applications\": [ // Приложения, связанные с проектом\n \"communications\"\n ]\n },\n \"id\": 1 // Уникальный идентификатор запроса или null\n}","options":{"raw":{"language":"json"}}},"url":"https://api.botto.ru/"},"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":"19e6d7b6-7897-4f6a-b3ac-aa0d479cad04","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\": \"projects.create\", // Имя метода\n \"params\": {\n \"name\": \"anyname\", // Название проекта\n \"description\": \"anydescription\", // Описание проекта\n \"applications\": [ // Приложения, связанные с проектом\n \"communications\"\n ]\n },\n \"id\": 1 // Уникальный идентификатор запроса или null\n}","options":{"raw":{"language":"json"}}},"url":"https://api.botto.ru/"},"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 \"super-admin\",\n \"client\"\n ]\n },\n \"message\": \"Access is denied for the role 'role'\"\n }\n}\n\n// У пользователя нет прав на выполнение операции."}],"_postman_id":"261ceb73-c0f4-4911-90e6-45e020ef6971"},{"name":"#projects.my","id":"1908f58c-0363-4a12-b8a1-365ffb6fcda4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Token","value":"your_token_here","description":"

Token с вашим персональным ключом доступа

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"jsonrpc\": \"\", // Версия протокола JSON-RPC\n \"method\": \"projects.my\", // Имя метода\n \"params\": {\n \"filter\": \"

ПАРАМЕТР	ТИП ДАННЫХ	ОПИСАНИЕ
`filter`	`object` optional	Объект с параметрами для фильтрации. Содержит поля: - `name` (string): Значение для поиска по полному наименованию проекта. Поиск регистрозависимый. Необязательные параметры: `filter` Пример: Смотрите ниже.
`status`	`enum` optional `[` `active,` `archived` `]`	Статус проектов, возможные значения: - `active` : активные проекты, - `archived` : архивированные проекты. Необязательные параметры: `status` Пример: `\"status\": \"active\"`
`offset`	`int` optional	Количество записей, которые нужно пропустить при выборке — отсчет ведется с '`1`'. При передаче значения '`0`' результат в ответе будет возвращен с первого элемента без пропуска записей. Необязательные параметры: `offset` Пример: `\"offset\": 25`
`limit`	`int` optional	Максимальное количество записей, которые нужно вернуть в ответе. Необязательные параметры: `limit` Пример: `\"limit\": 25`

ПАРАМЕТР	ТИП ДАННЫХ	ОПИСАНИЕ
`gw`	`int` optional	Идентификатор SIP-транка. Необязательные параметры: `gw` Пример: `\"gw\": 7`
`operator`	`int` optional	Идентификатор оператора. Необязательные параметры: `operator` Пример: `\"operator\": 3`
`offset`	`int` optional	Количество записей, которые нужно пропустить при выборке — отсчет ведется с '`1`'. При передаче значения '`0`' результат в ответе будет возвращен с первого элемента без пропуска записей. Необязательные параметры: `offset` Пример: `\"offset\": 25`
`limit`	`int` optional	Максимальное количество записей, которые нужно вернуть в ответе. Необязательные параметры: `limit` Пример: `\"limit\": 100`
`label`	`int` optional	Идентификатор этикетки отображаемой при исходящем вызове на принимабщее устройство клинета при совершении звонка. Необязательные параметры: `label` Пример: `\"label\": 1`
`is_system`	`boolean` optional	Флаг отметки системного номера. Необязательные параметры: `is_system` Пример: `\"is_system\": true`
`type`	`enum` optional `[` `mobile,` `landline` `]`	Тип номера. Возможные значения: -- `mobile` : мобильный -- `landline` : стационарный Необязательные параметры: `type` Пример: `\"type\": \"mobile\"`
`status`	`enum` optional `[` `rented,` `moderating` `]`	Статус номера. Возможные значения: -- `rented` : арендованный -- `moderating` : на модерации Необязательные параметры: `status` Пример: `\"status\": \"rented\"`

ПАРАМЕТР	ТИП ДАННЫХ	ОПИСАНИЕ
`operator`	`int[]` optional	Список ID операторов связи, к которым принадлежат номера, разделитель элементов списка `запятая`. Необязательные параметры: `operator` Пример: `\"operator\": [3, 5]`
`region`	`int` optional	ID региона, к которому относятся номера. Необязательные параметры: `region` Пример: `\"region\": 1`
`prefix`	`int` optional	Префикс номера. Необязательные параметры: `prefix` Пример: `\"prefix\": 000`
`offset`	`int` optional	Количество записей, которые нужно пропустить при выборке — отсчет ведется с '`1`'. При передаче значения '`0`' результат в ответе будет возвращен с первого элемента без пропуска записей. Необязательные параметры: `offset` Пример: `\"offset\": 25`
`limit`	`int` optional	Максимальное количество записей, которые нужно вернуть в ответе. Необязательные параметры: `limit` Пример: `\"limit\": 100`
`type`	`enum` optional `[` `mobile,` `landline` `]`	Тип номера. Возможные значения: -- `mobile` : мобильный -- `landline` : стационарный Необязательные параметры: `type` Пример: `\"type\": \"mobile\"`
`label`	`int` optional	Идентификатор этикетки отображаемой при исходящем вызове на принимабщее устройство клинета при совершении звонка. Необязательные параметры: `label` Пример: `\"label\": 1`

ПАРАМЕТР	ТИП ДАННЫХ	ОПИСАНИЕ
`q`	`string` optional	Поисковый запрос для поиска номеров, поиск осуществляется как по целому номеру так и по его части. Необязательные параметры: `q` Пример: `\"q\": \"4932\"`
`status`	`enum` optional `[` `active,` `archived` `]`	Статус телефонных номеров. Возможные значения: - `active` : активные номера. - `archived` : архивированные номера. Необязательные параметры: `status` Пример: `\"status\": \"active\"`
`offset`	`int` optional	Количество записей, которые нужно пропустить при выборке — отсчет ведется с '`1`'. При передаче значения '`0`' результат в ответе будет возвращен с первого элемента без пропуска записей. Необязательные параметры: `offset` Пример: `\"offset\": 25`
`limit`	`int` optional	Максимальное количество записей, которые нужно вернуть в ответе. Необязательные параметры: `limit` Пример: `\"limit\": 100`
`hide_unavailable`	`boolean` optional	Флаг для скрытия недоступных номеров. Необязательные параметры: `hide_unavailable` Пример: `\"hide_unavailable\": true`

ПАРАМЕТР	ТИП ДАННЫХ	ОПИСАНИЕ
`offset`	`int` optional	Количество записей, которые нужно пропустить при выборке — отсчет ведется с '`1`'. При передаче значения '`0`' результат в ответе будет возвращен с первого элемента без пропуска записей. Необязательные параметры: `offset` Пример: `\"offset\": 25`
`limit`	`int` optional	Максимальное количество записей, которые нужно вернуть в ответе. Необязательные параметры: `limit` Пример: `\"limit\": 100`
`status`	`enum` optional `[` `active,` `archived` `]`	Статус пула номеров (карусели). Доступные значения: - `active` : активный - `archived` : архивированный Необязательные параметры: `status` Пример: `\"status\": \"active\"`
`type`	`enum[]` required `[` `user,` `global,` `callback` `]`	Список типов каруселей. Доступные значения: - `user` : Пользовательский пул номеров - `global` : Системный пул номеров в аренду. - `callback` : Системный пул номеров (отсутствует в аренде), используется для повторных вызовов в настройках голосовой рассылки. Обязательные параметры: `type` Пример: `\"type\": [\"user\"]`

ПАРАМЕТР	ТИП ДАННЫХ	ОПИСАНИЕ
`id`	`int` required	Идентификатор проекта, который необходимо обновить. Обязательные параметры: `id` Пример: `\"id\": 15`
`status`	`enum` optional `[` `active,` `archived` `]`	Статус проекта, возможные значения: - `active` : активные проекты, - `archived` : архивированные проекты. Необязательные параметры: `status` Пример: `\"status\": \"active\"`
`name`	`string` optional	Новое название проекта. Необязательные параметры: `name` Пример: `\"name\": \"newprojectsname\"`
`applications`	`enum[]` optional `[` `communications,` `broker,` `bigdata` `]`	Массив приложений, которые будут связаны с проектом. Возможные значения: - `communications` : создание голосовых рассылок. - `broker` : не используется. - `bigdata` : не используется. Необязательные параметры: `applications` Пример: `\"applications\": [\"communications\"]`
`description`	`string` optional	Новое описание проекта. Необязательные параметры: `description` Пример: `\"description\": \"newdescription\"`

ПАРАМЕТР	ТИП ДАННЫХ	ОПИСАНИЕ
`name`	`string` required	Наименование создаваемого пула номеров (карусели). Обязательные параметры: `name` Пример: `\"name\": \"Carousel Name\"`
`type`	`enum` required `[` `user,` `global,` `callback` `]`	Тип карусели. Доступные значения: - `user` : Пользовательский пул номеров - `global` : Системный пул номеров в аренду. - `callback` : Служебный системный пул номеров (отсутствует в аренде), используется для повторных вызовов в настройках голосовой рассылки `communications.mailing.create` и определяется параметром `\"recall\": { \"tries\": 3, \"period\": 60, \"use_system_carusel\": true }`. Обязательные параметры: `type` Пример: `\"type\": \"user\"`
`phones`	`int[]` optional	Список арендованных пользователем номеров для создания пула номеров. Формат номера E.164 без ведущего плюса. Необязательные параметры: `phones` Пример: `\"phones\": [00000000001, 00000000002]`

ПАРАМЕТР	ТИП ДАННЫХ	ОПИСАНИЕ
`id`	int required	Идентификатор пула номеров (карусели). Обязательные параметры: `id` Пример: `\"id\": 25`
`offset`	`int` optional	Количество записей, которые нужно пропустить при выборке — отсчет ведется с '`1`'. При передаче значения '`0`' результат в ответе будет возвращен с первого элемента без пропуска записей. Необязательные параметры: `offset` Пример: `\"offset\": 25`
`limit`	`int` optional	Максимальное количество записей, которые нужно вернуть в ответе. Необязательные параметры: `limit` Пример: `\"limit\": 100`
`status`	`enum` optional `[` `active,` `used,` `backlog` `]`	Фильтр по статусам номеров в пуле. Доступные значения: - `active` : активные номера, используются для совершения вызовов - `used` : технический статус: номера, выведенные из `active` - `backlog` : технический статус: резерв доступных, но ещё не активных номеров Для пользовательской карусели номера всегда `active` Необязательные параметры: `status` Пример: `\"status\": \"active\"`
`gw`	`int` optional	Идентификатор SIP-транка. Необязательные параметры: `gw` Пример: `\"gw\": 1`
`operator`	`int` optional	ID оператора. Необязательные параметры: `operator` Пример: `\"operator\": 1`

ПАРАМЕТР	ТИП ДАННЫХ	ОПИСАНИЕ
`id`	`int` required	ID сегмента (аудитории) для добавления контактов. Обязательные параметры: `id` Пример: `\"id\": 851`
`project_id`	`int` required	ID проекта которому принадлежит выбранный сегмент (аудитория). Обязательные параметры: `project_id` Пример: `\"project_id\": 123`
`matching`	`object[]` optional	Сопоставление полей, может быть пустым массивом. Необязательные параметры: `matching` Пример: `\"matching\": []`
`file`	`string` optional	Поле для указания пути к загруженному файлу, значение должно быть получено в результате выполнения загрузки файла `POST /upload` Формат телефонных номеров E.164 без ведущего плюса. Необязательные параметры: `file` Пример: `\"file\": \"/upload/0/0/0/000x0xx0.csv\"`
`phone_column`	`int[]` optional	Индекс столбца с телефонными номерами. Необязательные параметры: `phone_column` Пример: `\"phone_column\": [1]`
`contacts`	`string` optional	Строка для передачи списка номеров телефонов, при передаче нескольких значений в качестве разделителя используется `\\n`. Формат телефонных номеров E.164 без ведущего плюса. Необязательные параметры: `contacts` Пример: `\"contacts\": \"00000000001\\n00000000002\"`
`remove_duplicates`	`boolean` optional	Флаг с отметкой для возможности удаления дубликатов. Удаление дубликатов осуществляется по телефонным номерам. Необязательные параметры: `remove_duplicates` Пример: `\"remove_duplicates\": true`

ПАРАМЕТР	ТИП ДАННЫХ	ОПИСАНИЕ
`id`	`int` required	ID сегмента (аудитории) для исключения (минусации) контактов. Обязательные параметры: `id` Пример: `\"id\": 851`
`project_id`	`int` required	ID проекта которому принадлежит выбранный сегмент (аудитория). Обязательные параметры: `project_id` Пример: `\"project_id\": 123`
`file`	`string` optional	Поле для указания пути к загруженному файлу, значение должно быть получено в результате выполнения загрузки файла `POST /upload` Формат телефонных номеров E.164 без ведущего плюса. Необязательные параметры: `file` Пример: `\"file\": \"/upload/0/0/0/000x0xx0.csv\"`
`contacts`	`string` optional	Строка для передачи списка номеров телефонов, при передаче нескольких значений в качестве разделителя используется `\\n`. Формат телефонных номеров E.164 без ведущего плюса. Необязательные параметры: `contacts` Пример: `\"contacts\": \"00000000001\\n00000000002\"`
`sids`	`string` optional	Строка для передачи списка внутренних ID каждого контакта внутри сегмента (аудитории) (segment_id), при передаче нескольких значений в качестве разделителя используется `\\n`. Необязательные параметры: `sids` Пример: `\"sids\": \"1234567\\n1234568\"`

ПАРАМЕТР	ТИП ДАННЫХ	ОПИСАНИЕ
`id`	`int` required	ID сегмента (аудитории). Обязательные параметры: `id` Пример: `\"id\": 851`
`project_id`	`int` required	ID проекта к которому принадлежит выбранный сегмент (аудитория). Обязательные параметры: `project_id` Пример: `\"project_id\": 123`
`offset`	`int` required	Количество записей, которые нужно пропустить при выборке — отсчет ведется с '`1`'. При передаче значения '`0`' результат в ответе будет возвращен с первого элемента без пропуска записей. Обязательные параметры: `offset` Пример: `\"offset\": 0`
`limit`	`int` required	Максимальное количество записей, которые нужно вернуть в ответе. Обязательные параметры: `limit` Пример: `\"limit\": 25`
`sort`	`object` optional	Объект с параметрами сортировки. Содержит поля: - `name` (enum) : наименование поля по которому производится сортировка: -- `timestamp` — время, -- `phone` — телефонный номер, -- `email` — Email, -- `wa` — WA, -- `tg` — TG, -- `viber` — Viber, не используется -- `type` — тип контактов определенный после создания сегмента (аудитории), -- `sid` — внутренний ID каждого контакта внутри сегмента (аудитории) (segment_id). - `direction`(enum) : направление сортировки: -- `ASC` — по возрастанию, -- `DESC` — по убыванию. Необязательные параметры: `sort` Пример: смотрите ниже
`filter`	`object` 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, -- `max` — MAX. - `country` (string): наименование страны. - `country_iso_code` (string): двухбуквенный Alpha-2-код по ISO 3166-1. - `phone_connectability` (object): диапазон для выборки по контактности номера полученное после скоринга, при передаче значений вне диапазона вернет либо значения соответствующие min-max, либо пустоту если значение переданное значение находится за пределами диапазона данных скоринга: -- `max` (int) — максимальное значение, -- `min` (int) — минимальное значение - `connectability_types` (enum[]): фильтр по типу оценки контактности телефонного номера, возможные значения: -- sms (string) — оценка контактности телефонного номера для отправки SMS-сообщений -- voice (string) — оценка контактности телефонного номера для голосового трафика -- messengers (string) — оценка контактности телефонного номера в мессенджерах - `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` Пример: смотрите ниже

ПАРАМЕТР	ТИП ДАННЫХ	ОПИСАНИЕ
`base_id`	`int` required	ID сегмента (аудитории). Обязательные параметры: `base_id` Пример: `\"base_id\": 851`
`project_id`	`int` required	ID проекта к которому принадлежит выбранный сегмент (аудитория). Обязательные параметры: `project_id` Пример: `\"project_id\": 123`

ПАРАМЕТР	ТИП ДАННЫХ	ОПИСАНИЕ
`project_id`	`int` required	Идентификатор проекта, которому принадлежит сегмент (аудитория). Обязательные параметры: `project_id` Пример: `\"project_id\": 8`
`id`	`int` required	Идентификатор сегмента (аудитории), для скачивания. Обязательные параметры: `id` Пример: `\"id\": 84`
`export_format`	`enum` optional `[` `csv,` `excel` `]`	Тип формата файла для скачивания данных сегмента (аудитории). Возможные значения: - `csv` — скачивание csv-файла. - `excel` — скачивание Excel-файла. Если не передать в запросе параметр `export_format` — по-умолчанию будет сформирован xlsx-файл. Необязательные параметры: `export_format` Пример: `\"export_format\": \"csv\"`

ПАРАМЕТР	ТИП ДАННЫХ	ОПИСАНИЕ
`project_id`	`int` required	ID проекта которому принадлежит сегмент (аудитория). Обязательные параметры: `project_id` Пример: `\"project_id\": 123`
`id`	`int` required	ID сегмента (аудитории) для экспорта. Обязательные параметры: `id` Пример: `\"id\": 851`
`filter`	`object` 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, -- `max` — MAX. - `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` Пример: смотрите ниже
`only_system_fields`	`boolean` optional	Флаг использования только системных полей для экспорта. Необязательные параметры: `only_system_fields` Пример: `\"only_system_fields\": true`
`export_format`	`enum` optional `[` `csv,` `excel` `]`	Тип формата файла для экпорта данных сегмента (аудитории). Возможные значения: - `csv` — экспорт в csv-файл - `excel` — экспот в Excel-файл . Если не передать в запросе параметр `export_format` — по-умолчанию будет сформирован xlsx-файл. Необязательные параметры: `export_format` Пример: `\"export_format\": \"csv\"`

ПАРАМЕТР	ТИП ДАННЫХ	ОПИСАНИЕ
`project_id`	`int` required	ID проекта, к которому будет прикреплена создаваемая база контактов (сегмент). Обязательные параметры: `project_id` Пример: `\"project_id\": 123`
`name`	`string` required	Название создаваемого сегмента (аудитории). Обязательные параметры: `name` Пример: `\"name\": \"any_name\"`
`email_column`	`int[]` optional	Индекс столбца с email адресами. Необязательные параметры: `email_column` Пример: `\"email_column\": [2]`
`file`	`string` optional	Поле для указания пути к загруженному файлу, значение должно быть получено в результате выполнения загрузки файла `POST /upload` Формат телефонных номеров E.164 без ведущего плюса. Необязательные параметры: `file` Пример: `\"file\": \"/upload/0/0/0/000x0xx0.csv\"`
`wa_column`	`int` optional	Индекс столбца с WA аккаунтами. Необязательные параметры: `wa_column` Пример: `\"wa_column\": 4`
`viber_column`	`int` optional	Индекс столбца с Viber аккаунтами. Не используется. Необязательные параметры: `viber_column` Пример: `\"viber_column\": 5`
`region_column`	`int` optional	Индекс столбца с наименованиями регионов. Необязательные параметры: `region_column` Пример: `\"region_column\": 6`
`operator_column`	`int` optional	Индекс столбца с наименованиями операторов связи. Необязательные параметры: `operator_column` Пример: `\"operator_column\": 7`
`phone_column`	`int[]` optional	Индекс столбца с телефонными номерами. Необязательные параметры: `phone_column` Пример: `\"phone_column\": [1]`
`matching`	`object[]` optional	Сопоставление полей, может быть пустым массивом. Необязательные параметры: `matching` Пример: `\"matching\": []`
`sep`	`string` optional	Указание на разделитель полей загружаемого файла. Примеры значений для указания различных разделителей: `\"sep\": \"semicolon\"` — \"точка с запятой\" `\"sep\": \"common\"` — \"запятая\" `\"sep\": \"whitespace\"` — \"пробел\" и знак \"табуляция\" `\"sep\": \"-\"` — свой вариант с указанием его в качестве значения, в данном примере используется символ \"дефис\". Необязательные параметры: `sep` Пример: `\"sep\": \"-\"`
`contacts`	`string` optional	Строка для передачи списка номеров телефонов, при передаче нескольких значений в качестве разделителя используется `\\n`. Формат телефонных номеров E.164 без ведущего плюса. Необязательные параметры: `contacts` Пример: `\"contacts\": \"00000000001\\n00000000002\"`
`country_column`	`int` optional	Индекс столбца с наименованиями стран. Необязательные параметры: `country_column` Пример: `\"country_column\": 8`
`tg_column`	`int` optional	Индекс столбца с TG аккаунтами. Необязательные параметры: `tg_column` Пример: `\"tg_column\": 3`
`geo_iso_code`	`string` optional	Указание гео к которому относятся контакты абонентов в сегменте, принимает двухбуквенный код alpha-2 ISO 3166. Важно: Если параметр указан, номера, не соответствующие указанной географии, будут отфильтрованы при загрузке. Если параметр опущен, будут приняты все валидные контакты независимо от их географии. Необязательные параметры: `geo_iso_code` Пример: `\"geo_iso_code\": \"XX\"`
`remove_duplicates`	`boolean` optional	Флаг с отметкой для возможности удаления дубликатов контактов после нормализации. Удаление дубликатов осуществляется по телефонным номерам и email. Необязательные параметры: `remove_duplicates` Пример: `\"remove_duplicates\": true`

ПАРАМЕТР	ТИП ДАННЫХ	ОПИСАНИЕ
`project_id`	`int` required	ID проекта к которому принадлежит сегмент (аудитория). Обязательные параметры: `project_id` Пример: `\"project_id\": 123`
`id`	`int` required	ID сегмента (аудитории) по которому нужно получить данные. Обязательные параметры: `id` Пример: `\"id\": 851`

ПАРАМЕТР	ТИП ДАННЫХ	ОПИСАНИЕ
`id`	`int` required	ID сегмента для обновления. Обязательные параметры: `id` Пример: `\"id\": 851`
`project_id`	`int` required	ID проекта которому принадлежит сегмент. Обязательные параметры: `project_id` Пример: `\"project_id\": 123`
`name`	`string` optional	Новое наименование сегмента. Необязательные параметры: `name` Пример: `\"name\": \"any_name_updated\"`
`status`	`enum` optional `[` `active,` `archived` `]`	Новый статус сегмента. Возможные значения: - `active` : активный. - `archived` : архивированный. Необязательные параметры: `status` Пример: `\"status\": \"active\"`

ПАРАМЕТР	ТИП ДАННЫХ	ОПИСАНИЕ
`base_id`	`int[]` required	Список ID сегментов (аудиторий) для преобразования в новый сегмент. Обязательные параметры: `base_id` Пример: `\"base_id\": [851]`
`project_id`	`int` required	ID проекта которому принадлежит(ат) выбранный(ые) сегмент(ы). Обязательные параметры: `project_id` Пример: `\"project_id\": 123`
`name`	`string` required	Наименование нового создаваемого сегмента после операции преобразования. Необязательные параметры: `name` Пример: `\"name\": \"any_name_segmented\"`
`contacts`	`string[]` optional	Список SID контактов (уникальные идентификаторы контактов внутри сегмента) для выборки в новый формируемый сегмент. При передаче нескольких значений в качестве разделителя используется запятая '`,`'. Список SID сегмента можно получить методом 'communications.bases.contacts.list' Необязательные параметры: `contacts` Пример: `\"contacts\": [\"123\", \"456\"]`
`filter`	`object` 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[]): выборка по типам мессенджеров, работает в связке с 'messengers_validity' и работает от значения активности (если `\"messengers_validity\": \"inactive\"` то фильтр по '`messengers`' вернет контакты у которых нет выбранного мессенджера): -- `telegram` — TG -- `whatsapp` — WA -- `viber` — Viber, не используется -- `facebook` — FB -- `instagram` — IG -- `max` — MAX - `country` (string): выборка по наименованию страны. - `country_iso_code` (string): выборка по двухбуквенному Alpha-2-коду по ISO 3166-1. - `phone_connectability` (object): указание диапазона для выборки по контактности номера полученное после скоринга, при передаче значений вернет либо значения соответствующие `min-max`, либо пустоту если переданное значение находится за пределами диапазона данных полученных после операции скоринга: -- `max` (int) — максимальное значение -- `min` (int)— минимальное значение - `connectability_types` (enum[]): фильтр для выборки по полученной ранее оценке типа контактности телефонного номера, возможные значения: -- `sms` (string) — контактность телефонного номера для отправки SMS-сообщений -- `voice` (string) — контактность телефонного номера для голосового трафика -- `messengers` (string) —контактность телефонного номера в мессенджерах. - `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` Пример: смотрите ниже

ПАРАМЕТР	ТИП ДАННЫХ	ОПИСАНИЕ
`project_id`	`int` required	Идентификатор проекта, к которому будет добавлен черный список. Обязательные параметры: `project_id` Пример: `\"project_id\": 8`
`name`	`string` required	Название черного списка. Обязательные параметры: `name` Пример: `\"name\": \"blacklistname\"`
`contacts`	`string` optional	Список номеров телефонов, для добавления в черный список. Каждый номер указывается на новой строке, разделенной переносом строки `\\n`, пробелы и другие разделители недопустимы. Необязательные параметры: `contacts` Пример: `\"contacts\": \"00000000001\\n00000000002\"`
`file`	`string` optional	Путь к загруженному файлу с контактами, для добавления в черный список, значение должно быть получено в результате выполнения загрузки файла `POST /upload` Необязательные параметры: `file` Пример: `\"file\": \"path/to/file\"`
`sep`	`string` optional	Указание на разделитель полей загружаемого файла. Примеры значений для указания различных разделителей: `\"sep\": \"semicolon\"` — \"точка с запятой\" `\"sep\": \"common\"` — \"запятая\" `\"sep\": \"whitespace\"` — \"пробел\" и знак \"табуляция\" `\"sep\": \"-\"` — свой вариант с указанием его в качестве значения, в данном примере используется символ \"дефис\". Необязательные параметры: `sep` Пример: `\"sep\": \"-\"`
`remove_duplicates`	`boolean` optional	Флаг с отметкой для возможности удаления дубликатов контактов. Необязательные параметры: `remove_duplicates` Пример: `\"remove_duplicates\": true`

ПАРАМЕТР	ТИП ДАННЫХ	ОПИСАНИЕ
`project_id`	`int` required	Идентификатор проекта, для которого необходимо получить список черных списков. Обязательные параметры: `project_id` Пример: `\"project_id\": 8`
`q`	`string` optional	Поисковый запрос для фильтрации черных списков по названию. Поиск регистронезависимый. Необязательные параметры: `q` Пример: `\"q\": \"some_blacklist_na\"`
`status`	`enum` optional `[` `active,` `archived` `]`	Фильтр по статусу черного списка, возможные значения: - `active` : активный черный список. - `archived` : архивированный черный список. Необязательные параметры: `status` Пример: `\"status\": \"active\"`
`offset`	`int` optional	Количество записей, которые нужно пропустить при выборке — отсчет ведется с '`1`'. При передаче значения '`0`' результат в ответе будет возвращен с первого элемента без пропуска записей. Необязательные параметры: `offset` Пример: `\"offset\": 10`
`limit`	`int` optional	Максимальное количество записей, которые нужно вернуть в ответе. Необязательные параметры: `limit` Пример: `\"limit\": 25`

ПАРАМЕТР	ТИП ДАННЫХ	ОПИСАНИЕ
`type`	`enum` required `[` `phones,` `domains,` `alpha_names,` `code` `]`	Тип записи DMP. Доступыне значения: -- `phones` : Телефонные номера -- `domains` : Домены -- `alpha_names` : Альфа-имена SMS -- `code` : Код пискселя DMP -- не используется Обязательные параметры: `type` Пример: `\"type\": \"`phones`\"`
`material_id`	`int` optional	ID материала, используется вместе с`\"source\": \"materials\"` Необязательные параметры: `material_id` Пример: `\"material_id\": 123`
`confirmation_file`	`string` optional	Файл подтверждения — в параметре необходимо указать путь к загруженному файлу, значение должно быть получено в результате выполнения загрузки файла `POST /upload` Используется вместе с `\"source\": \"file\"` Необязательные параметры: `confirmation_file` Пример: `\"confirmation_file\": \"path/to/file\"`
`target_segment_id`	`int` optional	ID целевого сегмента. Необязательные параметры: `target_segment_id` Пример: `\"target_segment_id\": 1234`
`blacklist_segment_id`	`int` optional	ID сегмента черного списка для исключения Необязательные параметры: `blacklist_segment_id` Пример: `\"target_segment_id\": 1235`
`items`	`string` optional	Cписок (номера/домены/альфа-имена). Используется вместе с `\"source\": \"list\"` при передаче списком телефонов, доменов, альфа-имён. Разделитель элементов списка символ переноса строки `\\n` Необязательные параметры: `items` Пример: `\"items\": \"item1\\nitem2\"`
`project_id`	`int` optional	ID проекта. Необязательные параметры: `items` Пример: `\"project_id\": 9`
`source`	`enum` optional `[` `materials,` `list,` `file` `]`	Указание источника данных для создаваемой DMP-записи. Используется для следующих типов: -- `\"type\": \"phones\"` -- `\"type\": \"domains\"` -- `\"type\": \"alpha_names\"` Необязательные параметры: `source` Пример: `\"source\": \"list\"`
`scheduler`	`enum` optional `[` `enabled,` `disabled` `]`	Флаг иcпользования планировщика. Доступные занчения: -- `enabled` : включен -- `disabled` : отключен Необязательные параметры: `scheduler` Пример: `\"scheduler\": \"disabled\"`
`working_dates`	`int[]` optional	Указание диапазона рабочих дат в формате UNIX timestamp. Используется с палнировщиком `\"scheduler\": \"enabled\"` Необязательные параметры: `working_dates` Пример: `\"working_dates\": [0,1]`
`excluded_dates`	`int[]` optional	Указание диапазона для исключения рабочих дат в формате UNIX timestamp. Используется с палнировщиком `\"scheduler\": \"enabled\"` Необязательные параметры: `excluded_dates` Пример: `\"excluded_dates\": [0,1]`
`working_weekdays`	`int[]` optional	Указание индексов диапазона рабочих дней недели. Используется с палнировщиком `\"scheduler\": \"enabled\"` Используем индексы для кодирования дней недели: -- `0` = воскресенье, -- `1` = понедельник, -- `2` = вторник, -- `3` = среда, -- `4` = четверг, -- `5` = пятница, -- `6` = суббота Необязательные параметры: `working_weekdays` Пример: `\"working_weekdays\": [0,1]`
`global_limit`	`int` optional	Общий лимит отправок. В поле параметра необходимо передать значение > `0`, значение `0` не допускается. Необязательные параметры: `global_limit` Пример: `\"global_limit\": 1`
`daily_limit`	`int` optional	Дневной лимит отправок. В поле параметра необходимо передать значение > `0`, значение `0` не допускается. Необязательные параметры: `daily_limit` Пример: `\"daily_limit\": 1`
`name`	`string` optional	Название DPM записи. Необязательные параметры: `name` Пример: `\"name\": \"any_DMP_name\"`
`coverage_regions`	`int[]` optional	ID регионов покрытия, по кодам субъектов PФ. Доступные значения и коды соответствия смотрите ниже. Необязательные параметры: `coverage_regions` Пример: `\"coverage_regions\": [1]`

ПАРАМЕТР	ТИП ДАННЫХ	ОПИСАНИЕ
`project_id`	`int` required	ID проекта. Обязательные параметры: `items` Пример: `\"project_id\": 9`
`id`	`int` required	ID DPM записи. Обязательные параметры: `items` Пример: `\"id\": 15`

ПАРАМЕТР	ТИП ДАННЫХ	ОПИСАНИЕ
`project_id`	`int` optional	ID проекта, которому принадлежат DMP записи. Необязательные параметры: `project_id` Пример: `\"project_id\": 9`
`offset`	`int` optional	Количество записей, которые нужно пропустить при выборке — отсчет ведется с '`1`'. При передаче значения '`0`' результат в ответе будет возвращен с первого элемента без пропуска записей. Необязательные параметры: `offset` Пример: `\"offset\": 10`
`limit`	`int` optional	Максимальное количество записей, которые нужно вернуть в ответе. Необязательные параметры: `limit` Пример: `\"limit\": 25`
`filter`	`object` optional	Объект для фильтрации DMP записей. Вложенные поля: -- `type` (enum): Тип записи. Значения: ---- `phones` ---- `domains` ---- `alpha_names` ---- `code -- не используется` -- `status` (enum[]): Массив статусов. Значения: ---- `active` ---- `paused` ---- `pending` -- не используется ---- `archived` -- `created.star`t (int): Начало диапазона UNIX-timestamp даты создания -- `created.end` (int): Конец диапазона UNIX-timestamp даты создания -- `q` (string): Поиск по `name`, `id`, `items` Необязательные параметры: `filter` Пример: смотрите ниже

ПАРАМЕТР	ТИП ДАННЫХ	ОПИСАНИЕ
`base_id`	`int` required	Идентификатор сегмента. Обязательные параметры: `base_id` Пример: `\"base_id\": 123`
`project_id`	`int` required	Идентификатор проекта. Обязательные параметры: `project_id` Пример: `\"project_id\": 9`
`name`	`string` required	Наименование триггера. Обязательные параметры: `name` Пример: `\"name\": \"any_trigger\"`
`types`	`enum[]` required `[` `scheduled,` `limits,` `iterations` `]`	Тип создаваемого триггера. Возможные значения: -- `scheduled`: планировщик, дата/время запуска триггера; -- `limits`: лимиты, количественное ограничение, при достижении которого должен произойти запуск триггера; -- `iterations`: итерации, повторяющееся событие. Важно: значения `scheduled` и `iterations` взаимоисключающие. Значение `limits` может использоваться отдельно либо совместно с `scheduled` или `iterations`. Обязательные параметры: `types` Пример: `\"types\": [\"scheduled\", \"limits\"]`
`actions`	`object[]` required	Список действий, которые выполняются при срабатывании триггера. Состав объекта описан ниже. Обязательные параметры: `actions` Пример: смотрите ниже
`config`	`object` optional	Конфигурация создаваемого триггера: планировщик, итерации, лимиты. Для передачи в объект доступны следующие поля : -- `\"scheduled_time\"` (string), -- `\"interval_delta\"` (int)`,` -- `\"days_of_week\"` (int[]), -- `\"at_time\"` (string), -- `\"cron_expression\":` (string), -- `\"limit_target_count\"` (int), -- `\"limit_step\"` (int), -- `\"timezone\"` (string) Состав объекта описан ниже. Необязательные параметры: `config` Пример: смотрите ниже

ПОЛЕ	ТИП ДАННЫХ	ОПИСАНИЕ
`action_definition_id`	`int`	Идентификатор системного действия из списка разрешенных действий. Список доступных действий можно получить методом `communications.triggers.action_definitions.list`.
`action_payload`	`object`	Параметры действия. Состав полей зависит от конкретного `action_definition_id`. Например, это может быть запуск скоринга сегмента.

Базовый URL, аутентификация, методы

Общие соглашения

Коды ошибок

Последовательность

Последовательность

Для работы с DMP доступно 4 типа DMP-записей:

Чтобы начать работу с DMP необходимо:

Последовательность вызова методов при типовом сценарии:

тип триггера → ожидаемый config

Подготовка действия перед созданием триггера

Примеры types/config при работе с различными триггерами

Однократный запуск действия по времени (scheduled)

Запуск действия при достижении лимита (limits)

Повторяющийся запуск (iterations)

Комбинированный запуск: расписание + лимит

Цепочка из нескольких действий

Просмотр и фильтрация триггеров

Изменение или архивирование триггера

Когда передавать timezone

Последовательность

Последовательность

Использование в рассылках

Последовательность

Последовательность

Важно

Последовательность подготовки голосовой рассылки

Минимальный набор для создания голосовой рассылки

Последовательность работы с звонками

Последовательность работы с трекером

Генерация персонализированной ссылки

Пример использования

Таблица методов

Использование

🟢 Публичный метод

Параметры и поля запроса

🟠 Защищенный метод

Параметры и поля запроса

🟠 Защищенный метод

Параметры и поля запроса

🟠 Защищенный метод

Параметры и поля запроса

🟠 Защищенный метод

Параметры и поля запроса

🟠 Защищенный метод

Параметры и поля запроса

🟠 Защищенный метод

Параметры и поля запроса

🟠 Защищенный метод

Параметры и поля запроса

🟠 Защищенный метод

Параметры и поля запроса

🟠 Защищенный метод

Параметры и поля запроса

🟠 Защищенный метод

Параметры и поля запроса

🟠 Защищенный метод

Параметры и поля запроса

🟠 Защищенный метод

Параметры и поля запроса

🟠 Защищенный метод

Параметры и поля запроса

🟠 Защищенный метод

Параметры и поля запроса

🟠 Защищенный метод

Параметры и поля запроса

🟠 Защищенный метод

Параметры и поля запроса

🟠 Защищенный метод

Параметры и поля запроса

🟠 Защищенный метод

Параметры и поля запроса

🟠 Защищенный метод

Параметры и поля запроса

🟠 Защищенный метод

Параметры и поля запроса

🟠 Защищенный метод

Параметры и поля запроса

🟠 Защищенный метод

Параметры и поля запроса

🟠 Защищенный метод

тип триггера → ожидаемый `config`

Примеры `types`/`config` при работе с различными триггерами

Однократный запуск действия по времени (`scheduled`)

Запуск действия при достижении лимита (`limits`)

Повторяющийся запуск (`iterations`)

Когда передавать `timezone`

Пример значения для `\"html_code\": \"string\"`

Доступные значения и коды соответствия для использования в параметре `\"coverage_regions\": int[]`

Пример передачи значений в параметр `\"filter\"`:

Пример значения для `\"html_code\": \"string\"` -- не используется

Доступные значения и коды соответствия для использования в параметре `\"coverage_regions\": int[]`

Объект `actions`

Объект `config`

Допустимые комбинации `types`

1. Пример заполнения `actions`

2. Примеры заполнения `config`

ПОЛЕ	ТИП ДАННЫХ	ОПИСАНИЕ
`scheduled_time`	`string`	Время, когда должен сработать планировщик, , формат `YYYY-MM-DD HH:MM:SS`. Используется с `types: [\"scheduled\"]`. Взаимоисключающий параметр для `interval_delta`.
`interval_delta`	`int`	Временной интервал в секундах, через который должен сработать планировщик. Используется с `types: [\"scheduled\"]`. Взаимоисключающий параметр для `scheduled_time`.
`days_of_week`	`int[]`	Список идентификаторов дней недели, определяющих периодичность выполнения триггера. Используется с `types: [\"iterations\"]` совместно с `at_time + timezone` Используемые индексы для кодирования дней недели: -- `0` = воскресенье, -- `1` = понедельник, -- `2` = вторник, -- `3` = среда, -- `4` = четверг, -- `5` = пятница, -- `6` = суббота Взаимоисключающий параметр для `cron_expression`.
`at_time`	`string`	Время, когда должно наступить выполнение триггера при совместном использовании с `timezone + days_of_week`, формат `HH:MM` Если передать `HH:MM:SS,` то значние будет принято, но `SS будут отброшены.` Используется с `types: [\"iterations\"]`. Взаимоисключающий параметр для `cron_expression`.
`cron_expression`	`string`	Cron-выражение, определяющее периодичность выполнения триггера, используется совместно с `timezone`. Используется с `types: [\"iterations\"]`. Взаимоисключающий параметр для `days_of_week` и `at_time`. Пример: `\"cron_expression\": \"0 10 \\\\\\\\\\\\\\\\\\\\* \\\\\\\\\\\\\\\\\\\\* 1,3,5\"`
`limit_target_count`	`int`	Пороговое значение счетчика. Применяется для `types: [\"limits\"]`.
`limit_step`	`int`	Шаг повторного срабатывания лимита. Применяется для `types: [\"limits\"]` при использовании совместно с `types: [\"iterations\"]`.
`timezone`	`string`	Часовой пояс. Формат передачи значения для `config.timezone` описан ниже. Используется с: -- `types: [\"scheduled\"]` -- `types: [\"iterations\"]` совместно с `days_of_week + at_time` -- `types: [\"iterations\"]` совместно с `cron_expression` Пример: `\"timezone\": \"Europe/Moscow\"`

TYPES	ОПИСАНИЕ	ОЖИДАЕМЫЕ ПОЛЯ `config`
`[\"scheduled\"]`	Однократный или отложенный запуск по времени	`scheduled_time` или `interval_delta`
`[\"scheduled\", \"limits\"]`	Запуск по времени с учетом лимита	`scheduled_time` или `interval_delta`, плюс `limit_target_count`
`[\"iterations\"]`	Повторяющийся запуск по расписанию	`days_of_week` + `at_time` или `cron_expression`
`[\"iterations\", \"limits\"]`	Повторяющийся запуск с лимитом	`days_of_week` + `at_time` или `cron_expression`, плюс `limit_target_count` и при необходимости `limit_step`
`[\"limits\"]`	Срабатывание только по достижению лимита	`limit_target_count`

ПАРАМЕТР	ТИП ДАННЫХ	ОПИСАНИЕ
`base_id`	`int` optional	Идентификатор сегмента. Необязательные параметры: `base_id` Пример: `\"base_id\": 123`
`project_id`	`int` optional	Идентификатор проекта. Необязательные параметры: `project_id` Пример: `\"project_id\": 9`
`offset`	`int` optional	Количество записей, которые нужно пропустить при выборке — отсчет ведется с '`1`'. При передаче значения '`0`' результат в ответе будет возвращен с первого элемента без пропуска записей. Необязательные параметры: `offset` Пример: `\"offset\": 0`
`limit`	`int` optional	Максимальное количество записей, которые нужно вернуть в ответе. Необязательные параметры: `limit` Пример: `\"limit\": 25`
`filter`	`object` optional	Объект с параметрами фильтров. Содержит поля: - status (enum): статус триггера: -- `active` (string) : создан, ожидает выполнения -- `processing` (string): выполняется -- `completed` (string): завершен -- `failed` (string): ошибка выполениея триггера - `search` (string): поиск по наименованию, регистронезависимый. -`created` (object) : объект для указания периода фильтрации по дате создания: -- `start` (int) : начало, Unix timestamp -- `end` (int) : конец, Unix timestamp - `trigger_type` (enum) : тип триггера, возможные значения: -- `scheduled` (string): планировщик -- `limits` (string): лимиты -- `iterations` (string): итерации - `action_definition_id` (int) : идентификатор действия триггера - `last_executed` (object): объект для указания периода фильтрации по последнему времени запуска триггера: -- `start` (int) : начало, Unix timestamp -- `end` (int) : конец, Unix timestamp - `is_archived` (boolean) : Флаг для отметки архивированного триггера. Необязательные параметры: `filter` Пример: смотрите ниже

ПАРАМЕТР	ТИП ДАННЫХ	ОПИСАНИЕ
`id`	`int` required	Идентификатор триггера. Обязательные параметры: `id` Пример: `\"id\": 1`
`base_id`	`int` optional	Идентификатор сегмента. Необязательные параметры: `base_id` Пример: `\"base_id\": 123`
`project_id`	`int` optional	Идентификатор проекта. Необязательные параметры: `project_id` Пример: `\"project_id\": 9`
`name`	`string` optional	Наименование триггера. Необязательные параметры: `name` Пример: `\"name\": \"updated_trigger\"`
`types`	`enum[]` optional `[` `scheduled,` `limits,` `iterations` `]`	Тип триггера. Возможные значения: -- `scheduled`: планировщик, дата/время запуска триггера; -- `limits`: лимиты, количественное ограничение, при достижении которого должен произойти запуск триггера; -- `iterations`: итерации, повторяющееся событие. Важно: значения `scheduled` и `iterations` взаимоисключающие. Значение `limits` может использоваться отдельно либо совместно с `scheduled` или `iterations`. Примечание: при изменении `types` необходимо также передать соответствующий новый `config`. Необязательные параметры: `types` Пример: `\"types\": [\"scheduled\", \"limits\"]`
`actions`	`object[]` optional	Список действий, которые выполняются при срабатывании триггера. При передаче массив полностью заменяет текущий список действий (не дополняет его). Состав объекта описан ниже. Необязательные параметры: `actions` Пример: смотрите ниже
`config`	`object` optional	Конфигурация создаваемого триггера: планировщик, итерации, лимиты. Для передачи в объект доступны следующие поля : -- `\"scheduled_time\"` (string), -- `\"interval_delta\"` (int)`,` -- `\"days_of_week\"` (int[]), -- `\"at_time\"` (string), -- `\"cron_expression\":` (string), -- `\"limit_target_count\"` (int), -- `\"limit_step\"` (int), -- `\"timezone\"` (string) Состав объекта описан ниже. Необязательные параметры: `config` Пример: смотрите ниже
`is_archived`	`boolean` optional	Флаг для отметки архивированного триггера. Необязательные параметры: `is_archived` Пример: `\"is_archived\": true`

ПАРАМЕТР	ТИП ДАННЫХ	ОПИСАНИЕ
`project_id`	`int` required	Идентификатор проекта, которому будет принадлежать созданное IVR-меню. Обязательные параметры: `project_id` Пример: `\"project_id\": 8`
`name`	`string` required	Название создаваемого IVR-меню. Обязательные параметры: `name` Пример: `\"name\": \"ivrname1\"`
`ivr_type`	`enum` optional `[` `custom,` `system,` `system_custom` `]`	Тип IVR-меню, возможные значения: - `custom` : IVR-меню созданные пользователем. - `system` : системные шаблоны IVR-меню, доступны на фронте пользователю при создании рассылки для выбора одного из предложенных вариантов. - `system_custom` : IVR-меню созданные из системных шаблонов (`system`), метка присваивается при изменении пользователем системного шаблона IVR-меню. Необязательные параметры: `ivr_type` Пример: `\"ivr_type\": \"custom\"`
`nodes`	`object[]` optional	Массив объектов, описывающих шаги (узлы) IVR-меню. Описание схемы смотрите ниже. Необязательные параметры: `nodes` Пример: смотрите ниже

ПАРАМЕТР	ТИП ДАННЫХ	ОПИСАНИЕ
`speed`	`int` required	Скорость рассылки, количество звонков в час. Допустимый диапазон: `100` – `12000` . Обязательные параметры: `speed` Пример: `\"speed\": 1000`
`project_id`	`int` required	Идентификатор проекта, к которому будет привязана рассылка. Обязательные параметры: `project_id` Пример: `\"project_id\": 8`
`name`	`string` required	Название рассылки. Обязательные параметры: `name` Пример: `\"name\": \"VoiceMailing_1\"`
`ivr`	`int` required	Идентификатор сценария IVR, который будет использоваться в рассылке, должен быть создан заранее в настройках проекта. Обязательные параметры: `ivr` Пример: `\"ivr\": 11`
`bases`	`int[]` required	Массив ID сегментов (аудиторий) для рассылки. Элементы внутри массива разделяются запятыми. Обязательные параметры: `bases` Пример: `\"bases\": [1,2,3]`
`start_materials`	`object[]` required	Массив объектов с настройками материалов для старта рассылки. Каждый объект содержит: - `id` (int) : ID материала установленный в IVR сценарии. - `start` (int) : Время (в секундах) с начала звонка, когда начнется распознавание голоса. Значение должно соответствовать указанному в настройках сценария (используется только для аудио-роликов). Обязательные параметры: `start_materials` Пример: смотрите ниже
`max_spent`	`int` optional	Лимит денежных средств на рассылку. Необязательные параметры: `max_spent` Пример: `\"max_spent\": 5000`
`max_leads`	`int` optional	Лимит максимального количества лидов, которое может быть собрано в рамках рассылки. Необязательные параметры: `max_leads` Пример: `\"max_leads\": 100`
`recall`	`object` optional	Настройки повторного обзвона. Содержит: - `tries` (int) : Количество попыток дозвона. - `period` (int) : Время между попытками (в секундах), минимальное значение 60, маскимальное значение 1200. - `use_system_carusel` (boolean) : Использовать системную карусель номеров, например, при значении `true` и количестве `tries == 3`, если нет дозвона с номеров подключенных к рассылке, то 4-я попытка дозвона будет сделана с системного номера. Необязательные параметры: `recall` Пример: смотрите ниже
`blacklists`	`int[]` optional	Массив ID черных списков, связанных с проектом. Элементы внутри массива разделяются запятыми. Необязательные параметры: `blacklists` Пример: `\"blacklists\": [4,5,6]`
`avg_cost`	`int` optional	Лимит на среднюю стоимость лида. Необязательные параметры: `avg_cost` Пример: `\"avg_cost\": 150`
`schedule`	`object[]` optional	Массив объектов с настройками расписания планировщика рассылки. Каждый объект содержит: - `start` (int) : Начало периода, UNIX timestamp. - `end` (int) : Конец периода, UNIX timestamp. - `timezone` (string) : Часовой пояс в формате UTC (например, \"GMT+3\"). - `region` (string) : Указание региона в IANA-формате, например: `\"region\": \"Europe/Moscow\"` Обратите внимание: При использовании планировщика, после создания рассылки, необходимо запустить рассылку методом `#communications.mailings.start` для того чтобы рассылка перешла в режим ожидания согласно настроек расписания используемых в рассылке. Необязательные параметры: `schedule` Пример: смотрите ниже
`small_operators_exclude`	`boolean` optional	Исключить операторов связи, не входящих в \"большую четверку\": МТС, Билайн, МегаФон, t2 (Tele2). Необязательные параметры: `small_operators_exclude` Пример: `\"small_operators_exclude\": true`
`phones`	`phone[]` optional	Массив номеров телефонов для обзвона из аренды, с которых будут совершаться звонки (формат E.164 без ведущего плюса). Элементы внутри массива разделяются `запятыми`. Взаимоисключающий параметр для `carousel_id` Необязательные параметры: `phones` Пример: `\"phones\": [\"00000000000\", \"00000000001\"]`
`response_timeout`	`int` optional	Время ожидания ответа абонента в секундах. Допустимый диапазон: `5` – `45` . Необязательные параметры: `response_timeout` Пример: `\"response_timeout\": 27`
`type`	`enum[]` optional	Тип рассылки. Допустимое значение: `voice` . Возможные значения: -- `voice` - голосовые рассылки -- `telegram` - не используется -- `viber` - не используется -- `sms` - не используется -- `whatsapp` - не используется -- `email` - не используется Необязательные параметры: `type` Пример: `\"type\": [\"voice\"]`
`new_telephony`	`boolean` optional	Флаг направления телефонии для совершения звонков. При значении `false` - звонки совершаться не будут. Необязательные параметры: `new_telephony` Пример: `\"new_telephony\": true`
`records`	`boolean` optional	Флаг для отметки использования записи разговоров, параметр связан с настройками используемого IVR-сценария. Необязательные параметры: `records` Пример: `\"records\": false`
`silence`	`boolean` optional	Флаг для отметки использования фильтра тишины, параметр связан с настройками используемого IVR-сценария. Необязательные параметры: `silence` Пример: `\"silence\": false`
`antispam`	`int` optional	Антиспам, параметр не используется. Необязательные параметры: `antispam`
`incoming_mailing`	`boolean` optional	Флаг для отметки использования обработки входящих звонков. Система распознает входящие вызовы и определяет к какой рассылке относится поступивший звонок, для определения логики обработки и воспроизведения сценария с фиксацией поступившего вызова. Необязательные параметры: `incoming_mailing` Пример: `\"incoming_mailing\": false`
`carousel_id`	`int` optional	Идентификатор карусели (набор телефоных номеров для совершения исходящих вызовов). Взаимоисключающий параметр для `phones` Необязательные параметры: `carousel_id` Пример: `\"carousel_id\": 1`
`use_carousel`	`boolean` optional	Флаг, для отметки использования карусели (набор телефоных номеров для совершения исходящих вызовов), применяется в связке с `carousel_id`. Необязательные параметры: `use_carousel` Пример: `\"use_carousel\": false`
`action_timeout`	`int` optional	Время ожидания действия от утсройства клиента в секундах для распознавания его действий (dtmf-нажатия или распознование голоса), во время ответа на исходящий вызов. Параметр связан с настройками используемого IVR-сценария. Необязательные параметры: `action_timeout` Пример: `\"action_timeout\": 7`
`emails`	`email[]` optional	Массив с адресами email, параметр не используется. Необязательные параметры: `emails`
`optimizer`	`object` optional	Настройки оптимизатора исходящих вызовов во время рассылки. Доступные параметры: -- `amd_optimizer` (boolean) : параметр для оценки истории вызовов на конкретный номер в рассылке, если ранее была фиксация автоответчика на номере по последним трем вызовам, то звонок на этот номер пропускается в ходе рассылки. -- `label_optimizer` (boolean) : парамерт для оценки действий с утсройства клиента принимающего звонок, если последние три вызова завершены без фиксации каких либо действий от клиента, то звонок на этот номер пропускается в ходе рассылки. -- `pre_answer_optimizer` (boolean) : флаг для отметки использования предответа в звонках и нужно ли определять автоответчики в предответе, параметр связан с настройками используемого IVR-сценария. Необязательные параметры: `optimizer` Пример: смотрите ниже
`amd`	`boolean` optional	Флаг для отметки использования фильтра автоответчиков, параметр связан с настройками используемого IVR-сценария. Необязательные параметры: `amd` Пример: `\"amd\": false`

ПАРАМЕТР	ТИП ДАННЫХ	ОПИСАНИЕ
`project_id`	`int` required	Идентификатор проекта, к которому привязана рассылка. Обязательные параметры: `project_id` Пример: `\"project_id\": 8`
`id`	`int` required	Идентификатор рассылки, информацию о которой необходимо получить. Обязательные параметры: `id` Пример: `\"id\": 900`

ПАРАМЕТР	ТИП ДАННЫХ	ОПИСАНИЕ
`id`	`int` required	Идентификатор рассылки, которую необходимо обновить. Обязательные параметры: `id` Пример: `\"id\": 123`
`project_id`	`int` required	Идентификатор проекта, к которому привязана рассылка. Обязательные параметры: `project_id` Пример: `\"project_id\": 8`
`speed`	`int` optional	Новая скорость рассылки, количество звонков в час. Допустимый диапазон: `100` – `36000`. Необязательные параметры: `speed` Пример: `\"speed\": 5000`
`name`	`string` optional	Новое название рассылки. Необязательные параметры: `name` Пример: `\"name\": \"VoiceMailing_1_upd\"`
`ivr`	`int` optional	Новый ID сценария IVR для рассылки. Необязательные параметры: `ivr` Пример: `\"ivr\": 12`
`bases`	`int[]` optional	Новые ID сегментов (аудиторий) для рассылки. Элементы внутри массива разделяются запятыми. Необязательные параметры: `bases` Пример: `\"bases\": [7,8,9]`
`start_materials`	`object[]` optional	Массив объектов с настройками материалов для старта рассылки. Каждый объект содержит: - `id` (int) : ID материала. - `start` (int) : Время (в секундах) с начала звонка, когда начнется распознавание голоса. Значение должно соответствовать указанному в настройках сценария (только для аудио-роликов). Необязательные параметры: `start_materials` Пример: смотрите ниже
`status`	`enum` optional `[` `active,` `archived` `]`	Новый статус рассылки. Возможные значения: - `active` : активная рассылка. - `archived` : архивированная рассылка. Необязательные параметры: `status` Пример: `\"status\": \"active\"`
`max_spent`	`int` optional	Новый лимит денежных средств на рассылку. Необязательные параметры: `max_spent` Пример: `\"max_spent\": 10000`
`max_leads`	`int` optional	Новое ограничение на количество лидов. Необязательные параметры: `max_leads` Пример: `\"max_leads\": 150`
`recall`	`object` optional	Настройки повторного обзвона. Содержит: - `tries` (int) : Количество попыток дозвона. - `period` (int) : Время между попытками (в секундах), минимальное значение 60, маскимальное значение 1200. - `use_system_carusel` (boolean) : Использовать системную карусель номеров, например, при значении `true` и количестве `tries == 3`, если нет дозвона с номеров подключенных к рассылке, то 4-я попытка дозвона будет сделана с системного номера. Необязательные параметры: `recall` Пример: смотрите ниже
`small_operators_exclude`	`boolean` optional	Исключить операторов связи, не входящих в \"большую четверку\": МТС, Билайн, МегаФон, t2 (Tele2). Необязательные параметры: `small_operators_exclude` Пример: `\"small_operators_exclude\": true`
`response_timeout`	`int` optional	Время ожидания ответа абонента (в секундах). Допустимый диапазон: `5` – `45`. Необязательные параметры: `response_timeout` Пример: `\"response_timeout\": 25`
`type`	`enum[]` optional	Тип рассылки. Допустимое значение: `voice` . Возможные значения: -- `voice` - голосовые рассылки -- `telegram` - не используется -- `viber` - не используется -- `sms` - не используется -- `whatsapp` - не используется -- `email` - не используется Необязательные параметры: `type` Пример: `\"type\": [\"voice\"]`
`schedule`	`object[]` optional	Массив объектов с настройками расписания планировщика рассылки. Каждый объект содержит: - `start` (int) : Начало периода, UNIX timestamp. - `end` (int) : Конец периода, UNIX timestamp. - `timezone` (string) : Часовой пояс в формате UTC (например, \"GMT+3\"). - `region` (string) : Указание региона в IANA-формате, например: `\"region\": \"Europe/Moscow\"` Необязательные параметры: `schedule` Пример: смотрите ниже
`phones`	`phone[]` optional	Новый массив номеров телефонов из аренды для обзвона, с которых будут совершаться звонки (формат E.164 без ведущего плюса). Элементы внутри массива разделяются запятыми. Необязательные параметры: `phones` Пример: `\"phones\": [\"00000000010\", \"00000000011\"]`
`blacklists`	`int[]` optional	Новые ID сегментов черных списков, связанных с рассылкой. Элементы внутри массива разделяются запятыми. Необязательные параметры: `blacklists` Пример: `\"blacklists\": [10,11,12]`
`avg_cost`	`int` optional	Новый лимит на среднюю стоимость лида. Необязательные параметры: `avg_cost` Пример: `\"avg_cost\": 125`
`new_telephony`	`boolean` optional	Флаг направления телефонии для совершения звонков. При значении `false` - звонков не будет. Необязательные параметры: `new_telephony` Пример: `\"new_telephony\": true`
`antispam`	`int` optional	Антиспам, параметр не используется. Необязательные параметры: `antispam`
`action_timeout`	`int` optional	Время ожидания действия от утсройства клиента в секундах для распознавания его действий (dtmf-нажатия или распознование голоса), во время ответа на исходящий вызов. Параметр связан с настройками используемого IVR-сценария. Необязательные параметры: `action_timeout` Пример: `\"action_timeout\": 7`
`optimizer`	`object` optional	Настройки оптимизатора исходящих вызовов во время рассылки. Доступные параметры: -- `amd_optimizer` (boolean) : параметр для оценки истории вызовов на конкретный номер в рассылке, если ранее была фиксация автоответчика на номере по последним трем вызовам, то звонок на этот номер пропускается в ходе рассылки. -- `label_optimizer` (boolean) : парамерт для оценки действий с утсройства клиента принимающего звонок, если последние три вызова завершены без фиксации каких либо действий от клиента, то звонок на этот номер пропускается в ходе рассылки. -- `pre_answer_optimizer` (boolean) : флаг для отметки использования предответа в звонках и нужно ли определять автоответчики в предответе, параметр связан с настройками используемого IVR-сценария. Необязательные параметры: `optimizer` Пример: смотрите ниже
`incoming_mailing`	`boolean` optional	Флаг для отметки использования обработки входящих звонков. Система распознает входящие вызовы и определяет к какой рассылке относится поступивший звонок, для определения логики обработки и воспроизведения сценария с фиксацией поступившего вызова. Необязательные параметры: `incoming_mailing` Пример: `\"incoming_mailing\": false`
`records`	`boolean` optional	Флаг для отметки использования записи разговоров, параметр связан с настройками используемого IVR-сценария. Необязательные параметры: `records` Пример: `\"records\": false`
`silence`	`boolean` optional	Флаг для отметки использования фильтра тишины, параметр связан с настройками используемого IVR-сценария. Необязательные параметры: `silence` Пример: `\"silence\": false`
`use_carousel`	`boolean` optional	Флаг, для отметки использования карусели (набор телефоных номеров для совершения исходящих вызовов), применяется в связке с `carousel_id`. Необязательные параметры: `use_carousel` Пример: `\"use_carousel\": false`
`amd`	`boolean` optional	Флаг для отметки использования фильтра автоответчиков, параметр связан с настройками используемого IVR-сценария. Необязательные параметры: `amd` Пример: `\"amd\": false`
`carousel_id`	`int` optional	Идентификатор карусели (набор телефоных номеров для совершения исходящих вызовов). Взаимоисключающий параметр для `phones` Необязательные параметры: `carousel_id` Пример: `\"carousel_id\": 1`

ПАРАМЕТР	ТИП ДАННЫХ	ОПИСАНИЕ
`id`	`int` required	Идентификатор рассылки. Обязательные параметры: `id` Пример: `\"id\": 913`
`project_id`	`int` required	Идентификатор проекта, к которому привязана рассылка. Обязательные параметры: `project_id` Пример: `\"project_id\": 90`
`offset`	`int` optional	Количество записей, которые нужно пропустить при выборке — отсчет ведется с '`1`'. При передаче значения '`0`' результат в ответе будет возвращен с первого элемента без пропуска записей. Необязательные параметры: `offset` Пример: `\"offset\": 10`
`limit`	`int` optional	Максимальное количество записей, которые нужно вернуть в ответе. Необязательные параметры: `limit` Пример: `\"limit\": 25`
`sort`	`object` optional	Объект с параметрами сортировки. Содержит два поля: - `name` (enum): наименование поля, по которому производится сортировка: -- `id` : по идентификатору рассылки, -- `created` : по дате создания - `direction` (enum) : направление сортировки: -- `ASC` : по возрастанию, -- `DESC` : по убыванию. Необязательные параметры: `sort` Пример: смотрите ниже
`period`	`object` optional	Объект, для фильтрации записей по временному периоду. Содержит два поля: - `start` (int) : начало периода , UNIX timestamp. - `end` (int): конец периода, UNIX timestamp. Необязательные параметры: `period` Пример: смотрите ниже

ПАРАМЕТР	ТИП ДАННЫХ	ОПИСАНИЕ
`id`	`int` required	Уникальный идентификатор рассылки. Обязательные параметры: `id` Пример: `\"id\": 900`
`project_id`	`int` required	Идентификатор проекта, которому принадлежит рассылка. Обязательные параметры: `project_id` Пример: `\"project_id\": 8`
`status`	`enum` optional `[` `failed,` `success` `]`	Фильтр по статусу звонков. Возможные значения: - `failed` : неуспешные звонки. - `success` : успешные звонки. Необязательные параметры: `status` Пример: `\"status\": \"success\"`
`offset`	`int` optional	Количество записей, которые нужно пропустить при выборке — отсчет ведется с '`1`'. При передаче значения '`0`' результат в ответе будет возвращен с первого элемента без пропуска записей. Необязательные параметры: `offset` Пример: `\"offset\": 10`
`limit`	`int` optional	Максимальное количество записей, которые нужно вернуть в ответе. Необязательные параметры: `limit` Пример: `\"limit\": 100`
`direction`	`enum` optional `[` `inbound,` `outbound` `]`	Фильтр по направлению звонков. Возможные значения: - `inbound` : входящие звонки. - `outbound` : исходящие звонки. Необязательные параметры: `direction` Пример: `\"direction\": \"outbound\"`
`from`	`phone` optional	Номер телефона, с которого был совершен звонок, формат E.164 без ведущего плюса. Необязательные параметры: `from` Пример: `\"from\": \"00000000000\"`
`sort`	`object` optional	Параметры сортировки результатов. Объект содержит два поля: - `name` (enum): наименование поля, по которому выполняется сортировка: -- `id` : сортировка по ID. -- `phone` : сортировка по номеру телефона. -- `direction` : сортировка по направлению звонка. -- `created` : сортировка по времени создания. -- `billsec` : сортировка по длительности звонка. -- `status` : сортировка по статусу звонка. -- `amount` : сортировка по стоимости звонка. -- `lead` : сортировка по флагу \"лид\". -- `blacklisted` : сортировка по флагу \"черный список\". -- `amd` : сортировка по флагу \"автоответчик\". - `direction` (enum): направление сортировки: -- `ASC` : сортировка по возрастанию. -- `DESC` : сортировка по убыванию. Необязательные параметры: `sort` Пример: смотрите ниже
`to`	`phone` optional	Номер телефона, на который был совершен звонок, формат E.164 без ведущего плюса. Необязательные параметры: `to` Пример: `\"to\": \"00000000001\"`
`period`	`object` optional	Период времени, за который необходимо получить данные. Объект содержит два поля: - `start` : Время начала периода, UNIX timestamp - `end` : Время окончания периода, UNIX timestamp Необязательные параметры: `period` Пример: смотрите ниже
`flag`	`enum[]` optional `[` `lead,` `blacklisted,` `amd` `]`	Фильтр по флагам звонков. Возможные значения: - `lead` : целевые звонки, помеченные как лид. - `blacklisted` : звонки, отфильтрованные как черный список. - `amd` : звонки, отфильтрованные автоответчиком. Необязательные параметры: `flag` Пример: `\"flag\": [\"lead\", \"blacklisted\"]`