بدون جستوجو میان بخشهای مختلف پلتفرم، سریع از همین صفحه شروع کنید.
Base URL روشن، auth header، نمونههای آماده، وبهوکها و کدهای خطا در تجربهای منظم.
بدون جستوجو میان بخشهای مختلف پلتفرم، سریع از همین صفحه شروع کنید.
سناریوی مناسب را انتخاب کنید و اولین درخواست را با cURL یا کدهای آماده اجرا کنید.
رویدادهای sent، delivered و failed را با retries و لاگ شفاف تلاشها داخل سیستم خود دریافت کنید.
دستگاهها، سلامت صف و وضعیت پیام را بدون ترک همین تجربه دنبال کنید.
در زمان توسعه یا CI از دو endpoint سریع استفاده کنید تا مطمئن شوید سرویس فعال است و حساب برای ترافیک واقعی آماده است.
{
"ok": true,
"request_id": "req_01H...",
"status": "queued",
"queued_at": "2026-03-14T12:30:00Z"
}
{
"ok": true,
"otp_id": "otp_01H...",
"status": "sent",
"expires_in_seconds": 300
}
{
"ok": true,
"request_id": "req_01H...",
"status": "delivered",
"device_name": "Relay Device 1",
"attempts": 1
}
از فایل OpenAPI و مجموعه Postman استفاده کنید تا کار توسعهدهنده و تیم عملیاتی هماهنگ بماند.
خطاهای مهم باید از طریق webhooks و لاگ روشن تلاش مجدد به سیستم شما برگردند.
پیش از اولین راهاندازی production، health و readiness و جفتسازی برنامه را تست کنید.
یک SMS تراکنشی را از طریق صف با مسیریابی دستگاه و رهگیری وضعیت ارسال کنید.
OTP را همراه با purpose، locale و زمان انقضای روشن ارسال کنید.
کد را بررسی کنید و نتیجه success/failed/expired را شفاف برگردانید.
وضعیت پیام، تلاشها و دلایل خطا را با request_id بخوانید.
دفترچه گیرندگان ذخیرهشده را بخوانید و با نام یا شماره جستوجو کنید.
یک فهرست کامل را در صف قرار دهید؛ هر شماره یک مورد جداگانه میشود.
unauthorizedکلید API یا هدر احراز هویت نامعتبر است.
invalid_deviceدستگاه در دسترس نیست یا برای مسیریابی معتبر نیست.
rate_limitedمحدودیتهای ارسال یا آستانههای ایمنی رد شدهاند.
queue_blockedارسال بهطور موقت بهدلیل وضعیت صف یا سیاستها مسدود شده است.
subscription_expiredاشتراک منقضی شده و نیاز به تمدید دارد.
It fits login systems, stores, bookings, invoices, and operational alerts that need OTP or event-driven messaging, not mass marketing campaigns.
Yes. Ready-to-copy examples include cURL, PHP, Laravel, Node, Axios, Python, Flutter, Kotlin, Java, C#, Go, and Ruby.
Yes. You can rely only on Send OTP and Verify OTP if your project needs verification without other messaging flows.
The device should preferably stay online with permissions and foreground service enabled so sending and status heartbeat continue normally.
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.