Developers

Nyaraka wazi zaidi za developers tangu siku ya kwanza

Base URL safi, auth header, mifano tayari, webhooks na error codes katika uzoefu uliopangwa.

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
1Nakili Base URL na Access Token

Anza haraka kutoka ukurasa huu bila kutafuta sehemu nyingi kwenye jukwaa.

2Jaribu OTP au transactional SMS

Chagua scenario sahihi kisha endesha request ya kwanza kwa cURL au snippets tayari.

3Unganisha webhook yako

Pokea callbacks za sent, delivered na failed ndani ya mfumo wako pamoja na retries na log inayoonekana.

4Fuatilia utekelezaji kutoka dashboard

Fuatilia devices, afya ya queue na hali ya ujumbe bila kuondoka kwenye uzoefu huo huo.

Mwongozo wa haraka

Start integration through three clear tracks

  • Unda Access Token kutoka paneli ya mteja.
  • Pair Android Relay na uhakikishe inaonekana online.
  • Tuma Send OTP au Send SMS ya kwanza, kisha fuatilia status na webhooks.
Request basics
  • Base URL https://sms.yebrax.com/api
  • Auth Header Bearer YOUR_ACCESS_TOKEN
  • Content-Type application/json
  • Relay Mode auto au manual kulingana na setup yako
Health & launch endpoints

Lightweight checks before go-live

Tumia endpoints mbili za haraka wakati wa development au CI kuthibitisha kuwa service iko hai na account iko tayari kwa traffic halisi.

GET /v1/healthHealth check ya jumla bila token
GET /v1/launch/readinessInarudisha ripoti ya launch-readiness ya account na inahitaji account.read
POST /v1/relay/app/pairPair app kupitia Pairing Code au QR payload.
Majibu ya mfano
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
}
Mwongozo wa haraka
OpenAPI

Tumia faili la OpenAPI na collection ya Postman kuweka developers na operations kwenye mstari mmoja.

Webhook Retry

Failures muhimu zinapaswa kurudi kwenye mfumo wako kupitia webhooks na retry log iliyo wazi.

Go Live

Jaribu health, readiness na app pairing kabla ya launch ya kwanza ya production.

Marejeo ya endpoint

Clear cards instead of scattered docs

API

POST /api/v1/sms/send

Tuma SMS ya miamala kupitia queue ukiwa na device routing na ufuatiliaji wa hali.

API

POST /v1/otp/send

Tuma OTP ikiwa na purpose, locale na muda wa kuisha ulio wazi.

API

POST /v1/otp/verify

Thibitisha msimbo na urudishe success/failed/expired kwa uwazi.

API

GET /v1/messages/status

Soma status ya ujumbe, attempts na sababu za failure kwa request_id.

API

GET /v1/recipients

Soma saraka ya wapokeaji waliohifadhiwa na utafute kwa jina au nambari.

API

POST /v1/recipient-lists/queue

Weka orodha nzima kwenye queue; kila nambari itakuwa item tofauti.

Matukio ya webhook
  • message.sent Imetumwa kwa mafanikio kutoka Relay.
  • message.failed Delivery imeshindwa na sababu imetolewa.
  • otp.verified Uthibitishaji wa OTP umefaulu.
  • device.offline Kifaa kimeenda offline.
Nambari za makosa

unauthorized

API key au auth header si sahihi.

invalid_device

Kifaa hakipatikani au si halali kwa routing.

rate_limited

Sending limits au safety thresholds zimevukwa.

queue_blocked

Utumaji umezuiwa kwa muda na hali ya queue au policies.

subscription_expired

Usajili umeisha na unahitaji kufanywa upya.

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