Перейти к основному содержанию

Базовый URL

По умолчанию http://localhost:3000. С APP_BASE_PATH=/gowa, каждый маршрут перемещается под /gowa за исключением /health.

Проверка подлинности

Если задан APP_BASIC_AUTH, все маршруты требуют HTTP Basic Auth, кроме /health, /statics/*, вебхука Chatwoot и эндпоинтов MCP OAuth. См. Аутентификация.

Выбор устройства

Большинство маршрутов действуют на одном устройстве WhatsApp. Выберите его с помощью заголовка X-Device-Id (slot ID или JID) или параметра device_id запроса. Когда на сервере есть ровно одно устройство, вы можете его опустить; с большим количеством это требуется. См. Работа с несколькими устройствами.

Группы конечных точек

Страницы конечной точки в этой вкладке генерируются из спецификации GOWA OpenAPI. Авторитетный контракт docs/openapi.yaml в репозитории сервера. Этот сайт использует синхронизированную копию в openapi.yml, включая /send/interactive. интерактивный гид записывает ее текущие лимиты.

Запросы

  • JSON отражает: Content-Type: application/json.
  • Загрузка файлов: multipart/form-data.
  • Номера телефонов: цифры с кодом страны (628123456789) или полный JID (...@s.whatsapp.net, ...@g.us).

Ответы

code — SUCCESS или код ошибки; results содержит данные. См. Errors.

Пример

Имена контактов

GET /user/my/contacts возвращает предпочтительное отображаемое имя для каждого контакта. В ветке GOWA main после v9.9.0 вызовите GET /user/my/contacts/detailed, чтобы получить сохранённые full_name, first_name, push_name и business_name как отдельные поля. GOWA пропускает пустые имена и добавляет lid к JID с номером телефона, если на устройстве есть соответствие. Результаты содержат контакты людей с выбранного устройства, отсортированные по jid.

Другие интерфейсы

  • WebSocket в /ws для событий в приборной панели.
  • MCP на /mcp для AI агентов (MCP сервер).
  • Webhooks оттолкнул к вашим URL-адресам (Webhooks).