Developers

له لومړۍ ورځې لا روښانه developer docs

روښانه Base URL، auth header، چمتو مثالونه، webhooks او 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 او Access Token کاپي کړئ

د پلاتفورم په بېلابېلو برخو کې له لټون پرته له همدې پاڼې ژر پیل وکړئ.

2OTP یا transactional SMS وازمویئ

سم سناریو وټاکئ او لومړی request د cURL یا چمتو snippets له لارې وچلوئ.

3خپل webhook ونښلوئ

په خپل سیسټم کې sent، delivered او failed callbacks د retries او ښکاره log سره ترلاسه کړئ.

4اجرا له dashboard څخه تعقیب کړئ

د همدې تجربې پرېښودو پرته devices، queue health او message state وګورئ.

چټک پیل

Start integration through three clear tracks

  • د client panel څخه Access Token جوړ کړئ.
  • Android Relay pair کړئ او ډاډ ترلاسه کړئ چې online ښکاري.
  • لومړی Send OTP یا Send SMS call واستوئ، بیا status او webhooks تعقیب کړئ.
Request basics
  • Base URL https://sms.yebrax.com/api
  • Auth Header Bearer YOUR_ACCESS_TOKEN
  • Content-Type application/json
  • Relay Mode ستاسې د setup له مخې auto یا manual
Health & launch endpoints

Lightweight checks before go-live

د development یا CI پر مهال دوه چټک endpoints وکاروئ څو ډاډ ترلاسه شي چې service فعاله ده او account د واقعي traffic لپاره چمتو دی.

GET /v1/healthله token پرته عمومي health check
GET /v1/launch/readinessد account launch-readiness راپور بېرته ورکوي او account.read ته اړتیا لري
POST /v1/relay/app/pairاپ د Pairing Code یا QR payload له لارې pair کړئ.
نمونه responses
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

د developer او operations ټیم د همغږۍ لپاره OpenAPI فایل او Postman collection وکاروئ.

Webhook Retry

مهمې ناکامۍ باید د webhooks او روښانه retry log له لارې ستاسې سیسټم ته راستانه شي.

Go Live

د لومړي production launch څخه مخکې health، readiness او app pairing وازمویئ.

Endpoint reference

Clear cards instead of scattered docs

API

POST /api/v1/sms/send

د device routing او status tracking سره د queue له لارې transactional SMS واستوئ.

API

POST /v1/otp/send

OTP د purpose، locale او روښانه پای وخت سره واستوئ.

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

بشپړ لست queue ته واستوئ؛ هر شمېره به جلا queue item شي.

Webhook events
  • message.sent له Relay څخه په بریالیتوب ولېږل شو.
  • message.failed لېږد د دلیل سره ناکام شو.
  • otp.verified د OTP تایید بریالی شو.
  • device.offline وسیله offline شوه.
Error codes

unauthorized

API key یا auth header ناسم دی.

invalid_device

وسیله شتون نه لري یا د routing لپاره سم نه دی.

rate_limited

د لېږلو حدود یا د خوندیتوب حدونه اوښتي دي.

queue_blocked

لېږل د queue حالت یا پالیسیو له امله لنډمهاله بند دي.

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 واټس‌اپ