Sender Справка

Методы API

Справочник API Sender: адрес, авторизация, формат запросов и ответов, все методы с параметрами и коды ошибок.

5 мин
Где в Sender: Управление → Настройки → «API-ключи канала»Открыть в Sender

Адрес и авторизация

  • Адрес: POST https://getsender.io/api/ext/<раздел>/<метод>, например …/api/ext/subscribers/add. Принимаются только запросы POST.
  • Ключ snd_… — в заголовке Authorization: Bearer snd_… или параметром access_token в теле запроса. Не пишите ключ в адресе запроса (?access_token=): так он легче утекает.
  • group_id можно не передавать: ключ уже привязан к одному каналу.
  • Не больше 20 запросов в секунду на ключ.

Формат

  • Тело запроса — обычная форма (application/x-www-form-urlencoded или multipart/form-data) или JSON с заголовком Content-Type: application/json.
  • Списки ID — через запятую (vk_user_id=1,2,3), массивом в JSON или повтором vk_user_id[]=…. В одном вызове — не больше 100 ID.
  • vk_user_id — ID человека в этом канале: во ВКонтакте — ID страницы, в Telegram и МАКС — ID пользователя (его можно скопировать в списке подписчиков: меню строки «Ещё» → «Скопировать ID»).
  • Ответ приходит в формате JSON, обычно с кодом HTTP 200 — даже при ошибке, поэтому смотрите на поле success. Успех — "success": true и данные. Ошибка — "success": false, error_code и error_message.

Подписчики

МетодЧто делаетПараметры
subscribers/addдобавляет человека в базу, а с subscription_id — подписывает на группу подписчиковvk_user_id — обязательно, до 100; subscription_id — группа; utm_id — номер метки; utm_source, utm_medium, utm_campaign, utm_content, utm_term
subscribers/delотписывает от группы, а без subscription_id — от всех групп, статус станет «Неактивен»vk_user_id — обязательно; subscription_id
subscribers/getсписок подписчиков по условиямсм. ниже
subscribers/countсколько подписчиковsubscription_id — посчитать в группах

Если у группы подписчиков настроены боты после подписки, subscribers/add их запустит — как при обычной подписке. Если кто-то из списка не разрешил сообщения, придёт ошибка 4: люди до него в списке уже будут подписаны, остальные — нет.

Условия subscribers/get (utm_id здесь и выше — номер метки, он виден в адресе страницы подписчиков с этой меткой: tag_id=3):

  • vk_user_id — эти люди (так проверяют, подписан ли человек);
  • subscription_id / ignore_subscription_id — подписан / не подписан на группы;
  • utm_id / ignore_utm_id — есть / нет метки;
  • delivery_id, ignore_delivery_id, read_delivery_id, error_delivery_id — получил рассылку, не получил, прочитал, получил с ошибкой;
  • lead_status — 1 только активные, другое значение — неактивные;
  • var_name и var_value — есть переменная (с этим значением);
  • count — сколько вернуть, до 100; offset_id — для следующей страницы передайте offset_id из прошлого ответа.

В ответе — items: у каждого vk_user_id, subscriber_id, имя, фото, date (первое появление, ДД.ММ.ГГГГ ЧЧ:ММ:СС, время UTC), lead_status (1 — активен, 2 — нет), ignore (1 — в чёрном списке), subscriptions (действующие подписки на группы и их даты), utms (метки), utm (UTM-метки) и vars (переменные).

Боты

МетодЧто делаетПараметры
bots/getсписок ботов канала: bot_id, название, active (1 — бот включён), published (1 — неопубликованных правок нет)—
bots/getStepsшаги бота: step_id, название, типbot_id
bots/addSubscriberзапускает человеку ботаvk_user_id, bot_id — обязательно; step_id — с какого шага; enforce=1 — заново, даже если уже проходил
bots/delSubscriberостанавливает бота у человекаvk_user_id, bot_id

Бот должен быть включён и опубликован, а человек — активен. Иначе Sender ответит {"success": true}, но бот не запустится. Того, кто уже проходит бота или прошёл его, bots/addSubscriber без enforce=1 и step_id заново не запускает.

Переменные

МетодЧто делаетПараметры
vars/getпеременные подписчикаvk_user_id; name — одна переменная
vars/setзаписывает переменную подписчикаvk_user_id, name, value
vars/delудаляет переменную подписчикаvk_user_id, name
vars_global/getглобальные переменные каналаname — одна переменная
vars_global/setзаписывает глобальную переменнуюname, value
vars_global/delудаляет глобальную переменнуюname

Имя переменной — латинские буквы, цифры и «_», до 40 символов; заглавные буквы Sender сам делает строчными. Подробнее о переменных — Переменные.

Справочники

МетодЧто возвращает
subscriptions/getгруппы подписчиков канала: subscription_id, name, title, subscribers_count
groups/getсам канал: group_id, название, type_id (1 — ВКонтакте, 2 — Telegram, 3 — МАКС), фото

Пример ответа subscribers/get:

json
{"success": true, "offset_id": 5012, "items": [
  {"vk_user_id": 123456, "subscriber_id": 5012, "first_name": "Анна", "last_name": "Петрова",
   "photo": "https://…", "date": "12.10.2026 09:15:00", "lead_status": 1, "ignore": 0,
   "subscriptions": [{"subscription_id": 12, "date": "12.10.2026 09:15:00", "source": "api"}],
   "utms": [{"utm_id": 3}],
   "utm": {"utm_source": "vk", "utm_medium": null, "utm_campaign": null, "utm_content": null, "utm_term": null},
   "vars": [{"n": "tariff", "v": "pro"}]}
]}

Коды ошибок

КодЧто значитЧто делать
1нет обязательного параметрапроверьте, что передали vk_user_id, bot_id или name
4человек не разрешил отправку сообщенийво ВКонтакте он должен разрешить сообщения сообществу, в Telegram и МАКС — запустить бота и не блокировать его
5человек не найден в базе каналасначала добавьте его через subscribers/add
6канал не найденключ от другого канала или неверный group_id
7группа подписчиков не найденапроверьте subscription_id через subscriptions/get
9слишком много запросовне больше 20 в секунду на ключ; после 60 запросов с неверным ключом за минуту с одного адреса Sender отвечает этой ошибкой, пока минута не пройдёт, — сколько ждать, сказано в тексте ошибки
10бот не найденпроверьте bot_id через bots/get
11неверное имя переменнойтолько латинские буквы, цифры и «_», до 40 символов
12неверное значение параметранапример, не число или больше 100 ID за раз
14недействительный ключключ отозван или скопирован не целиком
15канал недоступенканал отключён или заблокирован, либо проект заблокирован или удаляется — причина в тексте ошибки
100неизвестный методпроверьте раздел и метод в адресе

Частые вопросы

Как проверить, подписан ли человек на группу?

Вызовите subscribers/get с vk_user_id и subscription_id. Пустой items — не подписан.

Как отправить человеку сообщение через API?

Сделайте бота с нужным сообщением и запустите его методом bots/addSubscriber. Текст можно заранее положить в переменную через vars/set и подставить в сообщение бота.

Не нашли ответ?Напишите нам — ответим и дополним справку.
Написать в поддержку