# Подписка на канал

Описание

Метод позволяет подписаться и получать на заданный Callback URL уведомления о следующих событиях в Telegram-канале: выход новой публикации, редактирование публикации, удаление публикации.

Метод доступен в "API Callback" (на всех тарифах)

# Запрос


# URL запроса

POST

https://api.tgstat.ru/callback/subscribe-channel

# Параметры

Параметр Описание Значение по умолчанию Обязательно
token Ваш токен Не задан Да
subscription_id ID подписки (если передан, вместо добавления новой подписки произойдет редактирование подписки с указанным ID) Не задан Нет
channel_id Идентификатор канала (@username, t.me/username, t.me/joinchat/AAAAABbbbbcccc... или ID канала в TGStat) Не задан Да
event_types Типы событий, о которых необходимо уведомлять (через запятую) Не задан Да

# Доступные типы событий - параметр "event_types":

Событие Описание
new_post Выход новой публикации в канале
edit_post Редактирование публикации в канале
remove_post Удаление публикации в канале

# Ответ


# Успешная подписка

{
    "status": "ok",
    "response": {
        "subscription_id": 1234
    }
}

Полученный subscription_id пригодится при редактировании или отмене подписки с помощью метода callback/unsubscribe. После успешной подписки на канал - на callback_url, указанный ранее с помощью метода callback/set-callback-url начнут приходить уведомления о наступлении событий. Формат отправляемых уведомлений описан здесь - Объекты событий Callback API.

# Ошибки

# Не установлен callback_url. Воспользуйтесь методом callback/set-callback-url.

{
    "status": "error",
    "error": "callback_url not set yet"
}

# Передан некорректный идентификатор канала.

{
    "status": "error",
    "error": "channel_not_found"
}

# Передан некорректный идентификатор подписки (при редактировании)

{
    "status": "error",
    "error": "subscription not found"
}

# Передан id-подписки с типом, отличным от channel (при редактировании)

{
    "status": "error",
    "error": "can't edit non-channel type subscription via this method"
}

# Исчерпано кол-во подписок, разрешенное на вашем тарифе.

{
    "status": "error",
    "error": "quota_callback_objects_reached"
}