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

Метод mailings/getById показывает одну рассылку по её ID. Кому доступен, какие поля придут в ответе и какие ошибки возможны.

Обновлено

Показывает одну рассылку по её ID.

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

Параметры

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

ID рассылки — id из ответа mailings/get.

Пример: 65a6e5f4c0e8f20012d3a456

Результат

Возвращает объект рассылки — поля mailings/get, сообщество, текст и вложения.

{
  "status": "ok",
  "response": {
    "id": "65a6e5f4c0e8f20012d3a456",
    "title": "Акция выходного дня",
    "type": 4,
    "status": 4,
    "status_name": "Черновик",
    "archived": false,
    "date_send": 1704067200,
    "count": 0,
    "delivered": 0,
    "no_delivered": 0,
    "create_at": 1704060000,
    "group_id": 123456,
    "channel": "VK",
    "message": "Привет! Скидка 20% до воскресенья",
    "attachments": [
      {
        "id": "65a6e5f4c0e8f20012d3a222",
        "type": "photo"
      }
    ]
  }
}

Коды ошибок

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

Код

Когда

7

«Рассылка не найдена»: рассылки с таким mailing_id нет или она из чужого сообщества. Та же ошибка, если mailing_id не передан или записан неверно.

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

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

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

$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/getById'
params = {
    'mailing_id': '65a6e5f4c0e8f20012d3a456',
}

response = requests.post(url, json=params, headers={'Authorization': f'Bearer {token}'})
print(response.json())
const token = '<ваш_токен>';
const params = {
  "mailing_id": "65a6e5f4c0e8f20012d3a456"
};

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