Поиск

Найти сделки по имени клиента

POST /v1.3/search/customers

Тело запроса:

  • q - строка поиска
  • cursor - смещение, которое необходимо передать в следующем запросе (если запрос идет в первый раз, указывать не нужно)

После успешного выполнения возвращается следующий объект.

cursor integer Смещение, которое необходимо передать в следующем запросе [*]
leads массив Массив объектов обращений (см. раздел «Обращения»)
[*]Если вы получаете в ответе cursor равным -1, это значит, что достигли конца поисковой выборки.

Пример:

POST https://api.umnico.com/v1.3/search/customers

Body:

{
    "q": "Александр"
}

Response:

{
    "cursor": 93,
    "leads": [
        95,
        93
    ]
}

Найти сообщения в интеграциях

POST /v1.3/search/<integration-id>

Тело запроса:

  • q - строка поиска
  • cursors - массив объектов смещений, которые необходимо передать в следующем запросе (если запрос идет в первый раз, указывать не нужно). Для некоторых интеграций может быть использовано несколько курсоров.
    • type - тип курсора
    • cursor - значение смещения для данного типа курсора

После успешного выполнения возвращается следующий объект.

cursors массив Массив объектов смещений
  • type
string Тип курсора
  • cursor
string или integer Значение смещения для данного типа курсора [†]
messages массив Массив объектов сообщений
  • type
string Тип: комментарий или сообщение
  • externalId
integer Идентификатор сообщения в мессенджере или социальной сети
  • leadId
массив чисел Массив идентификаторов обращений, к которым относится данное сообщение
  • senderId
integer Идентификатор отправителя в мессенджере или социальной сети
  • sourceId
integer Идентификатор канала в мессенджере или социальной сети
  • message
объект  
    • text
string Текст сообщения
    • timestamp
integer Unix-время отправки сообщения (в миллисекундах)
[†]Если вы получаете в ответе cursor равным -1, это значит, что достигли конца поисковой выборки.

Пример:

POST https://api.umnico.com/v1.3/search/13

Body:

{
    "q": "привет"
}

Response:

{
    "cursors": [
        {
            "type": "vk_personal_message",
            "cursor": "20022020"
        }
    ],
    "messages": [
        {
            "message": {
                "text": "Привет. Как твои дела?",
                "timestamp": 1586313652000
            },
            "senderId": 97267038,
            "type": "message",
            "externalId": 1531938,
            "sourceId": 97267038,
            "leadId": [
                112
            ]
        }
    ]
}