Обращения (entry)

Метод “entry”

Метод позволяет запрашивать информацию по Обращениям

Запрос “list”

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

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

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

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

• dateStart – начальная дата создания записи (формат - YYYY-MM-DD)
• dateEnd – конечная дата создания записи (не обязательно, формат - YYYY-MM-DD)
  • только dateStart – вывод записей с датой создания больше указанной даты
  • только dateEnd – вывод записей с датой создания меньше указанной даты
• status – ограничение по статусам, через запятую ['0' => 'Новое', '1' => 'Обработано', '2' => 'Отменено']

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

$params['offset'] = '0';
$params['order'] = 'datum';
$params['first'] = '';
$params['dateStart'] = '';
$params['dateEnd'] = '';
$params['status'] = '0,1,2';

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

http(s)://crm_url/developer/v1/entry?login=vladislav@isaler.ru&apikey=aMgiCQyj8bCToNc47BZZYrRICoWSIl&action=list&offset=0&order=datum&first=&dateStart=2015-01-01&dateEnd=&status=0,1,2

Ответ:

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

{"data":[ {
   "ide":"57",
   "datum":"2017-02-02 15:30:45",
   "datum_do":"0000-00-00 00:00:00",
   "content":"",
   "clid":"6163",
   "client":"Байт и Ко",
   "pid":"2690",
   "person":"Масленкин Егор",
   "did":"0",
   "deal":null,
   "user":"Андреев Владислав",
   "autor":"Андреев Владислав",
   "status":"0",
   "statusName":"Новое"
} ]}

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

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

 

Запрос “info”

Запрос служит для вывода информации по id или uid обращения.

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

• id – уникальный идентификатор записи
• uid – уникальный идентификатор записи из внешней системы

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

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

Ответ:

В поле “data” приходит информация в виде строки в формате JSON и содержит следующую информацию:

• "id" - уникальный идентификатор записи
• "uid" - уникальный идентификатор записи из внешней системы, если есть
• "clid" - уникальный идентификатор записи клиента
• "pid" - уникальный идентификатор записи контакта
• "did" - уникальный идентификатор записи сделки, если Обращение преобразовано в сделку
• "datum" - дата-время создания записи
• "datum_do" - дата-время обработки Обращения
• "iduser" - идентификатор Ответственного
• "autor" - идентификатор Автора записи
• "content" - комментарий
• "status" - статус Обращения ['0' => 'Новое', '1' => 'Обработано', '2' => 'Отменено']
• "products" - спецификация
  • "prid" - уникальный идентификатор позиции из прайса
  • "title" -  название позиции
  • "kol" - количество
  • "price" - цена продажи

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

{"data": {
    "ide":"56",
    "uid":null,
    "clid":"6164",
    "pid":"2689",
    "did":"0",
    "datum":"2017-02-02 14:40:05",
    "datum_do":"0000-00-00 00:00:00",
    "iduser":"1",
    "autor":"1",
    "content":"",
    "status":"0",
    "products":[{
             "idp":"62",
             "ide":"56",
             "prid":"2315",
             "title":"SIP-T22P SIP-телефон, 3 линии, PoE",
             "kol":"3",
             "price":"4318",
            "identity":"1"
        },
        {
             "idp":"63",
             "ide":"56",
             "prid":"2354",
             "title":"BizFAX E200 факс-сервер, 2 FXO, 1 FXS, 1 RJ45",
             "kol":"1",
            "price":"26724"
        }]
    }
}

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

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

Запрос “update”

Запрос позволяет обновить значение поля uid по id Обращения

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

• id – уникальный идентификатор Обращения
• uid – уникальный идентификатор из внешней системы

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

$params['login'] = "vladislav@isaler.ru";
$params['apikey'] = 'aMgiCQyj8bCToNc47BZZYrRICoWSIl';
$params['action'] = 'update';
$params['id'] = '56';
$params['uid'] = '125';
$urlparams = http_build_query($params);

Ответ:

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

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

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

---

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