СПРАВОЧНЫЙ ЦЕНТР МОБИФОРС

Мобифорс API

Добавить новую задачи (add-task)

Строка запроса: https://domain.mobiforce.ru/api/v4/add-task
Параметры POST запроса:
{
"external_id": "БР-003875",// Внешний идентификатор, обязательный параметр
"number": "00001",// Номер задачи, строка
"contractor_id": "", // Внутренний идентификатор клиента/объекта
"employee_id": "", //Внутренний идентификатор сотрудника, обязателен для отправки задачи
"planned_visit_time": "2018-10-23T19:00:00",//Время запланированного визита
"draft": 1, // 1 – черновик, 0 готова к отправке 
"address": "", // Адрес выполнения
"address_porch": "", //Номер подъезда
"address_floor": "", // Номер этажа
"address_room": "", // Номер квартиры
"address_info": "", //Дополнительная информация по адресу
"lat": "", // Широта
"lon": "", // Долгота
"task_descripion": "", // Описание задачи
"template_id": "" // Внутренний идентификатор шаблона задачи
}
Результат выполнения – внутренний идентификатор задачи, или сообщение об ошибке

Важные особенности

Для добавления задачи с новым клиентом – перед отправкой задачи необходимо отправить объект – клиент, иначе будет возвращена ошибка записи задачи.

Для немедленной отправки задачи исполнителю необходимо указать ИД сотрудника-исполнителя.

Изменить существующую задачу (update-task)

Строка запроса: https://domain.mobiforce.ru/api/v4/update-task?id=1234

id - внутренний идентификатор задачи в системе Мобифорс
Параметры POST запроса:
{
"external_id": "БР-003875",// Внешний идентификатор, обязательный параметр
"number": "00001",// Номер задачи, строка
"contractor_id": "", // Внутренний идентификатор клиента/объекта
"employee_id": "", //Внутренний идентификатор сотрудника, обязателен для отправки задачи
"planned_visit_time": "2018-10-23T19:00:00",//Время запланированного визита
"draft": 1, // 1 – черновик, 0 готова к отправке 
"address": "", // Адрес выполнения
"address_porch": "", //Номер подъезда
"address_floor": "", // Номер этажа
"address_room": "", // Номер квартиры
"address_info": "", //Дополнительная информация по адресу
"lat": "", // Широта
"lon": "", // Долгота
"task_descripion": "", // Описание задачи
"template_id": "" // Внутренний идентификатор шаблона задачи
}
Результат выполнения – внутренний идентификатор задачи, или сообщение об ошибке

Важные особенности

Изменить возможно только задачу в статусе «черновик»

Для записи задачи с новым клиентов – перед отправкой задачи необходимо отправить объект – клиент, иначе будет возвращена ошибка записи задачи.

Для немедленной отправки задачи исполнителю необходимо указать ИД сотрудника-исполнителя.
Закрыть задачу (close-task)

Строка запроса: https://domain.mobiforce.ru/api/v4/close-task?id=1234

id - внутренний идентификатор задачи в системе Мобифорс
Параметры POST запроса:
INPUT: {
"result_status": "74",// Внутренний идентификатор статуса завершения задачи
"results_description": "Задача отменена клиентом"
}
Результат выполнения – внутренний идентификатор задачи, или сообщение об ошибке
Получить задачу (get-task)

Строка запроса: https://domain.mobiforce.ru/api/get-task?id=43535

id - внутренний идентификатор задачи в системе Мобифорс
Пример ответа:
 (
    [id] => 3392
    [unreadedComments] => 
    [name] => 000002/7
    [author] => Array
        (
            [id] => 495
            [name] => Администратор
        )

    [draft] => 1
    [request] => 0
    [redirectedFrom] => Array
        (
        )

    [redirectedTo] => Array
        (
        )

    [timeZone] => 0
    [createdAt] => 1539784593
    [plannedVisitTime] => 1539801300
    [plannedEndVisitTime] => 1539801300
    [finishTime] => 1539810848
    [plannedVisitTm] => 1539801300
    [plannedVisitDt] => 1539801300
    [description] => 
    [employee] => Array
        (
            [id] => 497
            [name] => Исполнитель
            [senior] => 0
            [currentTime] => 1539810961
            [lastSync] => Array
                (
                    [time] => 1539810939
                )

        )

    [tasktemplate] => 0
    [contractor] => 0
    [subdivision] => 0
    [address] => 
    [addressFloor] => 
    [addressRoom] => 
    [addressPorch] => 
    [addressInfo] => 
    [lat] => 
    [lon] => 
    [contact] => 0
    [results] => 
    [task_status] => Array
        (
            [id] => 475
            [name] => Завершена
            [statusId] => 7
        )

    [verificationRequired] => 
    [longTimeTask] => 
    [resultStatus] => Array
        (
            [id] => 74
            [name] => Выполнена
        )

    [task_statuses] => Array
        (
            [0] => Array
                (
                    [description] => Черновик
                    [descr] => Черновик
                    [statusId] => 0
                    [color] => #e52222
                    [time] => 1539784593
                )

            [1] => Array
                (
                    [description] => Отправлена
                    [descr] => Отправлено
                    [statusId] => 1
                    [color] => #cccdfe
                    [time] => 1539800904
                )

            [2] => Array
                (
                    [description] => Доставлена
                    [descr] => Доставлено
                    [statusId] => 2
                    [color] => #a0ddff
                    [time] => 1539801227
                )

            [3] => Array
                (
                    [description] => Прочитано
                    [descr] => Прочитано
                    [statusId] => 3
                    [color] => #97f5fe
                    [time] => 1539809335
                )

            [4] => Array
                (
                    [description] => Принял
                    [descr] => Принял
                    [statusId] => 6
                    [color] => #fffba0
                    [time] => 1539809364
                )

            [5] => Array
                (
                    [description] => Выехал
                    [descr] => Выехал
                    [statusId] => 4
                    [color] => #dbfe97
                    [time] => 1539809859
                )

            [6] => Array
                (
                    [description] => Приехал
                    [descr] => Приехал
                    [statusId] => 5
                    [color] => #acfe97
                    [time] => 1539809939
                )

            [7] => Array
                (
                    [description] => Завершена
                    [descr] => Выполнил
                    [statusId] => 7
                    [color] => #d0d0d0
                    [time] => 1539810848
                )

        )

    [listValue] => Array
        (
        )

    [props] => Array
        (
        )

    [checklist] => Array
        (
        )

)
Получить список измененных задач за период (get-taskupdates)

Строка запроса: https://domain.mobiforce.ru/api/get-taskupdates?id=866888

Максимальный период запросов 1 раз в пять минут, более частые обращения будут генерировать в ответе ошибку.

id – последовательный идентификатор в системе мобифорс, если в запросе идентификатор не задан или соответствует событию старше недели, то выводится список обновлений, начиная с первого события недельной давности.

Ответ содержит не более ста последовательных идентификаторов событий, и соответствующих им внешних идентификаторов задач.

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

                  task_id: 8298402,// внутренний идентификатор задачи в Мобифорс 
                  id: 1867878 
             } 
]
Для получения следующего блока – нужно повторить запрос, передав максимальный полученный идентификатор из прошлого сеанса
Добавить новый объект (add-contractor)

Строка запроса: https://domain.mobiforce.ru/api/v4/add-contractor
Параметры POST запроса:
{
"external_id": "2",
"name": "Перекресток",
"address": "Ленинский проспект 38",
"address_porch": "1",
"address_floor": "2",
"address_room": "3",
"address_info": "Вход со двора",
"lat": "",
"lon": "",
"template_id": 1,
"contact": [
{
"external_id": "3334",
"name": "Александр",
"tel": [
{
"name": "89036277781"
}
]
},
{
"external_id": "3335",
"name": "Сергей Сергеевич"
}
]
}
Результат запроса – внутренний идентификатор клиента/объекта, или сообщение об ошибке
Обновить существующий объект (update-contractor)

Строка запроса:
Добавить новое подразделение (add-subdivision)

Строка запроса: https://domain.mobiforce.ru/api/v4/add-subdivision
Параметры POST запроса:
{
"contractor_id": "2",//Обязательное поле, идентификатор клиента в Мобифорс, к которому будет привязано подразделение
"external_id": "2",
"name": "Перекресток",
"address": "Ленинский проспект 38",
"address_porch": "1",
"address_floor": "2",
"address_room": "3",
"address_info": "Вход со двора",
"lat": "",
"lon": "",
"template_id": 1,
"contact": [
{
"external_id": "3334",
"name": "Александр",
"tel": [
{
"name": "89036277781"
}
]
},
{
"external_id": "3335",
"name": "Сергей Сергеевич"
}
]
}
Результат запроса – внутренний идентификатор подразделения, или сообщение об ошибке
Обновить существующее подразделение (update-subdivision)

Строка запроса: https://domain.mobiforce.ru/api/v4/update-subdivision?id=12345

id - внутренний идентификатор подразделения в системе Мобифорс
Параметры POST запроса:
{
"name": "Перекресток",
"address": "Ленинский проспект 38",
"address_porch": "1",
"address_floor": "2",
"address_room": "3",
"address_info": "Вход со двора",
"lat": "",
"lon": "",
"template_id": 1,
"contact": [
{
"external_id": "3334",
"name": "Александр",
"tel": [
{
"name": "89036277781"
}
]
},
{
"external_id": "3335",
"name": "Сергей Сергеевич"
}
]
}