Получить список лидов
Получает список лидов (50 шт. за запрос максимум) с фильтром или без (см. ПолучитьСтруктуруФильтраЛидов)
Функция ПолучитьСписокЛидов(Знач URL, Знач Фильтр = "", Знач Отступ = 0, Знач Токен = "") Экспорт
| Параметр | CLI опция | Тип | Назначение |
|---|---|---|---|
| URL | --url | Строка | URL внешнего вебхука или адрес Bitrix24 при использовании токена |
| Фильтр | --filter | Структура из КлючИЗначение | Структура отбора лидов (см. ПолучитьСтруктуруФильтраЛидов) |
| Отступ | --offset | Число, Строка | Отступ от начала списка для получения лидов > 50 шт. рекурсивно |
| Токен | --token | Строка | Токен авторизации, если используется не вебхук |
Возвращаемое значение: Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrix24
подсказка
Метод в документации API: crm.lead.list
Пример кода
URL = "https://b24-ar17wx.bitrix24.by/rest/1/1o2...";
Результат = OPI_Bitrix24.ПолучитьСписокЛидов(URL);
URL = "b24-ar17wx.bitrix24.by";
Токен = "c3abf666006e9f06006b12e400000001000...";
Фильтр = Новый Структура;
Фильтр.Вставить("TITLE" , "Мегаклиент");
Фильтр.Вставить("HAS_EMAIL", "Y");
Результат = OPI_Bitrix24.ПолучитьСписокЛидов(URL, Фильтр, , Токен);
Пример команды CLI
oint bitrix24 ПолучитьСписокЛидов --url "b24-ar17wx.bitrix24.by" --filter %filter% --offset %offset% --token "ec4dc366006e9f06006b12e400000001000..."
Результат
{
"result": [
{
"ID": "8",
"TITLE": "Мегаклиент",
"HONORIFIC": null,
"NAME": "Петр",
"SECOND_NAME": null,
"LAST_NAME": "Петров",
"COMPANY_TITLE": null,
"COMPANY_ID": null,
"CONTACT_ID": "8",
"IS_RETURN_CUSTOMER": "N",
"BIRTHDATE": "",
"SOURCE_ID": null,
"SOURCE_DESCRIPTION": null,
"STATUS_ID": "CONVERTED",
"STATUS_DESCRIPTION": null,
"POST": null,
"COMMENTS": null,
"CURRENCY_ID": "BYN",
"OPPORTUNITY": "0.00",
"IS_MANUAL_OPPORTUNITY": "N",
"HAS_PHONE": "Y",
"HAS_EMAIL": "Y",
"HAS_IMOL": "N",
"ASSIGNED_BY_ID": "1",
"CREATED_BY_ID": "1",
"MODIFY_BY_ID": "1",
"DATE_CREATE": "2024-08-22T16:48:12+00:00",
"DATE_MODIFY": "2024-08-22T16:48:12+00:00",
"DATE_CLOSED": "2024-08-22T16:48:12+00:00",
"STATUS_SEMANTIC_ID": "S",
"OPENED": "N",
"ORIGINATOR_ID": null,
"ORIGIN_ID": null,
"MOVED_BY_ID": "1",
"MOVED_TIME": "2024-08-22T16:48:12+00:00",
"ADDRESS": "ул. Пушкина, д. 10",
"ADDRESS_2": null,
"ADDRESS_CITY": null,
"ADDRESS_POSTAL_CODE": null,
"ADDRESS_REGION": null,
"ADDRESS_PROVINCE": null,
"ADDRESS_COUNTRY": "Россия",
"ADDRESS_COUNTRY_CODE": null,
"ADDRESS_LOC_ADDR_ID": "14",
"UTM_SOURCE": null,
"UTM_MEDIUM": null,
"UTM_CAMPAIGN": null,
"UTM_CONTENT": null,
"UTM_TERM": null,
"LAST_ACTIVITY_BY": "1",
"LAST_ACTIVITY_TIME": "2024-08-22T16:48:12+00:00"
},
{
"ID": "10",
"TITLE": "Мегаклиент",
"HONORIFIC": null,
"NAME": "Иван",
"SECOND_NAME": null,
"LAST_NAME": "Иванов",
"COMPANY_TITLE": null,
"COMPANY_ID": null,
"CONTACT_ID": "10",
"IS_RETURN_CUSTOMER": "N",
"BIRTHDATE": "",
"SOURCE_ID": null,
"SOURCE_DESCRIPTION": null,
"STATUS_ID": "CONVERTED",
"STATUS_DESCRIPTION": null,
"POST": null,
"COMMENTS": null,
"CURRENCY_ID": "BYN",
"OPPORTUNITY": "0.00",
"IS_MANUAL_OPPORTUNITY": "N",
"HAS_PHONE": "Y",
"HAS_EMAIL": "Y",
"HAS_IMOL": "N",
"ASSIGNED_BY_ID": "1",
"CREATED_BY_ID": "1",
"MODIFY_BY_ID": "1",
"DATE_CREATE": "2024-08-22T16:48:13+00:00",
"DATE_MODIFY": "2024-08-22T16:48:13+00:00",
"DATE_CLOSED": "2024-08-22T16:48:13+00:00",
"STATUS_SEMANTIC_ID": "S",
"OPENED": "N",
"ORIGINATOR_ID": null,
"ORIGIN_ID": null,
"MOVED_BY_ID": "1",
"MOVED_TIME": "2024-08-22T16:48:13+00:00",
"ADDRESS": "ул. Пушкина, д. 10",
"ADDRESS_2": null,
"ADDRESS_CITY": null,
"ADDRESS_POSTAL_CODE": null,
"ADDRESS_REGION": null,
"ADDRESS_PROVINCE": null,
"ADDRESS_COUNTRY": "Россия",
"ADDRESS_COUNTRY_CODE": null,
"ADDRESS_LOC_ADDR_ID": "18",
"UTM_SOURCE": null,
"UTM_MEDIUM": null,
"UTM_CAMPAIGN": null,
"UTM_CONTENT": null,
"UTM_TERM": null,
"LAST_ACTIVITY_BY": "1",
"LAST_ACTIVITY_TIME": "2024-08-22T16:48:13+00:00"
},
{
"ID": "12",
"TITLE": "Мегаклиент",
"HONORIFIC": null,
"NAME": "Петр",
"SECOND_NAME": null,
"LAST_NAME": "Петров",
"COMPANY_TITLE": null,
"COMPANY_ID": null,
"CONTACT_ID": "12",
"IS_RETURN_CUSTOMER": "N",
"BIRTHDATE": "",
"SOURCE_ID": null,
"SOURCE_DESCRIPTION": null,
"STATUS_ID": "CONVERTED",
"STATUS_DESCRIPTION": null,
"POST": null,
"COMMENTS": null,
"CURRENCY_ID": "BYN",
"OPPORTUNITY": "0.00",
"IS_MANUAL_OPPORTUNITY": "N",
"HAS_PHONE": "Y",
"HAS_EMAIL": "Y",
"HAS_IMOL": "N",
"ASSIGNED_BY_ID": "1",
"CREATED_BY_ID": "1",
"MODIFY_BY_ID": "1",
"DATE_CREATE": "2024-08-22T17:00:19+00:00",
"DATE_MODIFY": "2024-08-22T17:00:20+00:00",
"DATE_CLOSED": "2024-08-22T17:00:20+00:00",
"STATUS_SEMANTIC_ID": "S",
"OPENED": "N",
"ORIGINATOR_ID": null,
"ORIGIN_ID": null,
"MOVED_BY_ID": "1",
"MOVED_TIME": "2024-08-22T17:00:20+00:00",
"ADDRESS": "ул. Пушкина, д. 10",
"ADDRESS_2": null,
"ADDRESS_CITY": null,
"ADDRESS_POSTAL_CODE": null,
"ADDRESS_REGION": null,
"ADDRESS_PROVINCE": null,
"ADDRESS_COUNTRY": "Россия",
"ADDRESS_COUNTRY_CODE": null,
"ADDRESS_LOC_ADDR_ID": "22",
"UTM_SOURCE": null,
"UTM_MEDIUM": null,
"UTM_CAMPAIGN": null,
"UTM_CONTENT": null,
"UTM_TERM": null,
"LAST_ACTIVITY_BY": "1",
"LAST_ACTIVITY_TIME": "2024-08-22T17:00:19+00:00"
},
{
"ID": "14",
"TITLE": "Мегаклиент",
"HONORIFIC": null,
"NAME": "Иван",
"SECOND_NAME": null,
"LAST_NAME": "Иванов",
"COMPANY_TITLE": null,
"COMPANY_ID": null,
"CONTACT_ID": "14",
"IS_RETURN_CUSTOMER": "N",
"BIRTHDATE": "",
"SOURCE_ID": null,
"SOURCE_DESCRIPTION": null,
"STATUS_ID": "CONVERTED",
"STATUS_DESCRIPTION": null,
"POST": null,
"COMMENTS": null,
"CURRENCY_ID": "BYN",
"OPPORTUNITY": "0.00",
"IS_MANUAL_OPPORTUNITY": "N",
"HAS_PHONE": "Y",
"HAS_EMAIL": "Y",
"HAS_IMOL": "N",
"ASSIGNED_BY_ID": "1",
"CREATED_BY_ID": "1",
"MODIFY_BY_ID": "1",
"DATE_CREATE": "2024-08-22T17:00:20+00:00",
"DATE_MODIFY": "2024-08-22T17:00:20+00:00",
"DATE_CLOSED": "2024-08-22T17:00:20+00:00",
"STATUS_SEMANTIC_ID": "S",
"OPENED": "N",
"ORIGINATOR_ID": null,
"ORIGIN_ID": null,
"MOVED_BY_ID": "1",
"MOVED_TIME": "2024-08-22T17:00:20+00:00",
"ADDRESS": "ул. Пушкина, д. 10",
"ADDRESS_2": null,
"ADDRESS_CITY": null,
"ADDRESS_POSTAL_CODE": null,
"ADDRESS_REGION": null,
"ADDRESS_PROVINCE": null,
"ADDRESS_COUNTRY": "Россия",
"ADDRESS_COUNTRY_CODE": null,
"ADDRESS_LOC_ADDR_ID": "26",
"UTM_SOURCE": null,
"UTM_MEDIUM": null,
"UTM_CAMPAIGN": null,
"UTM_CONTENT": null,
"UTM_TERM": null,
"LAST_ACTIVITY_BY": "1",
"LAST_ACTIVITY_TIME": "2024-08-22T17:00:20+00:00"
},
{
"ID": "16",
"TITLE": "Мегаклиент",
"HONORIFIC": null,
"NAME": "Петр",
"SECOND_NAME": null,
"LAST_NAME": "Петров",
"COMPANY_TITLE": null,
"COMPANY_ID": null,
"CONTACT_ID": "16",
"IS_RETURN_CUSTOMER": "N",
"BIRTHDATE": "",
"SOURCE_ID": null,
"SOURCE_DESCRIPTION": null,
"STATUS_ID": "CONVERTED",
"STATUS_DESCRIPTION": null,
"POST": null,
"COMMENTS": null,
"CURRENCY_ID": "BYN",
"OPPORTUNITY": "0.00",
"IS_MANUAL_OPPORTUNITY": "N",
"HAS_PHONE": "Y",
"HAS_EMAIL": "Y",
"HAS_IMOL": "N",
"ASSIGNED_BY_ID": "1",
"CREATED_BY_ID": "1",
"MODIFY_BY_ID": "1",
"DATE_CREATE": "2024-08-22T17:01:03+00:00",
"DATE_MODIFY": "2024-08-22T17:01:03+00:00",
"DATE_CLOSED": "2024-08-22T17:01:03+00:00",
"STATUS_SEMANTIC_ID": "S",
"OPENED": "N",
"ORIGINATOR_ID": null,
"ORIGIN_ID": null,
"MOVED_BY_ID": "1",
"MOVED_TIME": "2024-08-22T17:01:03+00:00",
"ADDRESS": "ул. Пушкина, д. 10",
"ADDRESS_2": null,
"ADDRESS_CITY": null,
"ADDRESS_POSTAL_CODE": null,
"ADDRESS_REGION": null,
"ADDRESS_PROVINCE": null,
"ADDRESS_COUNTRY": "Россия",
"ADDRESS_COUNTRY_CODE": null,
"ADDRESS_LOC_ADDR_ID": "30",
"UTM_SOURCE": null,
"UTM_MEDIUM": null,
"UTM_CAMPAIGN": null,
"UTM_CONTENT": null,
"UTM_TERM": null,
"LAST_ACTIVITY_BY": "1",
"LAST_ACTIVITY_TIME": "2024-08-22T17:01:03+00:00"
},
{
"ID": "18",
"TITLE": "Мегаклиент",
"HONORIFIC": null,
"NAME": "Иван",
"SECOND_NAME": null,
"LAST_NAME": "Иванов",
"COMPANY_TITLE": null,
"COMPANY_ID": null,
"CONTACT_ID": "18",
"IS_RETURN_CUSTOMER": "N",
"BIRTHDATE": "",
"SOURCE_ID": null,
"SOURCE_DESCRIPTION": null,
"STATUS_ID": "CONVERTED",
"STATUS_DESCRIPTION": null,
"POST": null,
"COMMENTS": null,
"CURRENCY_ID": "BYN",
"OPPORTUNITY": "0.00",
"IS_MANUAL_OPPORTUNITY": "N",
"HAS_PHONE": "Y",
"HAS_EMAIL": "Y",
"HAS_IMOL": "N",
"ASSIGNED_BY_ID": "1",
"CREATED_BY_ID": "1",
"MODIFY_BY_ID": "1",
"DATE_CREATE": "2024-08-22T17:01:03+00:00",
"DATE_MODIFY": "2024-08-22T17:01:04+00:00",
"DATE_CLOSED": "2024-08-22T17:01:04+00:00",
"STATUS_SEMANTIC_ID": "S",
"OPENED": "N",
"ORIGINATOR_ID": null,
"ORIGIN_ID": null,
"MOVED_BY_ID": "1",
"MOVED_TIME": "2024-08-22T17:01:04+00:00",
"ADDRESS": "ул. Пушкина, д. 10",
"ADDRESS_2": null,
"ADDRESS_CITY": null,
"ADDRESS_POSTAL_CODE": null,
"ADDRESS_REGION": null,
"ADDRESS_PROVINCE": null,
"ADDRESS_COUNTRY": "Россия",
"ADDRESS_COUNTRY_CODE": null,
"ADDRESS_LOC_ADDR_ID": "34",
"UTM_SOURCE": null,
"UTM_MEDIUM": null,
"UTM_CAMPAIGN": null,
"UTM_CONTENT": null,
"UTM_TERM": null,
"LAST_ACTIVITY_BY": "1",
"LAST_ACTIVITY_TIME": "2024-08-22T17:01:03+00:00"
},
{
"ID": "22",
"TITLE": "Мегаклиент",
"HONORIFIC": null,
"NAME": "Иван",
"SECOND_NAME": null,
"LAST_NAME": "Иванов",
"COMPANY_TITLE": null,
"COMPANY_ID": null,
"CONTACT_ID": "22",
"IS_RETURN_CUSTOMER": "N",
"BIRTHDATE": "",
"SOURCE_ID": null,
"SOURCE_DESCRIPTION": null,
"STATUS_ID": "CONVERTED",
"STATUS_DESCRIPTION": null,
"POST": null,
"COMMENTS": null,
"CURRENCY_ID": "BYN",
"OPPORTUNITY": "0.00",
"IS_MANUAL_OPPORTUNITY": "N",
"HAS_PHONE": "Y",
"HAS_EMAIL": "Y",
"HAS_IMOL": "N",
"ASSIGNED_BY_ID": "1",
"CREATED_BY_ID": "1",
"MODIFY_BY_ID": "1",
"DATE_CREATE": "2024-08-22T17:01:39+00:00",
"DATE_MODIFY": "2024-08-22T17:01:40+00:00",
"DATE_CLOSED": "2024-08-22T17:01:40+00:00",
"STATUS_SEMANTIC_ID": "S",
"OPENED": "N",
"ORIGINATOR_ID": null,
"ORIGIN_ID": null,
"MOVED_BY_ID": "1",
"MOVED_TIME": "2024-08-22T17:01:40+00:00",
"ADDRESS": "ул. Пушкина, д. 10",
"ADDRESS_2": null,
"ADDRESS_CITY": null,
"ADDRESS_POSTAL_CODE": null,
"ADDRESS_REGION": null,
"ADDRESS_PROVINCE": null,
"ADDRESS_COUNTRY": "Россия",
"ADDRESS_COUNTRY_CODE": null,
"ADDRESS_LOC_ADDR_ID": "42",
"UTM_SOURCE": null,
"UTM_MEDIUM": null,
"UTM_CAMPAIGN": null,
"UTM_CONTENT": null,
"UTM_TERM": null,
"LAST_ACTIVITY_BY": "1",
"LAST_ACTIVITY_TIME": "2024-08-22T17:01:39+00:00"
}
],
"total": 7,
"time": {
"start": 1724348720.37208,
"finish": 1724348720.53316,
"duration": 0.161087989807129,
"processing": 0.13583493232727,
"date_start": "2024-08-22T17:45:20+00:00",
"date_finish": "2024-08-22T17:45:20+00:00",
"operating_reset_at": 1724349320,
"operating": 0.135812044143677
}
}