Skip to content

Commit

Permalink
Merge pull request #30 from green-api/SW-1971
Browse files Browse the repository at this point in the history
Sw 1971
  • Loading branch information
AknurKh committed Feb 12, 2024
2 parents e1af0c5 + b38d161 commit b0ec203
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 2 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,19 @@ python -m pip install whatsapp-chatbot-python
from whatsapp_chatbot_python import GreenAPIBot, Notification
```

## Setup

Before launching the bot, you should enable incoming notifications in instance settings by using [SetSettings method](https://green-api.com/en/docs/api/account/SetSettings/).


```json
{
"incomingWebhook": "yes",
"outgoingMessageWebhook": "yes",
"outgoingAPIMessageWebhook": "yes"
}
```

## Examples

### How to initialize an object
Expand Down
16 changes: 14 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,18 @@ python -m pip install whatsapp-chatbot-python
from whatsapp_chatbot_python import GreenAPIBot, Notification
```

## Настройки

Перед запуском бота необходимо включить входящие уведомления в настройках экземпляра с помощью [метода SetSettings](https://green-api.com/en/docs/api/account/SetSettings/).

```json
{
"incomingWebhook": "yes",
"outgoingMessageWebhook": "yes",
"outgoingAPIMessageWebhook": "yes"
}
```

## Примеры

### Как инициализировать объект
Expand Down Expand Up @@ -126,7 +138,7 @@ bot.run_forever()
тексту, по команде и регулярным выражениям. Ниже таблица с названиями фильтров и возможными значениями.

| Название фильтра | Описание | Возможные значения |
|------------------|-----------------------------------------------------------------------------------------------|---------------------------------------------------------------------|
| ---------------- | --------------------------------------------------------------------------------------------- | ------------------------------------------------------------------- |
| `from_chat` | Чат или чаты от которых нужно получать сообщения | `"11001234567@c.us"` или `["11001234567@c.us", "11002345678@c.us"]` |
| `from_sender` | Отправитель или отправители от которых нужно получать сообщения | `"11001234567@c.us"` или `["11001234567@c.us", "11002345678@c.us"]` |
| `type_message` | Тип или типы сообщения, которые нужно обрабатывать | `"textMessage"` или `["textMessage", "extendedTextMessage"]` |
Expand Down Expand Up @@ -240,7 +252,7 @@ bot.run_forever()
обновления и удаления состояния. Также у вас есть возможность сохранить данные пользователя в его состоянии.

| Метод менеджера | Описание |
|---------------------|---------------------------------------------------------------------------------------------|
| ------------------- | ------------------------------------------------------------------------------------------- |
| `get_state` | Возвращает класс состояния в котором есть имя состояния и данные пользователя |
| `set_state` | Устанавливает состояние для пользователя. Если состояние существует то данные будут удалены |
| `update_state` | Если состояние существует то изменяет его. Если нет то создает новое состояние |
Expand Down

0 comments on commit b0ec203

Please sign in to comment.