{"id":32612829,"url":"https://github.com/green-api/max-api-client-python","last_synced_at":"2026-07-04T15:32:13.449Z","repository":{"id":318735358,"uuid":"1075307293","full_name":"green-api/max-api-client-python","owner":"green-api","description":"Python MAX библиотека для интеграции с мессенджером MAX через API сервиса green-api.com.","archived":false,"fork":false,"pushed_at":"2026-05-27T10:42:49.000Z","size":122,"stargazers_count":6,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2026-05-27T12:21:10.753Z","etag":null,"topics":["max","max-api","max-api-python","max-bot","max-chat","max-chatbot","max-chatbot-python","max-python"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/green-api.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-10-13T10:18:38.000Z","updated_at":"2026-05-27T10:42:47.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/green-api/max-api-client-python","commit_stats":null,"previous_names":["green-api/max-api-client-python"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/green-api/max-api-client-python","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/green-api%2Fmax-api-client-python","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/green-api%2Fmax-api-client-python/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/green-api%2Fmax-api-client-python/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/green-api%2Fmax-api-client-python/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/green-api","download_url":"https://codeload.github.com/green-api/max-api-client-python/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/green-api%2Fmax-api-client-python/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":35127443,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-07-04T02:00:05.987Z","response_time":113,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["max","max-api","max-api-python","max-bot","max-chat","max-chatbot","max-chatbot-python","max-python"],"created_at":"2025-10-30T14:57:22.701Z","updated_at":"2026-07-04T15:32:13.443Z","avatar_url":"https://github.com/green-api.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# max-api-client-python\n\n![](https://img.shields.io/badge/license-CC%20BY--ND%204.0-green)\n![](https://img.shields.io/pypi/status/max-api-client-python)\n![](https://img.shields.io/pypi/pyversions/max-api-client-python)\n![](https://img.shields.io/github/actions/workflow/status/green-api/max-api-client-python/python-package.yml)\n![](https://img.shields.io/pypi/dm/max-api-client-python)\n\n## Поддержка\n\n[![Support](https://img.shields.io/badge/support@green--api.com-D14836?style=for-the-badge\u0026logo=gmail\u0026logoColor=white)](mailto:support@green-api.com)\n[![Support](https://img.shields.io/badge/Telegram-2CA5E0?style=for-the-badge\u0026logo=telegram\u0026logoColor=white)](https://t.me/greenapi_support_ru_bot)\n[![Support](https://img.shields.io/badge/WhatsApp-25D366?style=for-the-badge\u0026logo=whatsapp\u0026logoColor=white)](https://wa.me/79993331223)\n\n## Руководства и новости\n\n[![Guides](https://img.shields.io/badge/YouTube-%23FF0000.svg?style=for-the-badge\u0026logo=YouTube\u0026logoColor=white)](https://www.youtube.com/@green-api)\n[![News](https://img.shields.io/badge/Telegram-2CA5E0?style=for-the-badge\u0026logo=telegram\u0026logoColor=white)](https://t.me/green_api)\n[![News](https://img.shields.io/badge/WhatsApp-25D366?style=for-the-badge\u0026logo=whatsapp\u0026logoColor=white)](https://whatsapp.com/channel/0029VaHUM5TBA1f7cG29nO1C)\n\nmax-api-client-python - библиотека для интеграции с мессенджером MAX через API сервиса [green-api.com](https://green-api.com/max). Чтобы воспользоваться библиотекой, нужно получить регистрационный токен и ID аккаунта в [личном кабинете](https://console.green-api.com/). Есть бесплатный тариф аккаунта разработчика.\n\n## API\n\nДокументация к REST API находится по [ссылке](https://green-api.com/v3/docs/api/). Библиотека является обёрткой к REST API,\nпоэтому документация по ссылке выше применима и к самой библиотеке.\n\n## Авторизация\n\nЧтобы отправить сообщение или выполнить другие методы GREEN API, аккаунт MAX в приложении телефона должен быть в авторизованном состоянии. Для авторизации аккаунта перейдите в [личный кабинет](https://console.green-api.com/), запросите SMS код. Введите SMS код, после чего инстанс будет авторизован.\n\n## Установка\n\n```shell\npython -m pip install max-api-client-python\n```\n\n## Импорт\n\n```\nfrom max_api_client_python import API\n```\n\n## Примеры\n\n### Как инициализировать объект\n\n```\ngreenAPI = API.GreenAPI(\n    \"3100000001\", \"d75b3a66374942c5b3c019c698abc2067e151558acbd412345\"\n)\n```\n\n### Отправка текстового сообщения на номер MAX\n\nСсылка на пример: [sendTextMessage.py](../examples/sendTextMessage.py).\n\n```\nresponse = greenAPI.sending.sendMessage(\"10000000\", \"Message text\")\n\nprint(response.data)\n```\n\n### Отправка картинки по URL\n\nСсылка на пример: [sendPictureByLink.py](../examples/sendPictureByLink.py).\n\n```\nresponse = greenAPI.sending.sendFileByUrl(\n    \"10000000\",\n    \"https://download.samplelib.com/png/sample-clouds2-400x300.png\",\n    \"sample-clouds2-400x300.png\",\n    \"Sample PNG\"\n)\n\nprint(response.data)\n```\n\n### Отправка картинки загрузкой с диска\n\nСсылка на пример: [sendPictureByUpload.py](../examples/sendPictureByUpload.py).\n\n```\nresponse = greenAPI.sending.sendFileByUpload(\n    \"10000000\",\n    \"data/rates.png\",\n    \"rates.png\",\n    \"Available rates\"\n)\n\nprint(response.data)\n```\n\n### Создание группы и отправка сообщения в эту группу\n\nСсылка на пример: [createGroupAndSendMessage.py](../examples/createGroupAndSendMessage.py).\n\n```\ncreate_group_response = greenAPI.groups.createGroup(\n    \"Group Name\", [\"10000000\"]\n)\nif create_group_response.code == 200:\n    send_message_response = greenAPI.sending.sendMessage(\n        create_group_response.data[\"chatId\"], \"Message text\"\n    )\n```\n\n### Получение входящих уведомлений через HTTP API\n\nСсылка на пример: [receiveNotification.py](../examples/receiveNotification.py).\n\nОбщая концепция получения данных в GREEN API описана [здесь](https://green-api.com/v3/docs/api/receiving/). Для старта\nполучения уведомлений через HTTP API требуется выполнить метод библиотеки:\n\n```\ngreenAPI.webhooks.startReceivingNotifications(onEvent)\n```\n\nonEvent - ваша функция, которая должен содержать параметры:\n\n| Параметр    | Описание                          |\n|-------------|-----------------------------------|\n| typeWebhook | тип полученного уведомления (str) |\n| body        | тело уведомления (dict)           |\n\nТипы и форматы тел уведомлений находятся [здесь](https://green-api.com/v3/docs/api/receiving/notifications-format/).\n\nЭта функция будет вызываться при получении входящего уведомления. Далее обрабатываете уведомления согласно бизнес-логике\nвашей системы.\n\n\n## Список примеров\n\n| Описание                                             | Модуль                                                                   |\n|------------------------------------------------------|--------------------------------------------------------------------------|\n| Пример отправки текста                               | [sendTextMessage.py](../examples/sendTextMessage.py)                     |\n| Пример отправки картинки по URL                      | [sendPictureByLink.py](../examples/sendPictureByLink.py)                 |\n| Пример отправки картинки загрузкой с диска           | [sendPictureByUpload.py](../examples/sendPictureByUpload.py)             |\n| Пример создание группы и отправка сообщения в группу | [createGroupAndSendMessage.py](../examples/createGroupAndSendMessage.py) |\n| Пример получения входящих уведомлений                | [receiveNotification.py](../examples/receiveNotification.py)             |\n| Пример создания инстанса                            | [createInstance.py](https://github.com/green-api/max-api-client-python/blob/master/examples/partherMethods/CreateInstance.py)                          |\n\n## Полный список методов библиотеки\n\n| Метод API                              | Описание                                                                                                                  | Ссылка на документацию                                                                                       |\n|----------------------------------------|---------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------|\n| `account.getSettings`                  | Метод предназначен для получения текущих настроек аккаунта                                                                | [GetSettings](https://green-api.com/v3/docs/api/account/GetSettings/)                                       |\n| `account.getAccountSettings`                | Метод предназначен для получения информации о аккаунте MAX                                                           | [GetAccountSettings](https://green-api.com/v3/docs/api/account/GetAccountSettings/)                                   |\n| `account.setSettings`                  | Метод предназначен для установки настроек аккаунта                                                                        | [SetSettings](https://green-api.com/v3/docs/api/account/SetSettings/)                                       |\n| `account.getStateInstance`             | Метод предназначен для получения состояния аккаунта                                                                       | [GetStateInstance](https://green-api.com/v3/docs/api/account/GetStateInstance/)                             |\n| `account.getStatusInstance`            | Метод предназначен для получения состояния сокета соединения инстанса аккаунта с MAX                                 | [GetStatusInstance](https://green-api.com/v3/docs/api/account/GetStatusInstance/)                           |\n| `account.reboot`                       | Метод предназначен для перезапуска аккаунта                                                                               | [Reboot](https://green-api.com/v3/docs/api/account/Reboot/)                                                 |\n| `account.logout`                       | Метод предназначен для разлогинивания аккаунта                                                                            | [Logout](https://green-api.com/v3/docs/api/account/Logout/)                                                 |\n| `account.qr`                       | Метод предназначен для получения QR кода для авторизации                                                                      | [QR](https://green-api.com/v3/docs/api/account/qr/)                                                 |\n| `account.setProfilePicture`            | Метод предназначен для установки аватара аккаунта                                                                         | [SetProfilePicture](https://green-api.com/v3/docs/api/account/SetProfilePicture/)                           |\n| `groups.createGroup`                   | Метод предназначен для создания группового чата                                                                           | [CreateGroup](https://green-api.com/v3/docs/api/groups/CreateGroup/)                                        |\n| `groups.updateGroupName`               | Метод изменяет наименование группового чата                                                                               | [UpdateGroupName](https://green-api.com/v3/docs/api/groups/UpdateGroupName/)                                |\n| `groups.getGroupData`                  | Метод получает данные группового чата                                                                                     | [GetGroupData](https://green-api.com/v3/docs/api/groups/GetGroupData/)                                      |\n| `groups.addGroupParticipant`           | Метод добавляет участника в групповой чат                                                                                 | [AddGroupParticipant](https://green-api.com/v3/docs/api/groups/AddGroupParticipant/)                        |\n| `groups.removeGroupParticipant`        | Метод удаляет участника из группового чата                                                                                | [RemoveGroupParticipant](https://green-api.com/v3/docs/api/groups/RemoveGroupParticipant/)                  |\n| `groups.setGroupAdmin`                 | Метод назначает участника группового чата администратором                                                                 | [SetGroupAdmin](https://green-api.com/v3/docs/api/groups/SetGroupAdmin/)                                    |\n| `groups.removeAdmin`                   | Метод лишает участника прав администрирования группового чата                                                             | [RemoveAdmin](https://green-api.com/v3/docs/api/groups/RemoveAdmin/)                                        |\n| `groups.setGroupPicture`               | Метод устанавливает аватар группы                                                                                         | [SetGroupPicture](https://green-api.com/v3/docs/api/groups/SetGroupPicture/)                                |\n| `groups.leaveGroup`                    | Метод производит выход пользователя текущего аккаунта из группового чата                                                  | [LeaveGroup](https://green-api.com/v3/docs/api/groups/LeaveGroup/)                                          |\n| `journals.getChatHistory`              | Метод возвращает историю сообщений чата                                                                                   | [GetChatHistory](https://green-api.com/v3/docs/api/journals/GetChatHistory/)                                |\n| `journals.getMessage`                  | Метод возвращает сообщение чата                                                                                           | [GetMessage](https://green-api.com/v3/docs/api/journals/GetMessage/)                                        |       \n| `journals.lastIncomingMessages`        | Метод возвращает крайние входящие сообщения аккаунта                                                                      | [LastIncomingMessages](https://green-api.com/v3/docs/api/journals/LastIncomingMessages/)                    |\n| `journals.lastOutgoingMessages`        | Метод возвращает крайние отправленные сообщения аккаунта                                                                  | [LastOutgoingMessages](https://green-api.com/v3/docs/api/journals/LastOutgoingMessages/)                    |\n| `journals.getChats`        | Метод возвращает список чатов аккаунта                                                                  | [GetChats](https://green-api.com/v3/docs/api/journals/getChats/)                    |\n| `queues.showMessagesQueue`             | Метод предназначен для получения списка сообщений, находящихся в очереди на отправку                                      | [ShowMessagesQueue](https://green-api.com/v3/docs/api/queues/ShowMessagesQueue/)                            |\n| `queues.clearMessagesQueue`            | Метод предназначен для очистки очереди сообщений на отправку                                                              | [ClearMessagesQueue](https://green-api.com/v3/docs/api/queues/ClearMessagesQueue/)                          |\n| `marking.readChat`                     | Метод предназначен для отметки сообщений в чате прочитанными                                                              | [ReadChat](https://green-api.com/v3/docs/api/marks/ReadChat/)                                               |\n| `receiving.receiveNotification`        | Метод предназначен для получения одного входящего уведомления из очереди уведомлений                                      | [ReceiveNotification](https://green-api.com/v3/docs/api/receiving/technology-http-api/ReceiveNotification/) |\n| `receiving.deleteNotification`         | Метод предназначен для удаления входящего уведомления из очереди уведомлений                                              | [DeleteNotification](https://green-api.com/v3/docs/api/receiving/technology-http-api/DeleteNotification/)   |\n| `receiving.downloadFile`               | Метод предназначен для скачивания принятых и отправленных файлов                                                          | [DownloadFile](https://green-api.com/v3/docs/api/receiving/files/DownloadFile/)                             |\n| `sending.sendMessage`                  | Метод предназначен для отправки текстового сообщения в личный или групповой чат                                           | [SendMessage](https://green-api.com/v3/docs/api/sending/SendMessage/)                                       |\n| `sending.sendFileByUpload`             | Метод предназначен для отправки файла, загружаемого через форму (form-data)                                               | [SendFileByUpload](https://green-api.com/v3/docs/api/sending/SendFileByUpload/)                             |\n| `sending.sendFileByUrl`                | Метод предназначен для отправки файла, загружаемого по ссылке                                                             | [SendFileByUrl](https://green-api.com/v3/docs/api/sending/SendFileByUrl/)                                   |\n| `sending.uploadFile`                   | Метод предназначен для загрузки файла в облачное хранилище, который можно отправить методом sendFileByUrl                 | [UploadFile](https://green-api.com/v3/docs/api/sending/UploadFile/)                                         |\n| `serviceMethods.checkAccount`         | Метод проверяет наличие аккаунта MAX на номере телефона                                                              | [CheckAccount](https://green-api.com/v3/docs/api/service/CheckAccount/)                                   |\n| `serviceMethods.getAvatar`             | Метод возвращает аватар корреспондента или группового чата                                                                | [GetAvatar](https://green-api.com/v3/docs/api/service/GetAvatar/)                                           |\n| `serviceMethods.getContacts`           | Метод предназначен для получения списка контактов текущего аккаунта                                                       | [GetContacts](https://green-api.com/v3/docs/api/service/GetContacts/)                                       |\n| `serviceMethods.getContactInfo`        | Метод предназначен для получения информации о контакте                                                                    | [GetContactInfo](https://green-api.com/v3/docs/api/service/GetContactInfo/)                                 |\n| `webhooks.startReceivingNotifications` | Метод предназначен для старта получения новых уведомлений                                                                 |                                                                                                          |\n| `webhooks.stopReceivingNotifications`  | Метод предназначен для остановки получения новых уведомлений                                                              |                                                                                                          |\n| `partner.GetInstances`   | Метод предназначен для получения всех инстансов аккаунтов созданных партнёром.                                           | [GetInstances](https://green-api.com/v3/docs/partners/getInstances/)                       |\n| `partner.CreateInstance`   | Метод предназначен для создания инстанса от имени партнёра.                                           | [CreateInstance](https://green-api.com/v3/docs/partners/createInstance/)                       |\n| `partner.DeleteInstanceAccount`   | Метод предназначен для удаления инстанса аккаунта партнёра.                                           | [DeleteInstanceAccount](https://green-api.com/v3/docs/partners/deleteInstanceAccount/)                       |\n\n## Документация по методам сервиса\n\n[https://green-api.com/v3/docs/api/](https://green-api.com/v3/docs/api/).\n\n## Сторонние продукты\n\n- [requests](https://requests.readthedocs.io/en/latest/) - для HTTP запросов.\n\n## Лицензия\n\nЛицензировано на условиях [\nCreative Commons Attribution-NoDerivatives 4.0 International (CC BY-ND 4.0)\n](https://creativecommons.org/licenses/by-nd/4.0/).\n[LICENSE](../LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgreen-api%2Fmax-api-client-python","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgreen-api%2Fmax-api-client-python","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgreen-api%2Fmax-api-client-python/lists"}