Дела в CRM: обзор методов

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

Дела делятся на входящие и запланированные:

  • Входящие — дела, поступившие от клиента, например письмо, звонок или чат. Для таких дел важно верно указать параметр DIRECTION = 1, чтобы сработал счетчик входящих дел CRM

  • Запланированные — дела, которые создают сотрудники, например задачи или универсальные дела. В них можно указать срок выполнения, добавить связи с элементами CRM, с календарем, пригласить коллег, прикрепить файлы

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

Пользовательская документация: дела в CRM, Направление активности

Связи дел с другими элементами CRM

Дела, связанные с элементами CRM, хранятся в таймлайне карточки элемента. Если у дела есть связь с несколькими элементами — например, письмо может быть привязано и к сделке и к контакту — оно будет храниться в таймлайнах всех связанных элементов.

Связи между делами и элементами CRM можно добавлять и удалять методами группы crm.activity.binding.*.

Системные дела

Системные дела CRM создает автоматически:

  • дело звонка создает подключенная в Битрикс телефония. Для завершения звонка используйте метод telephony.externalcall.finish. Метод завершает звонок, создает дело в карточке элемента, и возвращает ID созданного дела в параметре CRM_ACTIVITY_ID

  • дело письма создает почта. Когда на подключенный в Битрикс24 адрес приходит письмо от клиента, CRM проверяет, существует ли в базе клиент с e-mail из письма. По результатам проверки будет создано дело в карточке найденного элемента или новый клиент, в карточке которого появится дело

Чтобы создать, изменить или удалить системное дело используйте группу методов crm.activity.*. При создании системного дела указывайте TYPE_ID, например для дела письма TYPE_ID = 2 . Для получения значений других типов дел используйте метод crm.enum.activitytype.

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

Приложения могут регистрировать пользовательские типы дел: загрузить собственную иконку и указать название типа. Например, можно создать свой тип дел с иконкой и названием вашего приложения.

  • Зарегистрировать тип дела — используйте методы группы crm.activity.type.*. При создании типа необходимо задать его кодовое обозначение в параметре TYPE_ID

  • Создать дело с типом приложения — используйте группу методов системных дел crm.activity.add. При создании дела укажите кодовое обозначение пользовательского типа TYPE_ID, зарегистрированного для типа дел, в параметре PROVIDER_TYPE_ID

Методы crm.activity.delete (удаляет дело) и crm.activity.list (получает список дел) общие для всех видов дел CRM.

Универсальные дела

Универсальные дела — это тип дел с расширенными настройками. В карточке универсального дела можно синхронизировать дело с календарем, выбрать место встречи с клиентом, добавить коллег, выбрать клиента из элемента CRM, разделить дела по цветам, выбрать переговорную. Расширенные настройки доступны сотруднику на стороне Битрикс24.

Для создания универсального используйте метод crm.activity.todo.add. Для изменения крайнего срока дела — метод crm.activity.todo.updateDeadline, для изменения описания дела — crm.activity.todo.updateDescription.

Пользовательская документация

Конфигурируемые дела

Конфигурируемые дела — это тип дел, создать который можно только из приложения. Для этого типа можно настроить внешний вид карточки дела и ее функционал:

Чтобы создать или изменить конфигурируемое дело, используйте группу методов crm.activity.configurable.*.

Виджеты

В дела можно встраивать приложения. Для встроек используют специальные места, в делах доступно одно — Пункт контекстного меню дела в карточке элемента CRM_XXX_ACTIVITY_TIMELINE_MENU.

Благодаря встройке можно будет использовать приложение, не покидая карточку элемента. Приложение будет открываться на той странице, которую вы укажете при регистрации встройки.

Дополнительные возможности

Текстовые заметки можно добавлять к делам и удалять их. Используйте группу методов crm.timeline.note.*.

Контентные блоки можно добавлять к делам и удалять их. Используйте группу методов crm.activity.layout.blocks.*.

Обзор методов и событий

Scope: crm

Кто может выполнять методы: любой пользователь

Общие методы и события

Метод

Описание

crm.activity.add

Создает новое дело

crm.activity.update

Обновляет дело

crm.activity.get

Возвращает дело по идентификатору

crm.activity.list

Возвращает список дел всех типов по фильтру

crm.activity.delete

Удаляет любой тип дел

crm.activity.fields

Возвращает описание полей дел

crm.activity.communication.fields

Возвращает описание полей коммуникации

Событие

Вызывается

onCrmActivityAdd

При создании дела

onCrmActivityUpdate

При обновлении дела

onCrmActivityDelete

При удалении дела

Управление связями дел

Метод

Описание

crm.activity.binding.add

Добавляет привязку

crm.activity.binding.list

Возвращает список привязок

crm.activity.binding.delete

Удаляет привязку

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

Метод

Описание

crm.activity.type.add

Регистрирует пользовательский тип дела с указанием названия и иконки

crm.activity.type.list

Получает список дел

crm.activity.type.delete

Удаляет пользовательский тип

Универсальное дело

Метод

Описание

crm.activity.todo.add

Создает универсальное дело

crm.activity.todo.updateDeadline

Изменяет крайний срок

crm.activity.todo.updateDescription

Изменяет описание

Конфигурируемое дело

Метод

Описание

crm.activity.configurable.add

Добавляет новое конфигурируемое дело в таймлайн

crm.activity.configurable.update

Обновляет конфигурируемое дело

crm.activity.configurable.get

Получает информацию о деле по идентификатору

Бейджи конфигурируемого дела

Метод

Описание

crm.activity.badge.add

Создает значок

crm.activity.badge.get

Возвращает информацию о значке

crm.activity.badge.list

Возвращает список всех зарегистрированных значков

crm.activity.badge.delete

Удаляет значок

Дополнительные контентные блоки

Метод

Описание

crm.activity.layout.blocks.set

Устанавливает набор дополнительных контентных блоков в дело

crm.activity.layout.blocks.get

Получает установленный приложением набор дополнительных контентных блоков в деле

crm.activity.layout.blocks.delete

Удаляет установленный приложением набор дополнительных контентных блоков для дела

Предыдущая
Следующая