Читать 13

Типы матчингов в API методах


В рамках API методов:

Во входных параметрах запроса есть параметр matching, отвечающих за настройки поиска лидов для матчинга или присвоения источников.

Какие именно типы матчингов доступны в том или ином API метода - указано на странице справки по этому методу.

Параметр Формат Обязательный Описание
"type": "leadContact"
{
     "type": "leadContact",
     "leadContactParams": {
          "emails": ["name@server.com"],
          "phones": ["79157771122", "+7 (915) 888-11-22"],
          "date": "Дата и время лида",
          "tags": ["тег1","тег2"],
          "tagsLogic": "and",
          "leadTypeToMatch": "nearestUniq",
          "searchDepth": 262800
     }
}

...matching

.leadContactParams

object Обязательно, если "type": "leadContact" Параметра поиска лида по номеру телефона / почте / дате

...matching

.leadContactParams

.emails

array

Должен быть передан хотя бы один из параметров – phones, md5Phone, emails. Допустима передача сразу нескольких параметров, поиск будет идти по приоритету:
1) Поиск по phones.
2) Если не нашли, то поиск по md5Phones.
3) Если не нашли, то поиск по 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 Необязательно

Активация функционала поиска звонков по номерам телефонов распознанных в текстах звонков. Возможные значения:

  • false - отключено (по умолчанию)
  • true - включено.

При включении функционала поиска по номерам телефонов распознанных в тестах звонка поиск будет работать по следующей логике:

1) сначала будет совершен поиск по номерам звонящего в звонках.
2) если соответствий по пункту 1 не было найдено - то производится поиск по номерам распознанным в текстах звонков.

...matching

.leadContactParams

.withChats

 

boolean Необязательно

Данный функционал доступен только в рамках API методов по сделкам.

Активация функционала поиска чатов по контактным данным. Возможные значения:

  • false - отключено (по умолчанию)
  • true - включено.

...matching

.leadContactParams

.date

 

string Обязательно, если "type": "leadContact"

Дата и время, относительно которой будет происходить поиск подходящего лида в прошлое на кол-во минут из параметра searchDepth. Формат: dd-mm-yyyy hh:mm:ss.

...matching

.leadContactParams

.tags

array Необязательно

Если указан список тегов, то найденный лид перед склейкой будет дополнительно проверен на наличие указанных тегов. Лид считается подходящим для матчинга если его теги соответствуют указанным.

Фильтрация по тегам может передаваться вместе с типами call, request, chat, leadContact, callContact, requestContact, chatContact.

...matching

.leadContactParams

.tagsLogic

string Обязательно, если указан параметр tags Логические условия между тегами. Возможные значения: and (у лида должны быть все перечисленные теги) или or (у лида должен быть хотя бы один из перечисленных тегов).

...matching

.leadContactParams

.leadTypeToMatch

string Обязательно, если "type": "leadContact"

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

  • nearest - Любой ближайший лид
  • nearestUniq - Ближайший уникальный лид
  • nearestTarget - Ближайший целевой лид
  • nearestUniqTarget - Ближайший уникально-целевой лид

...matching

.leadContactParams

.searchDepth

integer Обязательно, если "type": "leadContact" Глубина поиска подходящего лида от даты в date, указывается в мин. Возможные значения от 1 до 525600 мин (1 год).
"type": "requestContact"
{
     "type": "requestContact",
     "requestContactParams": {
          "emails": ["name@server.com"],
          "phones": ["79157771122", "+7 (915) 888-11-22"],
          "date": "Дата и время заявки",
          "tags": ["тег1","тег2"],
          "tagsLogic": "and",
          "requestTypeToMatch": "nearestUniq",
          "searchDepth": 262800
}
}

...matching

.requestContactParams

object Обязательно, если "type": "requestContact" Параметр поиска заявки по номеру телефона / почте / дате.

...matching

.requestContactParams

.emails

array

Должен быть передан хотя бы один из параметров – phones, md5Phone, emails. Допустима передача сразу нескольких параметров, поиск будет идти по приоритету:
1) Поиск по phones.
2) Если не нашли, то поиск по md5Phones.
3) Если не нашли, то поиск по 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"
{
"type": "callContact",
"callContactParams": {
"phones": ["84953338877"],
"date": "Дата и время звонка",
"tags": ["тег1","тег2"],
"tagsLogic": "and",
"callTypeToMatch": "nearestUniq",
"searchDepth": 262800
}
}

...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": "chatContact"
{
     "type": "chatContact",
     "chatContactParams": {
          "emails": ["name@server.com"],
          "phones": ["79157771122", "+7 (915) 888-11-22"],
          "waPhones": ["79999999999", "+7 (911) 222-33-44"],
          "tgIds": [123456],
          "tgUsernames": ["@username", "username"],
          "vkIds": [123456],
          "date": "Дата и время чата",
          "tags": ["тег1","тег2"],
          "tagsLogic": "and",
          "chatTypeToMatch": "nearestUniq",
          "searchDepth": 262800
}
}

...matching

.chatContactParams

object Обязательно, если "type": "chatContact"

Данный тип матчинга доступен только в рамках API методов по сделкам.

Параметр поиска чата по номеру телефона / почте / телефону Whatsapp / ID Телеграм / username Телеграм / ID VK / дате.

...matching

.chatContactParams

.emails

array

Должен быть передан хотя бы один из параметров – phones, md5Phone, emails, waPhones, tgIds, tgUsernames, vkIds Допустима передача сразу нескольких параметров, поиск будет идти по приоритету:
1) Поиск по phones.
2) Если не нашли, то поиск по md5Phones.
3) Если не нашли, то поиск по emails.
4) Если не нашли, то поиск по waPhones.
5) Если не нашли, то поиск по tgIds.
6) Если не нашли, то поиск по vkIds.
7) Если не нашли, то поиск по tgUsernames.

Аналогично описанию из блока leadContactParams

...matching

.chatContactParams

.phones

array

Аналогично описанию из блока leadContactParams

 

...matching

.chatContactParams

.md5Phones

 

array

Аналогично описанию из блока leadContactParams

...matching

.chatContactParams

.waPhones

 

array

Телефон Whatsapp. Можно перечислить несколько номеров телефонов Whatsapp (до 5 в одном параметре). Номера могут быть в любом формате, например 71234567890, +71234567890, 8 (123) 456-78-90.

...matching

.chatContactParams

.tgIds

 

array

ID пользователя в Telegram. Можно перечислить несколько tgId (до 5 в одном параметре). Строка из цифр, максимум 20 символов в одном ID.

...matching

.chatContactParams

.tgUsernames

 

array

Username пользователя в Telegram. Можно перечислить несколько Username (до 5 в одном параметре). Формат: @username, username. Латинские буквы a-z, цифры 0-9, и нижнее подчеркивание. Минимум 3 символа. Максимальная длина 100 символов в одном tgUsernames (без учета @).

...matching

.chatContactParams

.vkIds

 

array

ID пользователя в VK. Можно перечислить несколько vkId (до 5 в одном параметре). Строка из цифр, максимум 20 символов в одном ID.

...matching

.chatContactParams

.date

 

string Обязательно, если "type": "chatContact"

Аналогично описанию из блока leadContactParams

...matching

.chatContactParams

.tags

array Необязательно Аналогично описанию из блока leadContactParams

...matching

.chatContactParams

.tagsLogic

string Обязательно, если указан параметр tags Аналогично описанию из блока leadContactParams

...matching

.chatContactParams

.chatTypeToMatch

string Обязательно, если "type": "chatContact"

Аналогично описанию из блока leadContactParams

...matching

.chatContactParams

.searchDepth

integer Обязательно, если "type": "chatContact" Аналогично описанию из блока leadContactParams
"type": "call"
{
"type": "call",
"callParams": {
"callId": 12345
}
}

...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"
{
"type": "request",
"requestParams": {
"requestNumber": 12345
}
}

...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": "chat"
{
"type": "chat",
"chatParams": {
"chatId": 12345
}
}

...matching

.chatParams

object Обязательно, если "type": "chat"

Данный тип матчинга доступен только в рамках API методов по сделкам.

Параметры поиска чата по ID

...matching

.chatParams.chatId

integer Обязательно, если "type": "chat"

ID чата в Calltouch

...matching

.chatParams.tags

array Необязательно

Аналогично описанию из блока leadContactParams

...matching

.chatParams.tagsLogic

string Обязательно, если указан параметр tags Аналогично описанию из блока leadContactParams
"type": "session"
{
"type": "session",
"sessionParams": {
"sessionId": 1234567
}
}
...matching
.sessionParams
object Обязательно, если "type": "session" Параметры матчинга сессии по ID
...matching
.sessionParams.sessionId
string Обязательно, если "type": "session" Значение sessionID
"type": "customSources"
{
"type": "customSources",
"customSourceParams": {
"source": "Произвольный источник",
"medium": "Произвольный канал",
"campaign": "Произвольная кампания",
"content": "Произвольное объявление",
"term": "Произвольная ключевая фраза"
}
}

orders.matching

.customSourceParams

object Обязательно, если "type": "customSources" Не осуществлять поиск лида или сессии, а присвоить произвольный источник.

orders.matching

.customSourceParams

.source

string Обязательно, если "type": "customSources" Произвольный источник, максимум 250 символов.

orders.matching

.customSourceParams

.medium

string Обязательно, если "type": "customSources" Произвольный канал, максимум 250 символов.

orders.matching

.customSourceParams

.campaign

string Обязательно, если "type": "customSources" Произвольная кампания, максимум 250 символов.

orders.matching

.customSourceParams

.content

string Нет Произвольное объявление, максимум 250 символов.

orders.matching

.customSourceParams

.term

string Нет Произвольная ключевая фраза, максимум 250 символов.
"type": "withoutSource"
{
"type": "withoutSource"
}
      Не осуществлять поиск лида или сессии, не присваивать произвольный источник.
Не имеет дополнительных параметров.
Не нашли решение проблемы?
Заполните форму, и мы вам поможем.