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

Метод возвращает полный список пользователей аккаунта WAMM.chat: активных, заблокированных и помеченных как удалённых. В ответе — роль, email, имя, даты регистрации и последней активности, флаги блокировки и удаления. Это удобно для синхронизации с CRM, аудита доступа и построения отчётов по операторам.

Список относится ко всему аккаунту, а не к одному каналу: с любым действующим API-токеном вы получите одних и тех же пользователей. Полученный user_id используйте в назначении ответственного за чат и в получении открытых чатов пользователя. Для списка подключённых каналов см. получение списка каналов связи.

Поддерживаемые мессенджеры

Метод не привязан к типу мессенджера: подойдёт API-токен любого подключённого канала (WhatsApp, Telegram Personal, Telegram Bot, MAX Personal и др.), если у канала активная оплата. Данные всегда по организации (org), в которой создан токен.

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

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

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

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

{
    "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
        }
    ]
}

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

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

Примеры использования

function getUserList($token) {
    $url = "https://wamm.chat/api2/user_list/" . rawurlencode($token);

    $response = file_get_contents($url);
    if ($response === false) {
        echo "Не удалось выполнить запрос к серверу";
        return null;
    }

    $json = json_decode($response, true);
    if (!is_array($json) || !isset($json['err'])) {
        echo "Не удалось обработать ответ от сервера";
        return null;
    }

    if ($json['err'] === 0 && isset($json['data'])) {
        return $json['data'];
    }

    echo "Ошибка: " . $json['err'];
    return null;
}

$token = "YOUR_TOKEN";
$users = getUserList($token);

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