ডেভেলপারস

প্রথম দিন থেকেই আরও পরিষ্কার ডেভেলপার ডকস

পরিষ্কার 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 বেছে নিয়ে cURL বা ready snippets দিয়ে প্রথম request চালান।

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-তে দুইটি দ্রুত endpoint ব্যবহার করে নিশ্চিত করুন যে service চালু আছে এবং account বাস্তব ট্রাফিকের জন্য প্রস্তুত।

GET /v1/healthtoken ছাড়া সাধারণ health check
GET /v1/launch/readinessaccount launch-readiness রিপোর্ট ফেরত দেয় এবং account.read প্রয়োজন
POST /v1/relay/app/pairPairing Code বা QR payload দিয়ে অ্যাপ pair করুন।
নমুনা response
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

developers এবং 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 এবং পরিষ্কার মেয়াদসহ OTP পাঠান।

API

POST /v1/otp/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

সাবস্ক্রিপশনের মেয়াদ শেষ হয়েছে এবং নবায়ন প্রয়োজন।

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 হোয়াটসঅ্যাপ