Документация API INTRUM CRM
Запросы отправляются на адрес: http://domainname.intrumnet.com:81/sharedapi/[тип_объекта]/[подтип] где domainname заменяется на имя вашего домена CRM.
Все запросы должны содержать ключ доступа длинной 32 символа. Ключ вы должны активировать в административной понели CRM INTRUM. Пример запроса:
{
apikey: /* 32 значный ключ */,
params: /* ассоциативный массив параметров */
}
Ответ доступен в формате JSON.
При успешно выполненном запросе ответ будет в следующем виде:
{
status: "success",
data: /* объект */
}
В случае ошибки придет ответ:
{
status: "fail",
message: /* код ошибки */
}
Возможные коды ошибок:
- ACCESS_DENY - нет доступа
- LIMIT_EXCEEDED - превышен лимит запросов
- BAD_REQUEST - неверный запрос объекта
- BAD_PARAMS - неверные параметры запроса
- SERVER_IS_OVERLOADED - сервер перегружен
Внимание!
По умолчанию действуют следующие ограничения:- - Число запросов по умолчанию не более 200 в час (может быть увеличен индивидуально)
- - Число элементов массива в запросе с учетом вложенных не более 1000
Внимание!
Если возникли ошибки подключения, Вы можете попробовать использовать альтернативный порт 80Кодировка запросов UTF-8
Для корректной обработки рекомендуем использовать кодировку UTF-8 для всех параметров запроса.Информация при написании кода не на PHP
Заголовок должен содержать "Content-Type": "application/x-www-form-urlencoded" и тело запроса должно быть в формате "PHP_QUERY_RFC1738"Формат данных
radio | Выбор Да(1) Нет(0) |
select | Выбор одного |
multiselect | Выбор нескольких |
date | Дата 2014-03-14 |
datetime | Дата 2014-03-14 21:34:05 |
time | Время 21:34:05 |
integer | Целое |
decimal | Вещественное |
text | Текст |
price | Цена (в формате, например: 10.52) |
file |
Ссылка на файл - Для объектов изображения /files/crm/product/$filename - оригинал /files/crm/product/resized200x200/$filename - маленькое /files/crm/product/resized800x600/$filename - большое прочие /files/crm/product/$filename - Остальные файлы /files/crm/$filename |
point | Гео координата // передается в формате array('lat'=>"35.013116",'lon'=>"41.906049") |
integer_range | Диапазон целых от - до // передается в формате array('from' => 1,'to' => 2) |
decimal_range | Диапазон вещественных от - до // передается в формате array('from' => 1.1,'to' => 2.1) |
date_range | Диапазон даты от - до |
time_range | Диапазон времени от - до |
datetime_range | Диапазон дата+время от - до |
attach | Прикрепление |
Внимание !
Для типов запрашиваемых сущностей "Объекты" и "Заявки" ("Активности"), поля с типом select и multiselect, зависящие от варианта выбора родителя (nested_selects) по умолчанию не отдаются, их нужно загружать отдельно, т.к. количество вариантов может достигать нескольких тысяч.Загрузка вариантов выбора
URL: | http://domainname.intrumnet.com:81/sharedapi/utils/variants |
Параметры: |
property_id - id поля выбора |
Загрузка вариантов выбора привязанных к конкретному значению (для зависимых полей)
URL: | http://domainname.intrumnet.com:81/sharedapi/utils/binded |
Параметры: |
bind - id варианта выбора |
URL: | http://domainname.intrumnet.com:81/sharedapi/constants |
Параметры: | нет |
Получение списка статей. Статьи могут быть вложены друг в друга.
URL: | http://domainname.intrumnet.com:81/sharedapi/publication/list |
Параметры: |
parent_id - id родителя (обязательное поле, корень = 0) |
Ответ: |
{
|
URL: | http://domainname.intrumnet.com:81/sharedapi/publication/single |
Параметры: |
id - id статьи (обязательное поле) |
Ответ: |
{
|
URL: | http://domainname.intrumnet.com:81/onlineforms |
справочник | примеры интеграции форм |
Параметры: |
action - передать значение getform
form - ID запрашиваемой формы
host - если используется AJAX запрос, необходимо указать имя сайта, с которого происходит запрос в формате sitename.com |
Ответ: |
{ |
URL: | http://domainname.intrumnet.com:81/onlineforms |
справочник | примеры интеграции форм |
Параметры: |
action - значение fillform
formtype - ID типа формы
host - если используется AJAX запрос, необходимо указать имя сайта, с которого происходит запрос в формате sitename.com
data - данные полей
def_customer - массив с основными данными по контакту (surname,name, secondname, email, phone)
ext_customer - массив с данными дополнительных полей по контакту (массив вида: {'id поля':{ value: 'значение'}, 'id поля':{ value: 'значение'})
ext_request - массив с данными дополнительных полей по прикрепеленной активности/заявки (массив вида: {'id поля':{ value: 'значение'}, 'id поля':{ value: 'значение'})
def_stock - массив с основными данными по прикрепеленному объекту (name, parent)
ext_stock - массив с данными дополнительных полей по прикрепеленному объекту (массив вида: {'id поля':{ value: 'значение'}, 'id поля':{ value: 'значение'})
{ |
Ответ: |
{ |
URL: | http://domainname.intrumnet.com:81/sharedapi/stock/types |
Параметры: | нет |
Ответ: |
[
|
URL: | http://domainname.intrumnet.com:81/sharedapi/stock/category |
Параметры: | нет |
Ответ: |
{
|
URL: | http://domainname.intrumnet.com:81/sharedapi/stock/fields |
Параметры: | нет |
Ответ: |
{
|
URL: | http://domainname.intrumnet.com:81/sharedapi/stock/filter |
Параметры: |
type - id типа объекта (обязательное поле, если не указаны byid/by_ids)
byid - id объекта
by_ids - массив id объектов, все объекты из массива должны быть одного типа
category - id категории объекта
nested - значение true или false, включить вложенные категории
search - поисковая строка может содержат имя объекта или вхождения в поля с типами text,select,multiselect (полнотекстовый поиск)
manager - id ответственного или массив с несколькими id
groups - массив CRM групп
stock_creator_id - id создателя
fields - массив условий поиска по полям
[{id:id свойства,value: значение},{...}]
для полей с типом integer,decimal,price,time,date,datetime возможно указывать границы:
value: '>= значение' - больше или равно value: '<= значение' - меньше или равно value: 'значение_1 & значение_2' - между значением 1 и 2 index_fields - индексировать массив полей по id свойства, 1 - да, 0 - нет, (по умолчанию 0)
related_with_customer - связанный с объектом контакт (например, собственник объекта недвижимости)
order - направление сортировки asc - по возрастанию, desc - по убыванию
order_field - id поля, по которому нужно сделать сортировку (если в качестве значения указать stock_activity_date выборка будет сортироваться по дате активности; date_add - по дате создания, date_delete - по дате удаления, id - по id)
date - {from: "2015-10-29 09:45:23", to: "2015-11-19 13:05:12"} выборка за определенный период
date_field - если в качестве значения указать stock_activity_date, то выборка по параметру последней активности (в этом случае период выборки нужно передавать в параметре date)
page - номер страницы выборки (например, 2 страница с limit 500 на каждой, нумерация page начиная с 1)
publish - 1 - активные, 0 - удаленные, ignore - вывод всех, по умолчанию 1
limit - число записей в выборке, по умолчанию 20, макс. 500
group_id - ID группы для группированных объектов
copy - ID Родителя группы для группированных объектов
object_groups - число записей в выборке, по умолчанию 20, макс. 500
count_total - подсчет общего количества найденых записей, 1 - считать, 0 - нет (по умолчанию 0)
only_primary_id - 1 - вывести в ответе только id объектов, 0 - стандартный вывод (по умолчанию 0)
only_count_field - 1 - вывести в ответе только количество, 0 - стандартный вывод (по умолчанию 0)
slice_fields - массив id дополнительных полей, которые будут в ответе (по умолчанию если не задано то выводятся все)
sum_field - id поля, которое нужно просуммировать. В ответе будет сумма значений поля результатов выборки (переменная: sum_field) и их число (count_field). Опция работает только для числовых полей (целое, число, цена)
log - фильтр по истории изменений
|
Ответ: |
{
list - массив выбранных данных
count - общее число найденных записей (или false если не передан параметр count_total) |
URL: | http://domainname.intrumnet.com:81/sharedapi/stock/groups |
Параметры: | нет |
Ответ: |
[
id - ID группы объектов
name - Название группы объектов
type - Тип объектов относящихся к группе
fields - Уникальные ( отличающиеся у прикреплённых и у родителя ) поля объектов
|
URL: | http://domainname.intrumnet.com:81/sharedapi/stock/insert |
Параметры: |
// массив добавляемых записей
Пример загрузки файлов в разделе Утилиты / Загрузка файлов
|
Ответ: |
//ответ содержит массив добавленных объектов
|
URL: | http://domainname.intrumnet.com:81/sharedapi/stock/update |
Параметры: |
//обновление записей аналогично вставке, в список параметров добавляется ID объекта
|
URL: | http://domainname.intrumnet.com:81/sharedapi/stock/updateByFilter |
Параметры: |
//Метод принимает два параметра, filter = аналогичный getStockByFilter и values, содержимое values для разных типов
|
URL: | http://domainname.intrumnet.com:81/sharedapi/stock/addComment |
Параметры: |
[
|
URL: | http://domainname.intrumnet.com:81/sharedapi/stock/delete |
Параметры: |
// для удаления объектов необходимо послать массив их ID
[10234,10432,10342,...] |
URL: | http://domainname.intrumnet.com:81/sharedapi/stock/alive |
Параметры: |
// для восстановления объектов необходимо послать массив их ID
[10234,10432,10342,...] |
URL: | http://domainname.intrumnet.com:81/sharedapi/stock/attach |
Параметры: |
{
|
Ответ: |
{
|
URL: | http://domainname.intrumnet.com:81/sharedapi/stock/attach-indirect |
Параметры: |
{
|
Ответ: |
[{
|
URL: | http://domainname.intrumnet.com:81/sharedapi/stock/favorite-tags |
Параметры: |
{
|
Ответ: |
{
|
URL: | http://domainname.intrumnet.com:81/sharedapi/stock/favorite-tags-info |
Ответ: |
{
|
URL: | http://domainname.intrumnet.com:81/sharedapi/stock/set-favorite-tags |
Параметры: |
{
|
См. также История добавления в избранное и движение по стадиям
URL: | http://domainname.intrumnet.com:81/sharedapi/worker/fields |
Параметры: | нет |
Ответ: |
[
Аналогично полям в объектах |
URL: |
GET
http://domainname.intrumnet.com:81/sharedapi/worker/department
|
Параметры: | Без параметров |
Ответ: |
[
{
"id": 0,
"name": "Имя отдела",
"publ": 1,
"parent_id": 0,
"order": 0,
"description": "Описание отдела",
"timezone": "Europe\/Moscow",
"fields": [
{
"id": 1818,
"type": "date",
"value": 1569877200
}
]
}
] параметры в ответе
|
URL: |
GET
http://domainname.intrumnet.com:81/sharedapi/worker/department/:department_id
|
Параметры: |
параметры в url
|
Ответ: |
Смотрите в примере ответа по отделам
|
URL: |
GET
http://domainname.intrumnet.com:81/sharedapi/worker/department/fields
|
Параметры: | Без параметров |
Ответ: |
Смотрите в примере ответа по полям объектов типа объектов
|
URL: | http://domainname.intrumnet.com:81/sharedapi/worker/filiation |
Параметры: | нет |
Ответ: |
{
id - id филиала
name - название
description - описание
adress - адрес
phone - телефон
email - email |
URL: | http://domainname.intrumnet.com:81/sharedapi/worker/filter |
Параметры: |
group - id CRM группы
id - массив id сотрудников
division_id - массив id отделов
suboffice_id - массив id филиалов
surname - фамилия
name - имя
email - email
phone - телефон
fields - массив условий поиска по полям
[{id:id свойства,value: значение},{...}]
для полей с типом integer,decimal,price,time,date,datetime возможно указывать границы:
value: '>= значение' - больше или равно value: '<= значение' - меньше или равно value: 'значение_1 & значение_2' - между значением 1 и 2 publish - 1 - активные, 0 - удаленные, ignore - вывод всех, по умолчанию 1
boss - 1 - Начадьник отдела, 0 - Не начальник отдела, не указано - вывод всех
slice_fields - массив id дополнительных полей, которые будут в ответе (по умолчанию, если не задано, то выводятся все)
|
Ответ: |
{
id - id сотрудника
avatars - массив аватаров разных размеров включая оригинал
type - может примать значения admin,hr,generalmanager,simple
division_id - id отдела
suboffice_id - id филиала
group_id - массив id групп
post - должность
boss - отметка "начальник отдела"
name - имя
surname - фамилия
secondname - отчество
internalemail,externalemail - внутренняя, внешняя почта
internalphone,externalphone,mobilephone - внутренний, внешний, мобильный телефон
birthday - дата рождения
address - адрес
about - описание
hobby - хобби
created_at - дата регистрации
created_at - дата увольнения
gender - пол male, female
fields - массив условий поиска по полям
[{id:id свойства,value: значение},{...}]
для полей с типом integer,decimal,price,time,date,datetime возможно указывать границы:
value: '>= значение' - больше или равно value: '<= значение' - меньше или равно value: 'значение_1 & значение_2' - между значением 1 и 2 asterisk_short_number - Короткие номера Asterisk |
Пример скрипта на PHP
URL: | http://domainname.intrumnet.com:81/sharedapi/worker/update |
Параметры: |
[
|
Example: | Пример скрипта на PHP |
URL: | [POST] http://domainname.intrumnet.com:81/sharedapi/worker/add |
Параметры: |
{
type : "Тип сотрудника" // Тип. Строго ограниченные значения
/**
simple - Сотрудник (по умолчанию)
admin - Администратор
hr - HR-специалист
generalmanager- менеджер
*/
status : "Статус" // Статус. Строго ограниченные значения
/**
new - Новый (по умолчанию)
onstate - В штате
outstate - Вне штата
*/
suboffice_id: "ID филиала" // (Обязательно) ID филиала к которму прикрепить сотрудника
division_id : "ID отдела" // (Обязательно) ID отдела к которму прикрепить сотрудника
name : "Имя" // (Обязательно) Имя
surname : "Фамилия" // (Обязательно) Фамилия
secondname : "Отчество" // Отчество
login : "login" // (Обязательно) Логин для входа
password : "Пароль" // (Опционально) пароль для входа, если не указано, то пароль будет сгенерирован и отправлен на почту указанную в соответствующем поле
gender : "Пол" // (Обязательно) пол сотрудника. Строго ограниченные значения
/**
male - мужской
female - женский
*/
birthday : "Дата рождения" // Дата рождения в формате YYYY-MM-DD
post : "Должность" // Должность
boss : "Начальник отдела" // Начальник отдела. Строго ограниченные значения
/**
1 - да
0 - нет
*/
is_callcenter: "0" // Сокращенный интерфейс колл-центра. Строго ограниченные значения
/**
1 - да
0 - нет
*/
emails : "Emails" // (Обязательно хотябы 1) Email адреса сотрудника в формате JSON
/** Example:
[{"email":"info@intrumnet.com","comment":"Комментарий к email адресу"},..]
*/
phones : "Телефоны" // (Обязательно хотябы 1) номера телефонов сотрудника в формате JSON
/** Example:
[{"phone":"+7 (495) 225-50-24","comment":"Комментарий к номеру","messengers":["telegram","whatsapp","viber"]},..]
*/
groups: {
crm_management: [CRM группы] // Массив ID CRM групп
email : [Почтовые группы] // Массив ID Почтовых групп
blank : [Администраторы бланков] // Массив ID групп Администраторов бланков
blank_users : [Пользователи бланков] // Массив ID групп Пользователей бланков
blank_chargers: [Ответственные за бланки] // Массив ID групп Ответственных за бланки
}
extproperties:{
/**
Ассоциативный массив, где ключ ID поля, а значение ключа - значение поля. значение зависит от типа поля
*/
}
send_notice : "1" // Отправить уведомление о регистрации на указанную почту. Строго ограниченные значения
/**
1 - Да (по умолчанию)
0 - Нет
*/
}
|
Ответ: |
В случае успеха:
{
"status": "success",
"data":{
"employee_id": ID,// ID добавленного сотрудника
"password": "Пароль"// Пароль
}
}
В случае ошибки:
{
"status": "fail",
"message":[// Массив строк с ошибками
"Some error"
]
}
|
URL: | http://domainname.intrumnet.com:81/sharedapi/managergroup |
Параметры: | нет |
Ответ: |
stdClass Object
id - id CRM группы
name - название группы |
URL: | http://domainname.intrumnet.com:81/sharedapi/purchaser/types |
Параметры: | нет |
URL: | http://domainname.intrumnet.com:81/sharedapi/purchaser/fields |
Параметры: | нет |
Ответ: | (см. получение полей объектов) |
URL: | http://domainname.intrumnet.com:81/sharedapi/purchaser/filter |
Параметры: |
groups - массив id CRM групп
manager - id ответственного или массив с несколькими id
additional_manager_id - массив ID дополнительных ответственных
customer_creator_id - id создателя
byid - id контакта или массив id контактов
marktype - массив id типов
nattype - одно из значений подтипа physface - Юрлицо, jurface - Физлицо, по умолчанию выводятся все
search - поисковая строка (может содержать фамилию или имя, email, телефон)
fields - массив условий поиска по полям
[{id:id свойства,value: значение},{...}]
для полей с типом integer,decimal,price,time,date,datetime возможно указывать границы:
value: '>= значение' - больше или равно value: '<= значение' - меньше или равно value: 'значение_1 & значение_2' - между значением 1 и 2 index_fields - индексировать массив полей по id свойства, 1 - да, 0 - нет, (по умолчанию 0)
order - направление сортировки asc - по возрастанию, desc - по убыванию
order_field - если в качестве значения указать customer_activity_date выборка будет сортироваться по дате активности; create_date - по дате создания, delete_date - по дате удаления, id - по id
date - {from: "2015-10-29", to: "2015-11-19"} выборка за определенный период
date_field - если в качестве значения указать customer_activity_date выборка по параметру активности
page - номер страницы выборки (нумерация с 1)
publish - 1 - активные, 0 - удаленные, по умолчанию 1
limit - число записей в выборке (макс. 500)
count_total - подсчет общего количества найденых записей, 1 - считать, 0 - нет (по умолчанию 0)
only_count_field - 1 - вывести в ответе только количество, 0 - стандартный вывод (по умолчанию 0)
slice_fields - массив id дополнительных полей, которые будут в ответе (по умолчанию если не задано то выводятся все)
|
Ответ: |
{
list - массив выбранных данных
count - общее число найденных записей (или false если не передан параметр count_total)
|
URL: | http://domainname.intrumnet.com:81/sharedapi/purchaser/insert |
Для добавления комментриев используйте отдельный метод
URL: | http://domainname.intrumnet.com:81/sharedapi/purchaser/update |
URL: | http://domainname.intrumnet.com:81/sharedapi/purchaser/addComment |
Параметры: |
[
|
URL: | http://domainname.intrumnet.com:81/sharedapi/purchaser/delete |
URL: | http://domainname.intrumnet.com:81/sharedapi/purchaser/alive |
URL: | http://domainname.intrumnet.com:81/sharedapi/purchaser/attach |
Параметры: |
ids - массив id контактов или единичное значение
|
Ответ: |
{
|
URL: | http://domainname.intrumnet.com:81/sharedapi/applications/types |
Параметры: | нет |
Ответ: |
[
id - id заявки
name - имя
service - пометка "сервисный"
groups - список групп имеющих доступ к данному типу
|
URL: | http://domainname.intrumnet.com:81/sharedapi/applications/fields |
Параметры: | нет |
Ответ: | (См. получение полей объектов) |
URL: | http://domainname.intrumnet.com:81/sharedapi/applications/filter |
Параметры: |
search - поисковая строка (может содержать фамилию, телефон контакта или название заявки)
groups - массив CRM групп
manager - id ответственного или массив с несколькими id
request_creator_id - id создателя
byid - id заявки
by_ids - массив ids заявок
customer - id контакта
fields - массив условий поиска по полям
[{id:id свойства,value: значение},{...}]
для полей с типом integer,decimal,price,time,date,datetime возможно указывать границы:
value: '>= значение' - больше или равно value: '<= значение' - меньше или равно value: 'значение_1 & значение_2' - между значением 1 и 2 types - массив id типов
order_field - если в качестве значения указать request_activity_date выборка будет сортироваться по дате активности
order - направление сортировки asc - по возрастанию, desc - по убыванию (сортировка только по дате последней активности)
date - {from: "2015-10-29", to: "2015-11-19"} выборка за определенный период
date_field - если в качестве значения указать request_activity_date выборка по параметру заявки, create_date - по дате создания, delete_date - по дате удаления, id - по id
statuses - массив id статусов
unselected - Не выбран
mustbeprocessed - Требует обработки
processnow - Требует срочной обработки
processed - Обработан
postponed - Отложен
malformed - Неверен
cancelled - Отменен
reprocess - Требует доработки
page - номер страницы выборки (нумерация с 1)
publish - 1 - активные, 0 - удаленные, по умолчанию 1
log - фильтр по истории изменений
limit - число записей в выборке (макс. 500)
count_total - подсчет общего количества найденых записей, 1 - считать, 0 - нет (по умолчанию 0)
only_count_field - 1 - вывести в ответе только количество, 0 - стандартный вывод (по умолчанию 0)
slice_fields - массив id дополнительных полей, которые будут в ответе (по умолчанию, если не задано, то выводятся все)
|
Ответ: |
{
list - массив выбранных данных
count - общее число найденных записей (или false если не передан параметр count_total)
|
URL: | http://domainname.intrumnet.com:81/sharedapi/applications/insert |
Параметры: |
source - один из вариантов ('online_consult','none','help_manager','online_form')
customers_id - ID контакта (обязательное поле)
employee_id - ID ответственного
additional_employee_id - Массив ID дополнительных ответственных
comment - Комментарий *
request_name - Название заявки
status - один из вариантов ('unselected','mustbeprocessed','processnow','processed','postponed','malformed','cancelled','reprocess')
request_type - ID типа заявки (обязательное поле)
date_create - Дата создания
stock_id - ID объекта или массив ID прикрепляемых объектов
* данный тип комментарием устаревший, используйте |
URL: | http://domainname.intrumnet.com:81/sharedapi/applications/addCustomer |
Параметры: |
{
Пример загрузки файлов в разделе Утилиты / Загрузка файлов
|
Ответ: |
//ответ содержит ID контакта и ID заявки
|
URL: | http://domainname.intrumnet.com:81/sharedapi/applications/addComment |
Параметры: |
[
|
URL: | http://domainname.intrumnet.com:81/sharedapi/applications/favorite-add |
Параметры: |
{
|
URL: | http://domainname.intrumnet.com:81/sharedapi/applications/favorite-del |
Параметры: |
{
|
URL: | http://domainname.intrumnet.com:81/sharedapi/applications/favorite-tags |
Параметры: |
{
|
Ответ: |
{
|
URL: | http://domainname.intrumnet.com:81/sharedapi/applications/favorite-tags-info |
Ответ: |
{
|
URL: | http://domainname.intrumnet.com:81/sharedapi/applications/set-favorite-tags |
Параметры: |
{
|
URL: | http://domainname.intrumnet.com:81/sharedapi/sales/types |
Параметры: | нет |
Ответ: |
[
id - id типа сделки
name - название
stages - список стадий сделки
|
URL: | http://domainname.intrumnet.com:81/sharedapi/sales/fields |
Параметры: | нет |
Ответ: |
{
34 - id типа сделки
stages - группы полей для стадий, id = 0 для общих полей сделки
price_fields - поля являющиеся ценой сделки
fields - список полей
nested_selects - вложенные свойства с типом select, multiselect
|
URL: | http://domainname.intrumnet.com:81/sharedapi/sales/filter |
Параметры: |
search - поисковая строка
type - массив id типов сделок
stage - массив id стадий сделок
customer - id контакта
manager - id ответственного или массив с несколькими id
groups - массив CRM групп
fields - массив условий поиска по полям
[{id:id свойства,value: значение},{...}]
для полей с типом integer,decimal,price,time,date,datetime возможно указывать границы:
value: '>= значение' - больше или равно value: '<= значение' - меньше или равно value: 'значение_1 & значение_2' - между значением 1 и 2 sale_creator_id - id создателя
page - номер страницы выборки (нумерация с 1)
publish - 1 - активные, 0 - удаленные, по умолчанию 1
limit - число записей в выборке (макс. 500)
byid - получение сделки по ее id
by_ids - получение сделок по массиву id [1, 2, 3, ...]
order - направление сортировки asc - по возрастанию, desc - по убыванию
order_field - если в качестве значения указать sale_activity_date выборка будет сортироваться по дате активности, create_date - по дате создания, delete_date - по дате удаления, id - по id
date - {from: "2015-10-29", to: "2015-11-19"} выборка за определенный период
date_field - если в качестве значения указать sale_activity_date выборка по параметру активности
count_total - подсчет общего количества найденых записей, 1 - считать, 0 - нет (по умолчанию 0)
only_count_field - 1 - вывести в ответе только количество, 0 - стандартный вывод (по умолчанию 0)
slice_fields - массив id дополнительных полей, которые будут в ответе (по умолчанию, если не задано, выводятся все)
|
Ответ: |
{
list - массив выбранных данных
count - общее число найденных записей (или false если не передан параметр count_total)
|
URL: | http://domainname.intrumnet.com:81/sharedapi/sales/getbychangestage |
Параметры: |
date_start - Начало периода, в формате %Y-%m-%d
date_end - Конец периода в формате %Y-%m-%d
sale_id - ID Сделки или массив ID сделок
stage - Стадия сделки на которую был переход, id или массив id (если не указана - берутся все)
|
URL: | http://domainname.intrumnet.com:81/sharedapi/sales/details |
Параметры: |
ids - массив id сделок
|
Ответ: |
{
|
URL: | http://domainname.intrumnet.com:81/sharedapi/sales/insert |
Параметры: |
customers_id - id контакта
employee_id - id ответственного
additional_employee_id - массив id дополнительных ответственных
sales_type_id - id типа сделки
sales_status_id - id стадии сделки
sale_name - название сделки
date_create - дата создания
fields - массив данных полей
|
URL: | http://domainname.intrumnet.com:81/sharedapi/sales/addCustomer |
Параметры: |
{
Пример загрузки файлов в разделе Утилиты / Загрузка файлов
|
Ответ: |
//ответ содержит ID контакта и ID сделки
|
Добавляется обязательный параметр id - id сделки в CRM
URL: | http://domainname.intrumnet.com:81/sharedapi/sales/addComment |
Параметры: |
[
|
URL: | http://domainname.intrumnet.com:81/sharedapi/sales/favorite-add |
Параметры: |
{
|
URL: | http://domainname.intrumnet.com:81/sharedapi/sales/favorite-del |
Параметры: |
{
|
URL: | http://domainname.intrumnet.com:81/sharedapi/history/log |
Параметры: |
object_type - тип объекта (одно из значений: stock, customer, sale, request - обязательное поле)
object_id - id объекта (или массив id объектов)
employee_id - id сотрудника производившего изменения (или массив id сотрудников)
date - {from: "2015-10-29", to: "2015-11-19"} выборка за определенный период
log -
массив условий: [
[ { date: - {from: "2015-10-29", to: "2015-11-19"} выборка за определенный период, property_id: - ID свойства, Для запроса даных по фиксированным полям вместо id допустимы следующие параметры: для объектов: related_with_customer, publish, parent, name, deldouble_merge, count, author для сделок: sale_name, publish, employee_id, date_create, customer для заявок: stock, status, request_name, request_comment, publish, employee_id, date_create, customer для контактов: comment, create_date, email, group_id, manager_id, marktype, name, phone, publish, secondname, surname value: - предыдущее значение (так же доступны @any, @empty, @not-empty), current: - текущее значение (так же доступны @any, @empty, @not-empty), }, { ... массив условий И ... }, ], ... массив условий ИЛИ 1 ..., ... массив условий ИЛИ 2 ..., ... массив условий ИЛИ N ... ] |
URL: | http://domainname.intrumnet.com:81/sharedapi/history/favorites |
Параметры: |
date - {from: "2015-10-29", to: "2015-11-19"} выборка за определенный период
|
Ответ: |
[
|
URL: | http://domainname.intrumnet.com:81/sharedapi/accounts/get |
PHP библиотека | метод: billsGet |
Параметры: |
type - Тип счёта (in,out)
date_start - Счёт создан в данную дату или позже (формат dd.mm.YYYY / YYYY-mm-dd)
date_start - Счёт создан в данную дату или раньше (формат dd.mm.YYYY / YYYY-mm-dd)
active - Активые / неактивные счета (1,0)
pay_status - Статус оплаты (not,part,full)
client_id - ID контакта в CRM
search - Строка поиска, поиск осуществляется : по номеру счёта, фамилии контакта, названию компании
act_id - ID связанного акта если не 0, иначе без связанных актов
author - ID сотрудника создавшего акт
company_id - ID реквизитов контакта
sale_id - ID связанной сделки в CRM
not_sale_id - Выборка записей не связанных с указанной сделкой, при указании в фильтре sale_id и not_sale_id, not_sale_id - игнорируется
ids - Выборка записей входящих массив / строку(разделеную ",") ID счетов , применение этого фильтра, очищает фильтр по умолчанию
orderType - Сортировка по убыванию / возрастанию (ASC,DESC)
order - Поле сортировки ('b.id' - номер счёта, "b.date_create" - дата создания счёта)
limit - Количество результатов в одном (постарничном) запросе по умолчанию 1000
page - Номер страницы вывода
period_pay - Период полаты счёта, выодить счета по которам совершалась
оплата в указанный период {date_start: YYYY-mm-dd, date_end: YYYY-mm-dd}
|
Фильтр по умолчанию: |
{
|
Ответ: |
{
filter - Массив настроек фильтра
limit - Кол-во результатов
page - Номер страницы выборки (нумерация с 1)
total - Общее кол-во записей удовлетворяющих фильтру
list - Массив записей
act_id - ID связанного акта
author - ID создавшего сотрудника
author_name - Имя создавшего сотрудника
bill_active - Статус публикации
client_company_id - ID Реквизиов контакта
client_id - ID контакта
date_create - Дата создания в формате YYYY-mm-dd
hash - Уникальный ХЕШ для печати бланка
id - ID счёта
my_company_id - ID реквизитов компании
nds - ризнак НДС ( 1 / 0 )
outer_id - Внешний ключ
pay - Оплачено по счёту
pay_status - Статус оплаты ( "not" - неоплачено,'part'-частично оплачено,'full'-оплачено )
payer - Имя плательщика
payment_date - Дата оплаты
recipient - Имя получателя
sale_id - ID связанной сделки
stockgroup_id - ID списка товаров
summ - Суммма
type - Тип 'out' - исходящий/ 'in' - входящий
|
URL: | http://domainname.intrumnet.com:81/sharedapi/accounts/get_full |
Параметры: |
ids - Массив ID счетов
|
Ответ: |
{
act_id - ID связанного акта в CRM
author - ID сотрудника создавшего акт
author_name - Имя сотрудника создавшего акт
bill_active - Статус публикации
client - Массив данных о контакте
id - Уникальный номер в CRM
logo - Логотип типа пользователя в системе
name - Имя
secondname - Фамилия
surname - Отчество
client_company - Реквизиты контакта
bank_name - Название банка
bank_sity - Город банка
bik - БИК
email - Электронная почта
id - Уникальный номер в CRM
inn - ИНН
kpp - КПП
ks - КС
legal_addres - Юридический адрес
mail_addres - Почтовый адрес
name - Название
ogrn - ОГРН
phone - Телефон
rs - РС
sity - Город
type - Тип
date_create - Дата создания
hash - Уникальная строка индентификатор, для печати бланков
id - Уникальный номер в CRM
my_company - Массив прикреплёных реквизитов фирмы (поля совпадают с реквизитами контакта)
nds - Признак НДС
outer_id - Внешний (синхронизационный) Уникальный идентификатор
pay - Оплачено
pay_status - Статус оплаты
payer - Массив ссылок на плательщика
payment_date - Дата оплаты
products - Массив объектов
recipient - Массив ссылок на получателя
sale_id - Уникальный идентификатор связанной сделки в CRM
stockgroup_id - Идентификатор списка товаров
summ - Сумма счёта
to_pay - К оплате (с учётом НДС)
type - Тип счёта
|
Ответ возвращается так-же в виде массива, с результатом по кажому обьекту, и с ключом и описанием ошибок, если вставка обьекта не удалась.
URL: | http://domainname.intrumnet.com:81/sharedapi/accounts/add |
PHP библиотека | метод: billsAdd |
Параметры: |
[
{
act_id - ID прикреплёного акта
date_create - Дата создания
product - Массив объектов
count - Кол-во объекта
name - Название объекта
price - Цена объекта
sale_id - ID связанной сделки
client_company_id - ID реквизитов контакта
client_id - ID контакта
my_company_id - ID реквизитов фирмы
nds - Наличие ндс
type - Тип счёта входящий / исходящий(in/out)
}
]
|
Ответ: |
[
stat - Результат (1 - успех,0 - ошибка)
id - Уникальный идентификатор созданного счёта
error - Массив ошибок
key - Ключ ошибки
mes - Описание ошибки
|
Ответ возвращается так-же в виде массива, с результатом по кажому обьекту, и с ключом и описанием ошибок, если обновление счёта не удалось.
URL: | http://domainname.intrumnet.com:81/sharedapi/accounts/add |
Параметры: |
[
{
bill_id - Уникальный номер счёта
act_id - ID прикреплёного акта
date_create - Дата создания
product - Массив объектов
count - Кол-во объектов
name - Название объекта
price - Цена объекта
sale_id - ID связанной сделки
stockgroup_id - ID списка товаров
client_company_id - ID реквизитов контакта
client_id - ID контакта
my_company_id - ID реквизитов фирмы
nds - Наличие ндс
type - Тип счёта входящий / исходящий(in/out)
}
]
|
Ответ: | См.добавление счетов |
URL: | http://domainname.intrumnet.com:81/sharedapi/accounts/edit |
Параметры: |
{
bill_id - Уникальный номер счёта
act_id - ID прикрепленного акта
date_create - Дата создания "ГГГГ-ММ-ДД" / "ДД.ММ.ГГГГ"
product - Массив объектов
count - Кол-во объектов
name - Название объекта
price - Цена объекта
sale_id - ID связанной сделки
outer_id - внешний ID
client_company_id - ID реквизитов контакта
client_id - ID контакта
my_company_id - ID реквизитов фирмы
nds - Наличие ндс
is_cash - Оплата наличными
type - Тип счёта входящий / исходящий(in/out)
}
|
Ответ: |
stat:0,
stat - Результат (1 - успех,0 - ошибка)
error - Массив ошибок
key - Ключ ошибки
mes - Описание ошибки
|
Ответ возвращается в виде массива, с параметром stat и status_pay или error - если возникла ошибка
URL: | http://domainname.intrumnet.com:81/sharedapi/accounts/set_pay |
Параметры: |
{
id - Уникальный номер счёта
pay - Сумма платежа (необязательный)
}
|
Ответ: |
{
stat - Результат (1 - успех,0 - ошибка)
status_pay - Актуальный статус
error - Массив ошибки
key - Ключ ошибки
mes - Описание ошибки
|
URL: | http://domainname.intrumnet.com:81/sharedapi/acts/get |
Параметры: |
type - Тип счёта (in,out)
date_start - Счёт создан в данную дату или позже (формат dd.mm.YYYY / YYYY-mm-dd)
date_start - Счёт создан в данную дату или раньше (формат dd.mm.YYYY / YYYY-mm-dd)
active - Активые / неактивные акты (1,0)
pay_status - Статус оплаты (not,part,full)
client_id - ID контакта в CRM
search - Строка поиска, поиск осуществляется : по номеру счёта, фамилии контакта, названию компании
bill_id - ID связанного счёта если не 0, иначе без связанных актов
author - ID сотрудника создавшего акт
company_id - ID реквизитов контакта
orderType - Сортировка по убыванию / возрастанию (ASC,DESC)
order - Поле сортировки ('b.id' - номер счёта, "b.date_create" - дата создания счёта)
limit - Количество результатов в одном (постарничном) запросе по умолчанию 1000
page - Номер страницы вывода
|
Фильтр по умолчанию: |
{
|
Ответ: |
{
filter - Массив настроек фильтра
limit - Кол-во результатов
page - Номер страницы результатов
total - Общее кол-во записей удовлетворяющих фильтру
list - Массив записей
active - Статус публикации
author - ID создавшего сотрудника
author_name - Имя создавшего сотрудника
bill_id - ID связанного счёта
client_company_id - ID Реквизиов контакта
client_id - ID контакта
date_create - Дата создания в формате YYYY-mm-dd
hash - Уникальный ХЕШ для печати бланка
id - ID счёта
my_company_id - ID реквизитов компании
nds - ризнак НДС ( 1 / 0 )
pay - Оплачено по счёту
pay_status - Статус оплаты ( "not" - неоплачено,'part'-частично оплачено,'full'-оплачено )
payer - Имя плательщика
payment_date - Дата оплаты
recipient - Имя получателя
stockgroup_id - ID списка товаров
summ - Суммма
type - Тип 'out' - исходящий/ 'in' - входящий
|
Ответ возвращается так-же в виде массива, с результатом по добавлению каждого актв, и с ключом и описанием ошибок, если добавление акта не удалось.
URL: | http://domainname.intrumnet.com:81/sharedapi/acts/add |
Параметры: |
[
{
bill_id - ID прикреплёного счёта
date_create - Дата создания
product - Массив объектов
count - Кол-во объектов
name - Название объекта
price - Цена объекта
client_company_id - ID реквизитов контакта
client_id - ID контакта
my_company_id - ID реквизитов фирмы
nds - Наличие ндс
type - Тип акта входящий / исходящий(in/out)
}
]
|
Ответ: | Ответ такой-же, как при добавлении счетов |
Ответ возвращается так-же в виде массива, с результатом по кажому обьекту, и с ключом и описанием ошибок, если обновление акта не удалось.
URL: | http://domainname.intrumnet.com:81/sharedapi/acts/add |
Параметры: |
[
{
id - Уникальный номер акта в CRM
bill_id - ID прикреплёного счёта
date_create - Дата создания
product - Массив объектов
count - Кол-во объектов
id - Кникальный номер объекта
name - Название объекта
price - Цена объекта
stockgroup_id - ID списка товаров
client_company_id - ID реквизитов контакта
client_id - ID контакта
my_company_id - ID реквизитов фирмы
nds - Наличие ндс
type - Тип счёта входящий / исходящий(in/out)
}
]
|
Ответ: | См.добавление счетов |
URL: | http://domainname.intrumnet.com:81/sharedapi/acts/edit |
Параметры: |
{
act_id - Уникальный номер акта в CRM
bill_id - ID прикреплёного счёта
date_create - Дата создания
product - Массив объектов
count - Кол-во объектов
name - Название объекта
price - Цена объекта
client_company_id - ID реквизитов контакта
client_id - ID контакта
my_company_id - ID реквизитов фирмы
nds - Наличие ндс
type - Тип счёта входящий / исходящий(in/out)
}
|
Ответ: |
stat:0,
stat - Результат (1 - успех,0 - ошибка)
error - Массив ошибок
key - Ключ ошибки
mes - Описание ошибки
|
Ответ возвращается в виде массива, с параметром stat и status_pay или error - если возникла ошибка
URL: | http://domainname.intrumnet.com:81/sharedapi/acts/set_pay |
Параметры: |
{
id - Уникальный номер акта в CRM
pay - Сумма платежа (необязательный)
}
|
Ответ: |
{
stat - Результат (1 - успех,0 - ошибка)
status_pay - Актуальный статус
error - Массив ошибки
key - Ключ ошибки
mes - Описание ошибки
|
URL: | http://domainname.intrumnet.com:81/sharedapi/checks/get |
Параметры: |
company_inn - ИНН компании фигурирующей в выписке
search - Строка поиска, поиск осуществляется : По ИНН, ID выписки, внешнему номеру выписки, ФИО плательщика или получателя
author - ID сотрудника создавшего счёт
type - Тип выписки, взодящая/исходящая(in/out)
date_start - Дата создания старше или равна переданной
date_end - Дата создания младше или равна переданной
orderType - Сортировка по убыванию / возрастанию (ASC,DESC)
order - Поле сортировки ('с.id' - номер счёта, "с.date_create" - дата создания счёта)
limit - Количество результатов в одном (постарничном) запросе по умолчанию 1000, больше 1000 передавать нельзя
page - Номер страницы вывода
|
Фильтр по умолчанию: |
{
|
Ответ: |
{
filter - Массив настроек фильтра
limit - Кол-во результатов
page - Номер страницы результата
total - Общее кол-во записей удовлетворяющих фильтру
list - Массив записей
act_id - ID связанного акта
author - ID сотрудника создавшего выписку
bill_id - ID связанного счёта
check_type - Вид Оплаты
comment - Описание выписки
date - Дата выписки
id - Уникальный номер в CRM
info -(необязательный) JSON массива доп.информации {status: Статус Составителя, okato: ОКАТО}
nume - Внешний номер
outside -(необязательный) JSON массива показателей {kbk : Показатель КБК
grounds : Показатель Основания, period: Показатель Периода, nume: ПоказательНомера, date: ПоказательДаты,type: ПоказательТипа}
pay_type - Тип оплаты
payer_bank_city - Город банка плательщика
payer_bank_name - Название банка плательщика
payer_bik - БИК банка плательщика
payer_client_id - ID контакта плательщика (для исходящих виписок)
payer_id - ID реквизитов контакта-плательщика (для исходящих виписок)
payer_inn - ИНН плательщика
payer_kpp - КПП плательщика
payer_ks - Коррекционный счёт плательщика
payer_name - Имя плательщика
payer_rs - Расчётный счёт плательщика
priority - Приоритет
recipient_bank_city - Город банка получателя
recipient_bank_name - Название банка получателя
recipient_bik - БИК банка получателя
recipient_client_id - ID контакта получателя (для входящих виписок)
recipient_id - ID реквизитов контакта-получателя (для входящих виписок)
recipient_inn - ИНН получателя
recipient_kpp - КПП получателя
recipient_ks - Коррекционный счёт получателя
recipient_name - Имя получателя
recipient_rs - Расчётный счёт получателя
type - Тип выписки входящая/исходящая(in/out)
|
Ответ возвращается так-же в виде массива, с результатом по кажому обьекту, и описанием ошибоки, если добавление выписки не удалось.
URL: | http://domainname.intrumnet.com:81/sharedapi/checks/add |
Параметры: |
[
{
bill_id - ID прикреплёного счёта
comment - Комментарий по выписке
date - Дата создания выписки
nume - Внешний номер (1С) выписки
payer_bank_city - Город банка плательщика
payer_bank_name - Название банка плательщика
payer_bik - БИК плательщика
payer_client_id - ID контакта плательщика (для исходящих выписок)
payer_id - ID реквизитов плательщика (для исходящих выписок)
payer_inn - ИНН плательщика
payer_kpp - КПП плательщика
payer_ks - Коррекционный счёт плательщика
payer_name - Имя плательщика
payer_rs - Расчётный счёт плательщика
recipient_bank_city - Город банка получателя
recipient_bank_name - Название банка получателя
recipient_bik - БИК получателя
recipient_client_id - ID контакта получателя (для входящих выписок)
recipient_id - ID реквизитов получателя (для входящих выписок)
recipient_inn - ИНН получателя
recipient_kpp - КПП получателя
recipient_ks - Коррекционный счёт получателя
recipient_name - Имя получателя
recipient_rs - Расчётный счёт получателя
summ - Сумма по выписке
type - Тип выписки входящая/исходящая(in/out)
}
]
|
Ответ: |
[
error - Описание ошибки, если добавление выписки не удалось
id - ID добавленной выписки, при успешном добавлении
stat - Статус успеха операции добавления выписки
|
Ответ возвращается так-же в виде массива, с результатом по кажому обьекту, и описанием ошибоки, если обновление выписки не удалось.
URL: | http://domainname.intrumnet.com:81/sharedapi/checks/update |
Параметры: | Параметры те же что при добавлении выписки, плюс id выписки |
Ответ: | Аналогичен ответу, при добавлении выписки |
Пример скрипта на PHP | |
URL: | http://domainname.intrumnet.com:81/sharedapi/utils/upload |
Параметры: |
object - один из возможных вариантов: stock (объекты, продукты), applications (заявки), purchaser (контакты), sales (продажи)
upload - имя поля загружаемого файла, поддерживает множественную загрузку
|
Ответ: |
{
|
URL: |
http://domainname.intrumnet.com:81/sharedapi/[тип_объекта]/comments Тип объекта должен быть одним из значений: stock, applications, purchaser, sales |
Параметры: |
entity_id - id или массив id сущностей
|
Ответ: |
Для контакта выводятся все коментарии связаных с ним объектов, заявок (активности), сделок
{
|
- API ключ: | 32-символьная строка, генерируемая сервером INTRUM, потребуется при запросах; |
- Gateway Client: | url скрипта примимающего запросы от INTRUM; |
- Gateway CRM: | url скрипта для отправки запросов контактам; |
Затем необходимо добавить имя/номер отправителя, в качестве провайдера выбрав только что созданного. CRM INTRUM будет принимать только те входящие SMS, которые были отправлены на добавленные в админке номера.
В поле Gateway CRM введите адрес к PHP скрипту, размещенный на Вашем хостинге. В PHP скрипт добавьте класс CustomSmsService extends IntrumSmsApi из библиотеки, там в функциях sendSms, smsStatus разместите код, отправляющий запросы на внешний адрес sms провайдера
sendSms | отправить смс |
smsStatus | получить текущий статус отправки/доставки смс |
smsRecieved | получено новое сообщение |
Хеш запроса вычисляется следующим образом:
- 1. пары ключ-значение сортируются по имени ключа;
- 2. значения объединяются в единую строку;
- 3. к строке добавляется API ключ;
- 4. хешем является значение MD5 от полученной строки;
Параметры |
action = sendSms user = имя_пользователя, если оно было задано в настройках при добавлении провайдера sender = имя_отправителя, из настроек "Тел. номеров отправки" destination = номер_назначения text = текст_смс |
Ответ |
В случае успешной постановки смс в очередь на отправку в ответе должны содержаться поля:
{
|
В случае ошибки:
{
|
Параметры |
action = smsStatus sms_id = числовой_идентификатор_смс |
Ответ |
В случае успеха:
{
|
В случае ошибки:
{
В данном случае, через какое-то время сервер INTRUM повторит запрос.
|
new | в очереди на отправку |
inprogress | отправляется |
send | отправлено |
delivered | доставлено |
notdelivered | не доставлено |
blocked | отправка невозможна (нет средств и т. п.) |
absent | абонент недоступен |
notfound | смс с переданным id не существует |
Параметры |
action = smsRecieved sms_id = числовой_идентификатор_смс (> 0) sender = номер_отправителя destination = номер_назначения message = текст_смс count = количество_сообщений_в_смс date = дата_получения_в_unix_timestamp (необязательный параметр) |
Ответ |
В случае успешного добавления sms в INTRUM, ответом будет:
{
|
В случае если сервер не может обработать запрос в данный момент, и запрос следует повторить спустя какое-то время:
{
|
|
В случае ошибки, и когда повторять запрос не следует:
{
|
Запросы отправляются на адрес: http://domainname.intrumnet.com:81/sharedapi/calls/[имя_запроса] где domainname заменяется на имя вашего домена CRM.
Пример запроса:
{
apikey: /* 32 значный ключ */,
params: /* ассоциативный массив параметров */
}
Ответ доступен в формате JSON.
trunks | получить список соединений |
phoneNumbers | получить список номеров для совершения входящих и исходящих вызовов |
statuses | получить список доступных статусов звонков. Имеются ввиду статусы, которые назначаются пользователями вручную |
history | получить историю звонков |
update | редактирование звонка |
import | импорт одного звонка в историю |
importall | импорт нескольки звонков в историю, за один запрос |
call | создать звонок |
URL: | http://domainname.intrumnet.com:81/sharedapi/calls/trunks |
Параметры | Без параметров |
Ответ |
Перечисление всех соединений в системе:
{
|
В случае ошибки:
{
|
URL: | http://domainname.intrumnet.com:81/sharedapi/calls/phoneNumbers |
Параметры | Без параметров |
Ответ |
Перечисление всех номеров для входящих и исходящих вызовов в системе:
{
|
В случае ошибки:
{
|
URL: | http://domainname.intrumnet.com:81/sharedapi/calls/statuses |
PHP библиотека | метод: callsGetStatuses |
Параметры | Без параметров |
Ответ |
Перечисление всех статусов, которые могут быть назначены вонкам:
{
|
В случае ошибки:
{
|
URL: | http://domainname.intrumnet.com:81/sharedapi/calls/history |
Параметры |
id Числовой id звонка fromPhone Фильтр по номеру с которого звонили toPhone Фильтр по номеру на который звонили trunkId Фильтр по id соединения через которое звонили dateFrom Искать звонки после даты dateTo Искать звонки до даты type Тип звонков: in, out answered Был ли звонок успешным: true, false customStatus ID назначенного звонку статуса, список доступных статусов. Допускается указание знаков сравнения и частиты отрицания, например: >=5, <9, not 3 stockId ID объекта, напрямую связанного с искомыми звонками limit Ограничить ответ количеством записей (макс. 1000) page Совместно с ограничением, определяет страницу выдачи orderField Сортировать по полю (по-умолчанию поле даты) tags Массив тегов (источников), назначенных данному звонку orderType Направление сортировки: ASC, DESC (по-умолчанию DESC) count_total Подсчет общего количества найденых записей: 1 - считать, 0 - нет (по умолчанию 0 ) crm_entities Вернуть в ответе привязанные непосредственно к звонкам crm сущности: 1 - да, 0 - нет (по умолчанию 0 ) |
Ответ |
Список звонков из истории, по указанным фильтрам:
{
|
В случае ошибки:
{
|
|
Записи разговора могут быть в моно и стерео форматах. В зависимости от настроек, любая из них или обе сразу могут отсутствовать, в этом случае вместо ссылки в соответствующем поле будет передана пустая строка. По значению поля bridged в объектах сотрудников участвовавших в звонке, можно понять разговаривал ли определённый сотрудник (значение true), или просто находился в сценарии обработки звонка (значение false). |
URL: | http://domainname.intrumnet.com:81/sharedapi/calls/import | ||||||||||||||||||||||||||||
Параметры |
|
||||||||||||||||||||||||||||
Ответ |
в случае успеха операции, вовзращается ID добавленного звонка, в CRM звонок появится через екоторое время:
{
|
||||||||||||||||||||||||||||
В случае ошибки:
{
|
URL: | http://domainname.intrumnet.com:81/sharedapi/calls/importall | ||||||||||||||||||||||||
Параметры |
|
||||||||||||||||||||||||
Формат запроса |
Массив объектов call, в массиве с ключом calls
{
|
||||||||||||||||||||||||
Ответ |
{
|
URL: | http://domainname.intrumnet.com:81/sharedapi/calls/update | ||||||||||||||
Параметры |
|
||||||||||||||
Ответ |
в случае успеха операции, вовзращается ID добавленного звонка, в CRM звонок появится через некоторое время:
{
|
URL: | http://domainname.intrumnet.com:81/sharedapi/calls/attachRequest | ||||
Параметры |
|
||||
Ответ |
Ответ сервера в json формате
{
|
||||
В случае ошибки:
{
|
URL: | http://domainname.intrumnet.com:81/sharedapi/calls/attachSale | ||||
Параметры |
|
||||
Ответ |
Ответ сервера в json формате
{
|
||||
В случае ошибки:
{
|
Параметры |
action = call phone_to На какой номер позвонить phone_from Какой номер использовать для звонка user_id ID пользователя в CRM системе key Ключ, указанный при создании соединения |
Ответ |
Ответ сервера в json формате
{
|
В случае ошибки:
{
|
URL: | http://domainname.intrumnet.com:81/sharedapi/calls/callRequest |
Параметры |
phoneA - на какой номер позвонить сначала phoneB - на какой номер позвонить, если phoneA ответил на звонок trunkId - соединение, через которое будут совершаться внешние звонки. См. список соединений |
Ответ |
Ответ сервера в json формате
{
|
В случае ошибки:
{
|
[подтип] | insert |
URL: | http://domainname.intrumnet.com:81/sharedapi/externaldialogs/insert |
Параметры: |
customer - id контакта в системе INTRUM
Опционально если необходимо прикрепить диалог к контакту
Если нужно создать диалог без привязки к контакту в системе INTRUM то в параметре customer нужно указать 0
dialog - Набор свойств типа диалога
id - Заданный id типа диалога
Опционально! Если указан этот параметр, то остальные параметры в dialog Игнорируются
name - Название нового типа диалога
Если необходимо создать новый диалог
employees - Список участников диалога
Список id сотрудников.
Обратите внимание, чтобы не перечислять список сотрудников для каждого диалога, создайте тип диалога с заданным списком сотрудников и прикрепляйте все новые диалоги к нему. |
Ответ |
В любом случае в ответе будет присутствовать clientkey и client (идентификатор внешнего адресата диалога):
{
Внимание !Сохраните clientkey и client для дальнейшего использования
В дальнейшем можно указывать его в параметре dialogid.id, если вам необходимо создать аналогичный диалог (название, список сотрудников) с другим контактом.
{
|
[подтип] | update |
URL: | http://domainname.intrumnet.com:81/sharedapi/externaldialogs/update |
Параметры: |
id - id типа диалога (Обязательно)
name - новое имя типа диалога (Опционально)
Указать новое название если необходимо сменить
employees - новый список участников (Опционально)
Список id сотрудников (участников), если нужно изменить
|
Ответ |
status - boolean Статус завершения операции
{
|
[подтип] | history |
URL: | http://domainname.intrumnet.com:81/sharedapi/externaldialogs/history |
Параметры: |
group - id типа диалога (Обязательно)
client - id внешнего адресата (Обязательно)
date - timestamp (Обязательно)
Крайняя дата - отдаются все сообщения пришедшие до указанного момента
page - номер запрашиваемой страницы (0 - первая странциа)
Если параметр опущен то будет отдана первая страница
История отдается начиная с последнего сообщения
count - Количество на страницу (30 по умолчанию)
Целое число в диапазоне 10 - 50 включительно
|
Ответ |
list - Массив типов диалогов
{
|
[подтип] | notread |
URL: | http://domainname.intrumnet.com:81/sharedapi/externaldialogs/notread |
Параметры: |
groups - список id типов диалогов (Обязательно)
client - id внешнего адресата (Обязательно)
|
Ответ |
list - Массив типов диалогов
{
|
client -> server
Пакет авторизации
Пакет отправки сообщения
Пакет отчета о прочтении
Запрос списка пользователей онлайн
Произвольные настраиваемые пакеты
Pong пакет (ответ на ping)
Подписка на обновление данных об онлайн статусах для сотрудников
Одписка от обновлений данных об онлайн статусах для сотрудников
Запрос списка подписок
server -> client
Ответ на пакет авторизации
Ping пакет (Нужно ответить пакетом pong)
Список сотрудников онлайн
Входящее сообщение
Отчет о доставки сообщения до сервера
Отчет о прочтении сообщения
Список подписок
Произвольные настраиваемые пакеты
[подтип] | list |
URL: | http://domainname.intrumnet.com:81/sharedapi/org_events/list |
Параметры: |
filters - Фильтры
from - (unix timestamp) - Начало периода за который нужно получить события (по умолчанию текущее время)
to - (unix timestamp) - Окончание периода за который нужно получить события (по умолчанию текущее время + 30 дней)
publ - (1 - активные (по умолчанию) , 0 - удаленные , all - все) - Фильтр по опубликованности
employee - (целое) ID Сотрудника, если нужно по всем - то параметр не указывается.
uid - (строка) Уникальный идентефикатор события. Например для регулярных событий
types - (массив) Список идентефикаторов (id) Типов событий
|
Ответ |
list - Массив событий
{
|
[подтип] | types |
URL: | http://domainname.intrumnet.com:81/sharedapi/org_events/types |
Параметры: | Отсутствуют |
Ответ |
Массив типов событий
[
{
"id": "целое - id типа",
"is_system": "yes или no - системное или нет",
"system_name": "Если системное , название системного типа (например Показ)",
"title": "Название типа события",
"theme_id": "ID Маркера",
"textColor": "hex - цвет текста события",
"backgroundColor": "hex - цвет фона события,
"borderColor": "hex - цвет рамки события"
}
]
|
[подтип] | missed_alarms |
URL: | http://domainname.intrumnet.com:81/sharedapi/org_events/missed_alarms |
Параметры: |
employee_id - Id сотрудника
|
Ответ |
[
/****/
{
"id" : "целое - id пропущеного уведомления" ,
"alarm" : "целое - id уведомления" ,
"event_id" : "целое - id напоминания" ,
"queue" : "целое - id очереди напоминания" ,
"summary" : "строка - название события" ,
"description" : "строка - описание события" ,
"notice" : "строка - текс увемоления" ,
"datetime" : "unix timestamp - Время вызова уведомления"
}
/****/
]
|
[подтип] | get |
URL: | http://domainname.intrumnet.com:81/sharedapi/org_events/get |
Параметры: |
event_id - Id напоминания (Обязательно)
queue_id - Id очереди (не обязательно) , например если уведомление регулярное то некоторые напоминания в очереди могут отличаться друг от друга и если не указать этот параметр, то вернутся общие данные для всей очереди
|
Ответ |
{
"id" : "целое - id напоминания" ,
"queue" : "целое - id очереди напоминания" ,
"uid" : "Уникальный идентефикатор события" ,
"publ" : "1 (1 - Активно , 0 - удалено)" ,
"created" : "unix timestamp - время создания события" ,
"last-modified" : "timestamp - время последнего редактирования" ,
"author_id" : "целоа - id сотрудника (автора события)" ,
"summary" : "строка - краткое название события" ,
"description" : "строка - Описание события" ,
"dtstart" : "unix timestamp - Время начала события" ,
"dtend" : "unix timestamp - Время окончания события" ,
"dtoffset" : "целое - Смещение временной зоны относительно UTC в минутах (например для UTC +3 значение 180) для dtstart" ,
"dtendoffset" : "целое - Смещение временной зоны относительно UTC в минутах (например для UTC +3 значение 180) для dtend" ,
"allday" : "1 - Событие на весь день, 2 - событие на указанный интервал" ,
"theme_id" : "ID темы события",
"type_id" : "ID типа события",
"is_reg" : "1 - Повторяющееся событие, 0 - одиночное событие" ,
"bg-color" : "hex - цвет фона события" ,
"b-color" : "hex - цвет рамки события" ,
"t-color" : "hex - цвет текста события" ,
"alarms" : "json string - Уведомления события" ,
"missed_alarms" : "null или массив id пропущенных уведомлений" ,
"users" : "null или массив id сотрудников" ,
"connections" : [
/** Список прикрепленных сущностей **/
{
"substance_summary" : "строка - название сущности , если есть"
"object_type" : "строка - тип сущности"
"object_id" : "строка - id сущности"
}
/****/
]
}
|
Не забудьте включить настройку у используемого API ключа
[подтип] | insert |
URL: | http://domainname.intrumnet.com:81/sharedapi/org_events/insert |
Параметры: |
event - Массив с данными о событии
dtstart - (unix timestamp) - Начало события
dtend - (unix timestamp) - Окончание события
summary - (строка) - Название события
description - (строка) - Описание события
dtoffset - (целое) - Смещение временной зоны относительно UTC в минутах (например для UTC +3 значение 180) для dtstart
dtendoffset - (целое) - Смещение временной зоны относительно UTC в минутах (например для UTC +3 значение 180) для dtend (если не указан то используется dtoffset)
author_id - (целое) - автор (id сотрудника)
allday - 1 - Событие на весь день, 0 - событие на указанный интервал
type_id - (целое) - Тип соыбтия
users - (массив id сотрудников) - Если нужно добавить сотрудников в событие, автора указывать не нужно
connections - (массив) - Прикрепленные сущности, пример можно посмотреть в ответе с информацией о событии
bg-color - (hex) - цвет фона события
b-color - (hex) - цвет рамки события
t-color - (hex) - цвет текста события
alarms - (массив) - Уведомления по событию
trigger - (строка) - триггер в формате iCal подробнее. Например "-P10M" - за 10 минут до начала события
notice - (строка) - Описание к напоминанию
rrule - (строка) - Описание регулярно события в формате iCal подробнее. Если событие не повторяется то параметр не заполнять. Удобный конструктор строки
|
Ответ |
{
"event_id" : "(целое) - id созданного события"
"uid" : "(строка) - уникальный идентефикатор созданного события"
}
|
Не забудьте включить настройку у используемого API ключа
[подтип] | update |
URL: | http://domainname.intrumnet.com:81/sharedapi/org_events/update |
Параметры: |
Параметры аналогичны параметрам при добавление за исключениями
- в массив event добавить параметр id - id редатируемого события
- в массив event добавить параметр queue - id очереди редатируемого события если нужно отредактировать только определенное событие из очереди
- можно указать только те параметры которые нужно отредактировать
- Параметр users можно не указывать если список участников не меняется
- можно указать параметр publ = 0 для удаления , 1 - для восстановления (нужны соответствующие права)
|
Ответ |
{
"event_id" : "(целое) - id события"
"changes" : [
/* Список изменени */
{
"row" : "Поле" ,
"old" : "Старое значение" ,
"new" : "Новое значение"
}
]
}
|
Не забудьте включить настройку у используемого API ключа
[подтип] | delete |
URL: | http://domainname.intrumnet.com:81/sharedapi/org_events/delete |
Параметры: |
id - Id напоминания
queue - Id очереди напоминания
|
Ответ |
Пустой в случае успеха
|
URL: | http://domainname.intrumnet.com:81/sharedapi/blanks/types |
Параметры: | Без параметров |
Ответ: |
[
|
URL: | http://domainname.intrumnet.com:81/sharedapi/blanks/filter |
Параметры: |
date_fill - {from: "2015-10-29 09:45:23", to: "2015-11-19 13:05:12"} выборка документов за определенный период
blank_id - тип документа (id или массив id)
employee_id - сотрудник (id или массив id)
object_type - тип CRM сущности (customer,stock,request,sale)
object_id - id сущности (id или массив id)
page - номер страницы выборки (нумерация с 1)
limit - число записей в выборке (по умолчанию 50)
|
Ответ: |
{
|
URL: | http://domainname.intrumnet.com:81/sharedapi/blanks/info |
Параметры: |
id - id документа
|
Ответ: |
{
|
URL: | http://domainname.intrumnet.com:81/sharedapi/blanks/shipping |
Параметры: |
date_send - {from: "2015-10-29 09:45:23", to: "2015-11-19 13:05:12"} выборка отправленных за определенный период
status - статус отправки (тип или массив типов)
blank_id - тип документа (id или массив id)
employee_id - сотрудник (id или массив id)
object_type - тип CRM сущности (customer,stock,request,sale)
object_id - id сущности (id или массив id)
page - номер страницы выборки (нумерация с 1)
limit - число записей в выборке (по умолчанию 50)
|
Ответ: |
{
|
{
status: 'fail',
message: 'BAD_REQUEST',
error: '%error text%'
}
в котором в поле error указано описание ошибки
Общие ошибки: |
unknown api method
- данный метод API не реализован
sql error
- ошибка SQL при обработке запроса, обратитесь в техническую поддержку
|
URL: | http://domainname.intrumnet.com:81/sharedapi/tasks/list |
Параметры: |
id
- id задачи
status
- статус задачи:
type
- тип задачи для сотрудника, id которого указано в поле employee:
employee - id сотрудника для фильтра по типу задачи, или для получения типа задачи в поле type ответа, в выборке будут только задачи, в которых есть данный сотрудник
stock - id объекта для получения задач, к которым прикреплён данный объект;
request - id заявки для получения задач, к которым прикреплена данная заявка;
sale -id сделки для получения задач, к которым прикреплена данная сделка;
customer - id контакта для получения задач, к которым прикреплён данный контакт;
search - текст для поиска в заголовке или описании задачи
terms
- фильтр по срокам выполнения:
Допускается передача как обеих границ сроков выполнения задачи, так и только одной из них
created_at
- фильтр по дате создания задачи:
Допускается передача как обеих границ даты создания задачи, так и только одной из них
limit - лимит задач в выборке (по умолчанию - 100, макс. значение - 1000)
page - номер страницы выдачи (по умолчанию - 0)
fields
- перечень возвращаемых полей задачи, соединенных через запятую (по умолчанию - все поля, кроме type):
|
Ответ: |
{
|
Возможные ошибки: |
unknown task status
- неподдерживаемое значение поля фильтра status
employee field is required
- задан фильтр по полю фильтра type, и/или в поле fields указано поле type, но не задано поле фильтра employee
unknown task type
- неподдерживаемое значение поля фильтра type
empty field list
- в запрос передается параметр fields, но его значение пустое
invalid created_at
- неверно указаны границы даты создания задачи
invalid terms
- неверно указаны границы сроков выполнения задачи
unknown task field
- в параметре fields указано неподдерживаемое значение
negative limit
- в параметре limit указано отрицательное значение
zero limit
- в параметре limit указано нулевое значение
negative page
- в параметре page указано отрицательное значение
unknown filter field
- передан неподдерживаемый параметр
no search text
- пустой или невалидный текст для поиска
|
URL: | http://domainname.intrumnet.com:81/sharedapi/tasks/search |
Параметры: |
title - текст для поиска в заголовке задачи, обязательное поле
limit - лимит задач в выборке (по умолчанию - 100, макс. значение - 1000)
page - номер страницы выдачи (по умолчанию - 0)
|
Ответ: |
{
|
Возможные ошибки: |
no search text
- пустой или невалидный текст для поиска
negative limit
- в параметре limit указано отрицательное значение
zero limit
- в параметре limit указано нулевое значение
negative page
- в параметре page указано отрицательное значение
unknown filter field
- передан неподдерживаемый параметр
|
URL: | http://domainname.intrumnet.com:81/sharedapi/tasks/create |
Параметры: |
title - заголовок задачи (обязательное поле, если не указано поле description)
description - описание задачи (обязательное поле, если не указано поле title)
director - id сотрудника - постановщика задачи (обязательное поле)
performer - id сотрудника - исполнителя задачи (обязательное поле)
coperformer - список id сотрудников - соисполнителей задачи, соединенных через запятую
terms - сроки задачи
priority - приоритет задачи (1 - низкий, 7 - срочная задача)
checklist - массив пунктов чеклиста задачи
attaches - список прикрепленных CRM сущностей в виде сущность#id (stock - объекты, customer - клиенты, request - заявки, sale - сделки), соединенных через запятую
|
Ответ: |
{
|
Возможные ошибки: |
no text content
- не заданы заголовок и описание задачи (поля title, description)
no director
- не задан постановщик задачи (поле director)
no performer
- не задан исполнитель задачи (поле performer)
invalid priority
- значение приоритета вне диапазона [1, 7]
unknown entity type
- неизвестный тип CRM сущности в параметре attaches, допустимые значения: stock, customer, request, sale
invalid entity id
- некорректное значение id прикрепленной CRM сущности в параметре attaches
|
URL: | http://domainname.intrumnet.com:81/sharedapi/tasks/edit |
Параметры: |
id - id задачи, обязательный параметр
title - заголовок задачи
description - описание задачи
status - статус задачи:
new - новая,
open - просмотрена, performed - в работе, checking - на проверке, verified - проверена, correction - на доработке, frozen - заморожена terms - сроки задачи
priority - приоритет задачи (1 - низкий, 7 - срочная задача)
director - id сотрудника - постановщика задачи
performer - id сотрудника - исполнителя задачи
coperformer - список id сотрудников - соисполнителей задачи, соединенных через запятую
|
Ответ: |
{
|
Возможные ошибки: |
no task id
- не передан id задачи
no task
- задача по данному id не существует
unknown field
- передан неизвестный параметр
invalid priority
- значение приоритета вне диапазона [1, 7]
no director
- не задан постановщик задачи (поле director)
no performer
- не задан исполнитель задачи (поле performer)
no text content
- не заданы заголовок и описание задачи, требуется задать параметр title или description
|
URL: | http://domainname.intrumnet.com:81/sharedapi/tasks/delete |
Параметры: |
id - id задачи, обязательный параметр
|
Ответ: |
{
|
Возможные ошибки: |
no task id
- не передан id задачи
no task
- задача по данному id не существует
|
URL: | https://domainname.intrumnet.com/sharedapi/app_riskscommon/setUsers |
Параметры: |
users - список id пользователей (разделённых запятыми), которым разрешён доступ к функционалу приложения. Старый список будет заменён новым.
|
Ответ: |
{
|
Далее после настройки адреса url и выбора событий, на которые осуществяется подписка, на url будет отправляться post запрос c параметрами произошедшего в системе события в режиме реального времени.
Тело пост запроса, содержит массив данных, в формате json. Общий вид массива
{
"subject_type" : "employee",
"subject_type_id" : "2",
"event" : "create",
"object_typ" : "customer",
"object_sub_type" : "0",
"object_sub_id" : "10443",
"snapshot" : {
"merge" : []
}
}
Пример скрипта, обрабатывающего webhook, в php примерах (папке example/webhook, файл changeSaleStage.php)
{
"name" : {
"type" : "edit",
"value" : "Иван",
},
1207 : {
"type" : "edit",
"value" : "100000",
}
}
Ключ массива - изменяемое поле. Если ключ - строка - это основное поле объекта, если ключ цифра - это дополнительное поле объекта.
- business - Бизнес Процесс
- system - Система
- employee - Пользователь
- login - Вход в систему
- view - Просмотр
- create - Создание
- edit - Редактирование
- delete - Удаление
- export - Экспорт данных
- import - Импорт данных
- status - Смена статуса / стадии
- stage - Смена статуса / стадии
- comment - Новый комментарий
- manager - Смена ответственного
- answer - Ответ на вопрос-напоминание
- messenger - Новое сообщение
- queue - Выборка
- other - Другое
- customer - Контакты
- request - Заявки (Активности)
- stock - Объекты
- sale - Сделки
- task - Задачи
- messenger - Сообщения (индивидуальные, групповые)
- remind - Напоминания
- email - Email
- emailsystem - Email
- call - Звонок
- sms - Смс
- delivery - Рассылка
- comment - Комментарий
- blank - Документ
- app - Приложение
{
//id объекта
"id" : "10443",
//id автора
"author" : "2",
//id CRM группы
"group_id" : "0",
//имя
"name" : "Иван",
//фамилия
"surname" : "Иванов",
//отчество
"secondname" : "",
//менеджер
"manager_id" : "2",
//список email адресов
email: [
{
mail: "customer@mail.ru",
comment: ""
}
],
//список телефонов
phone: [
{
phone: "89650054332",
comment: "Первый"
},
{
phone: "54234532253",
comment: "Второй"
}
],
//дата создания
"create_date" : "2017-04-06 11:27:36",
//комментарий
"comment" : "",
//активен
"publish" : "1",
//тип контакта
"marktype" : "0",
//физлицо / юрлицо
"nattype" : "physface",
//допполя
"extproperty" : [
1246 : {
"id" : "1246",
"type" : "text",
"value" : ""
}
]
}
{
//id заявки
"request_id" : "455",
//дата заявки
"request_date" : "2017-03-27 16:56:33",
//комментарий
"request_comment" : "",
//id ответственного
"manager" : "2",
//контакт
"customer" : "10431",
//email
"email" : [
{
"mail" : "test@mail.ru",
"comment" : ""
}
]
//статус заявки
"status" : "unselected",
//тип заявки
"request_type" : "8",
//активна (не удалена)
"publish" : "1",
//автор
"employee_creator_id" : "2",
//список дополнительных ответственных
"shared_managers" : []
//допполя
"extproperty" : [
1246 : {
"id" : "1246",
"type" : "text",
"value" : ""
}
]
}
{
//id объекта
"id" : "536927",
//id CRM группы
"group_id" : "0",
//id раздела объектов
"parent" : "19",
//название раздела объектов
"parentname" : "Продажа",
//название
"name" : "commercial продажа м-н Парковый улица, 28",
//кол-во
"count" : "1",
//дата создания
"date_add" : "2017-04-05 16:00:29",
//активен
"publish" : "1",
//является копией / относится к группе объектов
"copy" : "0",
//тип объекта
"type" : "2",
//название типа объектов
"typename" : "Коммерческая недвижимость",
//тип последнего события с объектом
"stock_activity_type" : "edit",
//дата последнего события с объектом
"stock_activity_date" : "2017-04-05 16:19:54",
//объект связан с контактом
"related_with_customer" : "",
//автор
"stock_creator_id" : "0
//список дополнительных ответственных
"shared_managers" : []
//допполя
"extproperty" : [
1246 : {
"id" : "1246",
"type" : "text",
"value" : ""
}
]
}
{
//id сделки
"id" : "160",
//id контакта
"customers_id" : "10444",
//id сотрудника
"employee_id" : "2",
//Дата сделки
"date_create" : "2017-04-06 15:24:57",
//
"sales_type_id" : "4",
//
"sales_type_name" : "Подбор для покупки и сопровождение сделки",
//статус следки
"sales_status_id" : "14",
//название статуса сделки
"sales_status_name" : "Первоначальная договоренность",
//комментарий
"comment" : "",
//стоимость
"price" : "",
//активана/удалена
"publish" : "1",
//Имя контакта
"customer_name" : "Розничные продажи",
//Фамилия контакта
"customer_surname" : "",
//Отчество контакта
"customer_secondname" : "",
//email контакта
"customer_email" : "",
//Тип последнего собятия с сделкой
"sale_activity_type" : "create",
//Дата последнего события с сделкой
"sale_activity_date" : "0000-00-00 00:00:00",
//Автор сделки
"sale_creator_id" : "2"
//список дополнительных ответственных
"shared_managers" : []
//допполя
"extproperty" : [
1246 : {
"id" : "1246",
"type" : "text",
"value" : ""
}
]
}
{
//id письма контакту
"id" : "17",
//id рассылки
"delivery_id" : "10",
//id группы подписчиков
"group_id" : "1",
//id smtp аккаунта
"smtp_id" : "1",
//контакта
"customer_id" : "0",
//email получателя
"email" : "test@test.ru",
//индификатор получателя
"url" : "54f12091099d5c5c4cd9b055504df2c9",
//статсус письма
"status" : "open",
//дата последнего изменения
"date_change" : "2017-04-06 15:57:12",
//лог изменений
"log" : {,
//статус
"res" : "1",
"stat" : "1",
//описание ошибки
"error" : "",
//дата
"date_send" : "2017-04-06 03:51:52",
//Список дат открытия письма
"check" : [
"2017-04-06 16:01:34"
]",
]
//id письма контакту
"letter_id" : "17
}
{
"id" : "33902",
"date_time" : "2017-04-06 12:42:20",
"intrum_user" : "79",
"parent_type" : "direct_call",
"parent_id" : "79",
"call_to_type" : "crm_client",
"call_to_id" : "60046",
"call_id" : "4837780ff331a99d3ff76e5f7abd55cd",
"scenario_id" : "0",
"call_duration" : "0",
"call_cost" : "0.00000",
"trunk_id" : "7",
"caller_id" : "74952255024",
"from_number" : "108",
"to_number" : "79379840000",
"vox_login" : "login",
"url" : "http://test",
"path" : "",
"is_downloaded" : "0",
"answered" : "-1",
"voicemessage" : "0",
"fax" : "0",
"fax_status" : "0",
"custom_status" : "0",
"payload" : "",
"api_incoming" : "0",
"is_cached" : "0",
"record_download" : "",
"record_play" : ""
}
{
"id" : "2536",
"type" : "standard",
"autor_id" : "2",
"autor_type" : "employee",
"created_at" : "2017-04-07 09:53:00",
"edited_at" : "2017-04-07 10:11:17",
"terms" : "2017-04-30 00:00:00",
"title" : "Заголовок задачи",
"description" : "Обзвони клиентов и поздравь их.",
"status" : "new",
"priority" : "2",
"sms" : "0",
"room" : "",
"external" : "0",
"last_change" : "edit",
"changer_id" : "2",
"changer_type" : "employee",
"change_date" : "2017-04-07 10:11:17",
"desciption_rev" : "3",
"parent_task_id" : "0",
"terms_pset" : "0",
"files" : [
{
"id" : "8790",
"type" : "task",
"title" : "Текст поздравления.txt"
}
],
"users" : [
{
"id" : "2",
"type" : "director",
"name" : "admin",
"surname" : "admin",
"secondname" : "admin"
},
{
"id" : "6",
"type" : "accomplice",
"name" : "Вася",
"surname" : "Уткин",
"secondname" : "",
},
{
"id" : "8",
"type" : "performer",
"name" : "Валд",
"surname" : "Валдим",
"secondname" : "",
}
],
"history" : [
{
"task_id" : "2536",
"change_type" : "edit",
"change_arg0" : "3",
"status_from" : "new",
"status_to" : "new",
"date" : "2017-04-07 10:11:17",
"prev_terms" : "0000-00-00 00:00:00",
"changer_id" : "2",
"changer_type" : "employee"
}
"],
"tags" : {
"existTags" : []
"taskTags" : []
}
}
{
"action" : "change_status",
"data" : {
"task_id" : "2536",
"changer_type" : "employee",
"changer_id" : "2",
"status_from" : "new",
"status_to" : "frozen"
}
}
{
// id бланка
"blank" : "74",
// заголовок
"title" : "",
"filledtype" : "shared",
// допполя документа
"extfields" : [
{
"ext" : "1195",
"data" : "text",
"value" : "Пр.Мира 123",
}
// текст документа
"fish" : "Заполнил док",
"object_type" : "customer",
"object_id" : "0",
// индетификатор бланка
"hash" : "493b333b7d21f1ba344c3508bfa0edc9",
// id документа
"id" : "115"
}