Wazzup База знаний по сервису

wz-help-logo-part

База знаний

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

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

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

Для загрузки списка сделок из CRM в Wazzup, отправьте запрос

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

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

Параметры запроса
Параметр Тип Описание
id Number Id сделки. Обязательное поле, не более 100 символов.
responsibleUserId String Id ответственного пользователя. Заполните это поле, чтобы диалог с контактом из сделки отобразился у ответственного менеджера в окне чата Wazzup.
name String Название сделки, не более 200 символов
uri string Ссылка на сделку в CRM. Если указано, то в инструменте “чемодан”, пользователь сможет увидеть список сделок с контактом, в которых он ответственный и перейти на их страницу в CRM. Необязательное поле, не более 200 символов
contacts Object Массив с id контактов, связанных со сделкой. Id контактов может быть string
closed Boolean Флаг, отмечающий закрытые сделки
Пример запроса
 curl --location --request POST 'https://api.wazzup24.com/v3/deals' \
--header 'Authorization: Basic c8cf90444023482f909520d454368d27' \
--header 'Content-Type: application/json' \
--data-raw '[
{
"id": "1",
"responsibleUserId": "id007",
"name": "Daily Deal Test",
"Closed": "False",
"contacts": [
"id":"111-2e0df379-0e3c-470f-9b36"
],
"link": "https://link-to-deal-in-crm.com"
}
]
'

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

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

https://api.wazzup24.com/v3/deals. В одном запросе можно получить до 100 записей.

 GET https://api.wazzup24.com/v3/deals?offset=
Пример запроса
 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 символов.
Если указано, то в инструменте “чемодан”, пользователь сможет увидеть кнопку, ведущую на страницу контакта в CRM.

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

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

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

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

Параметр Тип Описание
id Number Id сделки. Обязательное поле, не более 100 символов.
responsibleUserId String Id ответственного пользователя. Нужно для отображения диалога с контактом из сделки у ответственного пользователя в чатах Wazzup.
name String Название сделки, не более 200 символов
uri string Ссылка на сделку в CRM. Если указано, то в инструменте “чемодан”, пользователь сможет увидеть список сделок с контактом, в которых он ответственный и перейти на их страницу в CRM. Необязательное поле, не более 200 символов
contacts Object Массив с id контактов, связанных со сделкой. Id контактов может быть string
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'
Ошибки
  • общие для всех роутов
  • 404 Not found если такой сделки нет

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

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

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

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