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

wz-help-logo-part

База знаний

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

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

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

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

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

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

Данный метод возвращает юзеров страницами по 100 с учётом offset с сортировкой по name.

Пример запроса
 curl --location --request GET 'https://api.wazzup24.com/v3/users' \
--header 'Authorization: Bearer c8cf90444442348we909520d454368d27'
Ответ

Пример результата запроса

{

“count”: “1”,
“data”: [
{"id": "2e0df379-0e3c-470f-9b36-06b9e34c3bdb", // id пользователя

"name": "User Name"}                           // имя пользователя

]
}

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

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

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

В ответ придет JSON вида

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

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

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

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

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

Параметр Тип Описание
id* String Идентификатор пользователя. До 200 символов
name* String Имя пользователя. Строка до 200 символов
phone String Номер телефона в международном формате “79261234567”. Если номер телефона не пройдёт формальную валидацию — ошибки не будет и свойство phone просто удалится.

Поле «phone» указывается только для возможности добавить пользователя в мобильное приложение.

Пример запроса
 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"
}
]'
Ошибка
Ошибка Описание
INVALID_USERS_DATA Тело запроса пустое или какие-то из переданных полей невалидны.
TOO_MACH_ENTITIES Превышен лимит сущностей на один запрос
USER_LIMIT_EXCEEDED Превышен лимит сущностей

 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,
}
}

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

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

 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'

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

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

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

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