Разработчики

Более понятная документация для разработчиков с первого дня

Чистый Base URL, auth header, готовые примеры, webhooks и коды ошибок в организованном опыте.

cURL PHP Laravel WordPress Node Axios Python Flutter Kotlin Java C# Go Ruby

      
cURL • PHP • Laravel • Node • Axios • Python • Flutter • Kotlin • Java • C# • Go • Ruby
1Скопируйте Base URL и Access Token

Быстро начните с этой же страницы, не переходя по разным разделам платформы.

2Проверьте OTP или транзакционное SMS

Выберите нужный сценарий и выполните первый запрос через cURL или готовые сниппеты.

3Подключите свой webhook

Получайте в своей системе callbacks sent, delivered и failed с повторными попытками и видимым журналом.

4Отслеживайте выполнение из дашборда

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

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

Start integration through three clear tracks

  • Создайте Access Token в панели клиента.
  • Свяжите Android Relay и убедитесь, что он отображается онлайн.
  • Отправьте первый вызов Send OTP или Send SMS, затем отслеживайте статус и webhooks.
Request basics
  • Base URL https://sms.yebrax.com/api
  • Auth Header Bearer YOUR_ACCESS_TOKEN
  • Content-Type application/json
  • Relay Mode auto или manual в зависимости от вашей настройки
Health & launch endpoints

Lightweight checks before go-live

Используйте два быстрых endpoint во время разработки или CI, чтобы убедиться, что сервис работает, а аккаунт готов к реальному трафику.

GET /v1/healthОбщая проверка работоспособности без токена
GET /v1/launch/readinessВозвращает отчёт о готовности аккаунта к запуску и требует account.read
POST /v1/relay/app/pairСвяжите приложение через Pairing Code или QR payload.
Примеры ответов
message.accepted
{
  "ok": true,
  "request_id": "req_01H...",
  "status": "queued",
  "queued_at": "2026-03-14T12:30:00Z"
}
otp.sent
{
  "ok": true,
  "otp_id": "otp_01H...",
  "status": "sent",
  "expires_in_seconds": 300
}
message.status
{
  "ok": true,
  "request_id": "req_01H...",
  "status": "delivered",
  "device_name": "Relay Device 1",
  "attempts": 1
}
Быстрые руководства
OpenAPI

Используйте файл OpenAPI и коллекцию Postman, чтобы согласовать работу разработчиков и операционной команды.

Webhook Retry

Важные ошибки должны возвращаться в вашу систему через webhooks и понятный журнал повторов.

Go Live

Проверьте health, readiness и привязку приложения перед первым production-запуском.

Справочник endpoints

Clear cards instead of scattered docs

API

POST /api/v1/sms/send

Отправляйте транзакционное SMS через очередь с маршрутизацией по устройству и отслеживанием статуса.

API

POST /v1/otp/send

Отправляйте OTP с назначением, локалью и понятным сроком действия.

API

POST /v1/otp/verify

Проверяйте код и явно возвращайте success/failed/expired.

API

GET /v1/messages/status

Читайте статус сообщения, попытки и причины ошибок по request_id.

API

GET /v1/recipients

Просматривайте сохранённый справочник получателей и ищите по имени или номеру.

API

POST /v1/recipient-lists/queue

Ставьте весь список в очередь: каждый номер станет отдельным элементом.

Webhook события
  • message.sent Успешно отправлено через Relay.
  • message.failed Доставка не удалась по указанной причине.
  • otp.verified Проверка OTP прошла успешно.
  • device.offline Устройство ушло офлайн.
Коды ошибок

unauthorized

API-ключ или заголовок авторизации недействителен.

invalid_device

Устройство недоступно или не подходит для маршрутизации.

rate_limited

Превышены лимиты отправки или пороги безопасности.

queue_blocked

Отправка временно заблокирована из-за состояния очереди или политик.

subscription_expired

Подписка истекла и требует продления.

What kinds of apps fit this integration best?+

It fits login systems, stores, bookings, invoices, and operational alerts that need OTP or event-driven messaging, not mass marketing campaigns.

Do you provide examples in multiple languages?+

Yes. Ready-to-copy examples include cURL, PHP, Laravel, Node, Axios, Python, Flutter, Kotlin, Java, C#, Go, and Ruby.

Can I use it only for OTP?+

Yes. You can rely only on Send OTP and Verify OTP if your project needs verification without other messaging flows.

Does the Android device need to stay online?+

The device should preferably stay online with permissions and foreground service enabled so sending and status heartbeat continue normally.

Where should I start in practice?+

Start by creating the account, pairing the Android Relay, taking an access token, then running your first request from the ready examples before moving to webhooks and production.

After the docs

Move to pricing, create the account, or ask for quick support

Once the integration picture is clear, the next step is account setup, pricing, or a direct message to the team for a faster rollout.

WhatsApp WhatsApp