Документация API

Основная информация

Все ответы платформы в JSON формате.

Пример ответа с ошибками

{
  \'errors\': [
    \'текст ошибки №1\',
    \'текст ошибки №2\'
  ]
}

Аутентификация

Каждый отправленный API запрос должен содержать заголовок X-AUTH-TOKEN с ключём который можно сгенерировать в профиле вкладка "Ключ API".

Список городов

Для получения списка городов необходимо отправить GET запрос на адрес /api/v1/cities

Пример ответа

[
  {
    \'id\': 1,
    \'name\': \'Краснодар\',
    \'leadPrice\': 20000,
    \'starPrice\': 1000
  }
]

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

Поле	Тип	Описание
id	number	Идентификатор города
name	string	Название города
leadPrice	number	Стоимость лида в копейках
starPrice	number	Соимость звезды в копейках

Список каналов поступления лида

Для получения списка каналов поступления лада необходимо отправить GET запрос на адрес /api/v1/properties/channel

Пример ответа

[
  {
    \'id\': 1,
    \'type\': \'channel\',
    \'value\': \'прямой контакт\'
  }
]

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

Поле	Тип	Описание
id	number	Идентификатор канала
type	string	Тип свойства, для каналов всегда channel
value	string	Название канала

Список комнат

Для получения списка комнат необходимо отправить GET запрос на адрес /api/v1/rooms

Пример ответа

[
  {
    \'id\': 1,
    \'name\': \'название\',
    \'leadCriteria\': \'описание критериев лида\',
    \'leadPrice\': 10000,
    \'platformWarranty\': true
  }
]

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

Поле	Тип	Описание
id	number	Идентификатор комнаты
name	string	Название комнаты
leadCriteria	string	Описание критериев лида
leadPrice	number	Стоимость лида в копейках
platformWarranty	bool	Гарантия платформы в комнате

Загрузка аудио записи

Для загрузки аудио записи разговора с лидом необходимо отправить POST запрос на адрес /api/v1/upload/audio с заголовком Content-Type: multipart/form-data и данными аудио записи в поле uploader

Пример ответа

[
  {
    \'path\': \'/uploads/audio/42010e19be6402b5612965718553408c.mpga\',
    \'url\': \'http://edward-lead.ru/uploads/audio/42010e19be6402b5612965718553408c.mpga\'
  }
]

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

Поле	Тип	Описание
path	string	Относительный путь загруженной аудио записи
url	string	Абсолютный URL загруженной аудиозаписи

Публикация лида

Для публикации лида необходимо отправить POST запрос на адрес /api/v1/lead с заголовком Content-Type: application/x-www-form-urlencoded

Данные для отправки

Поле	Тип	Обязательно	Описание
phone	string	Да	Номер телефона в формата +7(XXX)XXX-XX-XX
room	number	Да	Идентификатор комнаты в которую публикуется лид
publicationRule	bool	Да	Флаг того что вы ознакомились с публикацией лида на платформе
hasAgreement	bool	Да	Флаг того что вы согластны на обработку данных третьими лицами
name	string	Нет	Имя лида
city	number	Нет	Идентификатор города
channel	number	Нет	Идентификатор канала поступления лида
orderDate	date	Нет	Дата поступления заявки в формате дд.мм.гггг
decisionMaker	bool	Нет	Лицо принимающее решение
interestAssessment	number	Нет	Оценка заинтересованности по 10-ти бальной шкале, от 1 до 10
description	string	Нет	Описание лида в свободной форме
audioRecord	string	Нет	Относительный путь загруженного аудио

Пример ответа

{
  \'id\': 1
}

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

Поле	Тип	Описание
id	number	Идентификатор опубликованного лида