Полезные кастомизации itgrix_bx (Битрикс24)
Начиная с версии 3.0.0.
Дополнительные кастомизации описаны в разделе Полезные кастомизации (любая CRM).

Обновление кастомизаций, начиная с версии 3.0.0

Звонки регистрируются через API телефонии Битрикс24, что позволяет использовать сквозную аналитику.
  • Выделена кастомизация need_registration, в которой можно реализовать черные и белые списки.
  • Разделена кастомизация process_phone_number на два метода:
    • process_user_phone – кастомизация внутреннего номера пользователя;
    • process_client_phone – кастомизация номера клиента.
  • Кастомизация get_updated_entity_fields переименована в customize_entity.
  • Кастомизация get_updated_activity_fields переименована в customize_activity.

Схема обработки звонка модулем интеграции Itgrix

(Схема для версий начиная с 3.0.0)
“Сущность” – это контакт или лид. Запрос разговора – это начало звонка на внутреннем номере. В одном звонке может быть несколько разговоров (в случае перевода звонка).

Краткое описание кастомизаций

Файл кастомизации (по алфавиту)
Описание
1
Обновление полей дела (в конце звонка).
2
Обновление полей сущности (в конце звонка).
3
Нужна ли регистрация звонка? Можно сделать черные/белые списки по внутреннему номеру/транку.
4
Изменение номера телефона перед регистрацией в CRM: Можно сменить формат телефонного номера (+7, 8...).
5
Изменение данных завершения звонка.
6
Изменение параметров при инициализации звонка из CRM. Можно позвонить через другой транк, через другой контекст, сменить формат номера и прочее.
7
Кастомизация пути до файла записи разговора.
8
Изменение параметров регистрации звонка.
9
Кастомизация создания задач по пропущенным звонкам.
10
Изменение номера пользователя перед поиском пользователя в Б24.

Входные и выходные параметры кастомизаций

1) customize_activity

Обновление полей дела в конце звонка.
Примеры использования: Обновление полей дела.
Вход:
1
{
2
"params": {<Набор данных о разговоре (conversation)>}
3
}
Copied!
Набор данных о разговоре (conversation) описан в статье Параметры звонка (call) и разговора (conversation) в кастомизациях.
Вернуть:
1
{
2
"data": {
3
"<Название поля дела в Битрикс>": "<Значение этого поля>",
4
...
5
},
6
"state": "success"
7
}
Copied!
Описание полей дела в API Битрикс24.

2) customize_entity

Обновление полей лида/контакта в конце входящего звонка работает только для сущностей, которые созданы в результате регистрации звонка модулем.
Примеры использования: Обновление полей сущности.
Вход:
1
{
2
"params": {<Набор данных о звонке (call)>}
3
}
Copied!
Набор данных о звонке (call) описан в статье Параметры звонка (call) и разговора (conversation) в кастомизациях.
Вернуть:
1
{
2
"data": {
3
"<Название поля сущности в Битрикс>": "<Значение этого поля>",
4
...
5
},
6
"state": "success"
7
}
Copied!
Описание полей лида в API Битрикс24. Описание полей контакта в API Битрикс24.

3) need_registration

Используется для реализации функционала чёрных/белых список по номерам, транкам и прочим сложным условиям.
Подробное описание с примерами в статье Черные и белые списки. Как настроить?

4) process_client_phone

Преобразование телефонных номеров клиентов.
Начиная с версии itgrix_bx 3.0.0 касмитозация номера разделена на две: process_user_phone – кастомизация внутреннего номера пользователя; process_client_phone – кастомизация номера клиента.
Подробное описание с примерами в статье Изменение номера телефона перед отправкой данных в CRM.

5) process_final_params

Начиная с версии 2.15.0 кастомизация всех черных/белых списков реализуется через need_registration.
Вход:
1
{
2
"params": {
3
"ADD_TO_CHAT": <[0/1] Добавить ли сообщение о звонке в бизнес чат.
4
По умолчанию 1>,
5
"CALL_ID": "<Идентификатор звонка в Битрикс. Не рекомендуется изменять!>",
6
"DURATION": <Длительность в секундах>,
7
"STATUS_CODE": "<Статус звонка.
8
304 - пропущенный/неотвеченный, 200 - OK>",
9
"USER_ID": <Идентификатор пользователя Битрикс, ответственного за разговор>,
10
"call": {<Набор данных о звонке>},
11
"entity_type": "<Тип сущности текстом, например lead, contact>",
12
"entity_id": <ID сущности числом>,
13
"entity_new": <true/false создана ли сущность на этом звонке>
14
}
15
}
Copied!
Набор данных о звонке (call) описан в статье Параметры звонка (call) и разговора (conversation) в кастомизациях.
Вернуть:
Полный список параметров в документации API Битрикс24.
1
{
2
"data": {
3
"ADD_TO_CHAT": <[0/1] Добавить ли сообщение о звонке в бизнес чат>,
4
"CALL_ID": "<Идентификатор звонка в Битрикс. Не рекомендуется изменять!>",
5
"DURATION": <Длительность в секундах>,
6
"STATUS_CODE": "<Статус звонка>",
7
"USER_ID": <Идентификатор пользователя Битрикс, ответственного за разговор>
8
},
9
"state": "success"
10
}
Copied!

6) process_originate_params

Изменение параметров при инициализации звонка из Битрикс24.
Подробное описание с примерами в статье Изменение параметров при click-to-call.

7) process_record_file_path

Преобразование пути до файла записи разговора.
Подробное описание с примерами в статье Кастомизация имени файла аудиозаписи.
При установке Itgrix_bx по умолчанию уже включена конвертация файлов записей разговоров в формат mp3 перед отправкой в Битрикс24. Это позволяет вам:
  1. 1.
    Сэкономить место на диске Битрикс24 (mp3 занимает меньше, чем wav);
  2. 2.
    Прослушивать записи при помощи встроенного в CRM плеера.
Поскольку конвертация записей может занимать значительное время, у этой кастомизации особый, фиксированный таймаут 10 секунд, который не зависит от настроек кастомизаций. Если запись не успеет сконвертироваться до истечения таймаута, будет использован исходный файл.

8) process_registration_params

Используется для кастомизации параметров регистрации начала звонка.
Примеры:
Вход:
1
{
2
"params": {
3
"CALL_START_DATE": "<Дата-время начала звонка>",
4
"CRM_CREATE": <[0/1] Создавать или нет новый лид (если номер не найден в CRM)>,
5
"CRM_SOURCE": "<STATUS_ID источника из справочника источников>",
6
"LINE_NUMBER": "<Транк из настроек модуля, на который пришел звонок>",
7
"PHONE_NUMBER": "<Номер для поиска сущности в битрикс>",
8
"SHOW": <[0/1] Показывать ли карточку звонка при регистрации>,
9
"TYPE": <Направление звонка: 1 - исходящий, 2 - входящий>,
10
"USER_ID": <Идентификатор пользователя>,
11
"conversation": {<Набор данных о разговоре>}
12
}
13
}
Copied!
Набор данных о разговоре (conversation) описан в статье Параметры звонка (call) и разговора (conversation) в кастомизациях.
Вернуть:
Полный список параметров в документации API Битрикс24.
1
{
2
"data": {
3
"CALL_START_DATE": "<Дата-время начала звонка>",
4
"CRM_CREATE": <[0/1] Создавать или нет новый лид (если номер не найден в CRM)>,
5
"CRM_SOURCE": "<STATUS_ID источника из справочника источников>",
6
"LINE_NUMBER": "<Транк из настроек модуля, на который пришел звонок>",
7
"PHONE_NUMBER": "<Номер для поиска сущности в битрикс>",
8
"SHOW": <[0/1] Показывать ли карточку звонка при регистрации>,
9
"TYPE": <Направление звонка: 1 - исходящий, 2 - входящий>,
10
"USER_ID": <Идентификатор пользователя>
11
},
12
"state": "success"
13
}
Copied!

9) process_task_creation_params

Событие возникает перед постановкой задачи (при пропущенном входящем звонке). Полное описание полей задачи в документации API Битрикс24.
Вход:
В версии 2.15.0 добавлен блок данных о разговоре (conversation).
1
{
2
"params": {
3
"fields": {
4
"CREATED_BY": <Идентификатор постановщика>,
5
"DEADLINE": "<Крайний срок исполнения>",
6
"RESPONSIBLE_ID": <Идентификатор сотрудника, ответственного за задачу>,
7
"TITLE": "<Заголовок задачи>",
8
"UF_CRM_TASK": ["<Идентификатор сущности в специальном формате:
9
<Тип сущности>_<ID>.
10
Типы сущности:
11
лид - L
12
контакт - C,
13
компания - CO,
14
дело - D.
15
Пример: L_11201 для лида с ID 11201 >"]
16
},
17
"conversation": {<Набор данных о разговоре>}
18
}
19
}
Copied!
Набор данных о разговоре (conversation) описан в статье Параметры звонка (call) и разговора (conversation) в кастомизациях.
Вернуть:
1
{
2
"data": {
3
"fields": {
4
"<Название поля задачи в Битрикс>": "<Значение этого поля>"
5
...
6
}
7
},
8
"state": "success"
9
}
Copied!

10) process_user_phone

Изменение номера пользователя перед поиском пользователя в Битрикс24.
Начиная с версии itgrix_bx 3.0.0 касмитозация номера разделена на две: process_user_phone – кастомизация внутреннего номера пользователя; process_client_phone – кастомизация номера клиента.
Пример: Несколько внутренних номеров у сотрудника.
Вход:
1
{
2
"params": {
3
"phone":<номер>
4
}
5
}
Copied!
Вернуть:
1
{
2
"data": {
3
"phone":<кастомизированный_номер>
4
},
5
"state": "success"
6
}
Copied!
Last modified 1mo ago