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

# WhatsApp каналы

> Находите и читайте рассылки, загружайте каналы массовой информации и получайте обновления об активном взаимодействии.

GOWA называет каналы WhatsApp **информационными письмами** в своем API. Все запросы на этой странице используют базовую аутентификацию и подключенное устройство, выбранное `X-Device-Id`. ID канала заканчивается в `@newsletter`; номер контакта или группы JID не является идентификатором канала.

Установите URL сервера и учетные данные перед запуском примера curl. Используйте публичный URL-адрес HTTPS для удаленного сервера и включите `APP_BASE_PATH` при настройке.

```bash theme={null}
export GOWA_URL=http://localhost:3000
export GOWA_USER=admin
export GOWA_PASSWORD=replace-with-your-password
export DEVICE_ID=my-device
```

## Найти канал

Посмотрите метаданные канала по ссылке `newsletter_id` или `invite`. Посылайте ровно один. Приглашение может быть полным `https://whatsapp.com/channel/...` или его кодом.

```bash theme={null}
curl --user "$GOWA_USER:$GOWA_PASSWORD" --get \
  -H "X-Device-Id: $DEVICE_ID" \
  --data-urlencode 'invite=https://whatsapp.com/channel/0029Va4K0PZ5a245NkngBA2M' \
  "$GOWA_URL/newsletter/info"
```

`results` содержит метаданные канала, включая его ID, метаданные потока и метаданные просмотра. Поиск приглашений поддерживает публичные метаданные без следования за каналом. Поиск JID зависит от доступа выбранного аккаунта к каналу. `viewer_metadata` может быть `null`, если WhatsApp предоставляет только публичные метаданные.

Для просмотра каталога укажите по крайней мере один код страны. Для поиска по имени используйте `search_text`.

```bash theme={null}
curl --user "$GOWA_USER:$GOWA_PASSWORD" --get \
  -H "X-Device-Id: $DEVICE_ID" \
  --data-urlencode 'country_codes=ID' --data-urlencode 'view=TRENDING' \
  --data-urlencode 'limit=20' "$GOWA_URL/newsletter/directory"

curl --user "$GOWA_USER:$GOWA_PASSWORD" --get \
  -H "X-Device-Id: $DEVICE_ID" \
  --data-urlencode 'search_text=news' "$GOWA_URL/newsletter/directory"
```

| Запрос | Поведение |
| - | - |
| `view` | `RECOMMENDED` по умолчанию. Также принимает `TRENDING`, `POPULAR`, `NEW` и `FEATURED`. Игнорирует этот выбор. |
| `country_codes` | ISO двухбуквенные коды, повторяющиеся или разделенные запятыми. Требуется для просмотра. Поиск имени не поддерживает фильтрацию стран. |
| `categories` | Значения из списка `BUSINESS`, `ENTERTAINMENT`, `LIFESTYLE`, `NEWS`, `ORGANIZATIONS`, `PEOPLE` и `SPORTS`, переданные повторяющимися параметрами или через запятую. |
| `limit` | Default `20`, range `1`–`50`. |
| `cursor` | Используйте `results.next_cursor` предыдущего ответа, а `results.has_more` - `true`. |

Ответы каталога помещают каналы в `results.data`. Каталог использует недокументированные запросы WhatsApp и может меняться независимо от GOWA.

## Отслеживать или отписаться

```bash theme={null}
curl --user "$GOWA_USER:$GOWA_PASSWORD" \
  -H "X-Device-Id: $DEVICE_ID" -H 'Content-Type: application/json' \
  "$GOWA_URL/newsletter/follow" \
  --data '{"newsletter_id":"120363024512399999@newsletter"}'
```

Используйте такое же тело JSON с именем `POST /newsletter/unfollow`, чтобы отписаться. `GET /user/my/newsletters` отображает рассылку с последующим выбранным аккаунтом.

После канала и подписка на онлайн вовлечение - отдельная операция. Управляйте прямыми подписками через `/newsletter/live-updates`.

## Читать сообщения и счетчики

```bash theme={null}
curl --user "$GOWA_USER:$GOWA_PASSWORD" --get \
  -H "X-Device-Id: $DEVICE_ID" \
  --data-urlencode 'newsletter_id=120363024512399999@newsletter' \
  --data-urlencode 'count=50' "$GOWA_URL/newsletter/messages"
```

`GET /newsletter/messages` читает публикации напрямую из WhatsApp без необходимости подписываться. Доступная история определяется WhatsApp. GOWA не гарантирует определённый срок хранения или полный архив. По умолчанию `count` равен `50` и принимает значения от `1` до `100`. Чтобы загрузить более старые публикации, передайте `server_id` самой старой из полученных публикаций в качестве `before`.

`results.data` содержит записи `server_id`, `message_id`, `type`, `timestamp`, `text`, `views_count`, `forwards_count`, и необязательный `reaction_counts`. Содержимое полей может отсутствовать. WhatsApp отчеты просматривают администраторы каналов; другие аккаунты могут видеть `views_count: 0`.

Используйте числовые `server_id`, а не `message_id`, для пагинации и загрузки медиафайлов.

```bash theme={null}
curl --user "$GOWA_USER:$GOWA_PASSWORD" --get \
  -H "X-Device-Id: $DEVICE_ID" \
  --data-urlencode 'newsletter_id=120363024512399999@newsletter' \
  --data-urlencode 'after=123' --data-urlencode 'count=50' \
  "$GOWA_URL/newsletter/message-updates"
```

`GET /newsletter/message-updates` обновляет счетчики без получения содержимого сообщения. `after` является обязательным и должен быть идентификатором положительного сервера. `count` по умолчанию `50`, максимум `100`. Необязательная `since` - это неотрицательная отметка времени Unix в секундах. Результаты используют те же `results.data`, без полей содержимого, когда WhatsApp не возвращает их.

## Получать обновления в реальном времени

Настройте [webhook](https://gowa-docs.mintlify.site/ru/concepts/webhooks.md), затем подпишите каждое устройство на нужные ему каналы.

```bash theme={null}
curl --user "$GOWA_USER:$GOWA_PASSWORD" \
  -H "X-Device-Id: $DEVICE_ID" -H 'Content-Type: application/json' \
  "$GOWA_URL/newsletter/live-updates" \
  --data '{"newsletter_id":"120363024512399999@newsletter"}'
```

В ответе `results` содержится `newsletter_id`, `duration_seconds`, `expires_at`, `renewed_at`, и необязательный `last_error`. WhatsApp предоставляет короткую подписку, наблюдаемую примерно за 90 секунд. GOWA обновляет ее до истечения срока действия и после переподключения. Счетчик событий поступает в виде вебхуков `newsletter.message`.

Список подписок с `GET /newsletter/live-updates`. Его `results.data` включает в себя те же поля состояния. Проверять `last_error` при сбое обновления.

```bash theme={null}
curl --user "$GOWA_USER:$GOWA_PASSWORD" -X DELETE --get \
  -H "X-Device-Id: $DEVICE_ID" \
  --data-urlencode 'newsletter_id=120363024512399999@newsletter' \
  "$GOWA_URL/newsletter/live-updates"
```

Удаление подписки прекращает продление. WhatsApp может продолжать предоставлять обновления до тех пор, пока не истечет срок действия подписки. Отмена не восстанавливается пересоединением или продлением рейса. Удаление канала без подписки возвращает ошибку подтверждения.

> [!NOTE]
>
> Подписки хранятся в памяти и не перезапускаются сервером. Пересоздайте их после перезапуска GOWA. Статус подписки принадлежит выбранному устройству.

## Скачать канал

```bash theme={null}
curl --user "$GOWA_USER:$GOWA_PASSWORD" --get \
  -H "X-Device-Id: $DEVICE_ID" \
  --data-urlencode 'newsletter_id=120363024512399999@newsletter' \
  "$GOWA_URL/newsletter/messages/123/download"
```

Конечная точка извлекает этот пост непосредственно из WhatsApp и сохраняет поддерживаемый медиа-файл в каталог на сервере. Его JSON `results` содержит `server_id`, `message_id`, `status`, `media_type`, `mime_type`, `filename`, `file_path`, `file_url`, и `file_size`. Обработчик REST предоставляет `file_url` в качестве публичного статического URL для сохраненного файла. Это не двоичный файл ответа. Отсутствует пост или пост без загрузки медиа-файла возвращает ошибку.


## Related topics

- [GOWA: WhatsApp REST API](https://gowa-docs.mintlify.site/ru/index.md)
- [Проверьте, есть ли пользователь в WhatsApp](https://gowa-docs.mintlify.site/ru/api-reference/user/проверьте-есть-ли-пользователь-в-whatsapp.md)
- [Проверка подлинности](https://gowa-docs.mintlify.site/ru/authentication.md)
- [Ссылка на конфигурацию](https://gowa-docs.mintlify.site/ru/configuration.md)
- [Отправка ограничений](https://gowa-docs.mintlify.site/ru/advanced/rate-limiting.md)


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