ابزارک ها
مستندات SDK
پیامک (Rasan)

پیامک پزشک (Rasan)

اگر ابزارک شما نیاز دارد به بیمار پیامک بفرستد (مثل یادآوری نوبت یا کد پیگیری)، از ماژول rasan در Hamdast SDK استفاده کنید.

اول باید پیامک برای همان پزشک فعال شود؛ بعد می‌توانید از APIهای ارسال و موجودی استفاده کنید.

فعال‌سازی پیامک

قبل از اولین ارسال، در فرانت ابزارک متد activate را صدا بزنید:

window.hamdast.initialize({ app_key: "YOUR_APP_KEY" });
 
const result = await window.hamdast.rasan.activate();
 
if (result.event === "HAMDAST_RASAN_ACTIVATE_SUCCESS") {
  // پیامک آماده است
} else if (result.event === "HAMDAST_RASAN_ACTIVATE_CANCEL") {
  // پزشک فعال‌سازی را نپذیرفت
} else if (result.event === "HAMDAST_RASAN_ACTIVATE_ERROR") {
  // فعال‌سازی ناموفق بود — result.message
}
FieldTypeDescription
eventStringنتیجه درخواست: SUCCESS، CANCEL یا ERROR
activatedBooleanآیا پیامک فعال است (در حالت SUCCESS)
creditNumberموجودی فعلی پیامک پزشک (در صورت وجود)
messageStringتوضیح خطا در حالت ERROR

نکات مهم

  • این متد فقط وقتی ابزارک داخل پنل پذیرش۲۴ لود شده باشد کار می‌کند.
  • اگر پیامک از قبل فعال باشد، نتیجه موفق برمی‌گردد و نیازی به کار اضافه از طرف پزشک نیست.
  • تا وقتی فعال‌سازی موفق نشده، APIهای ارسال و موجودی قابل استفاده نیستند.

ارسال پیامک و مشاهده موجودی

بعد از فعال‌سازی موفق، از APIهای Rasan استفاده کنید:

  • مشاهده موجودی: GET /v1/rasan/balance
  • ارسال پیامک: POST /v1/rasan/messages

جزئیات کامل درخواست و پاسخ در مرجع API پیامک (Rasan) آمده است.

اگر هنوز فعال‌سازی انجام نشده باشد، این APIها با وضعیت 409 و کد SMS_NOT_ACTIVATED خطا می‌دهند.

شارژ موجودی پیامک

پکیج‌های پیامک در کل پلتفرم مشترک‌اند (ابزارک رسمی rasan). برای باز کردن مودال شارژ:

const result = await window.hamdast.rasan.charge();
 
if (result.event === "HAMDAST_RASAN_CHARGE_SUCCESS") {
  // result.credit / result.sms_count
}

پزشک بسته ثابت یا تعداد دلخواه را انتخاب می‌کند؛ مبلغ = تعداد × ۱۳۶۶ ریال؛ پرداخت از کیف پول/درگاه با اپ rasan انجام می‌شود و بعد اعتبار روی پنل کاوه‌نگار اعمال می‌شود.