Перейти к содержанию

API Управления заявками без CRM

Получить список заявок

POST https://cloud.roistat.com/api/v1/project/leads/lead/list

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

Для фильтрации заявок нужно передать только те поля, по которым хотите осуществлять поиск.

curl 'https://cloud.roistat.com/api/v1/project/leads/lead/list?project=12345' \
--request POST \
--header 'Content-type: application/json' \
--header 'Api-key: {KEY}' \
--data '{"period": {"from":"2022-11-08T21:00:00.000Z","to":"2023-11-09T20:59:59.999Z"}}'

Тело запроса:

{
    "filters": [
        { "field": "price", "operator": ">", "value": "1000" },
        { "field": "title", "operator": "like", "value": "заявка" },
        { "field": "name", "operator": "like", "value": "Иванов" },
        { "field": "email", "operator": "like", "value": "gmail.com" },
        { "field": "status", "operator": "in", "value": ["0", "1", "2"] },
        { "field": "id", "operator": ">", "value": "1" },
        { 
            "field": "creation_date", 
            "operator": ">", 
            "value": "2022-01-01T21:00:00+0000" 
        },
        { 
            "field": "paid_date", 
            "operator": "=", 
            "value": "2023-11-08T13:29:27+0000" 
        },
        { "field": "phone", "operator": "=", "value": "+79999999999" },
        { "field": "source", "operator": "!=", "value": "2gis" }
    ],
    "limit": 20,
    "offset": 0,
    "period": {
        "from": "2023-10-17T21:00:00.000Z",
        "to": "2023-11-31T20:59:59.999Z"
    },
    "sort_field": "creation_date",
    "sort_order": "desc"
}

{
    "leads": [
        {
            "id": "10",
            "title": "Вторая заявка",
            "creation_date": "2023-11-08T13:03:21+0000",
            "paid_date": "2023-11-08T13:29:27+0000",
            "status": "1",
            "price": 20000,
            "name": "Иванов Петр Иванович",
            "phone": "+79999999999",
            "email": "[email protected]",
            "source": "direct",
            "text": "Тоже важный клиент"
        },
        {
            "id": "9",
            "title": "Первая заявка",
            "creation_date": "2023-10-31T20:49:52+0000",
            "paid_date": "2023-11-08T13:29:27+0000",
            "status": "0",
            "price": 10000,
            "name": "Иванов Иван Иванович",
            "phone": "+79999999999",
            "email": "[email protected]",
            "source": "vk",
            "text": "Важный клиент"
        }
    ],
    "total": 2,
    "status": "success"
}

Строка запроса:

Параметр Тип Описание Обязательный
project string Номер проекта да

Тело запроса:

Параметр Тип Описание Обязательный
period object Период, за который нужно выгрузить заявки да
> from string Начальная дата в формате 2021-11-08T21:00:00.000Z да
> to string Конечная дата в формате 2022-11-09T20:59:59.999Z да
filters array Дополнительные фильтры. Указываются в формате "filters": [["<field>","<operator>","<value>"]] нет
> field string Один из параметров фильтрации:
  • creation_date – дата создания заявки в формате 2022-01-01T21:00:00+0000
  • email – email клиента
  • id – ID заявки в Roistat
  • name – имя клиента
  • paid_date – дата оплаты в формате 2022-01-01T21:00:00+0000
  • phone – телефон клиента
  • price – сумма сделки
  • status – ID текущего статуса заявки — можно получить с помощью метода /leads/status/list
  • source – источник заявки, передаваемый в поле roistat
  • title – название заявки
 нет
> operator string Один из операторов: =, !=, <=, >= нет
> value string Значение для фильтрации с типом string нет
sort_field string Параметр, по которому нужно сортировать список:
  • creation_date – дата создания заявки в формате 2022-01-01T21:00:00+0000
  • id – ID заявки в Roistat
  • paid_date – дата оплаты в формате 2022-01-01T21:00:00+0000
  • price – сумма сделки
  • source – источник заявки, передаваемый в поле roistat
  • status – ID текущего статуса заявки — можно получить с помощью метода /leads/status/list
 да
sort_order string Порядок сортировки: asc – по возрастанию, desc – по убыванию нет
limit integer Максимальное количество результатов в ответе нет
offset integer Количество результатов в начале, которое нужно пропустить нет
Параметр Тип Описание
leads array[object]
> id string ID заявки в Roistat
> title string Название заявки в Roistat
> creation_date string Дата создания заявки в формате 2022-01-01T21:00:00+0000
> paid_date string Дата оплаты в формате 2022-01-01T21:00:00+0000
> status string ID текущего статуса заявки
> price string Сумма сделки
> name string Имя клиента
> phone string Телефон клиента
> email string Email клиента
> source string Источник заявки
> text string Комментарий к заявке
total integer Количество результатов
status string Статус запроса

Получить список статусов

POST https://cloud.roistat.com/api/v1/project/leads/status/list

С помощью данного метода можно получить список статусов в Управлении заявками без CRM. 

curl 'https://cloud.roistat.com/api/v1/project/leads/status/list?project=12345' \
--request POST \
--header 'Content-type: application/json' \
--header 'Api-key: {KEY}'

Тело запроса:

Без тела. 

{
    "data": [
        {
            "id": "0",
            "name": "В работе",
            "type": "progress"
        },
        {
            "id": "1",
            "name": "Оплачен",
            "type": "paid"
        },
        {
            "id": "2",
            "name": "Отменен",
            "type": "canceled"
        }
    ],
    "total": 3,
    "status": "success"
}

Строка запроса:

Параметр Тип Описание Обязательный
project string Номер проекта да

Тело запроса:

Без тела.

Параметр Тип Описание
data array[object]
> id string ID статуса
> name string Название статуса
> type string Группа, к которой относится статус:
  • progress – В процессе
  • paid – Оплачено
  • canceled – Отменено
total integer Количество результатов
status string Статус запроса

Создать заявку

POST https://cloud.roistat.com/api/v1/project/leads/lead/create

С помощью данного метода можно создать заявку в Управлении заявками без CRM. 

curl 'https://cloud.roistat.com/api/v1/project/leads/lead/create?project=12345' \
--request POST \
--header 'Content-type: application/json' \
--header 'Api-key: {KEY}' \
--data '{"creation_date": "2023-02-22T08:05:35.569Z", "name": "Иванов Иван", "status": "1", "title": "Новая заявка"}'

Тело запроса:

{
    "creation_date": "2023-02-22T08:05:35.569Z",
    "email": "[email protected]",
    "name": "Иванов Иван",
    "paid_date": "2023-02-23T21:00:00.000Z",
    "phone": "71231231234",
    "price": 12500,
    "source": "direct",
    "status": "1",
    "title": "Новая заявка"
}

{
    "lead_id": "2",
    "status": "success"
}

Строка запроса:

Параметр Тип Описание Обязательный
project string Номер проекта да

Тело запроса:

Параметр Тип Описание Обязательный
creation_date string Дата создания заявки в формате 2022-01-01T21:00:00+0000 да
email string Email клиента нет
name string Имя клиента да
paid_date string Дата оплаты заявки в формате 2022-01-01T21:00:00+0000 нет
phone string Телефон клиента нет
price integer Сумма сделки нет
source string Значение поля roistat нет
status string Статус заявки:
  • 0 – В работе
  • 1 – Оплачен
  • 2 – Отменен
 да
title string Название заявки да
Параметр Тип Описание
lead_id string ID заявки
status string Статус запроса

Редактировать заявку

POST https://cloud.roistat.com/api/v1/project/leads/lead/update

С помощью данного метода можно редактировать заявку в Управлении заявками без CRM. Для обновления данных нужно передавать только те поля, которые хотите обновить.

curl 'https://cloud.roistat.com/api/v1/project/leads/lead/update?project=12345' \
--request POST \
--header 'Content-type: application/json' \
--header 'Api-key: {KEY}' \
--data '{id: "8", creation_date: "2023-10-22T21:00:00.000Z", name: "Михаил", phone: "+79999999997", price: 20000, source: "vk", status: "3", text: "Очень важный клиент", title: "Заявка 2" }'

Тело запроса:

{
    "creation_date": "2023-10-22T21:00:00.000Z",
    "email": "[email protected]",
    "id": "8",
    "name": "Михаил",
    "phone": "+79999999997",
    "price": 20000,
    "source": "vk",
    "status": "3",
    "text": "Очень важный клиент",
    "title": "Заявка 2"
}

{
    "status": "success"
}

Строка запроса:

Параметр Тип Описание Обязательный
project string Номер проекта да

Тело запроса:

Параметр Тип Описание Обязательный
creation_date string Дата создания заявки в формате 2022-01-01T21:00:00+0000 нет
email string Email клиента нет
id string ID заявки да
name string Имя клиента нет
paid_date string Дата оплаты заявки в формате 2022-01-01T21:00:00+0000 нет
phone string Телефон клиента нет
price integer Сумма сделки нет
source string Значение поля roistat нет
status string Статус заявки:
  • 0 – В работе
  • 1 – Оплачен
  • 2 – Отменен
 нет
text string Комментарий к заявке нет
title string Название заявки нет
Параметр Тип Описание
status string Статус запроса