Данный метод позволяет получить полный список каналов связи (мессенджеров), подключенных к аккаунту. В ответе содержится информация о типе канала, статусе подключения и оплаты, а также настройках. Метод полезен для получения общей картины подключений и их состояния в вашем аккаунте. Если у вас несколько каналов, то независимо, от канала с чьим токеном делается запрос - выводится информация по всем каналам аккаунта, активным и архивным.
Пример запроса:
GET https://wamm.chat/api2/channel_list/{token}/{filter} Параметры запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| token | string | Да | API-токен, полученный в настройках |
| filter | string | Нет | active - активные каналы, archive - архивные, statusOff - активные не на связи, statusOn - активные на связи, one - один текущий, соответствующий API-токену. Если не указать значение - все каналы любых статусов |
Ответ при успехе
{
"err": 0,
"data": [
{
"api_id": 100,
"api_tip": "tg",
"pay_state": "active",
"phone": "79181234567",
"api_tag": "Name 1",
"state": "authorized",
"hook": ""
},
{
"api_id": 110,
"api_tip": "tg",
"pay_state": "active",
"phone": "6289668857000",
"api_tag": "Name 2",
"state": "authorized",
"hook": ""
}
]
} Описание полей ответа
| Поле | Описание |
|---|---|
| api_id | Номер канала |
| api_tip | Тип канала связи (whatsapp, tg, tg_bot, ...) |
| pay_state | Статус оплаты (active / archive) |
| phone | Номер телефона, который подключен к каналу |
| api_tag | Имя канала |
| state | Статус подключения (authorized - работает / notAuthorized / starting / blocked) |
| hook | Текущий URL WebHook (если используется) |
Возможные ошибки
| Код ошибки | Описание |
|---|---|
| token fail | Ошибка в токене |
| fail get data | Ошибка получения данных, либо запрос не вернул данные (пусто) |
Примеры использования
curl -X GET "https://wamm.chat/api2/channel_list/YOUR_TOKEN" function getChannelList($token) {
// Подготавливаем URL запроса
$url = "https://wamm.chat/api2/channel_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";
$channels = getChannelList($token);
// Выводим информацию о каналах
if ($channels !== null) {
foreach ($channels as $channel) {
echo "ID: " . $channel['api_id'] . ", Тип: " . $channel['api_tip'] .
", Телефон: " . $channel['phone'] . ", Статус: " . $channel['state'] . "\n";
}
}