# Подробное описание сложных методов

Некоторые методы обладают сложной структурой и требуют более детального объяснения. В этом разделе вы найдете отдельные страницы, посвященные подробному описанию параметров и особенностей работы таких методов.

# where для bot.findLeads()

### Базовая структура:

Каждое условие внутри массива `where` имеет следующую структуру:

1. **Простое условие**: `['поле', 'значение']`
    
    Проверяет, равно ли поле заданному значению.
2. **Условие с оператором**: `['поле', 'оператор', 'значение']`
    
    Проверяет поле с использованием указанного оператора.

```JavaScript
let where = [
  ['поле', 'значение'],
  ['поле', 'оператор', 'значение']
]

bot.findLeads([], where, [])
```

### Доступные категории полей:

1. Поля лидов
2. Каналы (channels)
3. Статусы лидов (leadstatuses)
4. Атрибуты лидов (lead\_attributes)

#### **1. Поля лидов**

Это основные поля, доступные для каждого лида.

<table id="bkmrk-%D0%9F%D0%BE%D0%BB%D0%B5-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-id-id-"><thead><tr><th>Поле</th><th>Описание</th></tr></thead><tbody><tr><td>id</td><td>ID лида</td></tr><tr><td>name</td><td>Имя лида</td></tr><tr><td>identification</td><td>ID в мессенджере (например, Telegram ID)</td></tr><tr><td>person\_id</td><td>ID персоны</td></tr><tr><td>manager\_id</td><td>ID менеджера</td></tr><tr><td>bot\_id</td><td>ID бота</td></tr><tr><td>channel\_id</td><td>ID канала</td></tr><tr><td>lang\_code</td><td>Код языка</td></tr><tr><td>status\_id</td><td>ID статуса</td></tr><tr><td>is\_mute</td><td>Включен ли бот для лида (0 или 1)</td></tr><tr><td>is\_forwarded</td><td>Передан ли оператору (0 или 1)</td></tr><tr><td>last\_activity</td><td>Дата последней активности</td></tr><tr><td>last\_response</td><td>Timestamp последнего ответа</td></tr><tr><td>messenger</td><td>ID мессенджера</td></tr><tr><td>bot\_debug\_level</td><td>Уровень отладки бота (0 - обычный, 11 - админ)</td></tr><tr><td>created\_at</td><td>Дата создания</td></tr><tr><td>updated\_at</td><td>Дата обновления</td></tr><tr><td>dialog\_id</td><td>ID диалога</td></tr><tr><td>unread\_count</td><td>Количество непрочитанных сообщений</td></tr><tr><td>forwarded\_at</td><td>Дата передачи оператору</td></tr></tbody></table>

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

```jsx
where = [
  ['id', 145492],
  ['name', 'like', '%Иван%'],
  ['created_at', '>=', '2023-01-01']
]


```

#### **2. Каналы (channels)**

Для поиска по каналам используются поля `channels.code` и `channels.id`.

<table id="bkmrk-%D0%9A%D0%BE%D0%B4-id-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-unkn"><thead><tr><th>Код</th><th>ID</th><th>Описание</th></tr></thead><tbody><tr><td>unknown</td><td>0</td><td>Неизвестный канал</td></tr><tr><td>avito</td><td>1</td><td>Avito</td></tr><tr><td>facebook</td><td>2</td><td>Facebook</td></tr><tr><td>instagram</td><td>3</td><td>Instagram</td></tr><tr><td>livechatWidget</td><td>4</td><td>LiveChat Widget</td></tr><tr><td>skype</td><td>5</td><td>Skype</td></tr><tr><td>telegram</td><td>6</td><td>Telegram</td></tr><tr><td>twitter</td><td>7</td><td>Twitter</td></tr><tr><td>viber</td><td>8</td><td>Viber</td></tr><tr><td>vk</td><td>9</td><td>VKontakte</td></tr><tr><td>whatsapp</td><td>10</td><td>WhatsApp</td></tr><tr><td>youla</td><td>11</td><td>Youla</td></tr><tr><td>wechat</td><td>12</td><td>WeChat</td></tr><tr><td>metabotWidget</td><td>13</td><td>MetaBot Widget</td></tr><tr><td>webim</td><td>14</td><td>Webim</td></tr><tr><td>jivoWidget</td><td>15</td><td>Jivo Widget</td></tr><tr><td>odnoklassniki</td><td>16</td><td>Odnoklassniki</td></tr><tr><td>apple\_business\_chat</td><td>17</td><td>Apple Business Chat</td></tr></tbody></table>

Канал текущего лида можно получить с помощью метода `lead.getMessengerCode()`.

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

```JavaScript
// Ищет только telegram
let where = [
  ['channels.code', 'telegram']
]

// Ищет telegram и whatsapp
let where = [
  ['channels.id', 'IN', [6, 10]]
]
```

#### **3. Статусы лидов (leadstatuses)**

Для поиска по статусам используются поля `leadstatuses.name` и `leadstatuses.id`.

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

```JavaScript
let where = [
  ['leadstatuses.name', 'Новый'],
  ['leadstatuses.id', 1]
]
```

Статусы можно получить на странице [https://app.metabot24.com/status](https://app.metabot24.com/status)

#### Рекомендации:

```MarkDown
Используйте вместо leadstatuses.id - status_id
А вместо channels.id - channel_id

Если вы выполняете большие операции это сократит время вычисления
```

#### **4. Атрибуты лидов (lead\_attributes)**

Для поиска по атрибутам используются следующие поля:

<table id="bkmrk-%D0%9F%D0%BE%D0%BB%D0%B5-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-lead_a"><thead><tr><th>Поле</th><th>Описание</th></tr></thead><tbody><tr><td>lead\_attributes.attribute\_type</td><td>Тип атрибута (tag, variable, system, json, context)</td></tr><tr><td>lead\_attributes.attribute\_key</td><td>Ключ атрибута</td></tr><tr><td>lead\_attributes.attribute\_value</td><td>Значение атрибута. Если type = tag, то можно не использовать</td></tr></tbody></table>

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

```JavaScript
let where = [
  ['lead_attributes.attribute_type', 'variable'],
  ['lead_attributes.attribute_key', 'is_pay'],
  ['lead_attributes.attribute_value', '1']
]

```

### Операторы

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

- Сравнения: `=`, `<`, `>`, `<=`, `>=`, `<>`, `!=`
- Строковые: `like`, `not like`
- Множества: `IN`, `NOT IN`

<table id="bkmrk-%D0%9E%D0%BF%D0%B5%D1%80%D0%B0%D1%82%D0%BE%D1%80-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-%D0%A2%D0%B8"><thead><tr><th>Оператор</th><th>Описание</th><th>Тип переменной</th><th>Пример</th></tr></thead><tbody><tr><td>=</td><td>Равно</td><td>string, int</td><td>\['id', '=', 100\]</td></tr><tr><td>&lt;</td><td>Меньше</td><td>int, float</td><td>\['price', '&lt;', 1000\]</td></tr><tr><td>&gt;</td><td>Больше</td><td>int, float</td><td>\['age', '&gt;', 18\]</td></tr><tr><td>&lt;=</td><td>Меньше или равно</td><td>int, float</td><td>\['quantity', '&lt;=', 50\]</td></tr><tr><td>&gt;=</td><td>Больше или равно</td><td>int, float</td><td>\['rating', '&gt;=', 4.5\]</td></tr><tr><td>&lt;&gt; или !=</td><td>Не равно</td><td>string, int</td><td>\['status', '&lt;&gt;', 'closed'\]</td></tr><tr><td>like</td><td>Соответствует шаблону</td><td>string</td><td>\['name', 'like', '%John%'\]</td></tr><tr><td>not like</td><td>Не соответствует шаблону</td><td>string</td><td>\['email', 'not like', '%@spam.com'\]</td></tr><tr><td>ilike</td><td>Соответствует шаблону (без учета регистра)</td><td>string</td><td>\['title', 'ilike', '%book%'\]</td></tr><tr><td>IN</td><td>Содержится в списке</td><td>array</td><td>\['id', 'IN', \[1, 2, 3\]\]</td></tr><tr><td>NOT IN</td><td>Не содержится в списке</td><td>array</td><td>\['status', 'NOT IN', \['closed', 'deleted'\]\]</td></tr><tr><td>is</td><td>Равно (для null)</td><td>null</td><td>\['manager\_id', 'is', null\]</td></tr><tr><td>is not</td><td>Не равно (для null)</td><td>null</td><td>\['end\_date', 'is not', null\]</td></tr><tr><td>regexp</td><td>Соответствует регулярному выражению</td><td>string</td><td>\['phone', 'regexp', '^\\\\+7'\]</td></tr><tr><td>not regexp</td><td>Не соответствует регулярному выражению</td><td>string</td><td>\['username', 'not regexp', '\[0-9\]'\]</td></tr></tbody></table>

> Примечание: Некоторые операторы могут быть недоступны или работать иначе.

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

```JavaScript
let where = [
  ['id', '>', 1000],
  ['name', 'like', '%Иван%'],
  ['channels.code', 'IN', ['telegram', 'whatsapp']]
]
```

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

```JavaScript
let where = [
  ['name', 'like', '%Иван%'],
  ['channels.code', 'telegram'],
  ['leadstatuses.name', 'Новый'],
  ['lead_attributes.attribute_type', 'tag'],
  ['lead_attributes.attribute_key', 'важный_клиент']
]

let leads = bot.findLeads([], where, [])
debug(leads)
```

# orderBy для bot.findLeads()

### Базовая структура:

Параметр `orderBy` используется для сортировки результатов поиска лидов по заданным полям. Он представляет собой массив условий, где каждое условие задаёт поле для сортировки и порядок сортировки (по возрастанию или по убыванию).

Каждое условие внутри массива `orderBy` имеет следующую структуру:

```JavaScript
let orderBy = [
  ['поле', 'порядок']
]

bot.findLeads([], [], orderBy)
```

1. **Поле**: Название поля, по которому будет производиться сортировка (например, `created_at`, `updated_at`, `id`).
2. **Порядок**: Определяет, как будет сортироваться поле. Возможны два значения: 
    - `ASC` — по возрастанию.
    - `DESC` — по убыванию.

**Доступные категории полей:**

1. [Поля лидов](https://docs.metabot24.ru/link/744#bkmrk-1.-%D0%9F%D0%BE%D0%BB%D1%8F-%D0%BB%D0%B8%D0%B4%D0%BE%D0%B2)
2. [Статусы лидов (leadstatuses)](https://docs.metabot24.ru/link/744#bkmrk-3.-%D0%A1%D1%82%D0%B0%D1%82%D1%83%D1%81%D1%8B-%D0%BB%D0%B8%D0%B4%D0%BE%D0%B2-%28le)

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

#### **1. Сортировка по одному полю**

```JavaScript
let orderBy = [
  ['created_at', 'ASC']
]

let leads = bot.findLeads([], [], orderBy)
```

Этот пример сортирует лидов по дате создания в порядке возрастания (от самого раннего к самому позднему).

#### **2. Сортировка по нескольким полям**

```JavaScript
let orderBy = [
  ['updated_at', 'DESC'],
  ['id', 'ASC']
]

let leads = bot.findLeads([], [], orderBy)
```

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

### Пример с `where` и `orderBy`

```JavaScript
let where = [
  ['name', 'like', '%Иван%'],
  ['channels.code', 'telegram']
]

let orderBy = [
  ['created_at', 'DESC']
]

let leads = bot.findLeads([], where, orderBy)
```