Перейти к содержанию

SubscribeWebhook

SubscribeWebhook(bot, url, update_types=None, secret=None)

Bases: BaseConnection

Подписывает бота на получение обновлений через WebHook. После вызова этого метода бот будет получать уведомления о новых событиях в чатах на указанный URL. Ваш сервер должен прослушивать один из следующих портов: 80, 8080, 443, 8443, 16384-32383.

Attributes:

Name Type Description
bot Bot

Экземпляр бота для выполнения запроса.
url str

URL HTTP(S)-эндпойнта вашего бота. Должен начинаться с http(s)://
update_types Optional[List[str]]

Список типов обновлений, которые ваш бот хочет получать. Для полного списка типов см. объект
secret Optional[str]

От 5 до 256 символов. Cекрет, который должен быть отправлен в заголовке X-Max-Bot-Api-Secret в каждом запросе Webhook. Разрешены только символы A-Z, a-z, 0-9, и дефис. Заголовок рекомендован, чтобы запрос поступал из установленного веб-узла
Source code in maxapi/methods/subscribe_webhook.py 
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
def __init__(
    self,
    bot: "Bot",
    url: str,
    update_types: Optional[List[UpdateType]] = None,
    secret: Optional[str] = None,
):
    if secret is not None and not (5 <= len(secret) <= 256):
        raise ValueError(
            "secret не должен быть меньше 5 или больше 256 символов"
        )

    self.bot = bot
    self.url = url
    self.update_types = update_types
    self.secret = secret

fetch() async

Отправляет запрос на подписку бота на получение обновлений через WebHook

Returns:

Name Type Description
Subscribed Subscribed

Объект с информацией об операции
Source code in maxapi/methods/subscribe_webhook.py 
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
async def fetch(self) -> Subscribed:
    """
    Отправляет запрос на подписку бота на получение обновлений через WebHook

    Returns:
        Subscribed: Объект с информацией об операции
    """

    bot = self._ensure_bot()

    json: Dict[str, Any] = {}

    json["url"] = self.url

    if self.update_types:
        json["update_types"] = self.update_types

    if self.secret:
        json["secret"] = self.secret

    response = await super().request(
        method=HTTPMethod.POST,
        path=ApiPath.SUBSCRIPTIONS,
        model=Subscribed,
        params=bot.params,
        json=json,
    )

    return cast(Subscribed, response)