Developers

पहिलो दिनदेखि अझ स्पष्ट developer docs

सफा Base URL, auth header, ready examples, 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 तपाईंको setup अनुसार auto वा manual
Health & launch endpoints

Lightweight checks before go-live

development वा CI का बेला दुईवटा छिटा endpoints प्रयोग गरी service चलिरहेको र account वास्तविक traffic का लागि तयार भएको पुष्टि गर्नुहोस्।

GET /v1/healthtoken बिना सामान्य health check
GET /v1/launch/readinessaccount launch-readiness रिपोर्ट फर्काउँछ र account.read चाहिन्छ
POST /v1/relay/app/pairPairing Code वा QR payload मार्फत app pair गर्नुहोस्।
Sample 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
}
Quick guides
OpenAPI

developer र operations टोलीलाई एउटै दिशामा राख्न OpenAPI file र Postman collection प्रयोग गर्नुहोस्।

Webhook Retry

महत्त्वपूर्ण failures 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

queue मार्फत device routing र status tracking सहित transactional SMS पठाउनुहोस्।

API

POST /v1/otp/send

purpose, locale र स्पष्ट expiry सहित OTP पठाउनुहोस्।

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

सहेजिएको recipient 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

सदस्यता समाप्त भएको छ र नवीकरण चाहिन्छ।

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