Типы матчингов в API методах
В рамках API методов:
- Создание сделок
- Обновление сделок
- Тегирование лидов
- Комментирование лидов
- Добавление менеджеров к лидам
Во входных параметрах запроса есть параметр matching, отвечающих за настройки поиска лидов для матчинга или присвоения источников.
Какие именно типы матчингов доступны в том или ином API метода - указано на странице справки по этому методу.
Параметр | Формат | Обязательный | Описание |
"type": "leadContact" | |||
---|---|---|---|
{ |
|||
...matching .leadContactParams |
object | Обязательно, если "type": "leadContact" | Параметра поиска лида по номеру телефона / почте / дате |
...matching .leadContactParams .emails |
array |
Должен быть передан хотя бы один из параметров – phones, md5Phone, emails. Допустима передача сразу нескольких параметров, поиск будет идти по приоритету: |
Можно перечислить несколько почт (до 5 в одном параметре), формат x@x.x, любые символы. |
...matching .leadContactParams .phones |
array |
Можно перечислить несколько номеров телефонов (до 5 в одном параметре). Номера могут быть в любом формате, например 71234567890, +71234567890, 8 (123) 456-78-90.
|
|
...matching .leadContactParams .md5Phones
|
array |
Можно перечислить несколько md5-хэшей номеров телефонов (до 5 в одном параметре). Хэши требуется передавать от номеров в формате +74953080100 (с плюсом вначале, далее номер в федеральном формате). При передаче хэшей от других форматов номеров телефонов поиск лида не сработает. |
|
...matching .leadContactParams .searchAmongPhonesInText
|
boolean | Необязательно |
Активация функционала поиска звонков по номерам телефонов распознанных в текстах звонков. Возможные значения:
При включении функционала поиска по номерам телефонов распознанных в тестах звонка поиск будет работать по следующей логике:
1) сначала будет совершен поиск по номерам звонящего в звонках. |
...matching .leadContactParams .date
|
string | Обязательно, если "type": "leadContact" |
Дата и время, относительно которой будет происходить поиск подходящего лида в прошлое на кол-во минут из параметра searchDepth. Формат: dd-mm-yyyy hh:mm:ss. |
...matching .leadContactParams .tags |
array | Необязательно |
Если указан список тегов, то найденный лид перед склейкой будет дополнительно проверен на наличие указанных тегов. Лид считается подходящим для матчинга если его теги соответствуют указанным. Фильтрация по тегам может передаваться вместе с типами call, request, leadContact, callContact, requestContact. |
...matching .leadContactParams .tagsLogic |
string | Обязательно, если указан параметр tags | Логические условие между тегами. Возможные значения: and (у лида должны быть все перечисленные теги) или or (у лида должен быть хотя бы один из перечисленных тегов). |
...matching .leadContactParams .leadTypeToMatch |
string | Обязательно, если "type": "leadContact" |
Типы лидов, среди которых будет происходить поиск. Возможные значения:
|
...matching .leadContactParams .searchDepth |
integer | Обязательно, если "type": "leadContact" | Глубина поиска подходящего лида от даты в date, указывается в мин. Возможные значения от 1 до 525600 мин (1 год). |
"type": "requestContact" | |||
{ |
|||
...matching .requestContactParams |
object | Обязательно, если "type": "requestContact" | Параметр поиска заявки по номеру телефона / почте / дате. |
...matching .requestContactParams .emails |
array |
Должен быть передан хотя бы один из параметров – phones, md5Phone, emails. Допустима передача сразу нескольких параметров, поиск будет идти по приоритету: |
Аналогично описанию из блока leadContactParams |
...matching .requestContactParams .phones |
array |
Аналогично описанию из блока leadContactParams
|
|
...matching .requestContactParams .md5Phones
|
array |
Аналогично описанию из блока leadContactParams |
|
...matching .requestContactParams .date
|
string | Обязательно, если "type": "requestContact" |
Аналогично описанию из блока leadContactParams |
...matching .requestContactParams .tags |
array | Необязательно | Аналогично описанию из блока leadContactParams |
...matching .requestContactParams .tagsLogic |
string | Обязательно, если указан параметр tags | Аналогично описанию из блока leadContactParams |
...matching .requestContactParams .requestTypeToMatch |
string | Обязательно, если "type": "requestContact" |
Аналогично описанию из блока leadContactParams |
...matching .requestContactParams .searchDepth |
integer | Обязательно, если "type": "requestContact" | Аналогично описанию из блока leadContactParams |
"type": "callContact" | |||
{ |
|||
...matching .callContactParams |
object | Обязательно, если "type": "callContact" | Параметры поиска звонка по номеру телефона / дате. |
...matching .callContactParams .phones |
array |
Должен быть передан хотя бы один из параметров – phones, md5Phones. Допустима передача сразу нескольких параметров, поиск будет идти по приоритету: 1) Поиск по phones. 2) Если не нашли, то поиск по md5Phones. |
Аналогично описанию из блока leadContactParams |
...matching .callContactParams .md5phones |
array | Аналогично описанию из блока leadContactParams | |
...matching .callContactParams .date
|
string | Обязательно, если "type": "callContact" |
Аналогично описанию из блока leadContactParams |
...matching .callContactParams .searchAmongPhonesInText
|
boolean | Необязательно |
Аналогично описанию из блока leadContactParams
|
...matching .callContactParams.tags |
array | Необязательно | Аналогично описанию из блока leadContactParams |
...matching .callContactParams .tagsLogic |
string | Обязательно, если указан параметр tags | Аналогично описанию из блока leadContactParams |
...matching .callContactParams .callTypeToMatch |
string | Обязательно, если "type": "callContact" | Аналогично описанию из блока leadContactParams |
...matching .callContactParams .searchDepth |
integer | Обязательно, если "type": "callContact" | Аналогично описанию из блока leadContactParams |
"type": "call" | |||
{ |
|||
...matching .callParams |
object | Обязательно, если "type": "call" | Параметры поиска звонка по его ID |
...matching .callParams.callId |
integer | Обязательно указать один из параметров: callId, callReferenceId, sipCallId, если "type": "call" |
ID звонка в Calltouch |
...matching .callParams.callReferenceId |
string | ID звонка из внешней системы | |
...matching .callParams.sipCallId |
string | sipCallId звонка | |
...matching .callParams.tags |
array | Необязательно | Аналогично описанию из блока leadContactParams |
...matching .callParams.tagsLogic |
string | Обязательно, если указан параметр tags | Аналогично описанию из блока leadContactParams |
"type": "request" | |||
{ |
|||
...matching .requestParams |
object | Обязательно, если "type": "request" | Параметры поиска заявки по ID |
...matching .requestParams.requestId |
integer | Обязательно указать один из параметров: requestId или requestNumber, если "type": "request" |
ID заявки в Calltouch |
...matching .requestParams.requestNumber |
string | ID заявки из внешней системы | |
...matching .requestParams.tags |
array | Необязательно |
Аналогично описанию из блока leadContactParams |
...matching .requestParams.tagsLogic |
string | Обязательно, если указан параметр tags | Аналогично описанию из блока leadContactParams |
"type": "session" | |||
{ |
|||
...matching .sessionParams |
object | Обязательно, если "type": "session" | Параметры матчинга сессии по ID |
...matching .sessionParams.sessionId |
string | Обязательно, если "type": "session" | Значение sessionID |
"type": "customSources" | |||
{ |
|||
orders.matching .customSourceParams |
object | Обязательно, если "type": "customSources" | Не осуществлять поиск лида или сессии, а присвоить произвольный источник. |
orders.matching .customSourceParams .source |
string | Обязательно, если "type": "customSources" | Произвольный источник, максимум 100 символов или меньше. |
orders.matching .customSourceParams .medium |
string | Обязательно, если "type": "customSources" | Произвольный канал, максимум 100 символов или меньше. |
orders.matching .customSourceParams .campaign |
string | Обязательно, если "type": "customSources" | Произвольная кампания, максимум 100 символов или меньше. |
orders.matching .customSourceParams .content |
string | Нет | Произвольное объявление, максимум 100 символов или меньше. |
orders.matching .customSourceParams .term |
string | Нет | Произвольная ключевая фраза, максимум 100 символов или меньше. |
"type": "withoutSource" | |||
{ |
|||
Не осуществлять поиск лида или сессии, не присваивать произвольный источник. Не имеет дополнительных параметров. |
и мы поможем вам
- A/B тестирование (раздел «Подключение»)
- Email-трекинг (раздел «Подключение»)
- Отслеживание офлайн конверсии (раздел «Подключение»)
- Подключение к отслеживанию дополнительных доменов (раздел «Подключение»)
- Подмена номеров на AMP-страницах Google (раздел «Подключение»)