Получить список ботов

Метод bots/get возвращает ботов одного сообщества или всех сообществ, где вам открыт раздел ботов. Фильтр по group_id и channel, пример запроса.

Обновлено

Показывает ботов одного сообщества или всех сообществ, где вам открыт раздел ботов.

Нужен личный токен с продуктом BotHunter — как получить. Кому доступен: владельцу сообщества и сотрудникам с ролью «Админ (полный доступ)» или «Рассылки и чат-боты».

Параметры

group_id
целое число

Номер сообщества — group_id из ответа groups/get.

Пример: 123456

channel
строка

Канал сообщества: VK, TG, OK, MAX, CHAT или AVITO — константы.

Пример: VK

active
целое число

1 — только включённые боты, 0 — только выключенные.

Пример: 1

archived
целое число

1 — только боты в архиве, 0 — только боты не в архиве.

search
строка

Часть названия, без учёта регистра.

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

count
целое число

Сколько записей вернуть: по умолчанию 100, не больше 500.

Пример: 20

offset
целое число

Сколько записей пропустить — для выборки по страницам.

Результат

Возвращает объект: items — массив ботов, total — сколько их всего.

{
  "status": "ok",
  "response": {
    "items": [
      {
        "id": "607d97c6a01c6a25972ed95e",
        "name": "Мой бот",
        "group_id": 123456,
        "channel": "VK",
        "active": 1,
        "archived": 0,
        "activity_type": "message_new",
        "create_at": 1704067200
      }
    ],
    "total": 1
  }
}

Коды ошибок

Общие ошибки — на странице API.

Код

Когда

7

Сообщество не найдено; неверное значение group_id, channel, active или archived; сообщество с таким group_id есть в нескольких каналах — добавьте channel.

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

Подставьте свой токен вместо <ваш_токен>.

curl
PHP
Python
JavaScript
curl -X POST https://bot-api.targethunter.ru/external-api/v2/bots/get \
  -H "Authorization: Bearer <ваш_токен>" \
  -H "Content-Type: application/json" \
  -d '{"group_id": 123456, "channel": "VK", "active": 1, "count": 20}'
$token = '<ваш_токен>';
$url = 'https://bot-api.targethunter.ru/external-api/v2/bots/get';
$params = [
    'group_id' => 123456,
    'channel' => 'VK',
    'active' => 1,
    'count' => 20,
];

$curl = curl_init($url);
curl_setopt_array($curl, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_POST => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . $token,
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => json_encode($params),
]);

$response = json_decode(curl_exec($curl), true);
curl_close($curl);
import requests

token = '<ваш_токен>'
url = 'https://bot-api.targethunter.ru/external-api/v2/bots/get'
params = {
    'group_id': 123456,
    'channel': 'VK',
    'active': 1,
    'count': 20,
}

response = requests.post(url, json=params, headers={'Authorization': f'Bearer {token}'})
print(response.json())
const token = '<ваш_токен>';
const params = {
  "group_id": 123456,
  "channel": "VK",
  "active": 1,
  "count": 20
};

const response = await fetch('https://bot-api.targethunter.ru/external-api/v2/bots/get', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${token}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify(params),
});
console.log(await response.json());