CRM ліди

Дата створення 2026-03-20

Дата останньої зміни 2026-03-31

Отримання токена

Детальніше про отримання токена.

Створення ліда

Метод дозволяє створити нового ліда в CRM IPTel.

Додаткові сутності

1. Джерела. Детальніше про отримання джерел.
2 .Користувачі. Детальніше про.отримання користувачів.

Метод: POST

Body

Назва параметра	Доступні значення (тип)	Примітки
name	string	Назва ліда
firstName	string	Ім’я
lastName	string	Прізвище
companyName	string	Назва компанії
position	string	Посада
phoneNumbers	string[]	Список номерів телефону
emails	string[]	Список email
telegramUsernames	string[]	Telegram нікнейми
viberAccounts	ViberAccountInfo[]	Список Viber акаунтів
responsible	SimpleUserDto	Відповідальний користувач
source	Source	Джерело ліда
phase	IcsPhase	Фаза (етап) ліда
additionalFieldValues	AdditionalFieldValue[]	Додаткові поля ліда. Увага! Для коректної роботи CRM-системи слід передавати усі додаткові поля, доступні для лідів.
tags	Tag[]	Список тегів
externalId	string	Зовнішній ID ліда
isConverted	boolean	Чи конвертований лід

Додаткові об’єкти

ViberAccountInfo

Назва параметра	Доступні значення (тип)	Примітки
viberAccountId	string	ID Viber акаунта
name	string	Назва акаунта
lastTimeMessageReceived	string	Дата останнього отриманого повідомлення

Tag

Назва параметра	Доступні значення (тип)	Примітки
id	number	ID тегу
name	string	Назва тегу
description	string	Опис тегу
color	string	Колір тегу

AdditionalFieldValue

Назва параметра	Доступні значення (тип)	Примітки
id	number	ID значення
additionalField	SimpleIcsEntity	Додаткове поле
additionalForm	SimpleIcsEntity	Форма додаткового поля
value	string[]	Значення поля
entityType	"LEAD" \| "CONTACT" \| "COMPANY" \| "DEAL"	Тип сутності
entityId	number	ID сутності

SimpleUserDto, SimpleIcsEntity, Source

Назва параметра	Доступні значення (тип)	Примітки
id	number	ID користувача
name	string	Ім’я користувача

IcsPhase

Назва параметра	Доступні значення (тип)	Примітки
id	number	ID фази
name	string	Назва фази
pipelineId	number	ID воронки

URL:

https://{API_ENDPOINT}:8443/ics3/rest/crm/lead

Приклад запиту

curl -X POST \
  "https://{API_ENDPOINT}:8443/ics3/rest/crm/lead" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {TOKEN}" \
  -d '{"name":"New lead","firstName":"","lastName":"","source":null,"position":"","companyName":"","phoneNumbers":[""],"emails":[""],"responsible":null,"telegramUsernames":[""],"viberAccounts":[],"externalId":"","id":0,"created":"31-03-2026 09:45","modified":"31-03-2026 09:45","phase":{"id":4,"name":"Необроблений","pipelineId":2,"color":"0000ff","phaseType":"START","priority":0,"phaseRestriction":null},"additionalFieldValues":[{"id":0,"additionalForm":{},"additionalField":{"id":13,"name":""},"value":["{{ics_lead-external-id}}"],"entityType":"LEAD","entityId":0},{"id":0,"additionalForm":{},"additionalField":{"id":1,"name":""},"value":[""],"entityType":"LEAD","entityId":0},{"id":0,"additionalForm":{},"additionalField":{"id":11,"name":""},"value":[""],"entityType":"LEAD","entityId":0},{"id":0,"additionalForm":{},"additionalField":{"id":12,"name":""},"value":["2"],"entityType":"LEAD","entityId":0},{"id":0,"additionalForm":{},"additionalField":{"id":5,"name":""},"value":["hello-world"],"entityType":"LEAD","entityId":0},{"id":0,"additionalForm":{},"additionalField":{"id":6,"name":""},"value":["my-campaign"],"entityType":"LEAD","entityId":0},{"id":0,"additionalForm":{},"additionalField":{"id":9,"name":""},"value":["23"],"entityType":"LEAD","entityId":0},{"id":0,"additionalForm":{},"additionalField":{"id":10,"name":""},"value":["фвфвпфапвіапівапівап"],"entityType":"LEAD","entityId":0}],"isConverted":false,"tags":[]}'

Модифікація ліда

Метод дозволяє оновити існуючого ліда.
Метод: PUT

Body

Назва поля	Тип	Примітки
id	number	ID ліда (обов’язкове для апдейту)
name	string	Назва ліда
firstName	string	Ім’я
lastName	string	Прізвище
companyName	string	Назва компанії
position	string	Посада
responsible	SimpleUserDto	Відповідальний користувач
phoneNumbers	string[]	Номери телефонів
emails	string[]	Email-адреси
telegramUsernames	string[]	Telegram нікнейми
viberAccounts	ViberAccountInfo[]	Інформація по Viber акаунтах
created	string	Дата створення
modified	string	Дата модифікації
phase	IcsPhase	Фаза ліда
source	Source	Джерело ліда
externalId	string	Зовнішній ID
isAdditionalFormsValid	boolean	Чи пройшли додаткові форми валідацію
dealsCount	number	Кількість угод
additionalFieldValues	AdditionalFieldValue[]	Значення додаткових полів
hasTags	boolean	Наявність тегів (нове поле)
hasTasks	boolean	Наявність задач (нове поле)
tags	Tag[]	Теги ліда

URL

https://{API_ENDPOINT}:8443/ics3/rest/crm/lead/{id}

Приклад запиту

curl -X PUT \
  "https://{API_ENDPOINT}:8443/ics3/rest/crm/lead/{id}" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {TOKEN}" \
  -d '{"id":1705,"name":"New lead update","firstName":"","lastName":"","companyName":"","position":"","responsible":null,"phoneNumbers":[""],"emails":[""],"telegramUsernames":[""],"viberAccounts":[],"created":"31-03-2026 09:08","modified":"31-03-2026 09:44","phase":{"id":4,"name":"Необроблений","pipelineId":2,"color":"0000ff","phaseType":"START","priority":0,"phaseRestriction":null},"source":null,"externalId":"","isAdditionalFormsValid":true,"dealsCount":null,"additionalFieldValues":[{"id":0,"additionalField":{"id":13,"name":""},"additionalForm":{"id":null,"name":null},"value":["{{ics_lead-external-id}}"],"entityType":"LEAD","entityId":1705},{"id":0,"additionalField":{"id":1,"name":""},"additionalForm":{"id":null,"name":null},"value":[""],"entityType":"LEAD","entityId":1705},{"id":0,"additionalField":{"id":11,"name":""},"additionalForm":{"id":null,"name":null},"value":[""],"entityType":"LEAD","entityId":1705},{"id":0,"additionalField":{"id":12,"name":""},"additionalForm":{"id":null,"name":null},"value":["2"],"entityType":"LEAD","entityId":1705},{"id":0,"additionalField":{"id":5,"name":""},"additionalForm":{"id":null,"name":null},"value":["hello-world"],"entityType":"LEAD","entityId":1705},{"id":0,"additionalField":{"id":6,"name":""},"additionalForm":{"id":null,"name":null},"value":["my-campaign"],"entityType":"LEAD","entityId":1705},{"id":0,"additionalField":{"id":9,"name":""},"additionalForm":{"id":null,"name":null},"value":["23"],"entityType":"LEAD","entityId":1705},{"id":0,"additionalField":{"id":10,"name":""},"additionalForm":{"id":null,"name":null},"value":["фвфвпфапвіапівапівап"],"entityType":"LEAD","entityId":1705}],"hasTags":false,"hasTasks":false,"tags":[]}'

Отримання всіх лідів

Метод дозволяє отримати список усіх лідів.

Метод: GET

URL

https://{API_ENDPOINT}:8443/ics3/rest/crm/lead

Приклад запиту

curl -X GET \
  "https://{API_ENDPOINT}:8443/ics3/rest/crm/lead" \
  -H "Authorization: Bearer {TOKEN}"

Фільтрування лідів

Метод дозволяє отримати ліди з CRM IPTel з можливістю фільтрації, сортування та пагінації. Тип запиту визначається змінною requestType: "all" – всі ліди, "my" – ліди користувача, токен якого використовується
Метод: GET

Query

Назва параметра	Доступні значення (тип)	Примітки
ids	number[]	Список ID потрібних лідів
companyName	string	Назва компанії
position	string	Посада
email	string	Email
firstName	string	Ім’я
fromDateTimeCreated	string	Дата створення від
toDateTimeCreated	string	Дата створення до
fromDateTimeModified	string	Дата модифікації від
toDateTimeModified	string	Дата модифікації до
lastName	string	Прізвище ліда
name	string	Назва ліда
pipelineId	number	ID воронки
phaseIds	number[]	Список ID фаз воронки
phoneNumber	string	Номер телефону
responsibleId	number	ID відповідального користувача
sourceId	number	ID джерела
telegramUsername	string	Telegram нік користувача
additionalFields	AdditionalFieldFilterData[]	Додаткові поля з оператором та значенням. Приклад: &af12<100 – фільтрація по додатковому полю з id=2, при значення більшому 100
phaseLimit	number	Максимальна кількість лідів у кожній воронці
additionalFieldsId	string[]	ID додаткових полів
dialerCampaignsIds	string[]	ID кампаній автообдзвону
tags	number[]	Список ID тегів
externalId	string	Зовнішній ID ліда
pageSize	number	Максимальна кількість лідів
start	number	Початковий індекс для пагінації
sortByField	string	Назва поля ліда, яке використовується для сортування
sortingOrder	"ASC" \| "DESC"	Порядок сортування

URL

https://{API_ENDPOINT}:8443/ics3/rest/crm/lead/filter/{requestType}?{query_params}

Приклад запиту

curl -X GET \
  "https://{API_ENDPOINT}:8443/ics3/rest//crm/lead/filter/all?pageSize=50&start=0&sortByField=name&sortingOrder=ASC&companyName=Example" \
  -H "Authorization: Bearer {TOKEN}"