Updated README.md
This commit is contained in:
26
README.md
26
README.md
@@ -37,7 +37,23 @@ python main.py
|
||||
python main.py
|
||||
```
|
||||
|
||||
## Как работает этот бот
|
||||
## Как работает бот
|
||||
|
||||
Для каждой службы (канала уведомлений) создаётся своя собственная комната и в
|
||||
такие комнаты добавляется бот. Затем вся работа с ботом производится при помощи
|
||||
команд - текстовых сообщений, начинающихся с *восклицательного знака*.
|
||||
Поддерживаются следующие команды:
|
||||
- `!help` - получить справку
|
||||
- `!info` - получить сведения о комнате
|
||||
- `!tokens` - получить список токенов
|
||||
- `!auth [SERVICE_NAME]` - создать новый токен (если указать имя сервиса, то
|
||||
приложение, использующее токен, не сможет самостоятельно указывать имя
|
||||
сервиса - всегда будет использовано имя, указанное вами)
|
||||
- `!deauth <TOKEN>` - удалить токен
|
||||
- `!name <TOKEN> [SERVICE_NAME]` - указать (или удалить) имя сервиса для токена
|
||||
- `!leave` - покинуть комнату
|
||||
|
||||
## Как работает веб-сервер
|
||||
|
||||
Этот бот запускает веб-сервер, используя `web_host` и `web_port` из файла
|
||||
конфигурации.
|
||||
@@ -58,14 +74,12 @@ python main.py
|
||||
- `POST /<channel>/notify`
|
||||
- **Описание.** Используется, чтобы отправить уведомление в указанный канал.
|
||||
Вместо `<channel>` указывается код канала, получаемый при помощи команды
|
||||
`!channel_code`, выполненной в комнате Matrix.
|
||||
`!info`, выполненной в комнате Matrix.
|
||||
- **Тело запроса.** Тело запроса представляет собой `json` объект:
|
||||
```json
|
||||
{
|
||||
"service": "<название сервиса, передаётся только если разрешено>",
|
||||
"subservice": "<название подсервиса>",
|
||||
"text": "<текст уведомления>",
|
||||
"urgent": false
|
||||
"service": "<название сервиса; указывается, если токен это позволяет>",
|
||||
"text": "<текст уведомления>"
|
||||
}
|
||||
```
|
||||
- **Тело ответа.** Тело ответа представляет собой `json` объект. В случае
|
||||
|
||||
Reference in New Issue
Block a user