Задачи

Задача должна обязательно иметь ответственного и дату выполнения (число и время). Также задача может быть связана со сделкой, покупателем, компанией или контактом, но не обязательно, она может быть не связана ни с каким объектом. Основной сущностью системы являются задачи. Установить результат для закрытой задачи можно, используя метод ниже

Получение задачи по идентификатору

Метод позволяет получить задачу по ее идентификатору.

URL метода

GET /api/v4/tasks/{id}

Параметры GET

Параметр Тип Описание
id int Уникальный идентификатор задачи

Пример запроса для получения задачи:


GET https://example.amocrm.ru/api/v4/tasks/56981

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


{
    "id": 56981,
    "created_by": 54224,
    "updated_by": 3987910,
    "created_at": 1575910123,
    "updated_at": 1576767989,
    "responsible_user_id": 123123,
    "group_id": 0,
    "entity_id": 180765,
    "entity_type": "leads",
    "duration": 0,
    "is_completed": true,
    "task_type_id": 2,
    "text": "Назначить встречу с клиентом",
    "result": {
        "text": "Результат есть"
    },
    "complete_till": 1575910423,
    "account_id": 321312,
    "_links": {
        "self": {
            "href": "https://example.amocrm.ru/api/v4/tasks/56981"
        }
    }
}

Возможные параметры задачи:

Параметр Тип Описание
id int Уникальный идентификатор задачи
account_id int Уникальный идентификатор аккаунта
created_by int Кем создана задача
created_at timestamp Когда была создана задача
updated_by int Кем была обновлена задача
updated_at timestamp Когда была обновлена задача
responsible_user_id int ID ответственного за выполнение задачи
group_id int ID группы ответственного за задачу
entity_id int ID сущности, к которой привязана задача
entity_type string Тип сущности, к которой привязана задача
is_completed bool Выполнена ли задача
task_type_id int Тип задачи: 1-Звонок, 2-Встреча
text string Описание задачи
duration int Длительность задачи в секундах
result array Результаты выполнения задачи
complete_till timestamp Завершить задачу до
_links array Массив, содержащий информацию о текущем запросе

Получение списка задач

Метод позволяет получить список задач с возможностью фильтрации и постраничной выборки

URL метода

GET /api/v4/tasks

Возможные query параметры запроса:

Параметр Описание
page Страница выборки
limit Кол-во выбираемых строк (системное ограничение 250)
responsible_user_id Дополнительный фильтр поиска, по ответственному пользователю (Можно передавать в виде массива)
filter[status] Выбрать задачи по статусу (в параметр status необходимо передать массив со значением 1(завершенные) или 0(не завершенные))
filter[task_type] Выбрать задачи по типу (в параметр task_type необходимо передать массив типов задачи. (1 – Звонок, 2 – Встреча)

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

В следующем примере мы получим все завершенные задачи с типом 2 (Встреча) с ограничением выборки в 2 строки.


GET https://example.amocrm.ru/api/v4/tasks?filter[task_type][]=2&filter[status][]=1&limit=2

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


{
    "_page": 1,
    "_links": {
        "self": {
            "href": "https://example.amocrm.ru/api/v4/tasks?filter[task_type][]=2&filter[status][]=1&limit=2&page=1&offset=0"
        },
        "next": {
            "href": "https://example.amocrm.ru/api/v4/tasks?filter[task_type][]=2&filter[status][]=1&limit=2&page=2&offset=0"
        }
    },
    "_embedded": {
        "tasks": [
            {
                "id": 7087,
                "created_by": 3987910,
                "updated_by": 3987910,
                "created_at": 1575364000,
                "updated_at": 1575364851,
                "responsible_user_id": 123123,
                "group_id": 0,
                "entity_id": 167353,
                "entity_type": "leads",
                "duration": 0,
                "is_completed": true,
                "task_type_id": 2,
                "text": "Пригласить на бесплатную тренировку",
                "result": [],
                "complete_till": 1575665940,
                "account_id": 321321,
                "_links": {
                    "self": {
                        "href": "https://example.amocrm.ru/api/v4/tasks/7087"
                    }
                }
            },
            {
                "id": 215089,
                "created_by": 0,
                "updated_by": 3987910,
                "created_at": 1576767879,
                "updated_at": 1576767914,
                "responsible_user_id": 123123,
                "group_id": 0,
                "entity_id": 1035487,
                "entity_type": "leads",
                "duration": 0,
                "is_completed": true,
                "task_type_id": 2,
                "text": "Назначить встречу с клиентом",
                "result": [],
                "complete_till": 1576768179,
                "account_id": 321312,
                "_links": {
                    "self": {
                        "href": "https://example.amocrm.ru/api/v4/tasks/215089"
                    }
                }
            }
        ]
    }
}

Создание задач

Метод позволяет создавать задачи по одной или пакетно.
Для создания задачи необходимо передать массив с JSON-объектами, которые должны содержать обязательный параметр text и дополнительные параметры:
– task_type_id
– complete_till
– entity_id
– entity_type
– responsible_user_id
– duration

Описание каждого из параметров можно найти здесь

URL метода

POST /api/v4/tasks

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

В следующем примере мы создадим задачу “Встретиться с клиентом Иван Иванов” и свяжем ее со сделкой.


POST  https://example.amocrm.ru/api/v4/tasks

[
    {
        "task_type_id": 1,
        "text": "Встретиться с клиентом Иван Иванов",
        "complete_till": 1588885140,
        "entity_id": 9785993,
        "entity_type": "leads"
    }
]

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


{
    "_links": {
        "self": {
            "href": "https://example.amocrm.ru/api/v4/tasks"
        }
    },
    "_embedded": {
        "tasks": [
            {
                "id": 4745251,
                "request_id": 0,
                "_links": {
                    "self": {
                        "href": "https://example.amocrm.ru/api/v4/tasks/4745251"
                    }
                }
            }
        ]
    }
}

Редактирование задачи

Метод позволяет редактировать задачи по одной или пакетно.

URL метода

PATCH /api/v4/tasks/{id} – для редактирования по идентификатору

PATCH /api/v4/tasks – для редактирования пакетно

Для изменения задачи по ее идентификатору необходимо отправить тело запроса с JSON-объектом, содержащий один из следующих параметров:

– task_type_id
– text
– complete_till
– responsible_user_id

Описанные каждого из параметров можно найти здесь

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


PATCH https://example.amocrm.ru/api/v4/tasks/4745251
Content-Type: application/json

{
    "task_type_id": 1,
    "text": "Встретиться с клиентом Виталий Попов",
    "complete_till": 1588885140
}

Для изменения задач пакетно необходимо указать массив из json, содержащий в себе обязательное поле id (идентификатор задачи) и дополнительные параметры из списка выше, например:


PATCH https://example.amocrm.ru/api/v4/tasks
Content-Type: application/json

[
    {
        "id": 4745251,
        "task_type_id": 2,
        "text": "Новое название для задачи",
        "complete_till": 1588885140
    },
    {
        "id": 4747929,
        "task_type_id": 1,
        "text": "Новое название для задачи 2",
        "complete_till": 1588885140
    }
]

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


{
    "_links": {
        "self": {
            "href": "https://example.amocrm.ru/api/v4/tasks"
        }
    },
    "_embedded": {
        "tasks": [
            {
                "id": 4745251,
                "updated_at": 1588760725,
                "request_id": 0,
                "_links": {
                    "self": {
                        "href": "https://example.amocrm.ru/api/v4/tasks/4745251"
                    }
                }
            },
            {
                "id": 4747929,
                "updated_at": 1588760725,
                "request_id": 1,
                "_links": {
                    "self": {
                        "href": "https://example.amocrm.ru/api/v4/tasks/4747929"
                    }
                }
            }
        ]
    }
}

Установка результата задачи

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

URL метода

PATCH /api/v4/tasks/{id} – для установки результата по идентификатору

PATCH /api/v4/tasks – для пакетной установки

Пример установки результата


PATCH https://example.amocrm.ru/api/v4/tasks/4747929
Content-Type: application/json

{
    "is_completed": true,
    "result": {
        "text": "Удалось связаться с клиентом"
    }
}

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


{
    "id": 4747929,
    "updated_at": 1588770600,
    "request_id": 0,
    "_links": {
        "self": {
            "href": "https://example.amocrm.ru/api/v4/tasks/4747929"
        }
    }
}

Смотрите также

КОДЫ ОШИБОК API