استعلام اعتبار حساب | مستندات نجوا

احراز هویت: این سرویس کلید API را از مسیر URL می‌خواند (/v1/{apiKey}/...) و هدر احراز هویتی ندارد. درخواست فقط از آی‌پی‌های وایت‌لیست‌شده پذیرفته می‌شود. به احراز هویت و وایت‌لیست IP نگاه کنید.

اعتبار جاری حساب کاربری را برمی‌گرداند. این endpoint هیچ پارامتر ورودی جز apiKey در مسیر نمی‌گیرد.

برخلاف بیشتر مسیرهای /v1/، این مسیر فقط با متد GET ثبت شده است و فراخوانی با POST به مسیر معتبری نمی‌رسد. مقدار برگشتی همان فیلد credit سرویس حسابداری است؛ همین مقدار در زمان ارسال پیامک با هزینهٔ پیام مقایسه می‌شود. پاسخ برای مدت کوتاهی در حافظهٔ نهان سرویس نگهداری می‌شود.

پارامترهای مسیر

نام	نوع	الزامی	توضیح
`apiKey`*	string	الزامی	کلید API حساب کاربری که به‌صورت بخشی از مسیر URL ارسال می‌شود (نه به‌صورت هدر). نمونه`a1b2c3d4e5f60718293a4b5c6d7e8f90`

پاسخ‌ها

ساختار پاسخ

نام	نوع	الزامی	توضیح
`return`	ApiStatus	اختیاری	وضعیت پاسخ. مقدار `status` با کد وضعیت HTTP پاسخ یکسان است.
`status`*	integer	الزامی	کد وضعیت — همان کد وضعیت HTTP پاسخ. نمونه`200`
`message`*	string	الزامی	پیام فارسی قابل نمایش به کاربر. نمونه`درخواست تایید شد.`
`entries`	BalanceResponse	اختیاری
`balance`	integer· int64	اختیاری	اعتبار حساب. واحد آن در کد سرویس اعلام نشده — به TODO انتهای فایل نگاه کنید. نمونه`1250000`قالب`int64`

نمونهٔ پاسخ

{
  "return": {
    "status": 200,
    "message": "درخواست تایید شد."
  },
  "entries": {
    "balance": 12345
  }
}