رفتن به محتوای اصلی
مستندات نجوا
فایل

بارگذاری فایل برای ارسال در بله

post
https://sms.najva.com/upload-file/bale

یک فایل رسانه‌ای را روی سرویس بله بارگذاری می‌کند و شناسهٔ یکتای داخلی (UUID) آن را برمی‌گرداند. این شناسه را می‌توانید در پارامتر file_id اندپوینت‌های ارسال استفاده کنید. درخواست باید multipart/form-data با فیلد file باشد. پسوندهای مجاز: jpeg، jpg، png، gif، opus، ogg، mp4، mp3. حداکثر حجم فایل از متغیر پیکربندی UPLOAD_FILE_MAX_SIZE_BYTES خوانده می‌شود و مقدار پیش‌فرض آن ۱۰٬۴۸۵٬۷۶۰ بایت (۱۰ مگابایت) است. شناسهٔ بازگشتی به حساب کاربری شما گره خورده است و فقط با همان حساب قابل استفاده است.

احراز هویت

نوع احراز هویتتوکن BearerbearerAuth

کلید API را در هدر Authorization با پیشوند Bearer بفرستید:

``` Authorization: Bearer YOURAPIKEY ```

این روش برای سرویس‌های نسخهٔ ۲، نسخهٔ ۳ و بارگذاری فایل به کار می‌رود. سرویس‌های نسخهٔ ۱ کلید را از مسیر URL می‌گیرند و هدری نمی‌خواهند.

هدر لازم
Authorization: Bearer YOUR_ACCESS_TOKEN

کلید خود را کجا پیدا کنم؟

اطلاعات ورود را از پنل کاربری خود بگیرید و توکن را فقط روی سرور و در یک متغیر محیطی نگه دارید؛ هرگز آن را در کد سمت کاربر قرار ندهید.

بدنهٔ درخواست

multipart/form-dataالزامی

فرم چندبخشی حاوی فایل.

نامنوعالزامیتوضیح
file*
stringالزامی

فایل مورد نظر برای بارگذاری. پسوند از روی نام فایل بررسی می‌شود (بدون حساسیت به بزرگی/کوچکی حروف) و محتوای فایل اعتبارسنجی نمی‌شود.

محدودیت: حداکثر حجم: مقدار UPLOADFILEMAXSIZEBYTES (پیش‌فرض 10485760 بایت). پسوند مجاز: jpeg, jpg, png, gif, opus, ogg, mp4, mp3

مقادیر مجازjpegjpgpnggifopusoggmp4mp3

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

{
  "file": "jpeg"
}

پاسخ‌ها

ساختار پاسخ

نامنوعالزامیتوضیح
return
ApiStatusاختیاری

وضعیت پاسخ. مقدار status با کد وضعیت HTTP پاسخ یکسان است.

status*
integerالزامی

کد وضعیت — همان کد وضعیت HTTP پاسخ.

نمونه200
message*
stringالزامی

پیام فارسی قابل نمایش به کاربر.

نمونهدرخواست تایید شد.
entries
UploadFileResponseاختیاری
file_id
stringاختیاری

شناسهٔ فایل (UUID). همین مقدار را در file_id سرویس‌های ارسال بگذارید.

نمونه3f2b9c8e-5a41-4d7f-9c2a-8e1b6d0f4a73

نمونهٔ پاسخ

{
  "return": {
    "status": 200,
    "message": "درخواست تایید شد."
  },
  "entries": {
    "file_id": "3f2b9c8e-5a41-4d7f-9c2a-8e1b6d0f4a73"
  }
}