Developers

Birinchi kundan aniqroq developer docs

Toza Base URL, auth header, tayyor misollar, webhooks va error codes.

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
1Base URL va Access Token ni nusxa oling

Platformaning turli joylarini qidirmasdan shu sahifadan tez boshlang.

2OTP yoki transactional SMS ni sinab ko‘ring

To‘g‘ri scenariyni tanlang va birinchi request ni cURL yoki tayyor snippetlar orqali ishga tushiring.

3Webhook ni ulang

Tizimingizda sent, delivered va failed callbacklarini retries va ko‘rinadigan urinishlar logi bilan qabul qiling.

4Bajarilishni dashboard orqali kuzating

Xuddi shu tajribadan chiqmasdan devices, queue health va message state ni kuzating.

Tez boshlash

Start integration through three clear tracks

  • Client panelidan Access Token yarating.
  • Android Relay ni ulab, online ko‘rinayotganini tasdiqlang.
  • Birinchi Send OTP yoki Send SMS call ni yuboring, so‘ng status va webhooklarni kuzating.
Request basics
  • Base URL https://sms.yebrax.com/api
  • Auth Header Bearer YOUR_ACCESS_TOKEN
  • Content-Type application/json
  • Relay Mode Sozlamangizga qarab auto yoki manual
Health & launch endpoints

Lightweight checks before go-live

Development yoki CI vaqtida service ishlayotganini va account real traffic uchun tayyorligini tekshirish uchun ikki tezkor endpointdan foydalaning.

GET /v1/healthTokensiz umumiy health check
GET /v1/launch/readinessAccount launch-readiness hisobotini qaytaradi va account.read talab qiladi
POST /v1/relay/app/pairIlovani Pairing Code yoki QR payload orqali ulang.
Namunaviy javoblar
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
}
Tezkor qo‘llanmalar
OpenAPI

Developer va operations jamoasini moslashtirish uchun OpenAPI fayli va Postman collectiondan foydalaning.

Webhook Retry

Muhim xatolar webhooklar va aniq retry log bilan tizimingizga qaytishi kerak.

Go Live

Birinchi production launchdan oldin health, readiness va app pairing ni sinang.

Endpoint reference

Clear cards instead of scattered docs

API

POST /api/v1/sms/send

queue orqali device routing va status tracking bilan transactional SMS yuboring.

API

POST /v1/otp/send

OTP ni purpose, locale va aniq amal qilish muddati bilan yuboring.

API

POST /v1/otp/verify

Kodni tekshiring va success/failed/expired holatini aniq qaytaring.

API

GET /v1/messages/status

request_id orqali xabar holati, urinishlar va xatolik sabablarini ko‘ring.

API

GET /v1/recipients

Saqlangan qabul qiluvchilar ro‘yxatini ko‘ring va ism yoki raqam bo‘yicha qidiring.

API

POST /v1/recipient-lists/queue

To‘liq ro‘yxatni queue ga yuboring; har bir raqam alohida item bo‘ladi.

Webhook hodisalari
  • message.sent Relay orqali muvaffaqiyatli yuborildi.
  • message.failed Yuborish sabab bilan muvaffaqiyatsiz tugadi.
  • otp.verified OTP tasdiqlash muvaffaqiyatli bo‘ldi.
  • device.offline Qurilma offline bo‘ldi.
Xato kodlari

unauthorized

API key yoki auth header noto‘g‘ri.

invalid_device

Qurilma mavjud emas yoki routing uchun yaroqsiz.

rate_limited

Yuborish limitlari yoki xavfsizlik chegaralari oshib ketdi.

queue_blocked

Yuborish queue holati yoki siyosatlar sabab vaqtincha bloklangan.

subscription_expired

Obuna muddati tugagan va yangilash kerak.

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