YCloud API

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

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

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

https://api.ycloud.com/v2

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

curl https://api.ycloud.com/v2/balance \
  --header "X-API-Key: $YCLOUD_API_KEY" \
  --header "Accept: application/json"

Быстрый старт

Настройте API-ключ и выполните первый аутентифицированный запрос.

Аутентификация

Безопасно сохраняйте и используйте ваш API-ключ YCloud.

Вебхуки

Получайте обновления статусов сообщений и входящие сообщения.

Руководства

Изучите практические руководства по распространенным сценариям интеграции.

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

Возможности WhatsApp

Отправляйте шаблоны, текст, медиафайлы, интерактивные сообщения и многое другое.

SMS и голосовые сообщения

Отправляйте SMS по всему миру и автоматизированные голосовые коды.

Email

Отправляйте HTML- или текстовые письма с активированного домена.

Платформа WhatsApp

Управляйте WABA, номерами телефонов, шаблонами, Flows, медиафайлами и звонками.

Данные клиентов

Управляйте контактами, пользовательскими событиями и отписками по каналам.

Запрос

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

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.

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

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

Руководство по WhatsApp

Узнайте о диалоговых окнах сообщений, режимах отправки, полях запроса и статусах доставки.

Эндпоинт WhatsApp

Изучите полную схему запроса и ответа для прямой отправки.

Руководство по SMS

Узнайте, как работают SMS-запросы и обновления статусов доставки.

Эндпоинт SMS

Изучите полную схему запроса и ответа для SMS.

Начало работы

Руководства

Конечные точки

Webhooks

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

Быстрый старт

Аутентификация

Вебхуки

Руководства

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

Возможности WhatsApp

SMS и голосовые сообщения

Email

Платформа WhatsApp

Данные клиентов

Запрос

Ответ

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

Руководство по WhatsApp

Эндпоинт WhatsApp

Руководство по SMS

Эндпоинт SMS

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

Быстрый старт

Аутентификация

Вебхуки

Руководства

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

Возможности WhatsApp

SMS и голосовые сообщения

Email

Платформа WhatsApp

Данные клиентов

​Запрос

​Ответ

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

Руководство по WhatsApp

Эндпоинт WhatsApp

Руководство по SMS

Эндпоинт SMS

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

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

Запрос

Ответ

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