سرویس API پیامدهی
دریافت پیامک
دریافت پیامک — Relay Service
برای دریافت ترافیک ورودی پیامک روی URL خود، یک endpoint بسازید و پارامترهای زیر را بپذیرید:
فرمت callback
yourURL/?portalcode=$value&reference=$value&smsNumber=$value&from=$value&body=$value
ضروری فیلد ضروری
اختیاری فیلد اختیاری
| پارامتر | نوع | توضیح |
|---|---|---|
| portalcode | ضروری | کد پرتال |
| reference | ضروری | نوع مرجع شماره دریافتکننده |
| smsNumber | ضروری | شماره دریافتکننده |
| from | ضروری | شماره موبایل فرستنده |
| body | ضروری | متن پیامک |
به محض دریافت پیامک، علاوه بر ذخیره در Inbox سیستم، یک نسخه به URL شما POST/GET میشود.
تنظیم URL در هُما:
- تنظیمات سیستم → تب «تنظیمات پایه»
- SYSTEM REGISTRY
- جستجوی
MODULES_SMS_RELAY_FORWARDING_URL - در Value 1 آدرس مطلق URL را وارد کنید (بدون پارامتر اضافه) — مثال:
http://relay.example.com/Relay - ذخیره و تست
نکات
- برای اتصال نرمافزارهای حسابداری از بخش «اتصال سایر نرمافزارها» استفاده کنید: نام کاربری = توکن API، کد پرتال = پارامتر PortalCode.
- اتصال مستقیم فقط وقتی ممکن است که نرمافزار اجازه تعریف URL و پارامترهای دلخواه را بدهد؛ در غیر این صورت افزونه/واسط اختصاصی لازم است.
- ServerType=100 برای ارسال عمومی و OTP (لیست سیاه مخابرات) توصیه میشود.
- پاسخ موفق: عدد بزرگتر از ۱۰۰۰؛ هر عدد دیگر کد خطاست.
- برای پیام حاوی لینک یا ارسال از شماره عمومی، پروفایل WhoIS باید تکمیل و تأیید شده باشد.
- برای تست سریع REST API، URL را با پارامترها در مرورگر باز کنید.
- در صورت خطا، کد بازگشتی و ServerType را در تیکت پشتیبانی ذکر کنید.