مستندات ماژول گراویتی فرم
راهنمای کامل ماژول گراویتی فرم ویکیپیام
این راهنما نصب، فعالسازی و تنظیم ماژول گراویتی فرم ویکیپیام را توضیح میدهد؛ از دریافت توکن API و ساخت Feed پیامکی تا ارسال پیامک به مدیر، پیامک به کاربر، ارسال شرطی، OTP فرمها، قالب پیامک، Merge Tagها، گزارش ارسال و عیبیابی.
دانلود مستقیم در حال حاضر فعال نیست
چون فایل ZIP ماژول در مسیر عمومی پروژه موجود نیست، دکمه دانلود مستقیم به درخواست از پشتیبانی تغییر کرده است تا کاربر به صفحه 404 نرسد.
کاربردهای اصلی
ارسال پیامک پس از ثبت فرم، اعلان به مدیر، پیامک تأیید به کاربر، ارسال شرطی بر اساس فیلدها، OTP شماره موبایل و ثبت گزارش کامل ارسال.
پیشنیازها
وردپرس فعال، افزونه Gravity Forms، دسترسی مدیر، حساب ویکیپیام، توکن API و خط ارسالکننده معتبر برای تست ارسال.
مراحل اصلی
دریافت فایل ماژول از پشتیبانی، نصب و فعالسازی، ثبت Token، تست اتصال، ساخت Feed برای فرم، تعیین گیرنده مدیر و کاربر، تنظیم شرطها و بررسی گزارش ارسال.
پیامک فرمهای وردپرس، سریع، شرطی و قابل پیگیری
ماژول گراویتی فرم ویکی پیام برای ارسال پیامک پس از ثبت فرم، اعلان مدیر، پیامک کاربر، تأیید شماره موبایل با OTP، ارسال شرطی، قالبهای آماده و گزارش کامل ارسال طراحی شده است.
درخواست شما با کد پیگیری {{entry_id}} ثبت شد. کارشناسان ما با شما تماس میگیرند.
شروع سریع در ۵ دقیقه
از دریافت توکن تا تست ارسال پیامک فرم، همه مراحل اصلی در همین مسیر انجام میشود.
فایل ZIP ماژول پس از نهاییسازی در همین بخش قرار میگیرد. تا آن زمان برای دریافت فایل، با پشتیبانی ویکیپیام مکاتبه کنید.
توکن API را از پروفایل ویکی پیام دریافت کنید.
Token، Base URL و خط ارسال را ثبت کنید.
برای فرم موردنظر پیامک مدیر و کاربر را تعریف کنید.
فرم را ثبت و نتیجه را در گزارش ارسال ببینید.
مسیر نصب در وردپرس
پیشخوان وردپرس ← افزونهها ← افزودن ← بارگذاری افزونه ← انتخاب فایل ZIP ماژول گراویتی فرم ویکی پیام
امکانات ماژول گراویتی فرم
قابلیتها بر اساس نیاز فرمها، مدیر سایت و کاربر نهایی طراحی شدهاند.
ارسال به مدیر
ارسال پیامک به یک یا چند مدیر پس از ثبت فرم جدید.
ارسال به کاربر
خواندن شماره از فیلد موبایل و ارسال پیامک تأیید ثبت فرم.
OTP فرم
تأیید شماره موبایل قبل از ثبت نهایی فرم یا قبل از پرداخت.
ارسال شرطی
ارسال پیامک بر اساس مقدار فیلدها، نوع درخواست، شهر یا گزینه انتخابی.
Merge Tags
استفاده از متغیرهای فرم مانند نام، موبایل، ایمیل و شماره پیگیری.
گزارش ارسال
ثبت track_id، پاسخ API، وضعیت ارسال، تاریخ و شماره گیرنده.
قالب پیامک
تعریف قالبهای آماده برای ثبت فرم، مدیر و OTP.
تست اتصال
بررسی Token با دریافت موجودی از API ویکی پیام.
Token ماژول را از پروفایل ویکی پیام بردارید
برای فعالسازی ارسال پیامک در گراویتی فرم، ابتدا وارد پنل ویکی پیام شوید و از صفحه پروفایل، Token اختصاصی حساب خود را دریافت کنید. سپس آن را در بخش «ویکی پیام ← تنظیمات API» یا «Gravity Forms ← Settings ← SMS Settings» وارد کنید.
تنظیمات اولیه API
پس از فعالسازی افزونه، وارد منوی «ویکی پیام ← تنظیمات API» شوید و اطلاعات اتصال را وارد کنید.
| فیلد | توضیح | نمونه |
|---|---|---|
| Base URL | آدرس اصلی سرویس ویکی پیام | https://wikipayam.ir |
| API Prefix | مسیر نسخه API | api/v1 |
| Auth Token | توکن اختصاصی کاربر | YOUR_AUTH_TOKEN_HERE |
| Sender | خط ارسالکننده پیشفرض | 10002000 |
| OTP Pattern ID | شناسه الگوی OTP در صورت استفاده | 13 |
| Timeout | زمان انتظار درخواست API | 20 |
تست اتصال و دریافت موجودی
برای اطمینان از صحت Token، دکمه «تست اتصال» را بزنید. ماژول درخواست دریافت موجودی را ارسال میکند و نتیجه را در پنل نمایش میدهد.
GET https://wikipayam.ir/api/v1/user/balance
Authorization: Bearer YOUR_AUTH_TOKEN_HERE
Accept: application/jsonارسال پیامک تست
بعد از تست اتصال، یک پیامک آزمایشی به شماره موبایل خود ارسال کنید تا Sender، Token و مسیر API همزمان بررسی شوند.
POST https://wikipayam.ir/api/v1/sms/send
Authorization: Bearer YOUR_AUTH_TOKEN_HERE
Content-Type: application/json
Accept: application/json
[
{
"sender": "10002000",
"receiver": "09123456789",
"message": "تست اتصال ماژول گراویتی فرم ویکی پیام",
"track_id": "GF-TEST-001"
}
]ساخت Feed پیامکی برای هر فرم
برای هر فرم میتوانید چند سناریوی پیامکی جدا بسازید؛ مثلاً یکی برای مدیر، یکی برای کاربر و یکی برای OTP.
مسیر ساخت Feed
بعد از نصب ماژول، وارد فرم موردنظر شوید و از تنظیمات همان فرم، Feed پیامکی ویکی پیام را اضافه کنید.
Forms
→ انتخاب فرم
→ Settings
→ WikiPayam SMS
→ Add New Feed- انتخاب نوع ارسال: مدیر، کاربر، OTP یا سفارشی
- انتخاب فیلد شماره موبایل
- تعریف متن پیامک با Merge Tag
- فعالسازی شرط ارسال در صورت نیاز
- ذخیره و تست با ثبت فرم واقعی
فیلدهای مهم Feed
| فیلد | کاربرد |
|---|---|
| Feed Name | نام سناریوی پیامکی، مثل «اعلان مدیر» |
| Recipient | شماره مدیر یا فیلد موبایل کاربر |
| Sender | خط ارسال اختصاصی یا خط پیشفرض |
| Message | متن پیامک با متغیرهای فرم |
| Condition | ارسال فقط در شرایط خاص |
| Log | ذخیره نتیجه ارسال در گزارش و Entry Note |
نمونه پیامک به کاربر
{نام:1} عزیز
درخواست شما با کد پیگیری {entry_id} ثبت شد.
ویکی پیامنمونه پیامک به مدیر
فرم جدید ثبت شد:
نام: {نام:1}
موبایل: {موبایل:2}
موضوع: {موضوع:3}
کد ورودی: {entry_id}OTP شماره موبایل در Gravity Forms
Gravity OTPبا فعالسازی OTP، کاربر ابتدا کد تأیید را دریافت میکند و پس از وارد کردن کد صحیح، فرم قابل ثبت یا ادامه میشود.
- انتخاب فیلد شماره موبایل برای ارسال OTP
- تعیین مدت اعتبار کد، مثلاً ۲ یا ۵ دقیقه
- محدودیت ارسال مجدد برای جلوگیری از سوءاستفاده
- ثبت نتیجه در گزارش ارسال و Entry Note
Endpoint مورد استفاده
POST https://wikipayam.ir/api/v1/otp/sms/send
Authorization: Bearer YOUR_AUTH_TOKEN_HERE
Content-Type: application/json
Accept: application/jsonنمونه درخواست OTP
[
{
"receiver": "09123456789",
"code": "123456",
"otp_pattern_id": 13,
"track_id": "GF-OTP-1001"
}
]قالب پیامک و Merge Tagها
در متن پیامک میتوانید از Merge Tagهای گراویتی فرم استفاده کنید. ماژول قبل از ارسال، مقادیر فرم را جایگزین میکند.
{نام:1} عزیز، فرم شما با موفقیت ثبت شد.
کد پیگیری: {entry_id}
وضعیت درخواست از طریق پیامک اطلاعرسانی میشود.
ویکی پیامگزارش ارسال و وضعیت تحویل
تمام ارسالها با track_id ذخیره میشوند. برای پیامکهایی که id دارند، امکان پیگیری وضعیت تحویل از API فراهم است.
POST https://wikipayam.ir/api/v1/sms/deliver
Authorization: Bearer YOUR_AUTH_TOKEN_HERE
Content-Type: application/json
{
"id": ["69e5eeab439260d336015405"]
}پیامکهای دریافتی و لغو عضویت
اگر از خط دریافتدار استفاده میکنید، ماژول میتواند پیامکهای ورودی مانند «لغو» یا «۱۱» را بررسی کند و در گزارش یا لیست سیاه داخلی نمایش دهد.
GET https://wikipayam.ir/api/v1/receives/unread/count
Authorization: Bearer YOUR_AUTH_TOKEN_HERE
Accept: application/jsonعیبیابی سریع
منوی ویکی پیام را نمیبینم
- افزونه فعال باشد.
- کاربر فعلی دسترسی Administrator داشته باشد.
- مستقیم آدرس
/wp-admin/admin.php?page=wikipayam-sms-dashboardرا تست کنید. - اگر Gravity Forms غیرفعال است، آن را فعال کنید.
SMS Settings داخل Gravity Forms میآید؟
بله، طبیعی است. چون این ماژول روی هسته گراویتی فرم سوار میشود، یک بخش تنظیمات داخل خود Gravity Forms هم دارد. منوی ویکی پیام برای داشبورد، ظاهر جدید، تنظیمات سریع و گزارشها استفاده میشود.
خطای Token یا 401
- Token را دوباره از پروفایل ویکی پیام کپی کنید.
- فاصله اضافی قبل و بعد Token را حذف کنید.
- Base URL باید
https://wikipayam.irباشد. - API Prefix باید
api/v1باشد.
پیامک ارسال نمیشود
- مانده اعتبار حساب را بررسی کنید.
- شماره موبایل باید با فرمت معتبر مثل 09123456789 باشد.
- خط ارسالکننده در پنل فعال باشد.
- گزارش ارسال و پاسخ API را بررسی کنید.
سوالات متداول
آیا این ماژول بدون Gravity Forms کار میکند؟
خیر. این صفحه مخصوص ماژول گراویتی فرم است و برای کارکرد کامل، افزونه Gravity Forms باید نصب و فعال باشد.
آیا برای هر فرم میشود چند پیامک تعریف کرد؟
بله. برای هر فرم میتوانید Feedهای جداگانه برای مدیر، کاربر، OTP و سناریوهای شرطی ایجاد کنید.
آیا ارسال شرطی پشتیبانی میشود؟
بله. میتوانید تعیین کنید پیامک فقط زمانی ارسال شود که یک فیلد مقدار خاصی داشته باشد؛ مثلاً نوع درخواست «فوری» باشد.
آیا تست زنده باعث کسر اعتبار میشود؟
اگر پیامک واقعی ارسال شود، مطابق تعرفه حساب کاربر محاسبه میشود. دریافت موجودی و تست اتصال بدون ارسال پیامک نباید هزینه پیامک داشته باشد.