ڈیولپرز

پہلے دن سے زیادہ واضح ڈیولپر ڈاکس

منظم تجربے کے اندر صاف 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 آزمائیں

مناسب scenario منتخب کریں پھر پہلا request cURL یا ready snippets کے ذریعے چلائیں۔

3اپنا Webhook منسلک کریں

اپنے سسٹم میں sent، delivered اور failed callbacks retries اور واضح attempt log کے ساتھ وصول کریں۔

4dashboard سے execution کو فالو کریں

اسی تجربے سے نکلے بغیر 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 آپ کی سیٹنگ کے مطابق auto یا manual
Health & launch endpoints

Lightweight checks before go-live

development یا CI کے دوران دو تیز endpoints استعمال کریں تاکہ service چلنے اور account کے real traffic کے لیے تیار ہونے کی تصدیق ہو۔

GET /v1/healthtoken کے بغیر عمومی health check
GET /v1/launch/readinessaccount 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 ٹیم کو aligned رکھنے کے لیے OpenAPI فائل اور Postman collection استعمال کریں۔

Webhook Retry

اہم failures Webhooks اور واضح retry log کے ساتھ آپ کے سسٹم میں واپس آنے چاہئیں۔

Go Live

پہلے production launch سے پہلے health، readiness اور app pairing ٹیسٹ کریں۔

Endpoint حوالہ

Clear cards instead of scattered docs

API

POST /api/v1/sms/send

queue کے ذریعے device routing اور status tracking کے ساتھ transactional SMS بھیجیں۔

API

POST /v1/otp/send

OTP کو purpose، locale اور واضح expiry کے ساتھ بھیجیں۔

API

POST /v1/otp/verify

کوڈ verify کریں اور success/failed/expired واضح طور پر واپس کریں۔

API

GET /v1/messages/status

request_id کے ذریعے message status، attempts اور failure reasons دیکھیں۔

API

GET /v1/recipients

محفوظ recipients directory دیکھیں اور نام یا نمبر سے تلاش کریں۔

API

POST /v1/recipient-lists/queue

مکمل فہرست queue میں ڈالیں، ہر نمبر الگ queue item بن جائے گا۔

Webhook events
  • message.sent Relay سے کامیابی سے بھیج دیا گیا۔
  • message.failed delivery کسی وجہ کے ساتھ ناکام ہوئی۔
  • otp.verified OTP verification کامیاب ہوگئی۔
  • device.offline ڈیوائس offline ہو گیا۔
Error codes

unauthorized

API key یا auth header درست نہیں ہے۔

invalid_device

ڈیوائس دستیاب نہیں یا routing کے لیے درست نہیں۔

rate_limited

sending limits یا safety thresholds تجاوز ہو گئے ہیں۔

queue_blocked

queue state یا policies کی وجہ سے ارسال عارضی طور پر روکا گیا ہے۔

subscription_expired

سبسکرپشن ختم ہو چکا ہے اور renew درکار ہے۔

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 واٹس ایپ