Получение данных по клиентам

post
Список клиентов

https://api.lotinfo.ru/v1/CLIENTS
Эта конечная точка позволяет получать списки клиентов.
Request
Response
Request
Query Parameters
token
required
string
Ваш токен.
Form Data Parameters
nomedia
optional
integer
Не выводить данные о медиафайлах (и документах). Может быть равно 1 или быть не указано. 1 - не выводить данные.
encoding
optional
integer
Кодировка. Значения: 0 - не кодировать, 1 - кодировать. По умолчанию: 0. Пример закодированных символов: "\u0423\u043a\u0430\u0436".
code
required
integer
Код из СМС. Приходит директору агентства недвижимости. Получить код можно по ссылке: https://crm.lotinfo.ru/webMasters?getClientsBase.sendSMS
filter
optional
object
Фильтры для поиска. Параметры "filter": - userId (integer) - ID Пользователя. - id (integer) - ID клиента. - apiIdExchange (integer) - ID клиента в вашей системе. Примечание: этот параметр вы указываете при добавлении клиента по API. - fio (string) - Поиск клиента по имени. Примечание: выдаст клиентов в ФИО которых будет содержаться строка fio. - delclient (integer) - Статус. Значения: 1 - Актуальные, 2 - В архиве, 3 - Удалены, 4 - Активные в рекламе. - addDate (object) - Дата добавления. Параметры: - min (optional) - Нижний порог. - max (optional) - Верхний порог. Формат: Unix time. - editDate (object) - Дата изменения. Параметры: - min (optional) - Нижний порог. - max (optional) - Верхний порог. Формат: Unix time. - delDate (object) - Дата удаления. Параметры: - min (optional) - Нижний порог. - max (optional) - Верхний порог. Формат: Unix time. - archDate (object) - Дата архивирования. Параметры: - min (optional) - Нижний порог. - max (optional) - Верхний порог. Формат: Unix time. - typeClient (string) - Договор. Значения: "active" - На договоре (ЛПР), "activeIn" - На договоре (Сособственники), "nocontract" - Без договора, "arch" - Архив, "notarch" - Не в архиве. - typeContract (string) - Тип контракта. (Доступно, если typeClient не равен "arch"). Значения: "written", "verbal". - clientcat (array) - Тип и категория. Значения: "clientc_1" - Клиенты, "clientc_2" - Контрагенты, "clientc_3" - Лиды; "clientType_-1" - Физическое лицо, "clientType_1" - Агент, "clientType_3" - Застройщик, "clientType_4" - Подрядчик, "clientType_2" - Другое. - color (integer) - Цвет в системе. - pt (string) - Потребность. Значения: "objects" - Продажа, "orders" - Покупка, "objects_2" - Сдача в аренду, "orders_2" - Аренда, "services" - Услуги, "empty" - Пустые. - objectTypes (array) - Виды потребностей. Значения: Виды потребностей у "Продажа" и "Покупка" (pt = "objects" или pt = "orders"): 3 - Квартиры, 5 - Комнаты, 6 - Строящееся жилье, 7 - Склады, 8 - Индивидуальное жилье, 12 - Гаражи / паркинги, 13 - Офисы, 17 - Торговые площади, 19 - Земельные участки, 20 - Производственные помещения, 21 - Помещения свободного назначения. Виды потребностей у "Сдача в аренду" и "Аренда" (pt = "objects_2" или pt = "orders_2"): 4 - Комнаты, 9 - Офисные помещения, 11 - Квартиры, 18 - Торговые помещения, 14 - Коттеджи, дома, 15 - Склады, 22 - Производственные помещения, 23 - Помещения свободного назначения. Виды потребностей у "Услуги" (pt = "services"): id Ваших значений. - sex (string) - Пол. Значения: "male" - мужской, "female" - женский. - regionId (integer) - ID региона. Примечание: regionId не нужно указывать, если указан cityId, он определится автоматически. - cityid (integer) - ID города. - regionName (string) - Название региона. (Поиск regionId по названию региона.) - cityName (string) - Название города. (Поиск cityId по названию города.) Примечание: поиск по cityName возможет только, если указан regionId или regionName. - deeps (integer) - Правоспособность. Значения: 1 - Малолетний, 2 - Несовершеннолетний, 3 - Совершеннолетний. - deepon (integer) - Дееспособность. Значения: 1 - Дееспособный, 2 - Ограниченно дееспособный, 3 - Недееспособный. - family (integer) - Семейное положение. Значения: 0 - Нет, 1 - В браке. - userCategory (array) - Группы клиентов. Значения: "whatTheClient_1" - Я открыл доступ к клиентам, "whatTheClient_2" - Мне предоставлен доступ, "whatTheClient_3" - Переданные мне клиенты, "groups_all" - Все мои клиенты, "groups_notset" - Все мои клиенты без группы; id Ваших значений. - userCategoryOut (array) - Исключая группы клиентов. Значения: id Ваших значений.
order
optional
object
Поля сортировки. Параметры "order": - id - ID клиента. - addDate - Дата добавления. - lastWorkDate - Дата последнего взаимодействия. - filter1 - Статус клиента. - editDate - Дата изменения. - delDate - Дата удаления. - archDate - Дата архивирования. Значения для всех полей: asc - по возрастанию, desc - по убыванию.
projection
optional
array
Выводимые поля. Значения "projection": названия полей, которые необходимо вывести.
noobject
optional
integer
Не выводить данные об объектах. Может быть равно 1 или быть не указано. 1 - не выводить данные.
limit
optional
integer
Максимальное число выводимых клиентов. По умолчанию: 3000. Максимальное значение: 3000.
offset
optional
integer
Сдвиг. По умолчанию: 0.
Response
200: OK
Пример ответа (на запрос из примера ниже).
HTTP/1.1 200 OK
Content-Type: application/json
{
"result": [
{
"id": {
"fieldName": "ID в системе lotinfo",
"fieldType": "key",
"fieldMulti": "not_multi",
"values": [
{
"id": "1"
}
]
},
"addDate": {
"fieldName": "Дата добавления",
"fieldType": "value",
"fieldMulti": "not_multi",
"values": [
{
"value": "1620130528"
}
]
},
"objects": {
"fieldName": "Колличество объектов",
"fieldType": "value",
"fieldMulti": "not_multi",
"values": [
{
"value": "5"
}
]
}
},
{
"id": {
"fieldName": "ID в системе lotinfo",
"fieldType": "key",
"fieldMulti": "not_multi",
"values": [
{
"id": "31512428"
}
]
},
"addDate": {
"fieldName": "Дата добавления",
"fieldType": "value",
"fieldMulti": "not_multi",
"values": [
{
"value": "1620130528"
}
]
},
"objects": {
"fieldName": "Колличество объектов",
"fieldType": "value",
"fieldMulti": "not_multi",
"values": [
{
"value": "0"
}
]
}
}
]
}
400: Bad Request
Пример ответа на запрос с ошибкой. (Ответ сервера будет с кодом 200.)
HTTP/1.1 200 OK
Content-Type: application/json
{
"errors": [
{
"error": 9,
"error_text": "Укажите одно из доступных значений: 1, 2, 3, 4.",
"error_field": "delClient"
},
{
"error": 9,
"error_text": "Укажите одно из доступных значений: 0 (ASC), 1 (DESC)",
"error_field": "addDate"
}
]
}

Пример запроса

POST https://api.lotinfo.ru/v1/CLIENTS?TOKEN={ваш_токен} HTTP/1.1
Content-Type: application/json
{
"code": 101010,
"limit": 2,
"ofset": 10,
"filter": {
"userId": 123,
"clientCat": ["clientc_1", "clientc_2"],
"delClient": 2,
"typeClient": "nocontract",
"typeContract": "written",
"pt": "orders",
"objectTypes": [3, 6],
"regionName": "Москва",
"cityName": "Москва"
},
"order": {
"addDate": "desc",
"filter1": "asc"
},
"projection": ["id", "addDate", "objects"]
}

Кастомные поля

Контакты

"fieldType": "contact"

id - ID контакта. value - Значение. type - Тип. Значения: "mobile" - мобильный телефон, "city" - городской телефон, "email" - email, "other" - другой. comment - Комментарий. general - Главный номер. sky - Отслеживание.

"contacts": {
"fieldName": "Контакты",
"fieldType": "contact",
"fieldMulti": "multi",
"values": [
{
"id": "11332",
"value": "79778881111",
"type": "mobile",
"comment": "комментарий 2",
"general": null,
"sky": null
}
]
},

Комментарии

"fieldType": "comment"

id - ID комментария. value - Текст комментария. date - Дата комментария. userId - ID пользователя, который оставил комментарий.

"comments": {
"fieldName": "Комментарии",
"fieldType": "comment",
"fieldMulti": "multi",
"values": [
{
"id": "68614",
"value": "комментарий 1",
"date": "1620227708",
"userId": "123"
},
{
"id": "68615",
"value": "комментарий 2",
"date": "1620227708",
"userId": "123"
}
]
}

Объекты

"fieldType": "object"

id - ID объекта. lpr - Лицо принимающее решения. name - Комментарий. doled - Доля.

"objectsList": {
"fieldName": "Объекты",
"fieldType": "object",
"fieldMulti": "multi",
"values": [
{
"id": "1001",
"lpr": "1",
"name": "Объект 1",
"doled": ""
},
{
"id": "1002",
"lpr": "1",
"name": "Объект 2",
"doled": ""
}
]
}

Заявки

"fieldType": "order"

id - ID комментария. name - Комментарий.

"ordersList": {
"fieldName": "Заявки",
"fieldType": "order",
"fieldMulti": "multi",
"values": [
{
"id": "10001",
"name": ""
},
{
"id": "10002",
"name": ""
}
]
}

Документы

"fieldType": "media"

link - Ссылка на документ. typeContent - Тип контента. name - Название документа.

"documents": {
"fieldName": "Документы",
"fieldType": "docs",
"fieldMulti": "multi",
"values": [
{
"link": "https:\/\/files.lotinfo.ru\/usersFiles\/fdf6.jpg",
"typeContent": "image",
"name": "Документ"
}
]
}