Получить список клиентов (коробка)

Активити (робот) "Получить список клиентов Коробка" предназначено для использования в роботах и может быть полезно в следующих сценариях:

Получение данных по клиентам коробочной версии Битрикс24 из партнёрского кабинета;
Фильтрация клиентов по продукту, коду лицензии и сроку действия;
Постраничная выборка записей для отчётов и CRM;
Выбор одной конкретной записи из страницы по номеру строки;
Синхронизация контактов и данных Market24 с внешними системами;
Проверка подписки Market24 и даты её окончания;
Автоматизация напоминаний по окончанию лицензии;
Экспорт списка организаций с порталами и лимитами пользователей;
Связка с бизнес-процессов по событию из переменных партнёра;
Контроль количества найденных записей и навигации по страницам.

Как работает активити (робот):
- Выполняется запрос к партнёрскому API (метод clients.box.list) с идентификатором партнёра и секретным ключом;
- Фильтры передаются в теле запроса: поля с префиксом filter_ в активити преобразуются в ключи фильтра API;
- Из ответа выбирается одна запись: номер записи (row_rec) должен совпадать с порядковым индексом элемента в массиве list (нумерация с 1);
- Для вложенных блоков contact и market24 поля раскладываются в возвращаемые параметры с префиксами list_contact_ и list_market24_;
- Если список пуст или запись не найдена, возвращается math_search_results = N и остальные поля не заполняются;
- Возвращаются также параметры навигации: всего записей, число страниц, номер страницы, размер страницы.

Описание параметров активити (робота)

Название поля	Описание и примеры использования
Идентификатор партнера	Обязательный числовой идентификатор партнёра в партнёрском кабинете. Примеры: 1092905; {=Variable:PARTNER_ID}. Важно: без корректного partner_id запрос к API не выполняется.
Секретный ключ партнера	Обязательный ключ из карточки партнёра (partner_core). Примеры: {=Variable:PARTNER_CORE}.
Номер записи	Должен совпадать с ключом нужной записи в массиве list (в коде сравнивается с индексом в списке; указывайте номер записи в соответствии с порядком ответа API).
ID (фильтр)	Необязательный фильтр filter_id — идентификатор клиента в выборке.
Продукт	Необязательный фильтр filter_product — строка продукта.
Лицензия	Необязательный фильтр filter_licenseCode.
Срок действия: с / по	Необязательные фильтры filter_dateToFrom и filter_dateToTo в формате даты.
Номер страницы	Необязательный фильтр filter_page для постраничной выборки.
Запускать от имени	Укажите пользователя с правами, достаточными для выполнения запроса; рекомендуется администратор.
Устанавливать текст статуса	Параметр интерфейса робота: отображение статуса в истории бизнес-процесса при отладке.
Текст статуса	Текст статуса при включённой опции отображения.
Ожидать ответа	Служебный параметр: ожидание ответа приложения.
Период ожидания	Таймаут ожидания ответа от приложения (не менее 5 минут по смыслу настройки робота).

Примеры использования активити (робота)

Описание примера	Решение
Первая запись на первой странице без фильтра	partner_id и partner_core из констант партнёра, row_rec = 1, filter_page не задан или 1.
Фильтр по коду лицензии	filter_licenseCode = {=Variable:LICENSE_CODE}, row_rec = 1, partner_id = {=Variable:PARTNER_ID}.
Клиенты с действующей лицензией в диапазоне дат	filter_dateToFrom = {=System:Date}, filter_dateToTo через переменную с датой окончания периода.
Вторая строка на текущей странице	filter_page = {=Variable:PAGE}, row_rec = 2.
Передача партнёра из документа сделки	partner_id = {=Document:UF_CRM_PARTNER_ID} при заполненном пользовательском поле.
Поиск по продукту	filter_product = «Битрикс24», row_rec = 1.
Использование только обязательных полей	partner_id, partner_core, row_rec заполнены; фильтры пустые; проверка math_search_results.
Итерация по страницам в бизнес-процессе	Переменная PAGE увеличивается в цикле; filter_page = {=Variable:PAGE}, row_rec = 1 на каждой итерации.
Идентификация клиента по ID	filter_id = {=Variable:CLIENT_ID}, row_rec = 1.
Использование результата после проверки	Условие в БП: если «Все условия» (math_search_results) = Y, иначе ветка «нет данных».

Возвращаемые параметры данного активити (робота):
- list_id — идентификатор записи клиента;
- list_name — наименование организации;
- list_product — продукт;
- list_licenseId, list_licenseCode — лицензия;
- list_email, контактные поля list_contact_*;
- list_dateFrom, list_dateTo, list_buyDate, list_siteUrl, list_clientLang, list_maxUsers;
- list_market24_subscription, list_market24_dateTo — подписка Market24;
- list_totalCount, list_pageCount, list_pageNumber, list_pageSize — навигация;
- math_search_results — Y при успешном получении записи, N если список пуст или запись не найдена.

Важно: Номер записи row_rec должен соответствовать индексу в массиве list, возвращаемому API. При смене фильтров или страницы проверяйте list_totalCount и при необходимости корректируйте row_rec и filter_page.

Ваша корзина пуста

Получить список клиентов (коробка)