Полезные кастомизации itgrix_bx (Битрикс24) [С историей]
Начиная с версии 3.0.0.
Last updated
Начиная с версии 3.0.0.
Last updated
Дополнительные кастомизации описаны в разделе Полезные кастомизации (любая CRM).
Звонки регистрируются через API телефонии Битрикс24, что позволяет использовать сквозную аналитику.
По сравнению кастомизациями в версиях 2.15.0–2.15.6:
Выделена кастомизация need_registration
, в которой можно реализовать черные и белые списки.
Разделена кастомизация process_phone_number
на два метода:
process_user_phone
– кастомизация внутреннего номера пользователя;
process_client_phone
– кастомизация номера клиента.
Кастомизация get_updated_entity_fields
переименована в customize_entity
.
Кастомизация get_updated_activity_fields
переименована в customize_activity
.
(Схема для версий начиная с 3.10.0)
“Сущность” – это контакт или лид. Запрос разговора – это начало звонка на внутреннем номере. В одном звонке может быть несколько разговоров (в случае перевода звонка).
Обновление полей дела в конце звонка.
Если настроено прикрепление ссылки на запись вместо самой записи, ссылка добавляется в описание дела.
Начиная с версии 3.10.0 при прикреплении ссылки на запись звонка добавлена отдельная кастомизация customize_attach_record_url, которая запускается ДО кастомизации дела.
Примеры: Обновление полей дела.
Вход:
Набор данных о разговоре (conversation) описан в статье Параметры звонка (call) и разговора (conversation) в кастомизациях.
В версии 3.10.0 добавлен полный набор данных о звонке (call_full
): Данные о звонке (call_full) в кастомизациях.
В объекте raw
присутствуют только поля с непустым/ненулевым значением.
Вернуть:
Подробное описание полей дела в документации REST API Битрикс24.
Примеры: Обновление полей сущности.
Вход:
Набор данных о звонке (call) описан в статье Параметры звонка (call) и разговора (conversation) в кастомизациях.
В версии 3.10.0 добавлен полный набор данных о звонке (call_full
): Данные о звонке (call_full) в кастомизациях.
Формат данных сущности в поле entity
описан в соответствующем разделе статьи Данные о звонке (call_full) в кастомизациях.
Вернуть:
Подробное описание полей лида в документации REST API Битрикс24. Подробное описание полей контакта в документации REST API Битрикс24.
Используется для реализации функционала чёрных/белых список по номерам, транкам и прочим более сложным условиям.
Начиная с версии 3.0.7 настройка черного/белого списка для внутренних номеров доступна сразу из админки (интерфейса настройки) модуля.
Примеры: Черный/белый список для транков.
Вход:
Набор данных о разговоре (conversation) описан в статье Параметры звонка (call) и разговора (conversation) в кастомизациях.
В версии 3.10.0 добавлена стадия звонка (call_stage
) и полный набор данных о звонке (call_full
): Данные о звонке (call_full) в кастомизациях.
Вернуть:
Преобразование телефонных номеров клиентов перед отправкой запросов в Битрикс24.
Начиная с версии 3.0.0 кастомизация номера разделена на две:
process_user_phone – кастомизация внутреннего номера пользователя;
process_client_phone – кастомизация номера клиента.
Начиная с версии 3.7.0 доступна автозамена номеров, она запускается ДО выполнения кастомизации.
Примеры в статье Изменение номера телефона перед отправкой данных в CRM.
Вход:
В версии 3.10.0 добавлена стадия звонка (call_stage
) и полный набор данных о звонке (call_full
): Данные о звонке (call_full) в кастомизациях.
Вернуть:
Кастомизация параметров завершения регистрации звонка.
Примеры: Разные ответственные за пропущенные за разные транки.
Черные/белые списки начиная с версии 2.15.0 настраиваются в кастомизации need_registration.
Начиная с версии 3.0.7 настройка черного/белого списка для внутренних номеров доступна сразу из админки (интерфейса настройки) модуля.
Подробнее в статье Черные и белые списки. Как настроить?
Вход:
Статусы звонка в Битрикс24 описаны в статье Детальные статусы звонка.
Набор данных о звонке (call) описан в статье Параметры звонка (call) и разговора (conversation) в кастомизациях.
В версии 3.10.0 добавлен полный набор данных о звонке (call_full
): Данные о звонке (call_full) в кастомизациях.
Вернуть:
Подробное описание параметров завершения звонка в документации REST API Битрикс24.
Изменение параметров при инициализации звонка из Битрикс24.
Подробное описание с примерами в статье Изменение параметров при click-to-call.
Преобразование пути до файла записи разговора.
Подробное описание с примерами в статье Кастомизация имени файла аудиозаписи.
При установке Itgrix_bx по умолчанию уже включена конвертация файлов записей разговоров в формат mp3 перед отправкой в Битрикс24. Это позволяет вам:
Сэкономить место на диске Битрикс24 (mp3 занимает меньше, чем wav);
Прослушивать записи при помощи встроенного в CRM плеера.
Поскольку конвертация записей может занимать значительное время, у этой кастомизации особый, фиксированный таймаут 10 секунд, который не зависит от настроек кастомизаций. Если запись не успеет сконвертироваться до истечения таймаута, будет использован исходный файл.
Используется для кастомизации параметров регистрации начала звонка.
Примеры:
Вход:
Набор данных о разговоре (conversation) описан в статье Параметры звонка (call) и разговора (conversation) в кастомизациях.
В версии 3.10.0 добавлен полный набор данных о звонке (call_full
): Данные о звонке (call_full) в кастомизациях.
Номера внешних линий в Битрикс24 (LINE_NUMBER
) соответствуют транкам в настройках коннектора Itgrix.
Коннектор регистрирует номера транков как внешние линии в Битрикс24 при запуске, при этом каждой линии можно задать название в настройках.
В версии 3.10.0 показ карточки звонка вынесен в отдельный запрос, и кастомизируется отдельной кастомизацией customize_show_call_card, поэтому параметр SHOW
всегда равен 0
.
Это связано с тем, что теперь можно настроить, показывать карточку звонка в момент дозвона или при ответе.
Вернуть:
Подробное описание параметров регистрации звонка в документации REST API Битрикс24.
Кастомизация параметров создания задачи (при пропущенном входящем звонке или неотвеченном исходящем).
Данная кастомизация работает, только если создание задач включено в настройках коннектора: Настройка задачи по пропущенному через админку.
При этом сначала применяются настройки, описанные в статье, а затем выполняется данная кастомизация.
Пример: Кастомизация задач по пропущенным звонкам (начиная с версии 3.4.0 это можно делать через веб-интерфейс настройки модуля).
Вход:
В версии 2.15.0 добавлен блок данных о разговоре (conversation
). Набор данных о разговоре (conversation) описан в статье Параметры звонка (call) и разговора (conversation) в кастомизациях.
В версии 3.10.0 добавлен полный набор данных о звонке (call_full
): Данные о звонке (call_full) в кастомизациях.
Вернуть:
Подробное описание полей задачи в документации REST API Битрикс24.
Изменение номера пользователя перед поиском пользователя Битрикс24.
Начиная с версии 3.0.0 кастомизация номера разделена на две:
process_user_phone – кастомизация внутреннего номера пользователя;
process_client_phone – кастомизация номера клиента.
Начиная с версии 3.7.0 доступна автозамена номеров, она запускается ДО выполнения кастомизации.
Пример: Несколько внутренних номеров у сотрудника.
Вход:
В версии 3.10.0 добавлена стадия звонка (call_stage
) и полный набор данных о звонке (call_full
): Данные о звонке (call_full) в кастомизациях.
Вернуть:
Вход:
Вернуть:
name
- текст который появится в CallerID и будет отображен в телефоне (или софтфоне) оператора.
Должен быть не более 20 символов (ограничение Asterisk)!
Поля from
, user
, entity
и error
- только для чтения и присутствуют только когда не пустые.
Они будут автоматически удалены, даже если вернуть их в объекте data
.
Кастомизация добавлена в версии 3.10.0.
Данная кастомизация дает возможность выполнить какие-либо действия после регистрации звонка.
Может быть вызвана в разные моменты в зависимости от типа звонка:
Для звонков кликом (click-to-call, c2c) кастомизация будет вызвана в начале обработки стадии Запрос разговора (Conversation requested).
При звонках кликом Битрикс24 сам регистрирует звонок в момент клика и передает данные о регистрации коннектору, т.е. ещё до инициализации звонка в Asterisk.
Поэтому звонки кликом коннектор сам НЕ регистрирует, а только заканчивает как и все остальные звонки.
Пропущенные звонки на IVR регистрируются и завершаются на стадии Завершение звонка (Call ended).
Для всех остальных звонков кастомизация будет вызвана после выполнения запроса регистрации звонка в Битрикс24 на стадии Запрос разговора (Conversation requested).
Вход:
Полный набор данных о звонке описан в статье Данные о звонке (call_full) в кастомизациях.
Вернуть:
Нужно вернуть только state
, остальное игнорируется:
Кастомизация добавлена в версии 3.10.0.
Используется для кастомизации параметров отображения карточки звонка.
Вход:
Полный набор данных о звонке описан в статье Данные о звонке (call_full) в кастомизациях.
Вернуть:
Подробное описание параметров показа карточки в документации REST API Битрикс24.
Кастомизация добавлена в версии 3.10.0.
Кастомизация прикрепления ссылки на запись звонка. Запускается только если настроено прикрепление ссылки на запись вместо файла записи звонка.
По умолчанию в описание дела записывается HTML-код аудиоплеера (тег audio
) со ссылкой на запись звонка.
Вход:
Полный набор данных о звонке описан в статье Данные о звонке (call_full) в кастомизациях.
В объекте raw
присутствуют только поля с непустым/ненулевым значением.
Вернуть:
Подробное описание полей дела в документации REST API Битрикс24.