پشتیبانی از REST API
درخواست ارسال با پارامترهای مشخص از سمت سرور شما به سرویس ریلکس فرستاده میشود.
مراحل اتصال سایت به پنل پیامک ریلکس
۱. ساخت حساب
حساب کاربری بسازید و کلید API دریافت کنید.
۲. نگهداری کلید
کلید دسترسی را فقط در سمت سرور قرار دهید.
۳. ارسال تست
ارسال پیامک تراکنشی یا کد تأیید را تست کنید.
۴. وبهوک
آدرس بازگشت را فعال کنید تا وضعیت تحویل و خطا به سیستم شما برگردد.
Endpointهای اصلی
آدرسهای اصلی API برای ارسال و دریافت وضعیت پیامک
هر Endpoint وظیفه مشخصی دارد: ارسال پیام، دریافت وضعیت، ثبت آدرس بازگشت و ارسال کد یکبارمصرف.
POST
ارسال پیامک تراکنشی/v1/messagesارسال پیامک رویدادمحور برای وضعیت سفارش، اعلان کاربر، یادآوری یا پیام اطلاعرسانی.
tomessagesender
GET
دریافت وضعیت پیام/v1/messages/{id}بررسی وضعیت queued، sent، delivered یا failed برای پیگیری نتیجه ارسال.
queueddeliveredfailed
POST
ثبت وبهوک پیامک/v1/webhooksتعریف آدرس بازگشت یا Callback برای دریافت خودکار وضعیت تحویل و خطا.
urlsecretevents
POST
ارسال کد تأیید/v1/otp/sendارسال کد یکبارمصرف برای سناریوهای ورود، ثبتنام یا احراز شماره موبایل.
mobiletemplate_idttl
نمونه کد آماده
نمونهکد ارسال پیامک و دریافت پاسخ سرویس
نمونههای JavaScript و PHP و یک پاسخ JSON در ادامه قرار دارند. کلید API را فقط در سمت سرور نگه دارید و هرگز آن را در کد مرورگر قرار ندهید.
کلید فقط سمت سرور Retry کنترلشده بازگشت وضعیت تحویل
node.js
const response = await fetch('https://api.relax.ir/v1/messages', {
method: 'POST',
headers: {
Authorization: 'Bearer RELAX_API_KEY',
'Content-Type': 'application/json'
},
body: JSON.stringify({
to: '09XXXXXXXXX',
message: 'سفارش شما ثبت شد.'
})
});
const data = await response.json();php
$client = new \GuzzleHttp\Client();
$response = $client->post('https://api.relax.ir/v1/messages', [
'headers' => ['Authorization' => 'Bearer RELAX_API_KEY'],
'json' => ['to' => '09XXXXXXXXX', 'message' => 'سفارش شما ثبت شد.']
]);response.json
{
"ok": true,
"message_id": "msg_8x92ad",
"status": "queued",
"created_at": "2026-06-26T12:30:00+03:30"
}
اتصال به سامانه پیامکی
اتصال نرمافزار به پنل پیامک برای ارسال خودکار
این رابط برنامهنویسی پیامک برای اتصال CRM به پنل پیامک ریلکس مناسب است و فروشگاه، اپلیکیشن، سامانه رزرو یا نرمافزارهای داخلی را نیز پوشش میدهد؛ جایی که پیام باید پس از ثبت سفارش یا تغییر وضعیت، خودکار ارسال شود.
در این صفحه روش اتصال، ارسال پیامک تراکنشی، دریافت گزارش و بازگشت وضعیت تحویل توضیح داده شده است. برای طراحی تجربه ورود و کنترل درخواست کد، صفحه OTP را ببینید.
مسیر اتصال فنی
از ارسال پیام تا پیگیری نتیجه
ارسال پیامک تراکنشی
ثبت سفارش، تغییر وضعیت، یادآوری و اعلان حساب میتوانند بدون ورود دستی ارسال شوند.
گزارش تحویل و آدرس بازگشت
آدرس بازگشت، نتیجه ارسال و تحویل را به سیستم شما برمیگرداند تا وضعیت هر پیام در نرمافزار ثبت شود.
نمونهکد و مستندات API پیامک
برای شروع، نمونهکد و پارامترهای اصلی هر درخواست در همین صفحه قرار دارد.
نکات امنیتی API پیامک
- کلید API را فقط در سمت سرور نگه دارید.
- برای هر شماره یا IP محدودیت درخواست بگذارید.
- برای ارسال کد تأیید، مدت اعتبار و ارسال مجدد را کنترل کنید.
- درخواستهای Callback را با Secret اعتبارسنجی کنید.
خطاهای رایج وب سرویس پیامک
- شماره موبایل نامعتبر یا خارج از قالب.
- تعداد درخواست بیش از حد مجاز.
- قالب پیام یا کلید دسترسی نامعتبر.
- ثبت نکردن آدرس بازگشت یا اعتبارسنجی نادرست درخواستهای ورودی.
سؤالات API پیامک
پرسشهای متداول درباره API پیامک
پاسخهای این بخش درباره شروع اتصال، نگهداری کلید، آدرس بازگشت، گزارش تحویل و تفاوت اتصال فنی با سرویس OTP است.
API پیامک برای اتصال سایت، فروشگاه، CRM و اپلیکیشن به ارسال پیامک تراکنشی، پیامک وضعیت سفارش، اعلانهای خودکار، دریافت گزارش تحویل و ثبت رویدادهای پیامکی در نرمافزار شما استفاده میشود.
ابتدا حساب کاربری و کلید API را دریافت کنید، درخواست آزمایشی بفرستید و سپس وبهوک را برای دریافت وضعیت تحویل فعال کنید. کلید باید فقط در سمت سرور نگهداری شود.
کلید API باید فقط در سمت سرور نگهداری شود و نباید داخل کدهای مرورگر، فایل JavaScript، اپلیکیشن عمومی یا مخزن عمومی قرار بگیرد. برای امنیت بیشتر میتوان محدودیت IP، سطح دسترسی و چرخش دورهای کلید را هم در نظر گرفت.
این صفحه درباره اتصال فنی، Endpointها، کلید دسترسی و پاسخ API است. صفحه سرویس OTP بیشتر درباره سناریوی کد تأیید، احراز شماره موبایل، کنترل درخواست و تجربه کاربر توضیح میدهد.
وبهوک وضعیت ارسال، خطا یا تحویل را به سیستم شما برمیگرداند تا نتیجه هر پیام در دیتابیس ثبت و برای پشتیبانی قابل بررسی باشد.
بله، API برای پیامک خدماتی، پیامک تراکنشی، اعلان سفارش، یادآوری پرداخت، تمدید سرویس و اطلاعرسانیهای غیرتبلیغاتی کاربرد دارد. برای ارسالهای خدماتی، نوع خط، کاربرد پیام و شرایط فعالسازی باید جداگانه بررسی شود؛ جزئیات در راهنمای خط خدماتی پیامک آمده است.