# Подписка на ключевое слово

Описание

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

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

# Запрос

# URL запроса

POST

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

# Параметры

Параметр	Описание	Значение по умолчанию	Обязательно
token	Ваш токен	Не задан	Да
subscription_id	ID подписки (если передан, вместо добавления новой подписки произойдет редактирование подписки с указанным ID)	Не задан	Нет
q	Ключевое слово / фраза	Не задан	Да
event_types	Типы событий, о которых необходимо уведомлять (через запятую)	new_post	Да
strong_search	Включить строгий поиск (отключает морфологию и поиск по части слова)	0	Нет
minus_words	Список минус слов (разделитель - пробел)	Не задан	Нет
extended_syntax	Используется ли в запросе расширенный синтаксис запроса	0	Нет
peer_types	Тип источника (каналы или чаты)	channel	Нет

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

Событие	Описание
new_post	Выход новой публикации с указанным ключевым словом

# Доступные значения параметра "peer_types":

peer_types	Описание
channel	Каналы
chat	Чаты
all	Каналы и чаты

# Ответ

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

{
    "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": "param q syntax error"
}

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

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

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

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

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

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