crm.lead.fields

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

crm.lead.fields()

Возвращает описание полей лида, в том числе пользовательских.

Параметры

Без параметров.

Пример

BX24.callMethod(
	"crm.lead.fields", 
	{}, 
	function(result) 
	{
		if(result.error())
			console.error(result.error());
		else
			console.dir(result.data());
	}
);

Поля

Поле	Описание	Тип	Примечание
ADDRESS	Адрес контакта	string
ADDRESS_2	Вторая страница адреса	string	В некоторых странах принято разбивать адрес на 2 части
ADDRESS_CITY	Город	string
ADDRESS_COUNTRY	Страна	string
ADDRESS_COUNTRY_CODE	Код страны	string
ADDRESS_POSTAL_CODE	Почтовый индекс	string
ADDRESS_PROVINCE	Область	string
ADDRESS_REGION	Район	string
ASSIGNED_BY_ID	Связано с пользователем по ID	user
BIRTHDATE	Дата рождения	date
COMMENTS	Комментарии	string
COMPANY_ID	Привязка лида к компании	crm_company
COMPANY_TITLE	Название компании, привязанной к лиду	crm_company
CONTACT_ID	Привязка лида к контакту	crm_contact
CONTACT_IDS	Идентификатор привязанного контакта	crm_contact	Множественный. При использовании crm.deal.update и crm.deal.add можно подать массив контактов. В методах crm.deal.list и crm.deal.get поля нет и необходимо использовать crm.deal.contact.items.get для получения списка контактов. Для очистки поля используйте crm.deal.contact.items.delete, для замены значения используйте crm.deal.contact.items.set.
CREATED_BY_ID	Кем создана	user	Только для чтения
CURRENCY_ID	Идентификатор валюты	crm_currency
DATE_CLOSED	Дата закрытия	datetime	Только для чтения
DATE_CREATE	Дата создания	datetime	Только для чтения
DATE_MODIFY	Дата изменения	datetime	Только для чтения
EMAIL	Адрес электронной почты	crm_multifield	Множественное
HAS_EMAIL	Проверка заполненности поля электронной почты	char	Только для чтения
HAS_PHONE	Проверка заполненности поля телефон	char	Только для чтения
HONORIFIC	Вид обращения	crm_status
ID	Идентификатор контакта	integer	Только для чтения
IM	Мессенджеры	crm_multifield	Множественное
IS_RETURN_CUSTOMER	Признак повторного лида	char	Только для чтения
LAST_NAME	Фамилия	string	Обязательноcть настраиваемая.
MODIFY_BY_ID	Идентификатор автора последнего изменения	user	Только для чтения
MOVED_BY_ID	Идентификатор автора перемещения элемента на текущую стадию	user	Только для чтения
MOVED_TIME	Дата перемещения элемента на текущую стадию	user	Только для чтения
NAME	Имя	string	Обязательноcть настраиваемая.
OPENED	Доступен для всех	char
OPPORTUNITY	Предполагаемая сумма	double
ORIGINATOR_ID	Идентификатор источника данных	string	Используется только для привязки к внешнему источнику.
ORIGIN_ID	Идентификатор элемента в источнике данных	string	Используется только для привязки к внешнему источнику.
ORIGIN_VERSION	Оригинальная версия	string	Используется для защиты данных от случайного перетирания внешней системой. Если данные были импортированы и не изменялись во внешней системе, то такие данные могут быть редактированы в CRM без опасения, что следующая выгрузка приведет к перетиранию данных
PHONE	Телефон контакта	crm_multifield	Множественное
POST	Должность	string
SECOND_NAME	Отчество	string	Обязательноcть настраиваемая.
SOURCE_DESCRIPTION	Описание источника	string
SOURCE_ID	Идентификатор источника	crm_status	Статус из справочника. Список возможных идентификаторов можно получить методом crm.status.list с фильтром `filter[ENTITY_ID]=SOURCE`
STATUS_DESCRIPTION		string
STATUS_ID		string	NEW - Не обработан, IN_PROCESS – В работе PROCESSED – Обработан JUNK – Некачественный лид CONVERTED – Качественный лид
STATUS_SEMANTIC_ID		string	F (failed) – обработан неуспешно, S (success) – обработан успешно, P (processing) – лид в обработке.
TITLE	Название лида	string	Обязательное
UTM_CAMPAIGN	Обозначение рекламной кампании	string
UTM_CONTENT	Содержание кампании	string	Например, для контекстных объявлений.
UTM_MEDIUM	Тип трафика	string	CPC (объявления), CPM (баннеры)
UTM_SOURCE	Рекламная система	string	Yandex-Direct, Google-Adwords и другие.
UTM_TERM	Условие поиска кампании	string	Например, ключевые слова контекстной рекламы.
WEB	URL ресурсов лида	crm_multifield	Множественное

Пользовательские комментарии

Мы будем рады, если разработчики добавят свои комментарии по практическому использованию методов системы.

Для этого нужно всего лишь авторизоваться на сайте

Но помните, что Пользовательские комментарии, несмотря на модерацию, не являются официальной документацией. Ответственность за их использование несет сам пользователь.

Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.

0 belokurov.a 16.01.2024 22:12:53 Сообщение не промодерировано, возможны ошибки и неточности.
В описание поля CONTACT_IDS указываются методы для сделок, а не лидов. По крайне мере метод для поиска связанных контактов достаточно заменить deal на lead в названии метода.

Александр Князев 21.12.2022 12:20:04

Если кому интересны стандартные идентификаторы источников на конец 2022ого года (массив php):

Код

$sources= array(
   'CALL'=>'Звонок',
   'EMAIL'=>'Электронная почта',
   'WEB'=>'Веб-сайт',
   'ADVERTISING'=>'Реклама',
   'PARTNER'=>'Существующий клиент',
   'RECOMMENDATION'=>'По рекомендации',
   'TRADE_SHOW'=>'Выставка',
   'WEBFORM'=>'CRM-форма',
   'CALLBACK'=>'Обратный звонок',
   'RC_GENERATOR'=>'Генератор продаж',
   'STORE'=>'Интернет-магазин',
   'OTHER'=>'Другое',
);