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

POST /cc/deal/list

Назначение: получение списка сделок с возможностью фильтрации.

Параметры:

№	Параметр	Тип	Обяза-тель-ный	Описание
1	from_date	Дата	Нет	Дата начала периода
2	until_date	Дата	Нет	Дата окончания периода
3	abonent_ids	Массив	Нет	Уникальные номера ответственных за сделку сотрудников; Примечание. Для получения id сотрудника или списка сотрудников, используется запрос списка сотрудников ВАТС
4	contact_id	Число	Нет	Уникальный номер контакта. Его можно получить согласно метод API для работы с адресной книгой. Источник контакта - только адресная книга КЦ, не рассматривается внешняя система работы с адресной книгой (источник контакта и id источника всегда - КЦ)
5	status	Перечисление	Да	Доступен один из следующих статусов для отбора: ● "in_work" - в работе; ● "succeed" - состоялась; ● "failed" - не состоялась; ● "delete" - удалена

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

POST https://app.mango-office.ru/cc/deal/list

vpbx_api_key = 1234567890qwerty,
sign = 1234567890qwerty,
json =

{
    "abonent_ids": 10068839,
    "status": "in_work",
    "from_date": "2021-08-01",
    "until_date": "2021-08-14"
}

В результате обработки запроса, формируются и передаются JSON-данные, содержащие код результата result (см. Список кодов результата) и объект deal (обязательный):

№	Параметр	Тип	Обяза-тель-ный	Описание
1	deals_ids	Число	Да	Уникальный номер сделки
2	contact_id	Массив	Да	Уникальный номер контакта. Его можно получить методом API для работы с адресной книгой. Источник контакта - только адресная книга КЦ, не рассматривается внешняя система работы с адресной книгой (источник контакта и id источника всегда - КЦ)
3	name	Строка	Да	Название сделки
4	description	Тектс	Да	Описание сделки
5	amount	Число	Да	Сумма сделки.
6	abonent_id	Число	Да	Уникальный номер ответственного за сделку сотрудника. Для получения id сотрудника или списка сотрудников, используется запрос списка сотрудников ВАТС
7	funnel_id	Число	Да	Для получения ID воронки используется метод Получение списка воронок
8	step_id	Число	Да	Уникальный номер этапа, на котором находится сделка. Для получения id воронки используется метод получение списка воронок
9	custom_fields	Массив	Нет	Пользовательские поля, созданные на продукте для сделки. Для получения списка и типов пользовательских полей, используется метод получения списка пользовательских полей
10	status	Строка	Да	Вернет в ответе один из следующих статусов: ● "in_work" - в работе; ● "succeed" - состоялась; ● "failed" - не состоялась; ● "delete" – удалена.
11	status_change_reason	Строка	Да	Причина, по которой не состоялась сделка. Доступно только при изменении уже созданной сделки в статусе "не состоялась" - "failed" или при переводе статуса сделки в статус "не состоялась" - "failed". Вернет в отчете одну из следующих причин, если они указаны: ● too_expensive - слишком дорого; ● bad_condition - не устроили условия; ● competitor - выбрали других; ● missing_demand - пропала потребность; ● alternative – другое
12	reason_comment	Строка	Да	Комментарий к причине отказа, по которой не состоялась сделка при переводе в статус "Не состоялась"

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

{
    "result": 1000,
    "deals": [
        {
            "deal_id": 233018,
            "name": "аававав сделка 1213",
            "abonent_id": 10068839,
            "description": "",
            "amount": 123,
            "status": "in_work",
            "reason_comment": "",
            "contact_id": 19457233,
            "step_id": 1403,
            "funnel_id": 148,
            "custom_fields": null,
            "status_change_reason": null
        },
        {
            "deal_id": 233031,
            "name": "Мартин Лютер КингМалдший Мартин Лютер КингМалдший сделка",
            "abonent_id": 10068839,
            "description": "фывфывфвы фыввыфвфы фыввфывыф",
            "amount": 358,
            "status": "in_work",
            "reason_comment": "",
            "contact_id": 19457522,
            "step_id": 1406,
            "funnel_id": 148,
            "custom_fields": null,
            "status_change_reason": null
        },
        {
            "deal_id": 233072,
            "name": "Сделка из API 3 5",
            "abonent_id": 10068839,
            "description": "<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML 4.0//EN",
            "amount": 9991,
            "status": "in_work",
            "reason_comment": "",
            "contact_id": 19460060,
            "step_id": 1407,
            "funnel_id": 148,
            "custom_fields": {
                "702": {
                    "895": "1"
                },
                "703": {
                    "897": "1",
                    "898": "2"
                },
                "704": "фывывфвыф",
                "705": 234,
                "712": "123фыв",
                "714": "2021-08-08",
                "715": false,
                "716": "http://redmine.mango.local/issues/258123",
                "717": 10068839
            },
            "status_change_reason": null
        },
        {
            "deal_id": 233082,
            "name": "Александр сделка фывфывв фыфывфывыф",
            "abonent_id": 10068839,
            "description": "описание ячсячссяч ячссячясч ячсясчсячясч",
            "amount": 2123123132,
            "status": "in_work",
            "reason_comment": "",
            "contact_id": 19460060,
            "step_id": 1408,
            "funnel_id": 148,
            "custom_fields": null,
            "status_change_reason": null
        }
    ]
}

Была ли статья полезна?

4.5.3 Получение сделки по ID

4.5.5 Получение списка пользовательских полей