bot.findLeads()

Получить лиды по атрибутам

bot.findLeads($columns = [], $where = [], $orderBy = [], ?int $limit = null, ?int $offset = null)

Описание:

Находит лида по указанным атрибутам и другим данным.

Атрибуты:

Имя	Тип	Описание
columns	objectarray	Возвращаемые поля лидов, по умолчанию все поля. Вы можете вывести дополнительные поля: status_name, channel_name, channel_code
where	objectarray	Ищет лиды по: по -атрибутам, атрибутам - для этого вводим в $where названия полей атрибутов как lead_attributes.<имя поля> - статусам -и используемканалам. вПодробнее $whereчитайте leadstatuses.<имя поля> - каналам - используем в $where channels.<имя поля>здесь.
orderBy	objectarray	АтрибутМассив сортировки возвращаемых значений
limit	int	Максимальное число возвращаемых лидовлидов. Можно вернуть диапазон от 1 до 100
offset	int	ПараметрЧисловое показывающийзначение, суказывающее какогоколичество позаписей, счетукоторые найденногонеобходимо лидапропустить начатьот возвращатьначала значениярезультата выборки перед возвратом данных. Этот параметр используется для пагинации. Например, если limit установлен на 100, а offset равен 100, то будут возвращены записи, начиная со 101-го лида.

Возвращает:

array - массив полей лидов.

В массиве следующие поля:

• id - id лида;лида
• identification - внешний id лида;лида
• manager_id - id менеджера привязанного к лиду;лиду
• bot_id - id бота лида;лида
• channel_id - id канала лида;лида
• status_id - id статуса лида;

extra - ???лида
is_mute - включен ли бот для лида; все системные поля лида (по английски).

Пример:

let leads = bot.findLeads(
    [],
    [
     ['lead_attributes.attribute_type', 'variable'],
     ['lead_attributes.attribute_key', 'nlpLastIntentName'],
     ['lead_attributes.attribute_value', 'позвать_человека'],
    ],
    [['updated_at']]
);

if (leads.length) {
    let statusName = leads[0].getData('id');
}

или получаем поля для первого найденного лида (без условий):

let leads = bot.findLeads(['status_name', 'channel_name', 'channel_code']);
if (leads.length) {
    let statusName = leads[0].getData('status_name');
    let channelName = leads[0].getData('channel_name');
    let channelCode = leads[0].getData('channel_code');
}