Исходящая интеграция
Исходящая интеграция помогает автоматически передавать важные изменения и действия из «Мобильных сотрудников» во внешние системы — без лишних действий и задержек.
Это работает через веб-хуки — «Мобильные сотрудники» сами отправляют данные при их изменении, не дожидаясь запроса от вашей системы. Такой подход особенно удобен для событийной интеграции: вы сразу получаете нужную информацию и можете быстрее реагировать.
Вы можете получать уведомления об изменениях в задачах и расписаниях сотрудников, а также о рисках на маршруте — например, если сотрудник задержался, потерял связь или не выполнил задачу в срок. Это позволяет лучше контролировать работу в полях и улучшать клиентский сервис.
Подготовка веб-хука
Чтобы получать данные из «Мобильных сотрудников» в реальном времени, настройте веб-хук — адрес, на который сервис будет отправлять информацию об изменениях и событиях.
-
Подготовьте публичный URL-адрес, доступный по HTTPS, куда будет отправляться информация.
-
Обеспечьте прием POST-запросов с телом в формате JSON.
-
Обработайте полученные данные в своей системе (например, сохранить или передать дальше по бизнес-процессу).
После настройки вы сможете получать уведомления о ключевых изменениях в задачах, маршрутах, активности сотрудников и о других событиях, которые важны для вашей работы.
Настройка событий
Настроить нужное событие можно в веб-интерфейсе «Мобильных сотрудников»:
-
В рабочей области Координатор перейдите на вкладку События.
-
Нажмите кнопку Новое событие.
-
Выберите событие, по которому вы хотите получать уведомления в своей системе.
-
Введите название события и выберите сотрудников. Название события не должно содержать символ «\».
-
Настройте параметры события для отправки уведомления. Параметры отличаются во всех событиях.
-
Настройте:
-
период действия события — укажите период, когда нужно отправлять уведомления о зафиксированном событии. Чтобы сделать событие бессрочным, поставьте галочку без ограничения даты.
-
дни недели учета события — выберите дни недели, в которые вы хотите получать уведомления о событии, например, только в будни;
-
ограничения события в течение суток — настройте время, когда вы хотите получать уведомления о событии. Например, можно настроить получение уведомлений только в рабочее время с 9:00 до 18:00.
-
список почтовых адресов для отправки уведомлений — введите адреса электронной почты, на которые нужно отправлять уведомления;
-
список телефонных номеров для отправки уведомлений — введите номера телефона, на которые нужно отправлять уведомления о событиях по SMS. Для этого должна быть подключена платная опция Пакет SMS 1000.
-
список пользователей для отправки уведомлений через Telegram — выберите пользователей, которым нужно отправлять уведомления о событиях через Telegram. Для этого у пользователей должен быть подключен Telegram-бот «Мобильных сотрудников».
-
отправлять на API — отметьте галочкой Отправлять на API и в появившемся поле введите ссылку на API вашей системы (подробнее см. Подготовка веб-хука), например, https://example.ru/api.
- Нажмите кнопку Готово.
Получение событий из услуги в КИС
Общее описание
Запрос выполняется услугой в направлении вашей корпоративной информационной системы (КИС) и передает информацию о зафиксированных событиях в КИС.
Параметры запроса
Функция передает массив данных. Каждый элемент в массиве содержит следующие параметры:
| Параметр | Описание |
|---|---|
| subscriberID | ИД Сотрудника |
| subscriberExternalID | Внешний ИД Сотрудника |
| signalID | ИД события |
| signalDate | Дата и время события (подробнее о формате времени см. раздел 2.6). |
| signalTypeID | ИД типа события. Существуют следующие значения: 1 — превышение скорости; 2 — вход-выход из зон; 3 — остановки; 7 — отключение питания; 9 — погрузка ТБО; 10 — контроль датчиков; 11 — окончание поездки; 24 — уведомление о расчетном времени прибытия сотрудника. |
| sensorID | ИД датчика (только для типа событий «Контроль датчиков») |
| sensorValue | Значение датчика (только для типа событий «Контроль датчиков») |
| externalTaskID | Внешний идентификатор задачи (только для событий «Уведомление о расчетном времени прибытия сотрудника») |
| subscriberID | ИД сотрудника, на которого назначена задача (только для событий «Уведомление о расчетном времени прибытия сотрудника») |
| taskStartDate | Дата начала задачи по часовому поясу пользователя (только для событий «Уведомление о расчетном времени прибытия сотрудника») |
| taskDeadlineDate | Крайний срок завершения задачи (дата и время, только для событий «Уведомление о расчетном времени прибытия сотрудника») |
| estimatedArrivalDate | Расчетное время прибытия сотрудника по адресу задачи (дата и время). Только для событий «Уведомление о расчетном времени прибытия сотрудника» |
| taskClientPhone | Номер телефона клиента в формате 79XXXXXXXXX |
| taskClientName | Имя клиента |
| customFields | Параметры шаблона дополнительных полей (массив структур). Только для событий «Уведомление о расчетном времени прибытия сотрудника» |
| externalID | Внешний идентификатор дополнительного поля |
| value | Значение дополнительного поля |
Результат выполнения
События передаются в КИС клиента.
Пример запроса с типом события «Контроль датчиков»
POST /client_uri HTTP/1.1
Host: host
Content-Type: application/json
\{
"subscriberID": 1,
"subscriberExternalID": 1,
"signalID": 1,
"signalDate": "2021-02-03T11:44:35Z",
"signalTypeID": 10,
"sensorID": 1,
"sensorValue": 12
}Пример запроса с типом события «Уведомление о расчетном времени прибытия сотрудника»
POST /client_uri HTTP/1.1
Host: host
Content-Type: application/json
\{
"signalID": 5,
"signalDate": "2023-07-24T10:58:43.903Z",
"signalTypeID": 24,
"taskID": 1,
"externalTaskID": "123456",
"subscriberID": 1,
"taskStartDate": "2023-07-23T21:00:00Z",
"taskDeadlineDate": "2023-07-24T21:20:00Z",
"estimatedArrivalDate": "2023-07-24T10:59:44.137Z",
"taskClientPhone": "79161234567",
"taskClientName": "Иванов Иван",
"customFields": [
\{ "externalID": "1", "value": "1" },
\{ "externalID": "2", "value": "2" }
]
}Получение события «Все изменения задач» из Услуги в КИС клиента
Получение события о добавлении задачи
Общее описание
Запрос выполняется услугой в направлении КИС и передает информацию о зафиксированных событиях в КИС.
Параметры запроса
Функция передает массив данных. Каждый элемент массива содержит следующие параметры:
Результат выполнения
События передаются в КИС клиента.
| Параметр | Описание |
|---|---|
| taskID | ИД задачи. |
| subscriberID | ИД сотрудника. |
| deadline | Крайний срок завершения задачи (дата и время, подробнее о формате времени см. раздел 2.6). |
| title | Название задачи. |
| description | Описание задачи |
| address | Адрес задачи |
| longitude | Географическая долгота адреса (в градусах) |
| latitude | Географическая широта адреса (в градусах) |
| externalID | Внешний пользовательский ИД задачи |
| clientName | ФИО клиента |
| clientPhone | Телефон клиента |
| clientEmail | Адрес электронной почты клиента |
| priority | Приоритет задачи. Существуют следующие значения: 0 — низкий; 1 — средний; 2 — высокий. |
| startDate | Дата начала задачи (подробнее о формате времени см. раздел 2.6). |
| status | Статус задачи. Существуют следующие значения: 0 — новая; 1 — принята; 2 — отклонена; 3 — выполнена; 4 — в работе. |
| taskTypeID | ИД типа задачи |
| customStatusID | ИД пользовательского статуса задачи |
| customStatusReasonID | ИД причины смены пользовательского статуса задачи |
| mapObjectID | ИД объекта |
| mapObjectWorkScheduleID | ИД расписания |
| commentPolicy | Требования к комментарию при завершении задачи. Возможные значения: 0 — не обязателен; 1 — обязателен; 2 — обязателен при отклонении заявки; 3 — обязателен в обоих случаях. |
| serviceTime | Время выполнения задачи |
| startInterval | Интервал начала выполнения задачи |
| isFixed | Является ли задача закреплённой (нельзя менять время начала выполнения, изменять или снимать исполнителя). Возможные значения: true — задача закреплена; false — задача не закреплена. |
| isMandatoryInRoute | Должна ли задача быть обязательно поставлена в маршрут. Возможные значения: true — задача обязательна в маршруте; false — может не быть в маршруте. |
| creationDate | Дата и время создания задачи (подробнее о формате времени см. раздел 2.6). |
| Параметры задачи в маршруте (массив структур routeItems) | |
| plannedStartDate | Плановая дата начала выполнения задачи по UTC |
| plannedEndDate | Плановая дата окончания выполнения задачи по UTC |
| timeToPoint | Время в пути до адреса, указанного в задаче (в минутах) |
| distanceToPoint | Расстояние до адреса, указанного в задаче (в метрах) |
| creationDate | Дата и время создания маршрута по UTC |
| lastUpdateDate | Дата и время последнего обновления задачи в маршруте по UTC |
| Параметры назначения задачи (массив структур workOrders) | |
| workOrderID | Идентификатор назначения задачи |
| subscriberID | Идентификатор сотрудника |
| startTime | Дата и время начала назначения задачи по UTC |
| endTime | Дата и время окончания назначения задачи по UTC |
| serviceTime | Время выполнения задачи с учетом эффективности |
| creationDate | Дата и время создания назначения задачи по UTC |
| lastUpdateDate | Дата и время последнего обновления назначения задачи по UTC |
| subscriberName | Имя сотрудника |
| subscriberExternalID | Внешний идентификатор сотрудника |
| Параметры компетенций задачи (competences) | |
| competenceID | ИД компетенции |
| amount | Количество |
| level | Уровень владения компетенцией |
| efficiency | Эффективность |
| Параметры измерений (структура dimensions) | |
| weight | Вес (кг) |
| unit | Юниты |
| width | Ширина (м) |
| height | Высота (м) |
| length | Длина (м) |
| volume | Объем (м3) |
| Параметры дополнительных полей задачи (массив структур customFieldFormItems) | |
| externalID | ИД дополнительного поля |
| name | Название дополнительного поля |
| value | Значение дополнительного поля |
| values | Значения дополнительного поля в случае множественного выбора |
| type | Тип дополнительного поля. Существуют следующие типы: string – строка text – текст date – дата time – время integer – целое число double – вещественное число boolean – галочка select – список picture – изображение file – файл |
| Метаданные события (структура signalMetadataInfo) | |
| signalID | ИД события |
| signalDate | Дата и время события по UTC |
| signalTypeID | ИД типа события. Существуют следующие значения: 1 — добавление 2 — редактирование 3 — удаление |
| signalResultID | ИД сработавшего события |
| agentID / userID / subscriberID | ИД инициатора сработавшего события (автоматический агент или Пользователь или Сотрудник) |
| signalEntityTypeID | Идентификатор типа сущности, для которого сработало событие. Существуют следующие значения: 1 — задача 2 — сотрудник |
| entityID | ИД добавленной задачи |
| actualSignalDate | Фактическая дата срабатывания события по UTC |
Пример запроса
POST /client_uri HTTP/1.1
Host: host
Content-Type: application/json
[
\{
"task": \{
"taskID": 2533481,
"subscriberID": 644514,
"workOrders": [
\{
"workOrderID": 225571,
"subscriberID": 644514,
"startTime": "2025-02-04T19:00:00Z",
"endTime": "2025-02-04T19:30:00Z",
"serviceTime": 30,
"creationDate": "2025-02-04T09:56:11.113Z",
"subscriberName": "sotrudnik"
}
],
"title": "Задача 3222",
"address": "Москва, улица Ленина, 2",
"longitude": 43.990149,
"latitude": 56.314781,
"priority": 1,
"startDate": "2025-02-04T19:00:00Z",
"lastStatusChangeDate": "2025-02-04T09:56:05.34Z",
"status": 0,
"mapObjectID": 1,
"commentPolicy": 0,
"serviceTime": 30,
"preferredPositionInRoute": -1,
"isFixed": false,
"customFieldsFormTemplateID": 29843,
"customFieldFormItems": [
\{
"externalID": "1662395",
"name": "Важная информация",
"value": "звонок за полчаса",
"values": null,
"type": "String"
}
],
"creationDate": "2025-02-04T09:56:05.34Z"
},
"signalMetadataInfo": \{
"signalID": 1607,
"signalTypeID": 1,
"signalDate": "2025-02-04T09:56:12.544Z",
"agentID": 949,
"signalEntityTypeID": 1,
"entityID": 2533481,
"signalResultID": 349065,
"actualSignalDate": "2025-02-04T09:56:05.763Z"
}
}
]Получение события об изменении задачи
Общее описание
Запрос выполняется Услугой в направлении КИС и передает информацию о зафиксированных событиях в КИС клиента.
Параметры запроса
Функция передает массив данных. Каждый элемент в массиве содержит следующие параметры:
| Параметр | Описание |
|---|---|
| taskID | ИД задачи |
| subscriberID | ИД сотрудника |
| deadline | Крайний срок завершения задачи (дата и время, подробнее о формате времени см. раздел 2.6). |
| title | Название задачи |
| description | Описание задачи |
| address | Адрес задачи |
| longitude | Географическая долгота адреса (в градусах) |
| latitude | Географическая широта адреса (в градусах) |
| externalID | Внешний пользовательский ИД задачи |
| clientName | ФИО клиента |
| clientPhone | Телефон клиента |
| clientEmail | Адрес электронной почты клиента |
| priority | Приоритет задачи. Существуют следующие значения: 0 – низкий; 1 – средний; 2 – высокий. |
| startDate | Дата начала задачи (подробнее о формате времени см. раздел 2.6). |
| status | Статус задачи. Существуют следующие значения: 0 – новая; 1 – принята; 2 – отклонена; 3 – выполнена; 4 – в работе. |
| taskTypeID | ИД типа задачи |
| customStatusID | ИД пользовательского статуса задачи |
| customStatusReasonID | ИД причины смены пользовательского статуса задачи |
| mapObjectID | ИД объекта |
| mapObjectWorkScheduleID | ИД расписания |
| commentPolicy | Требования к комментарию при завершении задачи. Существуют следующие значения: 0 – не обязателен; 1 – обязателен; 2 – обязателен при отклонении заявки; 3 – обязателен в обоих случаях. |
| serviceTime | Время выполнения задачи. |
| startInterval | Интервал начала выполнения задачи. |
| isFixed | Является ли задача закреплённой (нельзя менять время начала выполнения, изменять или снимать исполнителя). Существуют следующие значения: true — задача закреплена; false — задача не закреплена. |
| isMandatoryInRoute | Должна ли задача быть обязательно поставлена в маршрут. Существуют следующие значения: true — задача обязательна в маршруте; false — задача может отсутствовать в маршруте. |
| creationDate | Дата и время создания задачи (подробнее о формате времени см. раздел 2.6). |
| Параметры задачи в маршруте (массив структур routeItems) | |
| plannedStartDate | Плановая дата начала выполнения задачи по UTC |
| plannedEndDate | Плановая дата окончания выполнения задачи по UTC |
| timeToPoint | Время в пути до адреса, указанного в задаче (в минутах) |
| distanceToPoint | Расстояние до адреса, указанного в задаче (в метрах) |
| creationDate | Дата и время создания маршрута по UTC |
| lastUpdateDate | Дата и время последнего обновления задачи в маршруте по UTC |
| Параметры назначения задачи (массив структур workOrders) | |
| workOrderID | Идентификатор назначения задачи |
| subscriberID | Идентификатор сотрудника |
| startTime | Дата и время начала назначения задачи по UTC |
| endTime | Дата и время окончания назначения задачи по UTC |
| serviceTime | Время выполнения задачи с учётом эффективности |
| creationDate | Дата и время создания назначения задачи по UTC |
| lastUpdateDate | Дата и время последнего обновления назначения задачи по UTC |
| subscriberName | Имя сотрудника |
| subscriberExternalID | Внешний идентификатор сотрудника |
| Параметры компетенций задачи (competences) | |
| competenceID | ИД компетенции |
| amount | Количество |
| level | Уровень владения компетенцией |
| efficiency | Эффективность |
| Параметры измерений (структура dimensions) | |
| weight | Вес (кг) |
| unit | Юниты |
| width | Ширина (м) |
| height | Высота (м) |
| length | Длина (м) |
| volume | Объем (м3) |
| Параметры дополнительных полей задачи (массив структур customFieldFormItems) | |
| externalID | ИД дополнительного поля |
| name | Название дополнительного поля |
| value | Значение дополнительного поля |
| values | Значения дополнительного поля в случае множественного выбора |
| type | Тип дополнительного поля. Существуют следующие типы: string – строка; text – текст; date – дата; time – время; integer – целое число; double – вещественное число; boolean – галочка; select – список; picture – изображение; file – файл. |
| changedValues | Структура параметров с предыдущими значениями полей Задачи до изменений (содержит только измененные поля) |
| Метаданные события (структура signalMetadataInfo) | |
| signalID | ИД события |
| signalDate | Дата и время события по UTC |
| signalTypeID | ИД типа события. Существуют следующие значения: 1 — добавление; 2 — редактирование; 3 — удаление. |
| signalResultID | ИД сработавшего события |
| agentID / userID / subscriberID | ИД инициатора сработавшего события (автоматический агент или Пользователь или Сотрудник) |
| signalEntityTypeID | Идентификатор типа сущности, для которого сработало событие. Существуют следующие значения: 1 — задача; 2 — Сотрудник. |
| entityID | ИД измененной задачи |
| actualSignalDate | Фактическая дата срабатывания события по UTC |
Результат выполнения
События передаются в КИС клиента.
Пример запроса
POST /client_uri HTTP/1.1
Host: host
Content-Type: application/json
[
\{
"task": \{
"subscriberID": 633903,
"routeItems": [
\{
"plannedStartDate": "2024-11-21T13:54:00Z",
"plannedEndDate": "2024-11-21T14:59:00Z",
"timeToPoint": 4,
"distanceToPoint": 1668,
"creationDate": "2024-11-21T18:48:27.167Z",
"lastUpdateDate": "2024-11-21T18:48:27.167Z"
}
],
"workOrders": [
\{
"workOrderID": 198760,
"subscriberID": 633903,
"startTime": "2024-11-21T13:54:00Z",
"endTime": "2024-11-21T14:59:00Z",
"creationDate": "2024-11-20T11:50:11.007Z",
"lastUpdateDate": "2024-11-21T18:48:27.167Z",
"subscriberName": "Иван Иванов"
}
],
"taskID": 2485152,
"deadline": "2024-12-13T10:29:29.507Z",
"title": "Задача 2",
"description": "Описание Задачи 2",
"address": "Москва, Свободы, 23",
"longitude": 37.452902,
"latitude": 55.833592,
"externalID": "2011-1_1",
"clientName": "Петр",
"clientPhone": "79161234567",
"clientEmail": "petr@mail.ru",
"priority": 1,
"startDate": "2024-11-25T09:55:00Z",
"status": 1,
"taskTypeID": 17,
"customStatusID": 123,
"commentPolicy": 2,
"competences": [
\{
"competenceID": 2,
"amount": 1
},
\{
"competenceID": 6,
"amount": 1
}
],
"dimensions": \{},
"serviceTime": 65,
"startInterval": 120,
"isMandatoryInRoute": true,
"isFixed": true,
"customFieldsFormTemplateID": 626,
"customFieldFormItems": [
\{
"externalID": "40907",
"name": "Дата",
"value": "2024-12-12T23:27:00",
"values": null,
"type": "Date"
}
],
"creationDate": "2024-11-20T07:21:14.89Z"
},
"signalMetadataInfo": \{
"signalID": 1578,
"signalTypeID": 2,
"signalDate": "2024-11-25T08:41:21.446Z",
"userID": 82404,
"signalEntityTypeID": 1,
"entityID": 2485152,
"actualSignalDate": "2024-11-25T08:40:21.446Z"
},
"changedValues": \{
"subscriberID": 633842,
"deadline": "2024-12-13T10:29:29.507",
"title": "Задача 1",
"description": "Описание Задачи 1",
"address": "Москва, Свободы, 21"
}
}
]Получение события об удалении задачи
Общее описание
Запрос выполняется Услугой в направлении КИС и передает информацию о зафиксированных событиях в КИС клиента.
Параметры запроса
Функция передает массив данных. Каждый элемент в массиве содержит следующие параметры:
| Параметр | Описание |
|---|---|
| signalID | ИД события |
| signalDate | Дата и время события по UTC |
| signalTypeID | ИД типа события. Существуют следующие значения: 1 — добавление; 2 — редактирование; 3 — удаление. |
| signalResultID | ИД сработавшего события |
| agentID / userID / subscruberID | ИД инициатора сработавшего события (автоматический агент, пользователь или сотрудник) |
| signalEntityTypeID | Идентификатор типа сущности, для которого сработало событие: 1 — задача; 2 — сотрудник |
| entityID | ИД удаленной задачи |
| actualSignalDate | Фактическая дата срабатывания события по UTC |
Результат выполнения
События передаются в КИС клиента.
Пример запроса
POST /client_uri HTTP/1.1
Host: host
Content-Type: application/json
[
\{
"signalMetadataInfo": \{
"signalID": 1607,
"signalTypeID": 3,
"signalDate": "2025-02-03T08:42:51.768Z",
"signalEntityTypeID": 1,
"entityID": 2533054,
"signalResultID": 348575,
"actualSignalDate": "2025-02-03T08:42:51.766Z"
}
}
]Получение события «Все изменения сотрудников» из услуги в КИС клиента
Получение события о добавлении сотрудника
Общее описание
Запрос выполняется услугой в направлении КИС и передает информацию о зафиксированных событиях в КИС клиента.
Параметры запроса
Функция передает массив данных. Каждый элемент в массиве содержит следующие параметры:
| Параметр | Описание |
|---|---|
| subscriberID | ИД Сотрудника |
| regionID | ИД региона Сотрудника |
| isActive | Является ли Сотрудник активным. Существуют следующие значения: true — сотрудник активен; false — сотрудник неактивный. |
| subscriberTariffTypeID | ИД тарифа Сотрудника. Существуют следующие значения: 9 – М2М.; 10 – тариф «Эконом». 11 – тариф «Стандарт». 12 – тариф «Бизнес». 13 – тариф «Премиум». |
| canTrack | Право устанавливать автоматическое расписание запросов Сотруднику. Существуют следующие значения: true — можно устанавливать автоматическое расписание запросов Сотруднику; false — нельзя устанавливать автоматическое расписание запросов Сотруднику. |
| canRequest | Право делать запросы местоположения Сотрудника. Существуют следующие значения: true — можно делать запросы местоположения Сотрудника; false — нельзя делать запросы местоположения Сотрудника. |
| canSend | Право отправлять SMS-сообщения Сотруднику. Существуют следующие значения: true — можно отправлять SMS-сообщения Сотруднику; false — нельзя отправлять SMS-сообщения Сотруднику. |
| isOnline | Находится ли Сотрудник онлайн в приложении «МТС Координатор». Существуют следующие значения: true — Сотрудник находится онлайн; false — Сотрудник находится офлайн. |
| isLocateEnabled | Включено ли определение местоположения. Существуют следующие значения: true — определение местоположения включено; false — определение местоположения выключено. |
| isBlockEnabled | Является ли Сотрудник активным. Существуют следующие значения: true – Сотрудник активен; false – Сотрудник заблокирован. |
| phone | Телефон Сотрудника |
| icon | Иконка Сотрудника |
| subscriberGroupID | ИД группы Сотрудника |
| name | ФИО Сотрудника |
| externalSubscriberID | Внешний ИД Сотрудника |
| allowedOvertime | Время допустимой переработки |
| workScheduleID | ИД графика работы |
| startLocationLatitude | Географическая широта начальной точки работы (в градусах) |
| startLocationLongitude | Географическая долгота начальной точки работы (в градусах) |
| customFieldFormTemplateID | ИД шаблона дополнительных полей Сотрудника |
| Параметры дополнительных полей Сотрудника (массив структур customFieldFormItems) | |
| externalID | ИД дополнительного поля |
| name | Название дополнительного поля |
| value | Значение дополнительного поля |
| type | Тип дополнительного поля. Существуют следующие типы: string – строка; text – текст; date – дата; time – время; integer – целое число; double – вещественное число; boolean – галочка; select – список; picture – изображение; file – файл. |
| Параметры прикрепленных к Сотруднику объектов (структура competences) | |
| competenceID | Идентификатор компетенции |
| level | Уровень владения компетенции |
| efficiency | Эффективность по этой компетенции |
| Параметры прикрепленных к Сотруднику гео-зон (структура zones) | |
| zoneID | Идентификатор гео-зоны |
| bindingType | Тип прикрепления. Существуют следующие значения: 0 – основная гео-зона; 1 – дополнительная гео-зона. |
| Параметры прикрепленных к Сотруднику объектов (структура mapObjects) | |
| objectID | Идентификатор объекта |
| signalID | ИД события |
| signalDate | Дата и время события по UTC |
| signalTypeID | ИД типа события. Существуют следующие значения: 1 — добавление 2 — редактирование 3 — удаление |
| signalResultID | ИД сработавшего события |
| agentID / userID / subscruberID | ИД инициатора сработавшего события (автоматический агент, Пользователь или Сотрудник) |
| signalEntityTypeID | Идентификатор типа сущности, для которого сработало событие. Существуют следующие значения: 1 — задача 2 — сотрудник |
| entityID | ИД добавленного Сотрудника |
| actualSignalDate | Фактическая дата срабатывания события по UTC |
Результат выполнения
События передаются в КИС клиента.
Пример запроса
POST /client_uri HTTP/1.1
Host: host
Content-Type: application/json
[
\{
"subscriber": \{
"subscriberID": 671766,
"regionID": 0,
"isActive": true,
"subscriberTariffTypeID": 13,
"canTrack": true,
"canRequest": true,
"canSend": true,
"isOnline": false,
"isLocateEnabled": true,
"isBlockEnabled": false,
"phone": "79116575676",
"icon": 0,
"subscriberGroupID": 175683,
"name": "Иванов Иван",
"allowedOvertime": 5,
"workScheduleID": 7217,
"startLocationLatitude": 55.79889,
"startLocationLongitude": 37.533858,
"competences": [],
"zones": [],
"mapObjects": []
},
"signalMetadataInfo": \{
"signalID": 1695,
"signalTypeID": 1,
"signalDate": "2025-05-30T10:51:36.731Z",
"userID": 89254,
"signalEntityTypeID": 2,
"entityID": 671766,
"signalResultID": 546324,
"actualSignalDate": "2025-05-30T10:51:35.015Z"
}
}
]Получение события об изменении сотрудника
Общее описание
Запрос выполняется услугой в направлении КИС и передает информацию о зафиксированных событиях в КИС клиента.
Параметры запроса
Функция передает массив данных. Каждый элемент в массиве содержит следующие параметры:
| Параметр | Описание |
|---|---|
| subscriberID | ИД Сотрудника |
| regionID | ИД региона Сотрудника |
| isActive | Является ли Сотрудник активным. Существуют следующие значения: true — сотрудник активен; false — сотрудник неактивный. |
| subscriberTariffTypeID | ИД тарифа Сотрудника. Существуют следующие значения: 9 – М2М.; 10 – тариф «Эконом». 11 – тариф «Стандарт». 12 – тариф «Бизнес». 13 – тариф «Премиум». |
| canTrack | Право устанавливать автоматическое расписание запросов Сотруднику. Существуют следующие значения: true — можно устанавливать автоматическое расписание запросов Сотруднику; false — нельзя устанавливать автоматическое расписание запросов Сотруднику. |
| canRequest | Право делать запросы местоположения Сотрудника. Существуют следующие значения: true — можно делать запросы местоположения Сотрудника; false — нельзя делать запросы местоположения Сотрудника. |
| canSend | Право отправлять SMS-сообщения Сотруднику. Существуют следующие значения: true — можно отправлять SMS-сообщения Сотруднику; false — нельзя отправлять SMS-сообщения Сотруднику. |
| isOnline | Находится ли Сотрудник онлайн в приложении «МТС Координатор». Существуют следующие значения: true — Сотрудник находится онлайн; false — Сотрудник находится офлайн. |
| isLocateEnabled | Включено ли определение местоположения. Существуют следующие значения: true — определение местоположения включено; false — определение местоположения выключено. |
| isBlockEnabled | Является ли Сотрудник активным. Существуют следующие значения: true – Сотрудник активен; false – Сотрудник заблокирован. |
| phone | Телефон Сотрудника |
| icon | Иконка Сотрудника |
| subscriberGroupID | ИД группы Сотрудника |
| name | ФИО Сотрудника |
| externalSubscriberID | Внешний ИД Сотрудника |
| allowedOvertime | Время допустимой переработки |
| workScheduleID | ИД графика работы |
| startLocationLatitude | Географическая широта начальной точки работы (в градусах) |
| startLocationLongitude | Географическая долгота начальной точки работы (в градусах) |
| customFieldFormTemplateID | ИД шаблона дополнительных полей Сотрудника |
| Параметры дополнительных полей Сотрудника (массив структур customFieldFormItems) | |
| externalID | ИД дополнительного поля |
| name | Название дополнительного поля |
| value | Значение дополнительного поля |
| type | Тип дополнительного поля. Существуют следующие типы: string – строка; text – текст; date – дата; time – время; integer – целое число; double – вещественное число; boolean – галочка; select – список; picture – изображение; file – файл. |
| Параметры прикрепленных к Сотруднику объектов (структура competences) | |
| competenceID | Идентификатор компетенции |
| level | Уровень владения компетенции |
| efficiency | Эффективность по этой компетенции |
| Параметры прикрепленных к Сотруднику гео-зон (структура zones) | |
| zoneID | Идентификатор гео-зоны |
| bindingType | Тип прикрепления. Существуют следующие значения: 0 – основная гео-зона; 1 – дополнительная гео-зона. |
| Параметры прикрепленных к Сотруднику объектов (структура mapObjects) | |
| objectID | Идентификатор объекта |
| signalID | ИД события |
| signalDate | Дата и время события по UTC |
| signalTypeID | ИД типа события. Существуют следующие значения: 1 — добавление 2 — редактирование 3 — удаление |
| signalResultID | ИД сработавшего события |
| agentID / userID / subscruberID | ИД инициатора сработавшего события (автоматический агент, Пользователь или Сотрудник) |
| signalEntityTypeID | Идентификатор типа сущности, для которого сработало событие. Существуют следующие значения: 1 — задача 2 — сотрудник |
| entityID | ИД добавленного Сотрудника |
| actualSignalDate | Фактическая дата срабатывания события по UTC |
Результат выполнения
События передаются в КИС клиента.
Пример запроса
POST /client_uri HTTP/1.1
Host: host
Content-Type: application/json
[
\{
"subscriber": \{
"subscriberID": 644514,
"regionID": 0,
"isActive": true,
"subscriberTariffTypeID":13,
"canTrack": true,
"canRequest": true,
"canSend": true,
"isOnline": false,
"isLocateEnabled": true,
"isBlockEnabled": false,
"phone": "79937776658",
"icon": 1,
"subscriberGroupID": 175683,
"name": "sotrudnik",
"externalSubscriberID": "444",
"allowedOvertime": 5,
"subscriberTypeID": 8,
"workScheduleID": 37165,
"startLocationLatitude": 55.7401980851445,
"startLocationLongitude": 37.5209350585937,
"customFieldsFormTemplateID": 29787,
"customFieldFormItems": [
\{
"externalID": "1662245",
"name": "Важная информация",
"value": "Поправить график",
"values": null,
"type": "String"
}
],
"userBossID": 89254,
"competences": [
\{
"competenceID": 14240,
"level": 1,
"efficiency": 2.0
}
],
"zones": [
\{
"zoneID": 687462,
"bindingType": 1
},
\{
"zoneID": 688074,
"bindingType": 0
}
],
"mapObjects": [
\{
"objectID": 12527257
}
]
},
"changedValues": \{
"externalSubscriberID": "333"
},
"signalMetadataInfo": \{
"signalID": 1691,
"signalTypeID": 2,
"signalDate": "2025-05-26T08:23:42.012Z",
"userID": 89254,
"signalEntityTypeID": 2,
"entityID": 644514,
"signalResultID": 543767,
"actualSignalDate": "2025-05-26T08:23:40.343Z"
}
}
]Получение события об удалении сотрудника
Общее описание
Запрос выполняется Услугой в направлении КИС и передает информацию о зафиксированных событиях в КИС клиента.
Параметры запроса
Функция передает массив данных. Каждый элемент в массиве содержит следующие параметры:
| Параметр | Описание |
|---|---|
| signalID | ИД события |
| signalDate | Дата и время события по UTC |
| signalTypeID | ИД типа события. Существуют следующие значения: 1 — добавление; 2 — редактирование; 3 — удаление. |
| signalResultID | ИД сработавшего события |
| agentID / userID / subscruberID | ИД инициатора сработавшего события (автоматический агент, пользователь или сотрудник) |
| signalEntityTypeID | Идентификатор типа сущности, для которого сработало событие: 1 — задача; 2 — сотрудник |
| entityID | ИД удаленного сотрудника |
| actualSignalDate | Фактическая дата срабатывания события по UTC |
Результат выполнения
События передаются в КИС клиента.
Пример запроса
POST /client_uri HTTP/1.1
Host: host
Content-Type: application/json
[
\{
"signalMetadataInfo": \{
"signalID": 1695,
"signalTypeID": 3,
"signalDate": "2025-05-30T10:52:54.141Z",
"userID": 89254,
"signalEntityTypeID": 2,
"entityID": 671735,
"signalResultID": 546325,
"actualSignalDate": "2025-05-30T10:52:52.42Z"
}
}
]