Получить список рассылок

Метод mailings/get возвращает рассылки одного сообщества с фильтром по статусу и выводом по страницам. Обязательные group_id и channel.

Обновлено

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

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

Параметры

group_id
целое число
обязательный

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

Пример: 123456

channel
строка
обязательный

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

Пример: VK

status
целое число

Показать только рассылки в одном состоянии: 0 — ждёт отправки, 1 — отправляется, 2 — приостановлена, 3 — завершена (кроме тех, что в архиве), 4 — черновик, 6 — в архиве, 7 — ждёт остановки. Если не передать, вернутся все рассылки.

Пример: 4

count
целое число

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

offset
целое число

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

Результат

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

{
  "status": "ok",
  "response": {
    "items": [
      {
        "id": "65a6e5f4c0e8f20012d3a456",
        "title": "Акция выходного дня",
        "type": 4,
        "status": 3,
        "status_name": "Завершена",
        "archived": false,
        "date_send": 1704067200,
        "count": 120,
        "delivered": 118,
        "no_delivered": 2,
        "create_at": 1704060000
      }
    ],
    "total": 1
  }
}

Коды ошибок

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

Код

Когда

7

Не передан group_id или channel, значение неверное или такого сообщества нет.

Неверный статус рассылки в status.

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

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

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

$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/mailings/get'
params = {
    'group_id': 123456,
    'channel': 'VK',
    'status': 4,
}

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

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