Обращения

Получить список новых обращений для аккаунта

GET /v1.3/leads/inbox?offset=<offset>&limit=&types=&users=&sa=&tags=

  • offset - смещение для пагинации
  • limit - максимальное количество объектов, которое вернет метод (максимальное значение поля - 200, значение по умолчанию - 50)
  • фильтрация

Возможные значения source_types:

  • comment
  • message

Возможные значения unread:

  • unread
  • read
  • unanswered
  • answered

После успешного выполнения возвращается массив объектов обращений.

id integer Идентификатор обращения
userId integer Идентификатор сотрудника, ответственного за обращение
statusId integer Идентификатор статуса, присвоенного данному обращению
read bool Флаг, отображающий наличие непрочитанных сообщений в обращении
amount integer Стоимость обращения
details string Комментарий к обращению
tags массив строк Теги
socialAccount объект Интеграция, в которую пришло обращение
  • id
integer Идентификатор интеграции в Umnico
  • login
string Логин в мессенджере или название аккаунта в социальной сети
  • type
string Тип интеграции
responseTime null или number Время ответа сотрудника на сообщения клиента в мс. Если null, значит последнее сообщение в обращении - это сообщение от клиента.
customer объект Клиент
  • id
integer Идентификатор клиента
  • login
string Логин клиента в мессенджере или название аккаунта в социальной сети
  • name
string Название аккаунта в Umnico
  • avatar
string Аватар аккаунта в мессенджере или социальной сети
message объект Последнее сообщение
  • unread
integer Количество непрочитанных сообщений в обращении
  • timestamp
string Дата последнего сообщения
  • incoming
bool true - входящее сообщение, false - исходящее
  • data
объект  
    • text
string Текст сообщения
    • url
string Ссылка на сообщение в социальной сети или мессенджере
    • attachments
массив Вложения в сообщения
      • type
string Тип вложения
      • url
string Ссылка для получения вложения
      • text
string Название вложения
address string Адрес клиента
ttn string Номер товарно-транспортной накладной
customData string Поле для ваших дополнительных данных. Не отображаются в интерфейсе
customFields string Поле для ваших дополнительных данных. Отображаются в интерфейсе
paymentTypeId integer Идентификатор типа оплаты
items массив Товары (примерная структура, подробнее см. пункт Изменить данные обращения).
  • id
integer Идентификатор товара в вашей системе
  • title
string Название товара
  • count
integer Количество товара
  • link
string Ссылка на товар

Пример:

GET https://api.umnico.com/v1.3/leads/inbox? offset=0 & limit=10 & types=whatsapp & source_types=message

Response:

[
    {
        "id": 96,
        "userId": 33,
        "statusId": 1,
        "read": false,
        "amount": 0,
        "details": null,
        "tags": [],
        "socialAccount": {
            "id": 13,
            "login": "User Test",
            "type": "vk_personal"
        },
        "responseTime": null,
        "customer": {
            "id": 78,
            "login": "Important Client",
            "name": "Important Client",
            "avatar": "https://sun9-8.userapi.com/c9аав2bb34.jpg"
        },
        "message": {
            "unread": 79,
            "timestamp": "2020-04-10T17:44:56.000Z",
            "incoming": true,
            "data": {
                "text": "Привет, как дела?",
                "url": "https://vk.com/im?msgid=15435421&sel=5344535437"
            }
        },
        "address": null,
        "ttn": null,
        "customData": null,
        "customFields": null,
        "paymentTypeId": null,
        "items": null
    }
]

Получить список активных обращений для аккаунта

GET /v1.3/leads/active?offset=<offset>&limit=&types=&statuses=&sa=&tags=&users=


Пример:

GET https://api.umnico.com/v1.3/leads/active? offset=10 & limit=20 & statuses=1 & from=1584464400000


После успешного выполнения возвращается массив объектов обращений (см. выше).

Получить список архивных обращений для аккаунта

GET /v1.3/leads/completed?offset=<offset>&limit=&types=&statuses=&sa=&tags=&users=


Пример:

GET https://api.umnico.com/v1.3/leads/completed? offset=0 & limit=20 & sa=1 & tags=completed


После успешного выполнения возвращается массив объектов обращений (см. выше).

Получить список всех обращений для аккаунта

GET /v1.3/leads/all?offset=<offset>&limit=&types=&statuses=&sa=&tags=&users=


Пример:

GET https://api.umnico.com/v1.3/leads/all? offset=0 & limit=20 & unread=read


После успешного выполнения возвращается массив объектов обращений (см. выше).

Получить данные для графика «Воронка»

GET /v1.3/leads/funnel?offset=<offset>&limit=&types=&statuses=&sa=&tags=&users=

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

id integer Идентификатор статуса
name string Название статуса
order integer Поле для сортировки
type string Тип статуса
color string Цвет статуса
leads массив Массив объектов обращений (см. выше)

Пример:

GET https://api.umnico.com/v1.3/leads/funnel? offset=0 & limit=20 & unread=unanswered & to=1585241940000

Response:

[
    {
        "id": 1,
        "type": "active",
        "name": "Первичный контакт",
        "order": 1,
        "color": "#64e4a3",
        "leads": [
            {
                "id": 12,
                "userId": 34,
                "statusId": 1,
                "read": true,
                "amount": 794,
                "details": "In velit quo similique quia.",
                "tags": [],
                "socialAccount": {
                    "id": 74,
                    "login": "test_only_test",
                    "type": "instagramVOff"
                },
                "responseTime": 137663,
                "customer": {
                    "id": 93,
                    "login": "Murray",
                    "name": "Nyasia Stroman",
                    "avatar": null
                },
                "message": {
                    "unread": 0,
                    "timestamp": "2020-04-08T21:02:44.537Z",
                    "incoming": true,
                    "data": {
                        "text": "How are you?"
                    }
                },
                "address": null,
                "ttn": null,
                "customData": null,
                "customFields": null,
                "paymentTypeId": null,
                "items": null
            }
        ]
    },
    {
        "id": 6,
        "type": "ignore",
        "name": "Спам",
        "order": 70,
        "color": "#ff5b60",
        "leads": []
    }
]

Получить данные для одного обращения

GET /v1.3/leads/<id>

  • id - идентификатор обращения

После успешного выполнения возвращается объект обращения.

id integer Идентификатор обращения
userId integer Идентификатор сотрудника, ответственного за обращение
statusId integer Идентификатор статуса, присвоенного данному обращению
read bool Флаг, отображающий наличие непрочитанных сообщений в обращении
details string Комментарий к обращению
amount integer Стоимость обращения
responseTime null или number Время ответа сотрудника на сообщения клиента в мс. Если null, значит последнее сообщение в обращении - это сообщение от клиента.
customerId integer Идентификатор клиента
timestamp string Дата последнего сообщения
address string Адрес клиента
ttn string Номер товарно-транспортной накладной
customData string Поле для ваших дополнительных данных. Не отображаются в интерфейсе
customFields string Поле для ваших дополнительных данных. Отображаются в интерфейсе
paymentTypeId integer Идентификатор типа оплаты
items массив Товары (примерная структура, подробнее см. пункт Изменить данные обращения).
  • id
integer Идентификатор товара в вашей системе
  • title
string Название товара
  • count
integer Количество товара
  • link
string Ссылка на товар

Пример:

GET https://api.umnico.com/v1.3/leads/12

Response:

{
    "id": 129,
    "userId": 34,
    "statusId": 1,
    "read": true,
    "amount": 794,
    "details": "In velit quo similique quia.",
    "responseTime": 137663,
    "customerId": 93,
    "timestamp": "2020-04-08T21:02:44.537Z",
    "address": null,
    "ttn": null,
    "customData": null,
    "customFields": null,
    "items": null
}

Получить список обращений по id

GET /v1.3/leads?&id=

  • id - идентификаторы обращения, например id=1&id=2

После успешного выполнения возвращается массив объектов обращений.

id integer Идентификатор обращения
userId integer Идентификатор сотрудника, ответственного за обращение
statusId integer Идентификатор статуса, присвоенного данному обращению
read bool Флаг, отображающий наличие непрочитанных сообщений в обращении
amount integer Стоимость обращения
details string Комментарий к обращению
tags массив строк Теги
socialAccount объект Интеграция, в которую пришло обращение
  • id
integer Идентификатор интеграции в Umnico
  • login
string Логин в мессенджере или название аккаунта в социальной сети
  • type
string Тип интеграции
responseTime null или number Время ответа сотрудника на сообщения клиента в мс. Если null, значит последнее сообщение в обращении - это сообщение от клиента.
customer объект Клиент
  • id
integer Идентификатор клиента
  • login
string Логин клиента в мессенджере или название аккаунта в социальной сети
  • name
string Название аккаунта в Umnico
  • avatar
string Аватар аккаунта в мессенджере или социальной сети
message объект Последнее сообщение
  • unread
integer Количество непрочитанных сообщений в обращении
  • timestamp
string Дата последнего сообщения
  • incoming
bool true - входящее сообщение, false - исходящее
  • data
объект  
    • text
string Текст сообщения
    • url
string Ссылка на сообщение в социальной сети или мессенджере
    • attachments
массив Вложения в сообщения
      • type
string Тип вложения
      • url
string Ссылка для получения вложения
      • text
string Название вложения
address string Адрес клиента
ttn string Номер товарно-транспортной накладной
customData string Поле для ваших дополнительных данных. Не отображаются в интерфейсе
customFields string Поле для ваших дополнительных данных. Отображаются в интерфейсе
paymentTypeId integer Идентификатор типа оплаты
items массив Товары (примерная структура, подробнее см. пункт Изменить данные обращения).
  • id
integer Идентификатор товара в вашей системе
  • title
string Название товара
  • count
integer Количество товара
  • link
string Ссылка на товар

Пример:

GET https://api.umnico.com/v1.3/leads? id=96

Response:

[
    {
        "id": 96,
        "userId": 33,
        "statusId": 1,
        "read": false,
        "amount": 0,
        "details": null,
        "tags": [],
        "socialAccount": {
            "id": 13,
            "login": "User Test",
            "type": "vk_personal"
        },
        "responseTime": null,
        "customer": {
            "id": 78,
            "login": "Important Client",
            "name": "Important Client",
            "avatar": "https://sun9-8.userapi.com/c9аав2bb34.jpg"
        },
        "message": {
            "unread": 79,
            "timestamp": "2020-04-10T17:44:56.000Z",
            "incoming": true,
            "data": {
                "text": "Привет, как дела?",
                "url": "https://vk.com/im?msgid=15435421&sel=5344535437"
            }
        },
        "address": null,
        "ttn": null,
        "customData": null,
        "customFields": null,
        "paymentTypeId": null,
        "items": null
    }
]

Пометить сообщения в обращении прочитанными

PUT /v1.3/leads/<id>/read

  • id - идентификатор обращения

Пример:

PUT https://api.umnico.com/v1.3/leads/12/read


Принять обращение в работу

PUT /v1.3/leads/<id>/accept

  • id - идентификатор обращения

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


Пример:

PUT https://api.umnico.com/v1.3/leads/12/accept

Body:

{
  "userId": 1
}

Изменить данные обращения

PUT /v1.3/leads/<id>

  • id - идентификатор обращения

В тело запроса добавляются поля, которые нужно изменить.

  • statusId - идентификатор статуса, который хотим установить.
  • details - строка комментария к обращению.
  • amount - новая стоимость обращения
  • userId - идентификатор сотрудника, ответственного за обращение
  • address - адрес клиента
  • ttn - номер товарно-транспортной накладной
  • customData - поле для ваших дополнительных данных, не отображаются в интерфейсе
  • customFields - объект полей для ваших дополнительных данных, отображаются в интерфейсе. Пример структуры данных: {"field1": "value", "field2": {"value": 123, "title": "Title in the UI"}}
    • id - ключ поля, требуется уникальное значение в пределах сделки
    • value - данные поля, строка или число
    • title - вспомогательное поле, используется для вывода заголовка поля
  • paymentTypeId - идентификатор типа оплаты
  • items - массив товаров (структура может быть любой, здесь указаны обязательные для заполнения поля)
    • title - название товара
    • count - количество товара

Пример:

PUT https://api.umnico.com/v1.3/leads/12

Body:

{
  "userId": 15,
  "items": [
    {
      "title": "Ковер-самолет",
      "count": 2
    }
  ]
}

Создать обращение на основе существующего обращения

POST /v1.3/leads/new/<id>

  • id - integer - существующее обращение, на основе которого создается новое обращение

После успешного выполнения запроса возвращается объект с идентификатором нового обращения

id integer Идентификатор обращения

Пример:

POST https://api.umnico.com/v1.3/leads/new/12

Response:

{
    "id": 13
}