mirror of
https://github.com/Bayselonarrend/OpenIntegrations.git
synced 2025-05-31 23:20:02 +02:00
86 lines
2.2 KiB
Plaintext
Vendored
86 lines
2.2 KiB
Plaintext
Vendored
---
|
|
sidebar_position: 4
|
|
---
|
|
|
|
import Tabs from '@theme/Tabs';
|
|
import TabItem from '@theme/TabItem';
|
|
|
|
# Get leads list
|
|
Gets a list of leads (50 per request max) with or without filtering (see GetLeadFilterStructure)
|
|
|
|
|
|
|
|
`Function GetLeadsList(Val URL, Val Filter = "", Val Indent = 0, Val Token = "") Export`
|
|
|
|
| Parameter | CLI option | Type | Required | Description |
|
|
|-|-|-|-|-|
|
|
| URL | --url | String | ✔ | URL of webhook or a Bitrix24 domain, when token used |
|
|
| Filter | --filter | Structure of KeyAndValue | ✖ | Lead filter structure (see GetLeadFilterStructure) |
|
|
| Indent | --offset | Number, String | ✖ | Offset from the beginning of the list to get leads > 50 recursively |
|
|
| Token | --token | String | ✖ | Access token, when app auth method used |
|
|
|
|
|
|
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
|
|
|
|
<br/>
|
|
|
|
:::tip
|
|
Method at API documentation: [crm.lead.list](https://dev.1c-bitrix.ru/rest_help/crm/leads/crm_lead_list.php)
|
|
:::
|
|
<br/>
|
|
|
|
|
|
|
|
```bsl title="1C:Enterprise/OneScript code example"
|
|
URL = "https://b24-ar17wx.bitrix24.by/rest/1/ps5...";
|
|
|
|
Result = OPI_Bitrix24.GetLeadsList(URL);
|
|
|
|
URL = "b24-ar17wx.bitrix24.by";
|
|
Token = "14bb8267006e9f06006b12e400000001000...";
|
|
|
|
Filter = New Structure;
|
|
Filter.Insert("TITLE" , "MegaClient");
|
|
Filter.Insert("HAS_EMAIL", "Y");
|
|
|
|
Result = OPI_Bitrix24.GetLeadsList(URL, Filter, , Token);
|
|
```
|
|
|
|
|
|
<Tabs>
|
|
|
|
<TabItem value="bash" label="Bash" default>
|
|
```bash
|
|
oint bitrix24 GetLeadsList \
|
|
--url "b24-ar17wx.bitrix24.by" \
|
|
--token "***"
|
|
```
|
|
</TabItem>
|
|
|
|
<TabItem value="bat" label="CMD/Bat" default>
|
|
```batch
|
|
oint bitrix24 GetLeadsList ^
|
|
--url "b24-ar17wx.bitrix24.by" ^
|
|
--token "***"
|
|
```
|
|
</TabItem>
|
|
</Tabs>
|
|
|
|
|
|
```json title="Result"
|
|
{
|
|
"result": [],
|
|
"total": 0,
|
|
"time": {
|
|
"start": 1728454939.89873,
|
|
"finish": 1728454939.94382,
|
|
"duration": 0.0450830459594727,
|
|
"processing": 0.0179238319396973,
|
|
"date_start": "2024-10-09T09:22:19+03:00",
|
|
"date_finish": "2024-10-09T09:22:19+03:00",
|
|
"operating_reset_at": 1728455539,
|
|
"operating": 0
|
|
}
|
|
}
|
|
```
|