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

wz-help-logo-part

База знаний

Работа с контактами

Контакт — сущность, связывающая пользователя и написавшего клиента. Это своего рода “карточка контакта”, куда складывается контактная информация клиента (номер телефона для связи в WhatsApp, id в telegram, username в instagram) и ответственный за него менеджер.

Добавление и обновление списка контактов

Для добавления списка контактов или изменения существующих отправьте запрос

 POST https://api.wazzup24.com/v3/contacts
Параметр Тип Описание
id* String Id контакта в CRM-системе. Не более 100 символов
responsibleUserId* String Id ответственного пользователя. Не более 100 символов
Заполните это поле, чтобы диалог отобразился в окне чата Wazzup у ответственного за контакт.
name* String Имя контакта. Не более 200 символов
contactData* Array Массив объектов с контактными данными контакта, который содержит:

chatType — string

chatId — string

contactData.chatType* String Тип мессенджера
contactData.chatId* String Идентификатор чата
uri String Ссылка на контакт в CRM. Не более 200 символов.
Если указано, то в инструменте “чемодан”, пользователь сможет увидеть кнопку, ведущую на страницу контакта в CRM.
Пример запроса
 curl --location --request POST 'https://api.wazzup24.com/v3/contacts' \
--header 'Authorization: Bearer c8cf90444023482f909520d454368d27' \
--header 'Content-Type: application/json' \
--data-raw '[
{
"id": "1",
"responsibleUserId": "id007",
"name": "Alex New",

"link": "https://link-to-contact-in-crm.com"
},

{
"id": "contact-id",
"responsibleUserId": "user-id",
"name": "Супервайзер",
"contactData": [
{
"chatType": "whatsapp",
"chatId": "79998881234"
}
]
}
]
'
Ошибки

Помимо общих ошибок для всех роутов, в данном еще возможны:

Ошибка Описание
INVALID_CONTACTS_DATA Тело запроса пустое или какие-то из переданных полей невалидны.
TOO_MACH_ENTITIES Превышен лимит сущностей на один запрос

 HTTP/1.1 400 Bad Request
{
"error": "INVALID_CONTACTS_DATA",
"description": "One or more of provided contacts data are not valid."
"data": [
{
index: 12,
fields: [
"responsibleUserId",
]
}
]
}

 HTTP/1.1 400 Bad Request
{
"error": "TOO_MACH_ENTITIES",
"description": "Too mach entities per request.",
"data": {
"count": 123,
"limit": 100,
}
}

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

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

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

За один запрос можно получить до 100 записей с учетом offset c сортировкой по id по возрастанию (ASC).

offset — Смещение по пагинации, целое неотрицательное число.

Ответ

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

Параметр Тип Описание
count Number Общее количество контактов
data Object массив с данными о контакте
data.id String Id контакта в CRM-системе. Не более 100 символов
data.responsibleUserId String Id ответственного пользователя. Не более 100 символов
data.name String Имя контакта. Не более 200 символов
data.contactData Object Массив объектов с контактными данными контакта, который содержит:
chatType — string
chatId — string
data.uri String Ссылка на контакт в CRM. Не более 200 символов.
Если указано, то в инструменте “чемодан”, пользователь сможет увидеть кнопку, ведущую на страницу контакта в CRM.

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

Для получения информации о загруженном из CRM в Wazzup отдельном контакте необходимо вызвать

 GET https://api.wazzup24.com/v3/contacts/{id контакта}
Пример запроса
 curl --location --request GET 'https://api.wazzup24.com/v3/contacts/111-2e0df379-0e3c-470f-9b36' \
--header 'Authorization: Bearer c8cf904467023482f909520d454368d27'
Ответ

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

Параметр Тип Описание
id String Id контакта в CRM-системе. Не более 100 символов
responsibleUserId String Id ответственного пользователя. Не более 100 символов
name String Имя контакта. Не более 200 символов
contactData Object Массив объектов с контактными данными контакта, который содержит:
chatType — string
chatId — string
uri String Ссылка на контакт в CRM. Не более 200 символов.
Если указано, то в инструменте “чемодан”, пользователь сможет увидеть кнопку, ведущую на страницу контакта в CRM.

Удаление контакта

Для удаления контакта необходимо вызвать

 DELETE https://api.wazzup24.com/v3/contacts/{id контакта}

Если в общем чате есть диалог с этим контактом — он там останется.

Пример запроса
 curl --location --request DELETE 'https://api.wazzup24.com/v3/contacts/111-2e0df379-0e3c-470f-9b36' \
--header 'Authorization: Basic c8cf90444023482f909520d454368d27'
Ошибки
  • общие для всех роутов
  • 404 Not found если такого контакта нет

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

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

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

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