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

# Управление аккаунтами WhatsApp Business

> Получайте список подключенных аккаунтов WhatsApp Business и проверяйте их рабочий статус.

## Что это такое

Аккаунт WhatsApp Business (WABA) содержит телефонные номера, шаблоны и
настройки обмена сообщениями, используемые бизнесом. Используйте эти API для поиска
аккаунтов WABA, подключенных к вашему аккаунту YCloud, и проверки готовности каждого аккаунта
к отправке сообщений в рабочей среде.

## Перед началом работы

* Подключите или зарегистрируйте WABA в YCloud.
* Обеспечьте безопасное хранение вашего API-ключа YCloud.
* Определите, требуются ли вам все подключенные аккаунты или один конкретный WABA ID.

## Как это работает

1. Получите список WABA, чтобы узнать их ID.
2. Получите данные конкретного WABA, когда вам требуется его текущий статус бизнеса, верификации, оплаты,
   ограничений или лимитов на отправку сообщений.
3. Сохраняйте WABA ID вместе с относящимися к нему телефонными номерами и шаблонами.

Этот API предназначен только для чтения. Подключение аккаунта и устранение проблем могут потребовать действий в
YCloud или Meta Business Manager.

## Запрос

### Получить список WABA

`GET /whatsapp/businessAccounts`

```bash theme={"theme":{"light":"github-light","dark":"github-dark"}}
curl "https://api.ycloud.com/v2/whatsapp/businessAccounts?page=1&limit=20&includeTotal=true" \
  --header "X-API-Key: $YCLOUD_API_KEY"
```

Используйте `filter.accountReviewStatus`, когда вам нужны аккаунты в определенном статусе
проверки.

### Получить один WABA

`GET /whatsapp/businessAccounts/{id}`

```bash theme={"theme":{"light":"github-light","dark":"github-dark"}}
curl https://api.ycloud.com/v2/whatsapp/businessAccounts/WABA_ID \
  --header "X-API-Key: $YCLOUD_API_KEY"
```

## Ответ

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
  "id": "WABA_ID",
  "name": "Example Business",
  "currency": "USD",
  "accountReviewStatus": "APPROVED",
  "businessVerificationStatus": "verified",
  "paymentMethodAttached": true,
  "primaryBusinessLocation": "US",
  "whatsappBusinessManagerMessagingLimit": "TIER_2K"
}
```

| Поле | Описание |
| - | - |
| `id` | Идентификатор WABA ID, используемый в API телефонных номеров, шаблонов и Flow. |
| `accountReviewStatus` | Текущий статус проверки аккаунта WhatsApp. |
| `businessVerificationStatus` | Статус верификации компании в Meta. |
| `paymentMethodAttached` | Привязан ли к аккаунту способ оплаты. |
| `restrictions` | Активные ограничения и время их окончания, если они есть. |
| `whatsappBusinessManagerMessagingLimit` | Текущий лимит на отправку сообщений на уровне компании. |

## Лимиты на регистрацию телефонных номеров

Эндпоинты получения списка и отдельного аккаунта не возвращают историю значений для
`maxPhoneNumbersPerBusiness` или `maxPhoneNumbersPerWaba`. Подпишитесь на
`whatsapp.business_account.updated` и обрабатывайте
`updateEvent=BUSINESS_CAPABILITY_UPDATE`, чтобы получать значения, которые Meta включает
в каждое обновление.

В настоящее время Meta передает эти два поля в отдельных обновлениях. Не рассматривайте
их как взаимоисключающие: обрабатывайте каждое поле независимо и принимайте оба, если
в будущем обновлении они будут переданы вместе. Значение `0` является допустимым. Сохраняйте эти
значения в своей системе, если вам требуется история или последнее известное состояние.

## Готовность аккаунта

Не рассматривайте успешный ответ на запрос как гарантию того, что каждый номер телефона может отправлять сообщения.
Проверяйте статус WABA в совокупности со статусом регистрации выбранного номера телефона,
состоянием шаблонов, доступом к продуктам и лимитами на отправку сообщений.

## Лимиты и устранение неполадок

* Если WABA не найден, обычно это означает, что он не подключен к текущему аккаунту
  YCloud или указан неверный ID.
* Статусы проверки, верификации, ограничений и оплаты контролируются Meta
  и могут изменяться асинхронно.
* Кэшируйте стабильные идентификаторы, но запрашивайте актуальный статус перед диагностикой
  проблем с подключением или отправкой сообщений.

<CardGroup cols={2}>
  <Card title="Получить список WABA" icon="list" href="/api-reference/whatsapp-business-accounts/list-wabas">
    Ознакомьтесь с пагинацией, фильтрами и полной схемой страницы.
  </Card>

  <Card title="Получить WABA" icon="code" href="/api-reference/whatsapp-business-accounts/retrieve-a-waba">
    Ознакомьтесь со всеми полями статуса аккаунта и ограничений.
  </Card>
</CardGroup>


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