فایل‌های چندرسانه‌ای

آپلود فایل

تصویر یا ویدیو آپلود می‌کند تا با پارامتر mediaid همراه پیام فرستاده شود. فقط روی خطوط پیام‌رسان داخلی کار می‌کند.

POST
https://api.payamras.ir/v1/YOUR_API_KEY/media/upload.json
  • درخواست multipart/form-data است و فایل در فیلد File قرار می‌گیرد.
  • تصویر: JPEG یا GIF تا ۱۰ مگابایت. ویدیو: MP4 تا ۲۰ مگابایت و ۶۰ ثانیه.
  • فایلی که ۳۰ روز پشت سر هم استفاده نشود حذف می‌شود.
  • فایل پس از آپلود بررسی می‌شود؛ تا review.status برابر 1 نشده، در پیام قابل استفاده نیست.

پارامترها

نامنوعتوضیح
File الزامی File فایل تصویر یا ویدیو.

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

curl -X POST "https://api.payamras.ir/v1/YOUR_API_KEY/media/upload.json" \
  -F "File=@banner.jpg"

پاسخ

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

فیلدنوعتوضیح
id Guid شناسه فایل؛ همان mediaid در ارسال پیام.
name String نام فایل.
mime_type String نوع فایل.
size Long حجم به بایت.
duration Integer مدت ویدیو به ثانیه.
resolution String ابعاد تصویر یا ویدیو.
status Integer وضعیت پردازش: 0 در حال پردازش، 1 آماده، 2 خطا.
review.status Integer نتیجه بررسی: 1 تایید، 2 رد.
response.json
{
    "return": {
        "status": 200,
        "message": "تایید شد"
    },
    "entries": {
        "id": "3f2b7c1e-9a4d-4e21-8b0f-6c5d2a1e9f30",
        "name": "banner.jpg",
        "mime_type": "image/jpeg",
        "extension": "jpg",
        "size": 284512,
        "duration": null,
        "resolution": "1080x1080",
        "status": 0,
        "status_desc": "در حال پردازش",
        "review": {
            "status": null,
            "status_desc": null,
            "reason": null,
            "reason_desc": null
        }
    }
}

خطاهای رایج

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

  • 800 فایل ارسال نشده است.
  • 801 فایل نامعتبر است یا قابل پردازش نیست.
  • 802 حجم فایل مجاز نیست.
  • 803 نسبت ابعاد فایل مجاز نیست.
  • 804 مدت ویدیو مجاز نیست.
  • 805 اجازه آپلود فایل ندارید.
  • 806 سهمیه آپلود تمام شده است.
  • 807 این فایل قبلا آپلود شده است.