Arrow
Начало работы с Wazzup
Arrow
Как подключить мессенджер
Arrow
Как пользоваться чатами Wazzup
Arrow
Как оплатить
Arrow
Битрикс24
Arrow
Как подключить Wazzup
Arrow
Как переписываться
Arrow
Как настроить автоматизацию
Arrow
Сквозная аналитика
Arrow
Решение проблем
Arrow
amoCRM
Arrow
Другие CRM
Arrow
1С: УНФ
Arrow
HubSpot
Arrow
Zoho
Arrow
Pipedrive
Arrow
Еще CRM
Arrow
Как продавать еще удобнее
Arrow
Всё о WABA
Arrow
Для партнеров
Arrow
API-документация
API-документация
Arrow

Работа со списком сделок

Сделка — сущность, которая объединяет один или более контактов. У нее есть ответственный пользователь. В CRM чаще всего эта сущность называется «заказом» или «сделкой».

Пример: один и тот же клиент написал по поводу покупки новых дверей и половых покрытий. Клиент пытается закрыть две разные задачи и нуждается в консультации двух разных менеджеров. Поэтому необходимо создать две разные сделки с одним и тем же контактом, но разными ответственными менеджерами.

Загрузка списка сделок

Чтобы загрузить список сделок из CRM в Wazzup, отправьте запрос:

 POST https://api.wazzup24.com/v3/deals

В теле запроса нужно отправить массив с данными о сделках. Сделки в Wazzup и из запроса сравниваем по id. Если сделки нет в Wazzup — добавляем ее, если есть — то обновляем данные о сделке. За один запрос можно загружать не больше 100 сделок.

Параметры запроса

Параметр Обязательные параметры отмечены «звездочкой» Тип Описание
id* Number ID сделки. Не более 100 символов.
responsibleUserId* String ID ответственного пользователя. Заполните это поле, чтобы диалог с контактом из сделки отобразился у ответственного менеджера в чатах Wazzup
name* String Название сделки. Не более 200 символов
uri* String Ссылка на сделку в CRM. Не более 200 символов. Если указаны ссылки, пользователь видит в списке «Сделки» те, за которые он ответственный в CRM. Пользователь сможет перейти в сделки в CRM из этого списка
contacts* Object Массив с id контактов, которые связаны со сделкой. ID контактов может быть String
closed* Boolean Флаг, которым отмечены закрытые сделки

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

fetch("https://api.wazzup24.com/v3/deals", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Authorization": "Bearer {apiKey}",
  },
  body: [
    {
      id: "deal-id",
      responsibleUserId: "user-id",
      name: "Супервайзер",
      uri: "any valid uri"
      contacts: [
        "contact-id-123",
        ...
      ],
      closed: false
    }
  ]
});

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

Для получения списка сделок отправьте:

 GET https://api.wazzup24.com/v3/deals?offset=

В одном запросе можно получить до 100 записей.

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

 curl --location --request GET 'https://api.wazzup24.com/v3/deals' \
--header 'Authorization: Bearer c8cf90474023482f909520d45f368d27'

Ответ

Ответ придет в виде массива объектов со следующими параметрами:

Параметр Тип Описание
count Number Количество сделок в ответе
data Object Массив с данными о сделках
data.id String ID сделки. Не более 100 символов
data.responsibleUserId String ID ответственного пользователя. Не более 100 символов. Нужно чтобы продавец видел в чатах Wazzup диалоги по сделке, за которую он ответственный
data.name String Имя сделки. Не более 200 символов
data.contacts Object Массив id контактов, с которыми связана сделка. Не более 10
data.uri String Ссылка на сделку в CRM. Не более 200 символов

Получение информации по отдельной сделке

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

 GET https://api.wazzup24.com/v3/deals/{id сделки}

Ответ

Данные придут в виде объекта со следующими параметрами:

Параметр Тип Описание
id Number ID сделки
responsibleUserId String ID ответственного пользователя. Нужно чтобы продавец видел в чатах Wazzup диалоги по сделке, за которую он ответственный
name String Название сделки
uri String Ссылка на сделку в CRM
contacts Object Массив с id контактов, связанных со сделкой
closed Boolean Флаг, которым отмечены закрытые сделки

Удаление сделки

Для удаление конкретной сделки нужно вызвать:

 DELETE https://api.wazzup24.com/v3/deals/{id сделки}

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

 curl --location --request DELETE 'https://api.wazzup24.com/v3/deals/101' \
--header 'Authorization: Bearer c8cf97644023482f909520d454368d27'

Ошибки

Удаление нескольких сделок

Чтобы удалить список сделок, необходимо вызвать:

 PATCH https://api.wazzup24.com/v3/deals/bulk_delete

В теле запроса необходимо передать массив id сделок, которых необходимо удалить. При успешном удалении вернется 200 ОК и пустой массив. Если в запросе на удаление были указаны сделки, некоторые из которых отсутствуют в Wazzup, то их ID вернутся в ответе в виде массива.

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

fetch("https://api.wazzup24.com/v3/deals/bulk_delete", {
  method: "PATCH",
  headers: {
    "Content-Type": "application/json",
    "Authorization": "Bearer {apiKey}",
  },
  body: [
    "deal-id-123",
    "deal-id-456",
  ]
});