Контакты в CRM: обзор методов
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Контакт — объект CRM, в котором хранятся данные клиентов — физических лиц. В карточке контакта находятся телефоны, электронные адреса, идентификаторы мессенджеров в специальном формате, позволяющем использовать их для коммуникации с клиентом сразу через Битрикс24.
Развитие методов crm.contact.* и crm.contact.details.configuration.* остановлено. Для новой разработки используйте универсальные методы crm.item.* с entityTypeId = 3. Методы связи с компаниями crm.contact.company.* и пользовательских полей crm.contact.userfield.* продолжают работать.
Быстрый переход: все методы и события
Пользовательская документация: контакты в Битрикс24
Актуальная версия API
Контакт — один из типов объектов CRM, поэтому им управляют универсальные методы crm.item.* с entityTypeId = 3. Методы crm.contact.* продолжают работать, оставляйте их только в существующих интеграциях.
|
Метод с остановленным развитием |
Чем заменить |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
У групп методов crm.contact.company.* и crm.contact.userfield.* замены нет, они актуальны.
Имена полей в двух группах методов различаются: crm.contact.* принимает и возвращает поля в формате UPPER_CASE, например LAST_NAME, а crm.item.* — в формате camelCase, например lastName. Точный состав полей возвращает метод crm.item.fields с entityTypeId = 3.
Как начать работу
- Получите описание полей контакта методом crm.contact.fields — он вернет системные и пользовательские поля с их типами.
- Создайте контакт методом crm.contact.add. Заполните
NAMEилиLAST_NAME: если оба поля пустые, метод вернет ошибку. Телефоны и почту передавайте множественными полямиPHONEиEMAIL— это массивы объектов с ключамиVALUEиVALUE_TYPE. - Свяжите контакт с компаниями группой методов crm.contact.company.*, если клиент представляет несколько компаний.
- Найдите нужные контакты методом crm.contact.list: он принимает
filter,orderиselect, а выдачу отдает страницами по 50 записей. - Ведите коммуникацию с клиентом в карточке контакта — делами crm.activity.* и записями таймлайна crm.timeline.*.
- Подпишитесь на события контакта, чтобы получать уведомления об изменениях в приложение.
Связь контакта с другими объектами CRM
Сделка, лид, смарт-процесс. У любого объекта CRM, в котором доступно стандартное поле Клиент, есть связь с контактами. Изменение связи регулируется через группы методов сделок, лидов, смарт-процессов.
Компания. Один контакт может быть привязан к нескольким компаниям. Для управления этой связью используется группа методов crm.contact.company.*. Когда вы выбираете компанию в поле Клиент в сделках или смарт-процессах, все связанные с ней контакты подтягиваются в поле автоматически.
Реквизиты. Сами реквизиты это отдельный объект, для их создания или изменения используются методы группы crm.requisite.* и crm.address.*. В карточке контакта они выводятся в поле Реквизиты.
Пользовательская документация
Карточка контакта
Основное рабочее пространство в контакте — это вкладка Общее его карточки. Она состоит из двух частей:
-
левая, в ней располагаются поля с информацией. Если системных полей недостаточно, вы можете создать собственные пользовательские поля. Они позволяют хранить информацию в различных форматах данных: строка, число, ссылка, адрес и другие. Для создания, изменения, получения или удаления пользовательских полей контактов используется группа методов crm.contact.userfield.*
-
правая, в ней располагается таймлайн контакта. В нем можно создавать, редактировать, фильтровать, удалять дела CRM — группа методов crm.activity.*, и записи таймлайна — группа методов crm.timeline.*
Параметрами карточки контакта можно управлять через группу методов crm.contact.details.configuration.*.
Пользовательская документация
Виджеты
В карточку контакта можно встроить приложение и работать с ним, не покидая карточку.
Есть два сценария встройки:
- использовать специальные места встраивания, например создать свою вкладку
- создать пользовательское поле, в которое загружается интерфейс вашего приложения
Частые кейсы и сценарии
Обзор методов и событий
Scope:
crmКто может выполнять метод: в зависимости от метода — методы контактов и связи с компаниями проверяют права доступа к контактам, а создание, изменение и удаление пользовательских полей доступно только администратору CRM. Подписаться на события может любой пользователь
Основные
|
Метод |
Описание |
|
Создает новый контакт |
|
|
Обновляет существующий контакт |
|
|
Возвращает контакт по идентификатору |
|
|
Возвращает список контактов по фильтру |
|
|
Удаляет контакт и все связанные с ним объекты |
|
|
Возвращает описание полей контакта, в том числе пользовательских |
|
Событие |
Вызывается |
|
При создании контакта |
|
|
При изменении контакта |
|
|
При удалении контакта |
Компании
|
Метод |
Описание |
|
Добавляет компанию к указанному контакту |
|
|
Удаляет компанию из указанного контакта |
|
|
Возвращает набор компаний, связанных с указанным контактом |
|
|
Устанавливает набор компаний, связанных с указанным контактом |
|
|
Очищает набор компаний, связанных с указанным контактом |
|
|
Возвращает описание полей для связи контакт-компания |
Пользовательские поля
|
Метод |
Описание |
|
Создает пользовательское поле для контактов |
|
|
Изменяет существующее пользовательское поле контактов |
|
|
Возвращает пользовательское поле контактов по Id |
|
|
Возвращает список пользовательских полей контактов |
|
|
Удаляет пользовательское поле контактов |
|
Событие |
Вызывается |
|
При добавлении пользовательского поля |
|
|
При изменении пользовательского поля |
|
|
При удалении пользовательского поля |
|
|
При изменении набора значений для пользовательского поля списочного типа |
Управление карточками контактов
|
Метод |
Описание |
|
Возвращает настройки карточки контакта |
|
|
Устанавливает настройки карточки контакта |
|
|
Сбрасывает настройки карточки контакта |
|
|
Принудительно устанавливает общую карточку контакта для всех пользователей |