Документация API

Green API предоставляет HTTP API WhatsApp для отправки и получения сообщений, файлов, работы с групповыми чатами, получения списка контактов и других методов.

Перед выполнением запросов убедитесь, что выполнены все шаги раздела Перед началом работы. Ознакомьтесь с разделом Выполнение запросов. Для отладки запросов к Green API воспользуйтесь Коллекцией Postman.

Аккаунт

• Получить настройки инстанса
• Установить настройки инстанса
• Получить состояние инстанса
• Перезапустить инстанс
• Разлогинить инстанс
• Получить QR-код
• Получить QR-код через websocket
• Связать по номеру телефона
• Получить информацию об аккаунте WhatsApp

Архив

• Получить состояние сокета инстанса

Отправка

• Отправить текст
• Отправить опрос
• Отправить видео, аудио, изображение, документ
• Отправить видео, аудио, изображение, документ по URL
• Отправить геолокацию
• Отправить контакт
• Переслать сообщения

Архив

• Отправить обычные кнопки
• Отправить шаблонные кнопки
• Отправить список выбора

Получение

Получение уведомлений через HTTP API

• Получить уведомление
• Удалить уведомление

Получение уведомлений через Webhook Endpoint

Формат входящих уведомлений

Входящее сообщение

• Входящее текстовое сообщение
• Выбор обычной кнопки
• Выбор шаблонной кнопки
• Выбор элемента списка
• Входящее текстовое сообщение, сообщение с URL, рекламное сообщение
• Входящее сообщение с изображением, видео, аудио, документом
• Входящее сообщение с геолокацией
• Входящее сообщение с контактом
• Входящее сообщение с массивом контактов
• Входящее сообщение со стикером
• Входящее сообщение-реакция
• Входящее сообщение с приглашением в группу
• Входящее сообщение с опросом
• Входящее сообщение с обновлением опроса

Отправленное сообщение

• Отправленное с телефона сообщение
• Отправленное сообщение через API
• Статус отправленного сообщения

Прочие

• Статус инстанса
• Входящий звонок

Архив

• Статус устройства

Объекты

• Типы входящих уведомлений

Получение файлов

• Скачать файл из входящего сообщения

Журналы

• Получить историю сообщений чата
• Получить сообщение чата
• Получить журнал входящих сообщений
• Получить журнал отправленных сообщений

Очереди

• Получить очередь сообщений к отправке
• Очистить очередь сообщений к отправке

Группы

• Создать группу
• Изменить имя группы
• Получить информацию о группе
• Добавить участника в группу
• Удалить участника из группы
• Назначить права администратора группы
• Отозвать права администратора группы
• Выйти из группы

Статусы (бета-версия)

Статусы

• Отправить текстовый статус
• Отправить голосовой статус
• Отправить медиа статус
• Удалить статус

Статистика

• Получить статистику статуса

История

• Получить входящие статусы
• Получить исходящие статусы

Отметка прочтения

• Отметить чат прочитанным

Сервисные методы

• Проверить наличие WhatsApp
• Получить аватар
• Получить контакты
• Получить информацию о контакте
• Удалить сообщение
• Архивировать чат
• Разархивировать чат
• Изменить настройки исчезающих сообщений чата

Прочее

• Идентификатор чата
• Интервал отправки сообщений
• Стандартные ошибки
• Достижение лимитов на тарифе Разработчик

Рекомендации по интеграции

• Создание и настройка инстанса
• Отслеживание состояния инстанса
• Подключение WhatsApp к Green API
• Работа с входящими звонками
• Использование хостов Green API
• Работа с входящими уведомлениями

Архив

Устройство (телефон)

• Получить информацию об устройстве