Работа с сущностью пользователя

Пользователи — это профили, которые вы создаете в CRM для своих сотрудников. Это не ваши клиенты, а менеджеры или сотрудники поддержки.

Набор методов ниже поможет вам настроить синхронизацию аккаунтов ваших пользователей в CRM с Wazzup.

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

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

 GET https://api.wazzup24.com/v3/users

Этот метод возвращает массив юзеров с сортировкой по name.

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

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

Пример ответа

[
    {
        "id": "2e0df379-0e3c-470f-9b36-06b9e34c3bdb", // id пользователя
        "name": "User Name" // имя пользователя
    } 
]

Получение данных одного пользователя

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

 GET https://api.wazzup24.com/v3/users/:id

Пример ответа

{
{"id": "2e0df379-0e3c-470f-9b36-06b9e34c3bdb", // id пользователя
"name": "User Name"} , // имя пользователя
"phone": "79332345432  // номер телефона пользователя в международном формате
]
}

Добавление пользователей

Чтобы добавить нового пользователя необходимо вызвать:

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

В теле запроса следует передавать массив с данными о пользователях (не более 100 за один запрос). Пользователи сравниваются по id: если пользователь еще не существует в Wazzup — добавится, если существует — его данные обновятся.

Добавление пользователей с одинаковым номером телефона через API ограничено. В случае ошибки вы получите уведомление.

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

 curl --location --request POST 'https://api.wazzup24.com/v3/users' \
--header 'Authorization: Bearer c8cf90444023482f909520d454368d27' \
--header 'Content-Type: application/json' \
--data-raw '[
{
"id": "2e0df379-0e3c-470f-9b36-06b9e34c3bdb",
"name": "Alex Salesman",
"phone": "79263334567"
},
{
"id": "111-2e0df379-0e3c-470f-9b36",
"name": "Kate Supportics",
"phone": "79261234567"
}
]'

Пример ответа

HTTP/1.1 200 OK

Ошибки

 HTTP/1.1 400 Bad Request
{
"error": "INVALID_USERS_DATA",
"description": "One or more of provided users identifiers are not valid."
"data": [
{
index: 12,
fields: [
"id",
"name"
]
}
]
}

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

 HTTP/1.1 400 Bad Request
{
"error": "USER_LIMIT_EXCEEDED",
"description": "User limit exceeded.",
"data": {
"limit": 1000,
}
}

{
    "status": 400,
    "requestId": "594101c6e81a1cace2646eee1edd5e66",
    "error": "DUPLICATE_PHONE_NUMBER",
    "description": "User with phone number 79999999999 already exists in the CRM.",
    "data": {
        "phone": "79999999999"
    }
}

Удаление пользователя

Чтобы удалить пользователя, вызовите:

 DELETE https://api.wazzup24.com/v3/users/{id пользователя}

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

 curl --location --request DELETE 'https://api.wazzup24.com/v3/users/111-2e0df379-0e3c-470f-9b36' \
--header 'Authorization: Bearer c8cf90444023482f909520d454368d27'

Пример ответа

HTTP/1.1 200 OK

Массовое удаление пользователей

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

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

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

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

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

Пример ответа

HTTP/1.1 200 OK