Документация для разработчиков
Документация для разработчиков Документация по D7 Документация по REST Пользовательская документация
Темная тема

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 Связано с пользователем по IDuser
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 stringNEW - Не обработан,
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 Тип трафикаstringCPC (объявления), CPM (баннеры)
UTM_SOURCE Рекламная системаstringYandex-Direct, Google-Adwords и другие.
UTM_TERM Условие поиска кампанииstringНапример, ключевые слова контекстной рекламы.
WEB URL ресурсов лидаcrm_multifieldМножественное


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

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

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

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

Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.
0
belokurov.a 16.01.2024 22:12:53
Сообщение не промодерировано, возможны ошибки и неточности.
В описание поля CONTACT_IDS указываются методы для сделок, а не лидов. По крайне мере метод для поиска связанных контактов достаточно заменить deal на lead в названии метода.
6
Александр Князев 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'=>'Другое',
);
© «Битрикс», 2001-2024, «1С-Битрикс», 2024
Наверх