Лиды
С помощью методов API из этого раздела вы можете получать информацию по лидам, добавлять новые и изменять существующие.
Получение списка лидов
GET https://{idcrm}-crm-api.vionvi.com/lead Для получения лидов можно указать следующие параметры запроса:
page — номер страницы для пагинации (По умолчанию 1)
per_page — лимит элементов на странице (По умолчанию 15) (Максимум 500)
dtCreate[0] — дата и время создания лида (с) (формат unixtime)
dtCreate[1] — дата и время создания лида (по) (формат unixtime)
При выполнении запроса Access Token необходимо поместить в заголовки (ключ Authorization с указанием типа Bearer)
Пример запроса:
Authorization: Bearer ezI1NiJ9.eyJhdWQiOiIyIiwianRpIjoiNGNhMTgwMDczM2 Тело запроса отсутствует, параметры передаются в URL (например, /lead?page=1&per_page=100&dtCreate[0]=1678089325&dtCreate[1]=1678092925
Параметры ответа:
| Параметр | Описание | |
| id | ID лида | |
| firstId | ID первого лида с такими же контактами | |
| name | Имя | |
| phone | Телефон | |
| email | Email | |
| userIdCreate | ID Сотрудника, создавший лид | |
| userIdUpdate | ID Сотрудника, изменивший лид | |
| ID Ответственного сотрудника | |
| sourceId | ID рекламного источника | |
| clientId | ID Клиента | |
| funnelStageId | ID этапа воронки | |
| remoteId | Внешний ID | |
| dtCreate | Дата и время создания (в unixtime) | |
| dtUpdate | Дата и время последнего изменения (в unixtime) | |
| cost | Сумма (Бюджет) | |
| utmSource | UTM Source | |
| utmMedium | UTM Medium | |
| utmCampaign | UTM Campaign | |
| utmContent | UTM Content | |
| utmTerm | UTM Term | |
| utmReferrer | UTM Referrer | |
| openstatService | openstat Service | |
| openstatCampaign | openstat Campaign | |
| openstatAd | openstat Ad | |
| openstatSource | openstat Source | |
| from | Метка From | |
| yclid | Метка Яндекс.Директ | |
| ymclid | Метка Яндекс.Маркет | |
| ymClientId | Client ID Яндекс.Метрика | |
| gclid | Метка Google Adwords | |
| yqrid | Метка Яндекс QR | |
| fbclid | Метка Facebook | |
| roistatId | Roistat ID | |
| referrer | Источник перехода | |
| ip | IP адрес клиента | |
| contractId | ID Сделки |
Пример ответа:
{
"data": [
{
"id": 7,
"firstId": null,
"name": "Клиент",
"sourceId": 1,
"clientId": null,
"phone": 79990009999,
"email": "mail@mai.ri",
"notAnswer": null,
"userIdCreate": 1,
"userIdUpdate": null,
"dtCreate": 1688146992,
"dtUpdate": 1688146992,
"dtNotAnswer": null,
"locationUnitId": null,
"locationCityId": null,
"funnelStageId": 7,
"userIdOwner": 1,
"otherCount": 0,
"cost": null,
"remoteId": null,
"utmSource": null,
"utmMedium": null,
"utmCampaign": null,
"utmContent": null,
"utmTerm": null,
"utmReferrer": null,
"openstatService": null,
"openstatCampaign": null,
"openstatAd": null,
"openstatSource": null,
"from": null,
"yclid": null,
"ymclid": null,
"ymClientId": null,
"gclid": null,
"yqrid": null,
"fbclid": null,
"roistatId": null,
"referrer": null,
"ip": null
},
{
"id": 6,
"firstId": null,
"name": "Имя клиента",
"sourceId": 3,
"clientId": null,
"phone": 79990000000,
"email": "mail@mail.com",
"notAnswer": null,
"userIdCreate": 1,
"userIdUpdate": null,
"dtCreate": 1688146184,
"dtUpdate": 1688146184,
"dtNotAnswer": null,
"locationUnitId": null,
"locationCityId": null,
"funnelStageId": 7,
"userIdOwner": 1,
"otherCount": 0,
"cost": null,
"remoteId": null,
"utmSource": null,
"utmMedium": null,
"utmCampaign": null,
"utmContent": null,
"utmTerm": null,
"utmReferrer": null,
"openstatService": null,
"openstatCampaign": null,
"openstatAd": null,
"openstatSource": null,
"from": null,
"yclid": null,
"ymclid": null,
"ymClientId": null,
"gclid": null,
"yqrid": null,
"fbclid": null,
"roistatId": null,
"referrer": null,
"ip": null
},
{
"id": 5,
"firstId": null,
"name": "Тест",
"sourceId": 3,
"clientId": null,
"phone": 79009999999,
"email": null,
"notAnswer": null,
"userIdCreate": 1,
"userIdUpdate": null,
"dtCreate": 1688122977,
"dtUpdate": 1688122977,
"dtNotAnswer": null,
"locationUnitId": null,
"locationCityId": null,
"funnelStageId": null,
"userIdOwner": 4,
"otherCount": 0,
"cost": null,
"remoteId": null,
"utmSource": null,
"utmMedium": null,
"utmCampaign": null,
"utmContent": null,
"utmTerm": null,
"utmReferrer": null,
"openstatService": null,
"openstatCampaign": null,
"openstatAd": null,
"openstatSource": null,
"from": null,
"yclid": null,
"ymclid": null,
"ymClientId": null,
"gclid": null,
"yqrid": null,
"fbclid": null,
"roistatId": null,
"referrer": null,
"ip": null
},
{
"id": 4,
"firstId": 1,
"name": "Тест",
"sourceId": 3,
"clientId": 1,
"phone": 79999999999,
"email": null,
"notAnswer": null,
"userIdCreate": 1,
"userIdUpdate": null,
"dtCreate": 1688122939,
"dtUpdate": 1688122939,
"dtNotAnswer": null,
"locationUnitId": null,
"locationCityId": null,
"funnelStageId": null,
"userIdOwner": 3,
"otherCount": 2,
"cost": null,
"remoteId": null,
"utmSource": null,
"utmMedium": null,
"utmCampaign": null,
"utmContent": null,
"utmTerm": null,
"utmReferrer": null,
"openstatService": null,
"openstatCampaign": null,
"openstatAd": null,
"openstatSource": null,
"from": null,
"yclid": null,
"ymclid": null,
"ymClientId": null,
"gclid": null,
"yqrid": null,
"fbclid": null,
"roistatId": null,
"referrer": null,
"ip": null
},
{
"id": 3,
"firstId": 1,
"name": "test",
"sourceId": 3,
"clientId": 1,
"phone": 79999999999,
"email": null,
"notAnswer": null,
"userIdCreate": 1,
"userIdUpdate": null,
"dtCreate": 1688122569,
"dtUpdate": 1688122569,
"dtNotAnswer": null,
"locationUnitId": null,
"locationCityId": null,
"funnelStageId": null,
"userIdOwner": null,
"otherCount": 2,
"cost": null,
"remoteId": null,
"utmSource": null,
"utmMedium": null,
"utmCampaign": null,
"utmContent": null,
"utmTerm": null,
"utmReferrer": null,
"openstatService": null,
"openstatCampaign": null,
"openstatAd": null,
"openstatSource": null,
"from": null,
"yclid": null,
"ymclid": null,
"ymClientId": null,
"gclid": null,
"yqrid": null,
"fbclid": null,
"roistatId": null,
"referrer": null,
"ip": null
},
{
"id": 2,
"firstId": null,
"name": "Иван",
"sourceId": 3,
"clientId": 2,
"phone": 79000300030,
"email": "mail@vionvi.com",
"notAnswer": null,
"userIdCreate": 1,
"userIdUpdate": null,
"dtCreate": 1687702314,
"dtUpdate": 1687702314,
"dtNotAnswer": null,
"locationUnitId": 1,
"locationCityId": null,
"funnelStageId": 11,
"userIdOwner": null,
"otherCount": 0,
"cost": null,
"remoteId": null,
"utmSource": null,
"utmMedium": null,
"utmCampaign": null,
"utmContent": null,
"utmTerm": null,
"utmReferrer": null,
"openstatService": null,
"openstatCampaign": null,
"openstatAd": null,
"openstatSource": null,
"from": null,
"yclid": null,
"ymclid": null,
"ymClientId": null,
"gclid": null,
"yqrid": null,
"fbclid": null,
"roistatId": null,
"referrer": null,
"ip": null
},
{
"id": 1,
"firstId": null,
"name": "Тест",
"sourceId": null,
"clientId": 1,
"phone": 79999999999,
"email": null,
"notAnswer": null,
"userIdCreate": 1,
"userIdUpdate": null,
"dtCreate": 1679322027,
"dtUpdate": 1679322027,
"dtNotAnswer": null,
"locationUnitId": 1,
"locationCityId": null,
"funnelStageId": 11,
"userIdOwner": null,
"otherCount": 2,
"cost": null,
"remoteId": null,
"utmSource": null,
"utmMedium": null,
"utmCampaign": null,
"utmContent": null,
"utmTerm": null,
"utmReferrer": null,
"openstatService": null,
"openstatCampaign": null,
"openstatAd": null,
"openstatSource": null,
"from": null,
"yclid": null,
"ymclid": null,
"ymClientId": null,
"gclid": null,
"yqrid": null,
"fbclid": null,
"roistatId": null,
"referrer": null,
"ip": null
}
],
"links": {
"first": "https://4-crm-api.vionvi.com/lead?page=1",
"last": "https://4-crm-api.vionvi.com/lead?page=1",
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"links": [
{
"url": null,
"label": "« Назад",
"active": false
},
{
"url": "https://4-crm-api.vionvi.com/lead?page=1",
"label": "1",
"active": true
},
{
"url": null,
"label": "Вперёд »",
"active": false
}
],
"path": "https://4-crm-api.vionvi.com/lead",
"per_page": 15,
"to": 7,
"total": 7
}
}
Результат возвращается постранично. В массиве meta содержится информация о постраничной разбивке.
Данные о Лидах находятся в массиве data.
Получение информации о лиде по ID
GET https://{idcrm}-crm-api.vionvi.com/lead/{id} Метод возвращает полную информацию по лиду.
Пример запроса:
Authorization: Bearer ezI1NiJ9.eyJhdWQiOiIyIiwianRpIjoiNGNhMTgwMDczM2 Тело запроса отсутствует, параметры передаются в URL (например, /lead/18)
Параметры ответа:
| Параметр | Описание | |
| id | ID лида | |
| firstId | ID первого лида с такими же контактами | |
| clientId | ID контакта, привязанного к лиду | |
| name | Имя | |
| phone | Телефон | |
| email | Email | |
| userIdCreate | ID Сотрудника, создавший лид | |
| userIdUpdate | ID Сотрудника, изменивший лид | |
| ID Ответственного сотрудника | |
| sourceId | ID рекламного источника | |
| funnelStageId | ID этапа воронки | |
| remoteId | Внешний ID | |
| dtCreate | Дата и время создания (в unixtime) | |
| dtUpdate | Дата и время последнего изменения (в unixtime) | |
| cost | Сумма (Бюджет) | |
| utmSource | UTM Source | |
| utmMedium | UTM Medium | |
| utmCampaign | UTM Campaign | |
| utmContent | UTM Content | |
| utmTerm | UTM Term | |
| utmReferrer | UTM Referrer | |
| openstatService | openstat Service | |
| openstatCampaign | openstat Campaign | |
| openstatAd | openstat Ad | |
| openstatSource | openstat Source | |
| from | Метка From | |
| yclid | Метка Яндекс.Директ | |
| ymclid | Метка Яндекс.Маркет | |
| ymClientId | Client ID Яндекс.Метрика | |
| gclid | Метка Google Adwords | |
| yqrid | Метка Яндекс QR | |
| fbclid | Метка Facebook | |
| roistatId | Roistat ID | |
| referrer | Источник перехода | |
| ip | IP адрес клиента |
Пример ответа:
{
"data": {
"id": 6,
"firstId": null,
"name": "Имя клиента",
"sourceId": 3,
"clientId": null,
"phone": 79990000000,
"email": "mail@mail.com",
"notAnswer": null,
"userIdCreate": 1,
"userIdUpdate": null,
"dtCreate": 1688146184,
"dtUpdate": 1688146184,
"dtNotAnswer": null,
"locationUnitId": null,
"locationCityId": null,
"funnelStageId": 7,
"userIdOwner": 1,
"otherCount": 0,
"cost": null,
"remoteId": null,
"utmSource": null,
"utmMedium": null,
"utmCampaign": null,
"utmContent": null,
"utmTerm": null,
"utmReferrer": null,
"openstatService": null,
"openstatCampaign": null,
"openstatAd": null,
"openstatSource": null,
"from": null,
"yclid": null,
"ymclid": null,
"ymClientId": null,
"gclid": null,
"yqrid": null,
"fbclid": null,
"roistatId": null,
"referrer": null,
"ip": null
}
}
Добавление лидов
POST https://{idcrm}-crm-api.vionvi.com/lead При выполнении запроса Access Token необходимо поместить в заголовки (ключ Authorization с указанием типа Bearer), а в
теле запроса указать все необходимые параметры метода. При этом не забудьте, что сервер ожидает перечисление параметров
в формате JSON, кодировке UTF-8.
Параметры запроса:
| Параметр | Тип данных | Описание | Обязательно | |
| name | string | Имя | Нет | |
| phone | string | Телефон | Да, если не указан email | |
| email | string | Email | Нет, если указан phone | |
| int | ID Ответственного сотрудника | Нет | |
| sourceId | int | ID рекламного источника | Да | |
| remoteId | int | Внешний ID | Нет | |
| locationUnitId | int | ID Офиса | Нет | |
| locationCityId | int | ID Города | Нет | |
| funnelStageId | int | ID Этапа воронки | Нет | |
| cost | int | Сумма (Бюджет) | Нет | |
| utmSource | string | UTM Source | Нет | |
| utmMedium | string | UTM Medium | Нет | |
| utmCampaign | string | UTM Campaign | Нет | |
| utmContent | string | UTM Content | Нет | |
| utmTerm | string | UTM Term | Нет | |
| utmReferrer | string | UTM Referrer | Нет | |
| openstatService | string | openstat Service | Нет | |
| openstatCampaign | string | openstat Campaign | Нет | |
| openstatAd | string | openstat Ad | Нет | |
| openstatSource | string | openstat Source | Нет | |
| from | string | Метка From | Нет | |
| yclid | string | Метка Яндекс.Директ | Нет | |
| ymclid | string | Метка Яндекс.Маркет | Нет | |
| ymClientId | string | Client ID Яндекс.Метрика | Нет | |
| gclid | string | Метка Google Adwords | Нет | |
| yqrid | string | Метка Яндекс QR | Нет | |
| fbclid | string | Метка Facebook | Нет | |
| roistatId | string | Roistat ID | Нет | |
| referrer | string | Источник перехода | Нет | |
| ip | string | IP адрес клиента | Нет |
Пример запроса с перечислением параметров:
{
"name": "test",
"phone": 79998888888,
"email": "fff@mail.ru",
"sourceId": "2",
"userIdOwner": 1,
"utmSource": "Yandex",
"utmMedium": "cpc",
"utmCampaign": "promo",
"utmContent": "link",
"utmTerm": "free",
"referrer": "https://site.ru"
}
Мы используем обычные коды ответов HTTP для обозначения результата выполнения запроса.
Ответ от сервера приходит в формате JSON и кодировке UTF-8.
При успешном ответе возвращаемый сервером результат будет представлен в теле ответа массивом data.
При ошибке выполнения запроса вы можете получить в теле ответа массив errors.
Пример успешного ответа:
201 Created
Content-Type: application/json
{
"data": {
"id": 50,
"firstId": null,
"name": "test",
"sourceId": 8,
"clientId": null,
"phone": "79998888888",
"email": "fff@mail.ru",
"notAnswer": null,
"userIdCreate": null,
"userIdUpdate": null,
"dtCreate": 1690290640,
"dtUpdate": 1690290640,
"dtNotAnswer": null,
"locationUnitId": null,
"locationCityId": null,
"funnelStageId": null,
"userIdOwner": 1,
"otherCount": 0,
"cost": null,
"remoteId": null,
"utmSource": null,
"utmMedium": null,
"utmCampaign": null,
"utmContent": null,
"utmTerm": null,
"utmReferrer": null,
"openstatService": null,
"openstatCampaign": null,
"openstatAd": null,
"openstatSource": null,
"from": null,
"yclid": null,
"ymclid": null,
"ymClientId": null,
"gclid": null,
"yqrid": null,
"fbclid": null,
"roistatId": null,
"referrer": null,
"ip": null
}
}
Пример неуспешного ответа:
422 Unprocessable Content
Content-Type: application/json
{
"errors": {
"phone": [
"Поле Телефон обязательно для заполнения."
]
}
}
Редактирование лидов по ID
PUT https://{idcrm}-crm-api.vionvi.com/lead/{id} При выполнении запроса Access Token необходимо поместить в заголовки (ключ Authorization с указанием типа Bearer), а в
теле запроса указать все необходимые параметры метода. При этом не забудьте, что сервер ожидает перечисление параметров
в формате JSON, кодировке UTF-8.
Параметры запроса:
| Параметр | Тип данных | Описание | |
| name | string | Имя | |
| phone | string | Телефон | |
| email | string | Email | |
| int | ID Ответственного сотрудника | |
| sourceId | int | ID рекламного источника | |
| remoteId | int | Внешний ID | |
| locationUnitId | int | ID Офиса | |
| locationCityId | int | ID Города | |
| funnelStageId | int | ID Этапа воронки | |
| cost | int | Сумма (Бюджет) | |
| utmSource | string | UTM Source | |
| utmMedium | string | UTM Medium | |
| utmCampaign | string | UTM Campaign | |
| utmContent | string | UTM Content | |
| utmTerm | string | UTM Term | |
| utmReferrer | string | UTM Referrer | |
| openstatService | string | openstat Service | |
| openstatCampaign | string | openstat Campaign | |
| openstatAd | string | openstat Ad | |
| openstatSource | string | openstat Source | |
| from | string | Метка From | |
| yclid | string | Метка Яндекс.Директ | |
| ymclid | string | Метка Яндекс.Маркет | |
| ymClientId | string | Client ID Яндекс.Метрика | |
| gclid | string | Метка Google Adwords | |
| yqrid | string | Метка Яндекс QR | |
| fbclid | string | Метка Facebook | |
| roistatId | string | Roistat ID | |
| referrer | string | Источник перехода | |
| ip | string | IP адрес клиента |
Пример запроса с перечислением параметров:
{
"name": "Новое Имя",
"phone": "79999999999"
}
Мы используем обычные коды ответов HTTP для обозначения результата выполнения запроса.
Ответ от сервера приходит в формате JSON и кодировке UTF-8.
При успешном ответе возвращаемый сервером результат будет представлен в теле ответа массивом data.
При ошибке выполнения запроса вы можете получить в теле ответа массив errors.