Этот метод возвращает список всех тегов, назначенных чатам в вашем аккаунте WAMM.chat, с количеством чатов по каждому тегу. Метод удобен для построения фильтров и отчётов в CRM, синхронизации справочника тегов с внешней системой и проверки, какие метки уже используются в переписке.
Запрос выполняется по любому действующему API-токену организации: в ответе будут теги по всему аккаунту, а не только по каналу, к которому привязан токен. Назначить тег чату можно через добавление тега, снять — через удаление тега. Теги конкретного чата также видны в ответе метода получение информации о контакте.
Для идентификаторов операторов, если нужно связать теги с ответственными, используйте получение списка пользователей.
Поддерживаемые мессенджеры
Метод не привязан к одному мессенджеру: теги собираются по всему аккаунту. Запрос доступен при работе с API любого подключённого канала — WhatsApp, Telegram Personal, Telegram Bot, MAX Personal, MAX Bot, Avito и других. Для вызова нужен действующий API-токен канала с оплатой.
Пример запроса:
GET https://wamm.chat/api2/tag_list/{token}/ Параметры запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| token | string | Да | API-токен канала из раздела Настройки > Управление > API |
Ответ при успехе
{
"err": 0,
"data": [
{
"tag": "VIP",
"col": 12
},
{
"tag": "Новый клиент",
"col": 5
}
]
} Описание полей ответа
| Поле | Описание |
|---|---|
| tag | Название тега (как в интерфейсе WAMM.chat) |
| col | Число чатов, у которых назначен этот тег |
Возможные ошибки
| Код ошибки | Описание |
|---|---|
| token fail | Токен отсутствует, неверный или канал в архиве |
| fail get data | В аккаунте нет ни одного тега на чатах |
Примеры использования
function getTagList($token) {
$url = "https://wamm.chat/api2/tag_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";
$tags = getTagList($token);
if ($tags !== null) {
foreach ($tags as $row) {
echo "Тег: {$row['tag']}, чатов: {$row['col']}\n";
}
}