from maxo.bot.methods.base import MaxoMethod
from maxo.bot.methods.markers import Body, Query
from maxo.omit import Omittable, Omitted
from maxo.types.new_message_body import NewMessageBody
from maxo.types.simple_query_result import SimpleQueryResult
[документация]
class AnswerOnCallback(MaxoMethod[SimpleQueryResult]):
"""
Ответ на callback
Этот метод используется для отправки ответа после того, как пользователь нажал на кнопку. Ответом может быть обновленное сообщение и/или одноразовое уведомление для пользователя
#### Пример запроса:
```bash
curl -X POST "https://platform-api.max.ru/answers?callback_id=callback_id" \
-H "Authorization: {access_token}" \
-H "Content-Type: application/json" \
-d '{
"message": {
"text": "Это сообщение с кнопкой-ссылкой",
"attachments": [
{
"type": "inline_keyboard",
"payload": {
"buttons": [
[
{
"type": "link",
"text": "Откройте сайт",
"url": "https://example.com"
}
]
]
}
}
]
}
}'
```
Args:
callback_id: Идентификатор кнопки, на которую нажал пользователь
Идентификатор можно получить в обновлениях о событиях через [Webhook](https://dev.max.ru/docs-api/methods/POST/subscriptions) или [Long Polling](https://dev.max.ru/docs-api/methods/GET/updates)
Получение обновлений с помощью [Long Polling](https://dev.max.ru/docs-api/methods/GET/updates) ограничено по скорости и сроку хранения событий - этот способ не подходит для production-окружения. Рекомендуем на всех этапах работы использовать [Webhook](https://dev.max.ru/docs-api/methods/POST/subscriptions)
Когда пользователь нажмёт на кнопку, МАКС отправит событие, содержащее объект [Update](https://dev.max.ru/docs-api/objects/Update) с типом `message_callback` и идентификатором кнопки в поле `updates[i].callback.callback_id`
message: Заполните это, если хотите изменить текущее сообщение
notification: Заполните это, если хотите просто отправить одноразовое уведомление пользователю
Источник: https://dev.max.ru/docs-api/methods/POST/answers
"""
__url__ = "answers"
__method__ = "post"
callback_id: Query[str]
"""
Идентификатор кнопки, на которую нажал пользователь
Идентификатор можно получить в обновлениях о событиях через [Webhook](https://dev.max.ru/docs-api/methods/POST/subscriptions) или [Long Polling](https://dev.max.ru/docs-api/methods/GET/updates)
Получение обновлений с помощью [Long Polling](https://dev.max.ru/docs-api/methods/GET/updates) ограничено по скорости и сроку хранения событий - этот способ не подходит для production-окружения. Рекомендуем на всех этапах работы использовать [Webhook](https://dev.max.ru/docs-api/methods/POST/subscriptions)
Когда пользователь нажмёт на кнопку, МАКС отправит событие, содержащее объект [Update](https://dev.max.ru/docs-api/objects/Update) с типом `message_callback` и идентификатором кнопки в поле `updates[i].callback.callback_id`
"""
message: Body[Omittable[NewMessageBody | None]] = Omitted()
"""Заполните это, если хотите изменить текущее сообщение"""
notification: Body[Omittable[str | None]] = Omitted()
"""Заполните это, если хотите просто отправить одноразовое уведомление пользователю"""
