index.md

Контакты в CRM: обзор методов

Контакт — объект CRM, в котором хранятся данные клиентов — физических лиц. В карточке контакта находятся телефоны, электронные адреса, идентификаторы мессенджеров в специальном формате, позволяющем использовать их для коммуникации с клиентом сразу через Битрикс.

Быстрый переход: все методы и события

Пользовательская документация: контакты в Битрикс24

Связь контакта с другими объектами CRM

Сделка, лид, смарт-процесс. У любого объекта CRM, в котором доступно стандартное поле Клиент, есть связь с контактами. Изменение связи регулируется через группы методов сделок, лидов, смарт-процессов.

Компания. Один контакт может быть привязан к нескольким компаниям. Для управления этой связью используется группа методов crm.contact.company.*. Когда вы выбираете компанию в поле Клиент в сделках или смарт-процессах, все связанные с ней контакты подтягиваются в поле автоматически.

Реквизиты. Сами реквизиты это отдельный объект, для их создания или изменения используются методы группы crm.requisite.* и crm.address.*. В карточке контакта они выводятся в поле Реквизиты.

{% note tip "Пользовательская документация" %}

• Связь между сделками, контактами и компаниями
• Связи реквизитов с объектами CRM
• Изменения в работе с адресами и реквизитами в CRM

{% endnote %}

Карточка контакта

Основное рабочее пространство в контакте — это вкладка Общее его карточки. Она состоит из двух частей:

• левая, в ней располагаются поля с информацией. Если системных полей недостаточно, вы можете создать собственные пользовательские поля. Они позволяют хранить информацию в различных форматах данных: строка, число, ссылка, адрес и другие. Для создания, изменения, получения или удаления пользовательских полей контактов используется группа методов crm.contact.userfield.*

• правая, в ней располагается таймлайн контакта. В нем можно создавать, редактировать, фильтровать, удалять дела CRM — группа методов crm.activity.*, и записи таймлайна — группа методов crm.timeline.*

Параметрами карточки контакта можно управлять через группу методов crm.contact.details.configuration.*.

{% note tip "Пользовательская документация" %}

• Карточка CRM: возможности и настройки
• Системные поля в CRM
• Пользовательские поля в CRM
• Таймлайн в элементе CRM

{% endnote %}

Виджеты

В карточку контакта можно встроить приложение. Благодаря встраиванию можно будет использовать приложение и не покидать карточку контакта.

Есть два сценария встройки:

• Использовать специальные места встраивания. Например, через создание своей вкладки
• Создать пользовательское поле, в которое будет загружается интерфейс вашего приложения

{% note tip "Частые кейсы и сценарии" %}

• Механизм встройки виджетов
• Встроить виджет в карточку CRM

{% endnote %}

Обзор методов и событий {#all-methods}

Scope: crm

Кто может выполнять методы: в зависимости от метода

Основные

{% list tabs %}

• Методы

  #| || Метод | Описание || || crm.contact.add | Создает новый контакт || || crm.contact.update | Обновляет существующий контакт || || crm.contact.get | Возвращает контакт по идентификатору || || crm.contact.list | Возвращает список контактов по фильтру || || crm.contact.delete | Удаляет контакт и все связанные с ним объекты || || crm.contact.fields | Возвращает описание полей контакта, в том числе пользовательских || |#

• События

  #| || Событие | Вызывается || || onCrmContactAdd | При создании контакта || || onCrmContactUpdate | При изменении контакта || || onCrmContactDelete | При удалении контакта || |#

{% endlist %}

Компании

#| || Метод | Описание || || crm.contact.company.add | Добавляет компанию к указанному контакту || || crm.contact.company.items.get | Получает набор компаний, связанных с указанным контактом || || crm.contact.company.items.set | Устанавливает набор компаний, связанных с указанным контактом || || crm.contact.company.delete | Удаляет компанию из указанного контакта || || crm.contact.company.items.delete | Очищает набор компаний, связанных с указанным контактом || || crm.contact.company.fields | Возвращает описание полей для связи контакт-компания || |#

Пользовательские поля

{% list tabs %}

• Методы

  #| || Метод | Описание || || crm.contact.userfield.add | Создает пользовательское поле для контактов || || crm.contact.userfield.update | Изменяет существующее пользовательское поле контактов || || crm.contact.userfield.get | Возвращает пользовательское поле контактов по Id || || crm.contact.userfield.list | Возвращает список пользовательских полей контактов || || crm.contact.userfield.delete | Удаляет пользовательское поле контактов || |#

• События

  #| || Событие | Вызывается || || onCrmContactUserFieldAdd | При добавлении пользовательского поля || || onCrmContactUserFieldUpdate | При изменении пользовательского поля || || onCrmContactUserFieldDelete | При удалении пользовательского поля || || onCrmContactUserFieldSetEnumValues | При изменении набора значений для пользовательского поля списочного типа || |#

{% endlist %}

Управление карточками контактов

#| || Метод | Описание || || crm.contact.details.configuration.get | Получает настройки карточки контактов || || crm.contact.details.configuration.reset | Сбрасывает настройки карточки контактов || || crm.contact.details.configuration.set | Устанавливает настройки карточки контактов || || crm.contact.details.configuration.forceCommonScopeForAll | Позволяет принудительно установить общую карточку контактов для всех пользователей || |#