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

crm.contact.fields

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

crm.contact.fields()

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

Параметры

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

Пример

	BX24.callMethod(
			"crm.contact.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_IDS Привязка контакта к нескольким компаниям.crm_companyМножественное.
В методах crm.contact.update и crm.contact.add используется для подачи массива компаний. В методах crm.contact.list и crm.contact.get поля нет и необходимо использовать crm.contact.company.items.get для получения списка компаний.
CREATED_BY_ID Кем созданаuserТолько для чтения.
DATE_CREATE Дата созданияdatetimeТолько для чтения.
DATE_MODIFY Дата измененияdatetimeТолько для чтения.
EMAIL Адрес электронной почтыcrm_multifieldМножественное.
EXPORT Участвует ли контакт в экспорте. Eсли N, то выгрузить его невозможно.charЗащита от сотрудников, которые хотят украсть базу клиентов.
FACE_ID Привязка к лицам из модуля faceidinteger
HAS_EMAIL Проверка заполненности поля электронной почтыcharТолько для чтения.
HAS_PHONE Проверка заполненности поля телефонcharТолько для чтения.
HONORIFIC Вид обращенияcrm_statusВсе поля типа crm_status должны содержать значения из справочника. Значения можно получить, вызвав crm.status.list.
ID Идентификатор контакта integerТолько для чтения.
IM Мессенджерыcrm_multifieldМножественное.
LAST_NAME ФамилияstringОбязательное.
LEAD_ID Идентификатор лида, связанного с контактомcrm_leadТолько для чтения.
MODIFY_BY_ID Идентификатор автора последнего измененияuserТолько для чтения.
NAME ИмяstringОбязательное.
OPENED Доступен для всехchar
ORIGINATOR_ID Идентификатор источника данныхstringИспользуется только для привязки к внешнему источнику.
ORIGIN_ID Идентификатор элемента в источнике данныхstringИспользуется только для привязки к внешнему источнику.
ORIGIN_VERSION Оригинальная версияstringИспользуется для защиты данных от случайного перетирания внешней системой. Если данные были импортированы и не изменялись во внешней системе, то такие данные могут быть редактированы в CRM без опасения, что следующая выгрузка приведет к перетиранию данных.
PHONE Телефон контактаcrm_multifieldМножественное.
PHOTO Фото контактаfile
POST Должностьstring
SECOND_NAME ОтчествоstringОбязательное.
SOURCE_DESCRIPTION Описание источникаstringТекстовое поле.
SOURCE_ID Идентификатор источникаcrm_statusСтатус из справочника. Список возможных идентификаторов можно получить методом crm.status.list с фильтром filter[ENTITY_ID]=SOURCE.
TYPE_ID Идентификатор типаcrm_statusВсе поля типа crm_status должны содержать значения из справочника. Значения можно получить, вызвав crm.status.list.
UTM_CAMPAIGN Обозначение рекламной кампанииstring
UTM_CONTENT Содержание кампанииstringНапример, для контекстных объявлений.
UTM_MEDIUM Тип трафикаstringCPC (объявления), CPM (баннеры).
UTM_SOURCE Рекламная системаstringYandex-Direct, Google-Adwords и другие.
UTM_TERM Условие поиска кампанииstringНапример, ключевые слова контекстной рекламы.
WEB URL ресурсов контактаcrm_multifieldМножественное.


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