توسعه‌دهندگان

مستندات شفاف‌تر برای توسعه‌دهندگان از روز اول

Base URL روشن، auth header، نمونه‌های آماده، وب‌هوک‌ها و کدهای خطا در تجربه‌ای منظم.

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 یا SMS تراکنشی را آزمایش کنید

سناریوی مناسب را انتخاب کنید و اولین درخواست را با cURL یا کدهای آماده اجرا کنید.

3Webhook خود را متصل کنید

رویدادهای sent، delivered و failed را با retries و لاگ شفاف تلاش‌ها داخل سیستم خود دریافت کنید.

4اجرای کار را از داشبورد دنبال کنید

دستگاه‌ها، سلامت صف و وضعیت پیام را بدون ترک همین تجربه دنبال کنید.

شروع سریع

Start integration through three clear tracks

  • از پنل مشتری یک Access Token بسازید.
  • Android Relay را جفت کنید و مطمئن شوید آنلاین دیده می‌شود.
  • اولین درخواست Send OTP یا Send SMS را بفرستید و سپس 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

در زمان توسعه یا CI از دو endpoint سریع استفاده کنید تا مطمئن شوید سرویس فعال است و حساب برای ترافیک واقعی آماده است.

GET /v1/healthبررسی عمومی سلامت بدون توکن
GET /v1/launch/readinessگزارش آمادگی راه‌اندازی حساب را برمی‌گرداند و به account.read نیاز دارد
POST /v1/relay/app/pairاپلیکیشن را از طریق Pairing Code یا payload کد QR جفت کنید.
نمونه پاسخ‌ها
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

از فایل OpenAPI و مجموعه Postman استفاده کنید تا کار توسعه‌دهنده و تیم عملیاتی هماهنگ بماند.

Webhook Retry

خطاهای مهم باید از طریق webhooks و لاگ روشن تلاش مجدد به سیستم شما برگردند.

Go Live

پیش از اولین راه‌اندازی production، health و readiness و جفت‌سازی برنامه را تست کنید.

مرجع endpointها

Clear cards instead of scattered docs

API

POST /api/v1/sms/send

یک 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

یک فهرست کامل را در صف قرار دهید؛ هر شماره یک مورد جداگانه می‌شود.

رویدادهای وب‌هوک
  • message.sent با موفقیت از Relay ارسال شد.
  • message.failed ارسال با ذکر دلیل ناموفق شد.
  • otp.verified تأیید OTP با موفقیت انجام شد.
  • device.offline دستگاه آفلاین شد.
کدهای خطا

unauthorized

کلید API یا هدر احراز هویت نامعتبر است.

invalid_device

دستگاه در دسترس نیست یا برای مسیریابی معتبر نیست.

rate_limited

محدودیت‌های ارسال یا آستانه‌های ایمنی رد شده‌اند.

queue_blocked

ارسال به‌طور موقت به‌دلیل وضعیت صف یا سیاست‌ها مسدود شده است.

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