Документация для разработчиков
Темная тема

crm.lead.list

Scope: crm Права на выполнение: для всех

Возвращает список лидов по фильтру. Является реализацией списочного метода для лидов.

При выборке используйте маски:

  • "*" - для выборки всех полей (без пользовательских и множественных)
  • "UF_*"- для выборки всех пользовательских полей (без множественных)

Маски для выборки множественных полей нет. Для выборки множественных полей укажите нужные в списке выбора ("PHONE", "EMAIL" и так далее).

Внимание! Возможности добавить к фильтру логическое условие OR, если нужно выбрать по нескольким разным полям, нет.

Параметры

Cм. описание списочных методов.

Пример

// Поиск несконвертированных лидов с суммой больше нуля
BX24.callMethod(
	"crm.lead.list", 
	{ 
		order: { "STATUS_ID": "ASC" },
		filter: { ">OPPORTUNITY": 0, "!STATUS_ID": "CONVERTED" },
		select: [ "ID", "TITLE", "STATUS_ID", "OPPORTUNITY", "CURRENCY_ID" ]
	}, 
	function(result) 
	{
		if(result.error())
			console.error(result.error());
		else
		{
			console.dir(result.data());
			if(result.more())
				result.next();
		}
	}
);
// Поиск лида по телефону
BX24.callMethod(
	"crm.lead.list", 
	{ 
		filter: { "PHONE": "555888" },
		select: [ "ID", "TITLE" ]
	}, 
	function(result) 
	{
		if(result.error())
			console.error(result.error());
		else
		{
			console.dir(result.data());
			if(result.more())
				result.next();
		}
	}
);

Пример выборки лидов за месяц:

$result = CRest::call(
	'crm.lead.list',
	[
		'filter' => [
			'>DATE_CREATE' => '2019-10-01T00:00:00',
			'<DATE_CREATE' => '2019-10-31T23:59:59'
		],
		'select' => [
			'ID',
			'DATE_CREATE'
		]
	]
);

Пример вывода следующего пакета лидов.

BX24.callMethod(
	"crm.lead.list",
	{
		order: { "STATUS_ID": "ASC" },
		filter: { ">OPPORTUNITY": 0, "!STATUS_ID": "CONVERTED" },
		select: [ "ID", "TITLE", "STATUS_ID", "OPPORTUNITY", "CURRENCY_ID" ],
		start: "50"
	},
	function(result)
	{
		if(result.error())
			console.error(result.error());
		else
		{
			console.dir(result.data());
			if(result.more())
				result.next();
		}
	}
); 


© «Битрикс», 2001-2024, «1С-Битрикс», 2024