{"id":21942925,"url":"https://github.com/green-api/v2-docs","last_synced_at":"2025-08-13T19:16:43.573Z","repository":{"id":109551375,"uuid":"371584799","full_name":"green-api/v2-docs","owner":"green-api","description":null,"archived":false,"fork":false,"pushed_at":"2021-05-28T05:45:56.000Z","size":2,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-22T15:49:02.594Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"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":null,"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}},"created_at":"2021-05-28T05:00:39.000Z","updated_at":"2021-05-28T07:54:51.000Z","dependencies_parsed_at":"2023-04-11T22:10:40.254Z","dependency_job_id":null,"html_url":"https://github.com/green-api/v2-docs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/green-api/v2-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/green-api%2Fv2-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/green-api%2Fv2-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/green-api%2Fv2-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/green-api%2Fv2-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/green-api","download_url":"https://codeload.github.com/green-api/v2-docs/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/green-api%2Fv2-docs/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":270296564,"owners_count":24560364,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-13T02:00:09.904Z","response_time":66,"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":[],"created_at":"2024-11-29T03:27:18.142Z","updated_at":"2025-08-13T19:16:43.524Z","avatar_url":"https://github.com/green-api.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# Техническая документация v2\n\nСодержание:\n\n* [Методы получения уведомлений](#01)\n* [Отладка получения уведомлений](#02)\n\n## Методы получения уведомлений {#01}\n\n### `receiveNotification`\n\nМетод выполняет получение очередного уведомления из очереди.\n\nМетод ожидает в течение 20 сек получения нового уведомления. Если в течение 20 сек новых уведомлений не поступает, то метод завершается с кодом 200 (ОК).\nЕсли в течение 20 сек в пуле появляется уведомление, то вызов метода завершается сразу же, без ожидания.\n\nПосле успешной обработки уведомления требуется вызывать метод `deleteNotification`, чтобы подтвердить обработку уведомления и перейти к следующему уведомлению.\n\n```\nGET {{host}}/waInstance{{idInstance}}/receiveNotification/{{apiTokenInstance}}\n```\n\nПараметры:\n\n - нет\n\nПример запроса:\n\n```\nGET https://api.green-api.com/waInstance33012345/receiveNotification/e8dc45b249b606615485432f5bb5e29166a7502e7e5ecfeb12\n```\n\nПример ответа:\n\n```json\n{\n    \"receiptId\": 488645,\n    \"body\": {\n        \"typeWebhook\": \"outgoingMessageReceived\",\n        \"instanceData\": {\n            \"idInstance\": 33012345,\n            \"wid\": \"79001234567@c.us\",\n            \"typeInstance\": \"whatsapp\"\n        },\n        \"timestamp\": 1588091580,\n        \"idMessage\": \"F7AEC1B7086ECDC7E6E45923F5EDB825\",\n        \"senderData\": {\n            \"chatId\": \"79001234568@c.us\",\n            \"sender\": \"79001234568@c.us\",\n            \"senderName\": \"Green API\"\n        },\n        \"messageData\": {\n            \"typeMessage\": \"textMessage\",\n            \"textMessageData\": {\n                \"textMessage\": \"I use Green-API to send this message to you!\"\n            }\n        }\n    }\n}\n```\n\n- receiptId - число - номер квитанции для последующего удаления уведомления методом deleteNotification\n- typeWebhook - тип уведомления; для сообщений на отправку значение outgoingMessageReceived\n- instanceData - данные об аккаунте; можно игнорировать\n- idMessage - идентификатор сообщения; по данному идентификатору ожидаем получать статусы отправлено/доставлено/прочитано/нет воцап/ошибка\n- senderData - данные об отправителе; можно игнорировать\n- messageData - полезные данные для отправки сообщения\n- messageData.typeMessage - тип сообщения (текст, видео, файл, картинка, звук, голос, контакт, геолокация и пр);\n- messageData.textMessageData.textMessage - текст сообщения\n\n### `deleteNotification`\n\nМетод выполняет удаление уведомления из очереди. Вызов метода подтверждает успешную обработку уведомления.\n\n```\nDELETE {{host}}/waInstance{{idInstance}}/deleteNotification/{{apiTokenInstance}}/{{receiptId}}\n```\n\nПараметры:\n\n- receiptId - число - номер квитанции, полученный методом `receiveNotification`\n\nПример запроса:\n\n```\nDELETE https://api.green-api.com/waInstance33012345/deleteNotification/e8dc45b249b606615485432f5bb5e29166a7502e7e5ecfeb12/488645\n```\n\nПример ответа:\n\n```json\n{\n    \"result\": true\n}\n```\n\n- result - булево - удалось или нет удалить уведомление из очереди\n\n\n## Отладка получения уведомлений {#02}\n\nДля публикации уведомления в очередь требуется отправить POST запрос на адрес `https://webhook.green-api.com`. Далее это уведомление можно будет получить из очереди методом `receiveNotification` в порядке FIFO.\n\nТело запроса:\n\n```json\n{\n    \"typeWebhook\": \"outgoingMessageReceived\",\n    \"instanceData\": {\n        \"idInstance\": 33012345,\n        \"wid\": \"79001234567@c.us\",\n        \"typeInstance\": \"whatsapp\"\n    },\n    \"timestamp\": 1588091580,\n    \"idMessage\": \"F7AEC1B7086ECDC7E6E45923F5EDB825\",\n    \"senderData\": {\n        \"chatId\": \"79001234568@c.us\",\n        \"sender\": \"79001234568@c.us\",\n        \"senderName\": \"Green API\"\n    },\n    \"messageData\": {\n        \"typeMessage\": \"textMessage\",\n        \"textMessageData\": {\n            \"textMessage\": \"I use Green-API to send this message to you!\"\n        }\n    }\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgreen-api%2Fv2-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgreen-api%2Fv2-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgreen-api%2Fv2-docs/lists"}