Метод возвращает полный список пользователей аккаунта WAMM.chat, включая активных, заблокированных и удаленных. В ответе содержится информация о роли пользователя, контактных данных и статусе активности. Метод полезен для управления доступом, аудита активности и контроля состояния учетных записей. Если у вас несколько каналов, то независимо, от канала с чьим токеном делается запрос - выводится информация по всем пользователям.

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

GET https://wamm.chat/api2/user_list/{token}

Параметры запроса

Параметр	Тип	Обязательный	Описание
token	string	Да	API-токен, полученный в настройках

Ответ при успехе

{
    "err": 0,
    "data": [
        {
            "user_id": 100,
            "acc": "admin",
            "email": "user1@gmail.com",
            "name": "User Name1",
            "dt_reg": "2022-10-04 23:17:22",
            "dt_active": "2024-02-29 11:29:49",
            "lock": 0,
            "deleted": 0
        },
        {
            "user_id": 110,
            "acc": "user",
            "email": "user2@gmail.com",
            "name": "User Name2",
            "dt_reg": "2020-08-18 18:43:46",
            "dt_active": "2024-01-25 17:55:21",
            "lock": 0,
            "deleted": 0
        }
    ]
}

Описание полей ответа

Поле	Описание
user_id	Идентификатор пользователя
acc	Роль пользователя (user / admin)
email	Email пользователя
name	Имя пользователя
dt_reg	Дата регистрации
dt_active	Дата последней активности в программе
lock	Статус блокировки (0 - активен, 1 - заблокирован)
deleted	Статус удаления (0 - активен, 1 - удален)

Возможные ошибки

Код ошибки	Описание
token fail	Ошибка в токене
fail get data	Ошибка получения данных

curl -X GET "https://wamm.chat/api2/user_list/YOUR_TOKEN"

function getUserList($token) {
    // Подготавливаем URL запроса
    $url = "https://wamm.chat/api2/user_list/$token";
    
    // Выполняем запрос
    $response = file_get_contents($url);
    
    // Обрабатываем ответ
    if ($response !== false) {
        // Преобразуем ответ в массив
        $json_response = json_decode($response, true);
        
        // Проверяем наличие ошибок
        if (isset($json_response['err'])) {
            if ($json_response['err'] == 0 && isset($json_response['data'])) {
                echo "Список пользователей успешно получен";
                return $json_response['data'];
            } else {
                echo "Ошибка: " . $json_response['err'];
                return null;
            }
        } else {
            echo "Не удалось обработать ответ от сервера";
            return null;
        }
    } else {
        echo "Не удалось выполнить запрос к серверу";
        return null;
    }
}

// Используем функцию для получения списка пользователей
$token = "YOUR_TOKEN";
$users = getUserList($token);

// Выводим информацию о пользователях
if ($users !== null) {
    foreach ($users as $user) {
        echo "ID: " . $user['user_id'] . ", Имя: " . $user['name'] . 
             ", Email: " . $user['email'] . ", Роль: " . $user['acc'] . 
             ", Активен: " . ($user['lock'] == 0 && $user['deleted'] == 0 ? 'Да' : 'Нет') . "\n";
    }
}