حساب کاربری

تنظیمات حساب

تنظیمات وب‌سرویس حساب را می‌خواند یا تغییر می‌دهد. بدون پارامتر فقط تنظیمات فعلی را برمی‌گرداند.

GET POST
https://api.payamras.ir/v1/YOUR_API_KEY/account/config.json
  • با debugmode=enabled درخواست‌های ارسال اجرا نمی‌شوند و اعتباری کم نمی‌شود؛ برای تست یکپارچه‌سازی مناسب است. یادتان باشد قبل از راه‌اندازی آن را غیرفعال کنید.

پارامترها

نامنوعتوضیح
apilogs اختیاری String ثبت لاگ درخواست‌ها: justfaults (فقط خطاها)، enabled یا disabled.
debugmode اختیاری String enabled یا disabled. در حالت enabled ارسال واقعی انجام نمی‌شود.
defaultsender اختیاری String خط پیش‌فرض ارسال.
mincreditalarm اختیاری Integer آستانه هشدار کمبود اعتبار به ریال.
resendfailed اختیاری String ارسال مجدد پیام‌های ناموفق: enabled یا disabled.

نمونه درخواست

curl -G "https://api.payamras.ir/v1/YOUR_API_KEY/account/config.json" \
  --data-urlencode "debugmode=enabled"

پاسخ

فیلدهای هر ردیف entries:

فیلدنوعتوضیح
apilogs String وضعیت ثبت لاگ.
dailyreport String وضعیت گزارش روزانه.
debugmode String وضعیت حالت تست.
defaultsender String خط پیش‌فرض.
mincreditalarm Integer آستانه هشدار اعتبار.
resendfailed String وضعیت ارسال مجدد.
response.json
{
    "return": {
        "status": 200,
        "message": "تایید شد"
    },
    "entries": {
        "apilogs": "justfaults",
        "dailyreport": "enabled",
        "debugmode": "enabled",
        "defaultsender": "10004346",
        "mincreditalarm": 500000,
        "resendfailed": "enabled"
    }
}

خطاهای رایج

علاوه بر خطاهای عمومی مثل 403 و 418، این متد ممکن است این کدها را در return.status برگرداند:

  • 407 دسترسی به این اطلاعات مجاز نیست.