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

# YCloud API

> Создавайте рабочие процессы для отправки сообщений, верификации, работы с контактами и событиями с помощью YCloud API.

YCloud предоставляет единый API для клиентских коммуникаций и сценариев взаимодействия. Вы можете отправлять сообщения WhatsApp, SMS, email и голосовые сообщения. Также вы можете верифицировать пользователей, управлять контактами, отслеживать пользовательские события и получать обновления статусов через вебхуки.

## Как работают запросы

Все серверные запросы используют следующий базовый URL:

```text theme={"theme":{"light":"github-light","dark":"github-dark"}}
https://api.ycloud.com/v2
```

Аутентифицируйте запросы с помощью API-ключа в заголовке `X-API-Key`. Храните ключ на сервере и никогда не передавайте его в коде браузера или мобильного приложения.

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

<CardGroup cols={2}>
  <Card title="Быстрый старт" icon="rocket" href="/ru/api-reference/getting-started/quickstart">
    Настройте API-ключ и выполните первый аутентифицированный запрос.
  </Card>

  <Card title="Аутентификация" icon="key" href="/ru/api-reference/guides/api-fundamentals/authentication">
    Безопасно сохраняйте и используйте ваш API-ключ YCloud.
  </Card>

  <Card title="Вебхуки" icon="webhook" href="/ru/api-reference/guides/api-fundamentals/configure-webhooks">
    Получайте обновления статусов сообщений и входящие сообщения.
  </Card>

  <Card title="Руководства" icon="book-open" href="/ru/api-reference/guides/overview">
    Изучите практические руководства по распространенным сценариям интеграции.
  </Card>
</CardGroup>

## Что можно создать

<CardGroup cols={2}>
  <Card title="Возможности WhatsApp" icon="whatsapp" href="/ru/api-reference/guides/whatsapp-platform/send-whatsapp-message">
    Отправляйте шаблоны, текст, медиафайлы, интерактивные сообщения и многое другое.
  </Card>

  <Card title="SMS и голосовые сообщения" icon="comment-sms" href="/ru/api-reference/guides/messaging/send-sms">
    Отправляйте SMS по всему миру и автоматизированные голосовые коды.
  </Card>

  <Card title="Email" icon="envelope" href="/ru/api-reference/guides/messaging/send-email">
    Отправляйте HTML- или текстовые письма с активированного домена.
  </Card>

  <Card title="Платформа WhatsApp" icon="building" href="/ru/api-reference/guides/whatsapp-platform/manage-whatsapp-business-accounts">
    Управляйте WABA, номерами телефонов, шаблонами, Flows, медиафайлами и звонками.
  </Card>

  <Card title="Данные клиентов" icon="address-card" href="/ru/api-reference/guides/customer-data-and-operations/manage-contacts">
    Управляйте контактами, пользовательскими событиями и отписками по каналам.
  </Card>
</CardGroup>

## Запрос

Отправляйте тело запроса в формате JSON с `Content-Type: application/json`. Параметры пути и строки запроса описаны на странице каждого эндпоинта.

```bash theme={"theme":{"light":"github-light","dark":"github-dark"}}
curl --request POST https://api.ycloud.com/v2/sms \
  --header "X-API-Key: $YCLOUD_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
    "to": "+16315551234",
    "text": "Your order has shipped."
  }'
```

Используйте Справочник API, если вам нужна полная схема запроса, значения перечислений (enum) или интерактивный конструктор запросов.

## Ответ

Успешные ответы возвращаются в формате JSON. Ответ на создание или отправку подтверждает, что YCloud принял запрос. Это не всегда означает окончательную доставку или выполнение. Сохраняйте возвращенный идентификатор ресурса и сопоставляйте его с результатами запросов или событиями вебхуков.

Ошибки содержат машиночитаемый `code`, понятный разработчику `message` и `requestId`, который вы можете передать в службу поддержки YCloud.

<Note>
  Для некоторых продуктов перед отправкой сообщений требуется активация аккаунта, подтвержденный отправитель или подключенный WhatsApp Business Account.
</Note>

## От руководства к справочнику API

<CardGroup cols={2}>
  <Card title="Руководство по WhatsApp" icon="whatsapp" href="/ru/api-reference/guides/whatsapp-platform/send-whatsapp-message">
    Узнайте о диалоговых окнах сообщений, режимах отправки, полях запроса и статусах доставки.
  </Card>

  <Card title="Эндпоинт WhatsApp" icon="code" href="/api-reference/whatsapp-messages/send-a-message-directly">
    Изучите полную схему запроса и ответа для прямой отправки.
  </Card>

  <Card title="Руководство по SMS" icon="comment-sms" href="/ru/api-reference/guides/messaging/send-sms">
    Узнайте, как работают SMS-запросы и обновления статусов доставки.
  </Card>

  <Card title="Эндпоинт SMS" icon="code" href="/api-reference/sms/send-an-sms">
    Изучите полную схему запроса и ответа для SMS.
  </Card>
</CardGroup>


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