Пользователи

Пользователи — это сотрудники вашего клиента, зарегистрированные в вашем сервисе. Например, менеджеры по продажам или сотрудники поддержки, которые ведут сделки или работают с обращениями в CRM.

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

Методы

• GET /v2/users — получение списка пользователей.
• GET /v2/users/{user_id} — получение пользователя по ID.
• POST /v2/users — добавление пользователей.
• PATCH /v2/users — обновление пользователей.
• DELETE /v2/users — удаление пользователей.
• PATCH /v2/settings — настроить роли пользователей по каналам и видимость номеров в iframe.
• GET /v2/settings — получить настройки ролей.

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

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

Пример:

curl -L 'https://tech.wazzup24.com/v2/users' -H 'Authorization: Bearer <client_access_token>' -H 'Content-Type: application/json' -d '{
"users": [
{
"id": "1",
"name": "Test",
"phone": "79999999999"
}
]
}'

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

{
"data": {
"processed": 1
},
"meta": {
"timestamp": 1759495852
}
}

Результат: Пользователь или список пользователей добавлен.

Типовые ошибки при добавлении пользователей

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

Пример:

curl -L 'https://tech.wazzup24.com/v2/users?offset=0&limit=50' -H 'Authorization: Bearer <client_access_token>'

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

{
"data": [
{
"id": "1",
"name": "Test",
"phone": "79999999999"
}
],
"meta": {
"timestamp": 1759496425
}
}

Результат: Список всех ранее созданных пользователей.

Получение пользователя по ID

Path-параметры
user_id — ID пользователя в CRM

Пример:

curl -L 'https://tech.wazzup24.com/v2/users/1' -H 'Authorization: Bearer <client_access_token>'

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

{
"data": [
{
"id": "1",
"name": "Test",
"phone": "79999999999"
}
],
"meta": {
"timestamp": 1759496425
}
}

Результат: Пользователь с id: 1, если такой существует.

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

Пример:

curl -L -X PATCH 'https://tech.wazzup24.com/v2/users' -H 'Authorization: Bearer <client_access_token>' -H 'Content-Type: application/json' -d '{
"users": [
{
"id": "1",
"name": "Tester",
"phone": "79999999999"
}
]
}'

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

{
"data": {
"processed": 1
},
"meta": {
"timestamp": 1759495852
}
}

Результат: Если пользователь существует, его данные обновлены.

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

Пример:

curl -L -X DELETE 'https://tech.wazzup24.com/v2/users'
-H 'Authorization: Bearer <client_access_token>'
-H 'Content-Type: application/json'
-d '{
"user_ids": [
"1"
]
}'

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

{
"data": null,
"meta": {
"timestamp": 1759393502
}
}

Результат: Пользователь id: 1 удален.

Настройка пользователей

С помощью метода вы можете настроить доступ к чатам для пользователей, а также скрыть номера контактов в их чатах.

Настройка ролей

Роль определяет права пользователя: какие чаты он видит и может ли переписываться.

Для каждого пользователя выберите одну из ролей:

• «Менеджер», seller — может написать только тем контактам, за которых он назначен ответственным в CRM. Не видит переписку других.
• «Руководитель», manager — видит все переписки и может написать любому контакту.
• «Контроль качества», auditor — видит все переписки, но не может ничего написать контактам.

Включите настройку «Получает новых клиентов» (allow_get_new_clients) тем пользователям, которые должны получать сообщения от новых контактов, за которых еще никто не назначен ответственным в CRM.

Включите настройку push_input_output_message_events_for_managers, если пользователям с ролью «Руководитель» нужно, чтобы уведомления приходили из всех чатов. Например, так работают интернет-магазины и отделы поддержки: контакты пишут с простыми вопросами и не важно, кто на них ответит. Отвечает первый, кто смог.

С выключенной настройкой пользователю с ролью «Руководитель» приходят уведомления только в чатах, за которые он ответственен. Значки «неотвеченных» в таких чатах в iframe Wazzup будут красного цвета. Из чатов других продавцов уведомления не приходят, а значки «неотвеченных» — серого цвета.

Скрытие номера

Настройка помогает защитить клиентскую базу.

При включенной настройке номера телефонов скрыты в iframe и в приложениях Wazzup. Выбранные сотрудники видят только первые и последние цифры: +7 (913) ***-**-23.

PATCH /v2/settings
├── user_roles[] *
│ ├── channel_id *
│ ├── user_id *
│ ├── role *
│ └── allow_get_new_clients *
├── hide_phone_numbers_for_user_ids[]
└── push_input_output_message_events_for_managers *

user_roles (объект)

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

{
"user_roles": [
{
"channel_id": "5d1c7dd8-bbfd-42d8-830d-3163b57e760",
"user_id": "user_1",
"role": "manager",
"allow_get_new_clients": true
}
],
"hide_phone_numbers_for_user_ids": [
"user_1"
],
"push_input_output_message_events_for_managers": true
}

Пример успешного ответа:

{
"user_roles": [
{
"channel_id": "5d1c7dd8-bbfd-42d8-830d-3163b57e760",
"user_id": "user_1",
"role": "manager",
"allow_get_new_clients": true
}
],
"hide_phone_numbers_for_user_ids": [
"user_1"
],
"push_input_output_message_events_for_managers": true
}

Получить настройки ролей

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

{
"user_roles": [
{
"channel_id": "5d1c7dd8-bbfd-42d8-830d-3163b57e760",
"user_id": "user_1",
"role": "manager",
"allow_get_new_clients": true
}
],
"hide_phone_numbers_for_user_ids": [
"user_1"
],
"push_input_output_message_events_for_managers": true
}