Facebook Google Plus Youtube

Напоминания и история (task)

Метод “task”

Метод позволяет управлять записями Напоминаний – добавлять, обновлять, удалять.

Специфичные признаки, используемые далее:

  • tid – уникальный идентификатор напоминания
  • active – признак активности напоминания (yes - активно или no - выполнено)
  • priority – важность (1 – не важно, 0 – нормально*, 2 – важно)
  • speed – срочность (1 – не срочно, 0 – нормально*, 2 – срочно)

* - по умолчанию

Запрос “tips”

Запрос позволяет получить список доступных типов дел и их цвета для формирования дальнейших запросов.

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

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

Ответ:

{"data":[
   {"title":"исх.1.Звонок","color":"#009900"},
   {"title":"Факс","color":"#cc00cc"},
   {"title":"Встреча","color":"#ffcc00"},
   {"title":"Задача","color":"#ff9900"},
   {"title":"Предложение","color":"#66ccff"},
   {"title":"Событие","color":"#666699"},
   {"title":"исх.Почта","color":"#cccc00"},
   {"title":"вх.Звонок","color":"#99cc00"},
   {"title":"вх.Почта","color":"#cc3300"},
   {"title":"Поздравление","color":"#009999"},
   {"title":"исх.2.Звонок","color":"#339966"},
   {"title":"Отправка КП","color":"#ff0000"}
]}

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

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

Запрос “fields”

Запрос позволяет получить список доступных полей, хранящих информацию о клиенте в формате – «Имя поля» - «Расшифровка назначения» для формирования дальнейших запросов.

В список включены поля, активированные в Панели управления / Формы. Не активные поля игнорируются при обработке.

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

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

Ответ:

{
"data":{
   "tid":"Идентификатор напоминания",
   "title":"Тема","des":"Агенда",
   "tip":"Тип напоминания",
   "active":"Признак: выполнено,активно",
   "priority":"Важность",
   "spees":"Срочность",
   "iduser":"Ответственный",
   "autor":"Автор напоминания",
   "clid":"ID клиента",
   "pid":"ID контакта",
   "did":"ID сделки"
   }
}

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

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

Запрос “list”

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

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

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

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

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

Примечание:

По умолчанию выводятся напоминания на текущий день

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

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

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

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

Запрос “info”

Запрос позволяет получить информацию по напоминанию по его идентификатору - tid.

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

  • tid – уникальный идентификатор записи напоминания

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

http(s)://crm_url/developer/v1/task?login=vladislav@isaler.ru&apikey=aMgiCQyj8bCToNc47BZZYrRICoWSIl&action=info&tid=100

Ответ:

{
 "data":{
   "tid":"2930",
   "datum":"2015-05-09",
   "totime":"22:00",
   "title":"Проверка задачи u2116100",
   "des":"",
   "tip":"исх.2.Звонок",
   "active":"yes",
   "priority":"0",
   "speed":"0",
   "iduser":"vladislav@isaler.ru",
   "autor":null,
   "clid":"1651",
   "client":"Белодедовка, ЗАО",
   "pid":"2467",
   "person":"Белодедов Максим",
   "did":"743",
   "dogovor":"Продажа для Белодедовка, ЗАО"
 }
}

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

  • 400 – Не верный API key
  • 401 – Неизвестный пользователь
  • 402 – Неизвестный метод
  • 403 – Напоминание с указанным tid не найдено в пределах аккаунта указанного пользователя
  • 404 – Не найдено
  • 405 – Отсутствуют параметры - tid напоминания

Запрос “add”

Запрос позволяет добавить новое напоминание в базу CRM. При этом ответственным устанавливается сотрудник, логин которого использовался в запросе или указанный отдельно в параметре user

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

  • user – login пользователя в SalesMan CRM, которому назначается напоминание
  • mailalert – отправлять пользователю уведомление по email (yes/no - по умолчанию)
  • прочие поля fields – информация для добавления
    • datum => Дата в формате YYYY-MM-DD (по умолчанию текущая дата)
    • totime => Время в формате H:i (по умолчанию текущее время + 1 час)
    • title => Тема
    • des => Агенда
    • tip => Тип напоминания
    • priority => Важность
    • speed => Срочность
    • autor => логин Автора напоминания (по умолчанию текущий пользователь)
    • clid => ID клиента
    • pid => ID контакта
    • did => ID сделки

Примечание:

  • при пустом поле user Ответственным будет назначен текущий пользователь (из запроса)
  • параметр mailalert = yes сработает только в том случае, если в системе включен параметр Отправки уведомлений и пользователь подписан на получение уведомлений календаря
  • следующие параметры передаются в явном, текстовом виде:
    • tip – Тип напоминания
      В случае отсутствия переданных значений в справочниках будут созданы новые записи

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

$params['login'] = "vladislav@isaler.ru";
$params['apikey'] = 'aMgiCQyj8bCToNc47BZZYrRICoWSIl';
$params['action'] = 'add';
$params['datum'] = '2015-05-10';
$params['totime'] = '22:00';
$params['title'] = 'Перезвонить клиенту с сайта';
$params['des'] = 'SalesMan - это веб-приложение класса CRM';
$params['tip'] = 'Задача';
$params['priority'] = '0';
$params['speed'] = '0';
$params['clid'] = '1200';
$urlparams = http_build_query($params);

Ответ:

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

{"result":"Успешно","data":2502,"message":"Отправлено сотруднику Андреев Владислав"}

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

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

Запрос “update”

Запрос позволяет обновить данные Напоминания по его tid. При этом нет необходимости передавать все данные – можно передать только изменившиеся данные.

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

  • tid – уникальный идентификатор контакта (обязательное поле)
  • прочие поля fields – информация для обновления
  • mailalert – отправлять пользователю уведомление по email (yes/no - по умолчанию)
  • Пример формирования запроса в PHP:

$params['login'] = "vladislav@isaler.ru";
$params['apikey'] = 'aMgiCQyj8bCToNc47BZZYrRICoWSIl';
$params['action'] = 'update';
$params['tid'] = '2502';
$params['datum'] = '2015-05-12';
$params['totime'] = '22:00';
$params['title'] = 'Перезвонить клиенту с сайта';
$params['des'] = 'SalesMan - это веб-приложение класса CRM';
$params['tip'] = 'Задача';
$params['priority'] = '0';
$params['speed'] = '0';
$urlparams = http_build_query($params);

Ответ:

{"result":"Успешно","data":"2509","message":"Отправлено сотруднику Андреев Владислав"}

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

  • 400 – Не верный API key
  • 401 – Неизвестный пользователь
  • 402 – Неизвестный метод
  • 403 – Напоминание не найдено
  • 405 – Отсутствуют параметры - tid напоминания

Запрос “doit”

Запрос позволяет отметить напоминание выполненным по его tid. При этом можно зафиксировать результат выполнения.

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

  • tid – уникальный идентификатор контакта (обязательное поле)
  • description – результат выполнения напоминания

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

http(s)://crm_url/developer/v1/task?login=vladislav@isaler.ru&apikey=aMgiCQyj8bCToNc47BZZYrRICoWSIl&action=doit&tid=2502&&description=%D0%9F%D1%80%D0%BE%D0%B1%D0%BD%D1%8B%D0%B9+%D0%BA%D0%BB%D0%B8%D0%B5%D0%BD%D1%82

Ответ:

{"result":"Успешно","data":"2502","message":"Выполнено напоминание"}

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

  • 400 – Не верный API key
  • 401 – Неизвестный пользователь
  • 402 – Неизвестный метод
  • 403 – Напоминание не найдено
  • 405 – Отсутствуют параметры - tid напоминания

Запрос “delete”

Запрос позволяет удалить напоминание по его tid.

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

  • tid – уникальный идентификатор напоминания (обязательное поле)

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

http(s)://crm_url/developer/v1/task?login=vladislav@isaler.ru&apikey=aMgiCQyj8bCToNc47BZZYrRICoWSIl&action=delete&tid=2502

Ответ:

{"result":"Успешно","data":2502}

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

  • 400 – Не верный API key
  • 401 – Неизвестный пользователь
  • 402 – Неизвестный метод
  • 403 – Напоминание не найдено
  • 405 – Отсутствуют параметры - tid напоминания

Запрос “addhist”

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

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

  • user – login пользователя в SalesMan CRM, которому назначается напоминание
  • прочие поля fields – информация для добавления
    • datum => Дата в формате YYYY-MM-DD H:i:s (по умолчанию текущие дата и время)
    • content => Содержимое записи истории
    • tip => Тип активности
    • clid => ID клиента
    • pid => ID контакта
    • did => ID сделки

Примечание:

  • при пустом поле user Ответственным будет назначен текущий пользователь (из запроса)
  • следующие параметры передаются в явном, текстовом виде:
    • tip – Тип активности (из справочника Типы напоминаний)
      В случае отсутствия переданных значений в справочниках будут созданы новые записи

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

$params['login'] = "vladislav@isaler.ru";
$params['apikey'] = 'aMgiCQyj8bCToNc47BZZYrRICoWSIl';
$params['action'] = 'add';
$params['datum'] = '2015-05-10 15:05:00';
$params['content'] = 'Выполнена задача: Перезвонить клиенту с сайта';
$params['tip'] = 'Задача';
$params['clid'] = '1200';
$urlparams = http_build_query($params);

Ответ:

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

{"result":"Успешно","data":2502}

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

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

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