> ## Documentation Index
> Fetch the complete documentation index at: https://gowa-docs.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Справочник по API

> Базовый URL, аутентификация, выбор устройств, форматы запросов и обозначение ответа для GOWA REST API.

## Базовый URL

```text theme={null}
http://<host>:3000<APP_BASE_PATH>
```

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

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

Если задан `APP_BASIC_AUTH`, все маршруты требуют HTTP Basic Auth, кроме `/health`, `/statics/*`, вебхука Chatwoot и эндпоинтов MCP OAuth. См. [Аутентификация](https://gowa-docs.mintlify.site/ru/api-reference/authentication.md).

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

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

| Устройство с прицепом | Не прикреплено к устройству |
| - | - |
| `/app/*` (кроме `/app/info` и `/app/metrics`), `/send/*`, `/message/*`, `/chat/*`, `/chats`, `/user/*`, `/group/*`, `/newsletter/*`, `/call/*` | `/devices*`, `/app/info`, `/app/metrics`, `/health`, `/mcp`, `/chatwoot/*` |

См. [Работа с несколькими устройствами](https://gowa-docs.mintlify.site/ru/concepts/multidevice.md).

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

| Группа | Цель |
| - | - |
| Устройства | Создание, список, логин, выход и удаление слотов устройств; веб-хуки для устройств и настройки Chatwoot. |
| Приложение | Логин (QR, код соединения, ключ доступа), выход, переподключение, статус, информация о сервере и процесс, память, диск и показатели устройства. |
| Отправить | Текст, средства массовой информации, контакты, местонахождение, ссылка, опрос, присутствие; планирование; немедленные экспериментальные интерактивные сообщения. |
| Сообщение | Реакция, редактирование, отзыв, удаление, чтение, звезда, пересылка, загрузка медиафайлов. |
| Чат | Список чатов и сообщений; прикреплять, архивировать, исчезающий таймер, запрос истории. |
| Пользователь | Информация о профиле, аватар, push-имя, конфиденциальность, контакты, группы, проверка номера. |
| Группа | Создание, участники, администраторы, запросы на регистрацию, настройки, пригласительные ссылки. |
| Рассылка | Отслеживайте информацию, информацию о каналах, директорию, сообщения, счетчики, актуальные обновления и загрузку медиафайлов. |
| Звонок | Отклонить входящие звонки. |

Страницы конечной точки в этой вкладке генерируются из спецификации GOWA OpenAPI. Авторитетный контракт [`docs/openapi.yaml`](https://github.com/aldinokemal/go-whatsapp-web-multidevice/blob/main/docs/openapi.yaml) в репозитории сервера. Этот сайт использует синхронизированную копию в `openapi.yml`, включая `/send/interactive`. [интерактивный гид](https://gowa-docs.mintlify.site/ru/examples/interactive-messages.md) записывает ее текущие лимиты.

## Запросы

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

## Ответы

```json theme={null}
{
  "code": "SUCCESS",
  "message": "Success",
  "results": {}
}
```

`code` — `SUCCESS` или код ошибки; `results` содержит данные. См. [Errors](https://gowa-docs.mintlify.site/ru/api-reference/errors.md).

## Пример

```bash theme={null}
curl -u admin:changeme -X POST http://localhost:3000/send/message \
  -H "Content-Type: application/json" \
  -H "X-Device-Id: my-device" \
  -d '{"phone": "628123456789", "message": "Hello from GOWA"}'
```

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

`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`.

```bash theme={null}
curl -u admin:changeme -H "X-Device-Id: my-device" \
  http://localhost:3000/user/my/contacts/detailed
```

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

* **[WebSocket](https://gowa-docs.mintlify.site/ru/api-reference/websocket.md)** в `/ws` для событий в приборной панели.
* **MCP** на `/mcp` для AI агентов ([MCP сервер](https://gowa-docs.mintlify.site/ru/integrations/mcp.md)).
* **Webhooks** оттолкнул к вашим URL-адресам ([Webhooks](https://gowa-docs.mintlify.site/ru/concepts/webhooks.md)).


## Related topics

- [Быстрый старт](https://gowa-docs.mintlify.site/ru/quickstart.md)
- [Аутентификация API](https://gowa-docs.mintlify.site/ru/api-reference/authentication.md)
- [Присоединиться к группе по ссылке](https://gowa-docs.mintlify.site/ru/api-reference/group/присоединиться-к-группе-по-ссылке.md)
- [Получить информацию о группе по ссылке приглашения](https://gowa-docs.mintlify.site/ru/api-reference/group/получить-информацию-о-группе-по-ссылке-приглашения.md)
- [Просмотр или поиск по публичному каталогу каналов](https://gowa-docs.mintlify.site/ru/api-reference/newsletter/просмотр-или-поиск-по-публичному-каталогу-каналов.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.