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

Контакт — сущность, которая связывает пользователя и клиента. Это «карточка контакта», где указан ответственный за клиента менеджер и хранятся контактные данные клиента: номер телефона для связи в WhatsApp, ID в Telegram, юзернейм в Instagram.

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

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

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

В одном запросе можно указать не более 100 контактов.

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

fetch("https://api.wazzup24.com/v3/contacts", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Authorization": "Bearer {apiKey}",
  },
  body: [
{
        "id": "1",
        "responsibleUserId": "1",
        "name": "3301",
        "contactData": [
            {
                "chatType": "whatsapp",
                "chatId": "79991114433"
            }
        ],
        "uri": "https://link-to-contact-in-crm.com"
    },
    {
        "id": "2",
        "responsibleUserId": "1",
        "name": "3302",
        "contactData": [
            {
                "chatType": "whatsapp",
                "chatId": "79884447788"
            }
        ]
    }
]

Ошибки

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

 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 — Смещение по пагинации, целое неотрицательное число.

Ответ

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

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

Чтобы получить информацию о загруженном из 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'

Ответ

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

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

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

 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 вернутся в ответе в виде массива.

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

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