Заявки с сайта проекта передаются в CRM4DEV через POST-запрос с телом в формате JSON.

Адрес приёма: Host/api/hs/extint/call.

Кодировка данных: UTF-8.

Структура запроса (JSON)

{
    "requestType": "call",
    "typeform": "название формы",
    "dateTime": "112345678",
    "contacts": {
        "phone": "71234567890",
        "name": "Иван Иванов",
        "email": "email@server.ru"
    },
    "data": {
        "flatId": "",
        "comment": "",
        "source": "",
        "chanell": "",
        "yclid": "",
        "utm": {
            "utm_source": "",
            "utm_medium": "",
            "utm_campaign": "",
            "utm_content": "",
            "utm_term": ""
        }
    },
    "referer": {
        "url": "",
        "urlsite": ""
    }
}

Описание полей

Корневой уровень

ПолеТипОписание
requestTypeстрокаметод обработки заявки, см. таблицу «Допустимые значения requestType» ниже
typeformстроканаименование/тип формы обратной связи на сайте
dateTimeстрокатаймстамп времени отправки формы

contacts — данные отправителя

ПолеТипОписание
contacts.phoneстрокателефон отправителя, формат 71234567890
contacts.nameстрокаимя отправителя, произвольный формат
contacts.emailстрокаemail отправителя, формат email@server

data — дополнительная информация по заявке

ПолеТипОписание
data.flatIdстрокаидентификатор квартиры/объекта, к которому относится заявка
data.commentстрокакомментарий отправителя
data.sourceстрокаисточник, откуда пришёл клиент на сайт
data.chanellстрокаканал заявки (именно так, с опечаткой — задано в самом контракте, при интеграции имя ключа менять нельзя)
data.yclidстрокаYandex Click ID — идентификатор клика по рекламе Яндекс.Директ, для сквозной аналитики
data.utm.utm_sourceстрокаUTM-метка source
data.utm.utm_mediumстрокаUTM-метка medium
data.utm.utm_campaignстрокаUTM-метка campaign
data.utm.utm_contentстрокаUTM-метка content
data.utm.utm_termстрокаUTM-метка term

referer — точка отправки формы

ПолеТипОписание
referer.urlстрокаполный URL, на котором была вызвана форма
referer.urlsiteстрокаURL сайта, с которого отправлена заявка

Допустимые значения requestType (метод API)

ЗначениеНазначение
callметод получения данных с сайта (заявка/обращение)
cons_noticeметод получения данных консультационных уведомлений
tracking_priceметод получения данных об отслеживании цен
  • Нет меток