Facebook Google Plus Youtube

Заявки (leads)

Метод “leads”

Метод позволяет передавать заявки с сайта в CRM

Запрос “add”

Запрос позволяет добавлять заявки с сайта напрямую в CRM.

Параметры запроса:

  • login - логин пользователя для авторизации
  • title – Имя посетителя
  • email – email
  • phone – телефон
  • company – название компании
  • description – текстовое описание
  • ip – ip-адрес посетителя
  • country – страна
  • city – город
  • path – источник клиента
  • partner – сайт партнера (партнер и сайт должны быть добавлены в систему отдельно)
  • user – логин сотрудника, который назначается ответственным за обработку заявок

    Начиная с версии 2016.20 можно передавать также UTM-метки для автоматической привязки заявки к определенному каналу
     
  • utm_source - Источник трафика (связан со справочником "Источник клиента")
  • utm_medium - Тип трафика
  • utm_campaign - Рекламная кампания
  • utm_term - Ключевая фраза
  • utm_content - Содержание

Примечание:

  • При отсутствии параметра user ответственным за обработку интереса будет назначен пользователь, указанный Координатором в Общих настройках панели управления CRM для версии < 2016.20
  • Распределение заявок по сотрудникам и прочие настройки работы модуля производятся в разделе "Модули" / "Обработчик заявок" в Панели управления CRM с версии 2016.20
  • Проводится поиск по базе Клиентов и Контактов по переданным параметрам email и phone. При найденном соответствии Ответственным за обработку заявки будет назначен пользователь, ответственный за найденного Клиента и Контакт.
  • После добавления заявки Ответственному будет выслано уведомление по email

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

http(s)://crm_url/developer/v1/leads?login=vladislav%40isaler.ru&apikey=aMgiCQyj8bCToNc47BZZYrRICoWSIl&action=add&title=%D0%90%D0%BD%D0%B4%D1%80%D0%B5%D0%B5%D0%B2+%D0%B2%D0%BB%D0%B0%D0%B4%D0%B8%D1%81%D0%BB%D0%B0%D0%B2&email=vladislav%40god.ry&phone=%2B79001234567&company=SalesMan&description=The+best+crm+practice&ip=127.0.0.1&country=Ruusia&city=Perm&path=Test+Path&partner=

Ответ:

В поле “data” приходит id записи

{"result":{"text":"Success","id":940}}

Возможные ответы в случае ошибок:

  • 400 – Не верный API key
  • 401 – Неизвестный пользователь
  • 402 – Неизвестный метод

Запрос “stat” (ранее info)

Запрос служит для вывода информации по количеству обработанных и не обработанных заявок в текущем месяце у активных пользователей системы SalesMan:

  • Логин сотрудника => Открыто, Обработано

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

http(s)://crm_url/developer/v1/leads?login=vladislav@isaler.ru&apikey=aMgiCQyj8bCToNc47BZZYrRICoWSIl&action=stat

Ответ:

В поле “data” приходит id записи

{
 "data":[
  {"title":"vladislav@isaler.ru","open":"2","processed":"1"},
  {"title":"viktor@isaler.ru","open":"0","processed":"0"}
 ]
}

Возможные ответы в случае ошибок:

  • 400 – Не верный API key
  • 401 – Неизвестный пользователь
  • 402 – Неизвестный метод

Запрос “info”

Запрос служит для вывода информации по id заявки:

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

http(s)://crm_url/developer/v1/leads?login=vladislav@isaler.ru&apikey=aMgiCQyj8bCToNc47BZZYrRICoWSIl&action=info&id=1

Ответ:

В поле “data” приходит массив с данными по заявке

Возможные ответы в случае ошибок:

  • 400 – Не верный API key
  • 401 – Неизвестный пользователь
  • 402 – Неизвестный метод

Запрос “list”

Запрос позволяет получить список заявок, в т.ч. с применением фильтров.

Параметры запроса (не обязательные):

  • offset – страница вывода, с учетом того, что установлен лимит в 200 записей на страницу (по умолчанию offset = 0)
  • order – поле, по которому будет производится сортировка списка (по умолчанию order = datum)
  • first – направление сортировки (new – сначала новые, old – сначала старые). (по умолчанию first = new)

Фильтры (не обязательные):

  • dateStart – начальная дата создания записи (формат - YYYY-MM-DD)
  • dateEnd – конечная дата создания записи (не обязательно, формат - YYYY-MM-DD)
    • только dateStart – вывод записей с датой создания больше указанной даты
    • только dateEnd – вывод записей с датой создания меньше указанной даты

Пример формирования запроса в PHP:

$params['login'] = "vladislav@isaler.ru";
$params['apikey'] = 'aMgiCQyj8bCToNc47BZZYrRICoWSIl';
$params['action'] = 'list';

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

http(s)://crm_url/developer/v1/leads?login=vladislav%40isaler.ru&apikey=gCG01Q5MA8msP1jXuQUC&action=list&offset=0&order=datum&first=&dateStart=2016-03-20&dateEnd=2017-03-29

Ответ:

В поле “data” приходит список записей, который содержит следующие данные:

  • id - идентификатор записи
  • datum - дата добавления в формате ГГГГ-ММ-ДД
  • datum_do - дата обработки в формате ГГГГ-ММ-ДД
  • данные из заявки:
    • email
    • phone
    • site
    • company
    • city
    • country
  • content - содержимое пришедшей заявки в виде текста
  • clid - идентификатор записи клиента или 0, если не обработан
  • client - название клиента
  • pid - идентификатор записи контакта или 0, если не обработан
  • person - фио контакта
  • did - идентификатор записи сделки или 0, если не обработан
  • deal - название сделки
  • user - идентификатор записи пользователя или 0, если не обработан
  • userName - фио пользователя
  • status - числовой статус заявки ('0' => 'Открыт', '1' => 'В работе', '2' => 'Обработан', '3' => 'Закрыт')
  • statusName - расшифровка статуса заявки
  • rezult - числовой результат обработки ('1' => 'Спам', '2' => 'Дубль', '3' => 'Другое', '4' => 'Не целевой')
  • rezultName - расшифровка результата обработки
  • clientpath - идентификатор источника клиента (канала)
  • clientpathName - расшифровка источника клиента

Возможные ответы в случае ошибок:

  • 400 – Не верный API key
  • 401 – Неизвестный пользователь
  • 402 – Неизвестный метод

Что-то не понятно? Задай вопрос: