راهنمای ارسالِ کدِ تأیید (OTP) با API پیامک
برای ارسالِ کدِ تأیید، API نسخهٔ جدیدِ HomaCRM را پیشنهاد میکنیم. با توکن کار میکند، به رمزِ پنل نیاز ندارد و خطاهایش روشن و قابلِ پیگیری است.
بهروزرسانی: ۱۴ آبان ۱۴۰۵
۱گرفتنِ توکن
- با حسابِ مدیرِ اصلیِ پرتال وارد پنل شوید.
- به مدیریتِ کاربران بروید و دکمهٔ «توکنها» را بزنید.
- پیشنهادِ ما: از بخشِ Token list یک توکنِ جدا با نامِ مشخص (مثلاً «OTP سایت») بسازید، بهجای استفاده از توکنِ اصلی.
- توکن را کپی کنید و فقط روی سرورِ خودتان نگه دارید.
با ساختنِ دوبارهٔ یک توکن، نسخهٔ قبلیِ آن باطل میشود.
۲ارسالِ کد
یک درخواستِ POST با توکن در هدرِ Authorization بفرستید:
POST https://www.homacrm.com/api/v1/external/messaging/send
Authorization: YOUR_TOKEN
Content-Type: application/json
{
"recipient": "09XXXXXXXXX",
"message": "کد تأیید شما: 482913"
}پاسخِ موفق "success": true دارد، همراه با شناسهٔ پیامک (messageId).
اگر senderId را نفرستید و پروفایلِ WhoIS پرتالتان تأیید شده باشد، پیام از خطِ خدماتیِ مشترک میرود. برای انتخابِ خطِ مشخص، شناسهٔ آن را از GET /api/v1/external/messaging/numbers بگیرید.
۳چند نکتهٔ مهم
- کد را خودتان بسازید (مثلاً ۶ رقم)، به مدتِ ۲ تا ۵ دقیقه معتبر نگه دارید و تأییدش را هم در سیستمِ خودتان انجام دهید.
- متن را کوتاه بنویسید. هر صفحهٔ پیامکِ فارسی ۷۰ حرف است.
- برای هر شماره سقف بگذارید، مثلاً یک کد در هر دقیقه، تا جلوی سوءاستفاده و هزینهٔ اضافه گرفته شود.
- توکن را هرگز در اپِ موبایل یا کدِ سمتِ مرورگر قرار ندهید.
- اگر خطا گرفتید، در پاسخ یک کدِ خطا و یک
requestIdهست. همین شناسه را برای پشتیبانی بفرستید تا سریع بررسی شود.
مستنداتِ کامل
همهٔ امکاناتِ دیگر، مثلِ موجودی، فهرستِ خطها و گزارشِ ارسال، در مستندات آمده است.
اگر سیستمِ شما از قبل به رابطِ قدیمی وصل است: وبسرویسِ SOAP قدیمی (متدِ OTPGenerate) هنوز کار میکند، ولی برای اتصالِ تازه همین نسخهٔ جدید را پیشنهاد میکنیم. امکاناتش بیشتر است و پشتیبانیاش سادهتر.